Click or drag to resize

Message Class

Interface for all Message related tasks and properties.
Inheritance Hierarchy
SystemObject
  Avaya.ClientServicesMessage

Namespace:  Avaya.ClientServices
Assembly:  AvayaClientServices (in AvayaClientServices.dll) Version: 550.0.60.0
Syntax
C#
public class Message

The Message type exposes the following members.

Properties
  NameDescription
Public propertyAddedParticipants
When the message type is Joined, this property returns the list of participants that were added to the conversation.
Public propertyAttachments
Gets the list of attachments for this message.
Public propertyBody
Returns the body of the message.
Public propertyConversationId
Returns the unique identifier of the conversation to which this message belongs.
Public propertyCreateAttachmentCapability
Returns a Capability object that indicates if an attachment can be added to the message.
Public propertyDeliveryDetailsCapability
Returns a Capability object that indicates whether the message can provide its delivery details.
Public propertyDeliveryState
The message delivery state describing whether this message is sent or delivered to one or more recipients.
Public propertyFromParticipant
Returns the participant who was the sender of the message.
Public propertyHasAttachment
Returns true if the message has one or more attachments.
Public propertyHasHtmlBody
Returns true if the message contains HTML body.
Public propertyHasInReplyTo
Returns true if message has InReplyTo message (does not mean it is in cache).
Public propertyHasUnreadAttachment
Returns true if the message has a least one attachment that has not been viewed.
Public propertyHtmlBody
Returns the HTML body of the message if the HTML body available, otherwise an empty string returned.
Public propertyId
Returns the unique message identifier.
Public propertyImportance
Returns the message importance.
Public propertyIsDoNotForward
Returns the IsDoNotForward status of the message, which indicates if the sender of this message had disallowed forwarding of this particular message.
Public propertyIsFromMe
Returns true if the current user is the sender of the message.
Public propertyIsPrivate
Returns true if the message is marked as a private message.
Public propertyLastModifiedDate
Returns the date and time that the message was last modified.
Public propertyMarkAsReadCapability
Returns a Capability object that indicates if the message can be marked as read.
Public propertyProviderMessageId
Returns the message ID from the underlying provider(e.g., the AMM server) as-is. It will be consistent across clients and application launches, but is only guaranteed to be unique for messages of that provider type. It will be empty for draft message.
Public propertyProviderType
Returns the messaging provider type.
Public propertyReadState
The message read state describing whether this message is read, partially read or not read.
Public propertyReason
Returns the message reason type.
Public propertyReceivedDate
Returns the date and time that the message was received.
Public propertyRecipients
Returns the list of participants, including the sender, that the message was sent to.
Public propertyRemoveCapability
Returns a Capability object that indicates if the message can be removed.
Public propertyRemovedParticipants
When the message type is Left, this property returns the list of participants that were removed from the conversation.
Public propertySendCapability
Returns a Capability object that indicates if the message can be sent.
Public propertySensitivity
Returns the message sensitivity.
Public propertyStatus
Returns the message status.
Public propertySubject
Returns the subject of the conversation at the time the message was sent.
Public propertyType
Returns the message type.
Public propertyUpdateBodyCapability
Returns a Capability object that indicates if the body text or "is typing" status of the message can be updated.
Public propertyUpdateDoNotForwardCapability
Returns a Capability object that indicates if the DoNotForward attribute of the message can be updated.
Public propertyUpdateImportanceCapability
Returns a Capability object that indicates if the Importance attribute of the message can be updated.
Public propertyUpdateInReplyToCapability
Returns a Capability object that indicates if the InReplyTo attribute of the message can be updated.
Top
Methods
  NameDescription
Public methodCreateAttachment
Creates an attachment for this message.
Public methodGetDeliveryDetails
Gets MessageDeliveryDetails or error. Delivery details are returned via completion handler.
Public methodGetInitiatorParticipant
Get initiator participant of an event message, such as LEFT message when a participant is removed from conversation by other participant(initiator)
Public methodGetInReplyTo
Gets InReplyToMessage or error if message is not in cache. Message is returned via completion handler.
Public methodMarkAsRead
Marks the message as read.
Public methodRemoveAttachment
Remove a specified attachment from this message.
Public methodReportTyping
Set or clear the "is typing" chat state. This is a "fire and forget" operation.
Public methodSend
Invokes a send request for this message.
Public methodSetBodyAndReportTyping(String, MessageCompletionHandler)
Sets the body of the draft message and the "is typing" chat state.
Public methodSetBodyAndReportTyping(String, String, MessageCompletionHandler)
Sets the plain text body and HTML body of the draft message along with "is typing" chat state.
Public methodSetDoNotForward
Sets a new message "do not forward" state.
Public methodSetImportance
Sets a new message importance.
Public methodSetInReplyTo
Sets the message that the current message is a direct reply to.
Top
Events
  NameDescription
Public eventBodyChanged
Notifies the application that the message's body text has changed in response to a local SetBodyAndReportTyping(String, MessageCompletionHandler) operation.
Public eventCapabilitiesChanged
Notifies the application that one or more of the capabilities of the message has changed. The application should query each of the capabilities and enable/disable elements of the user interface based on the new capability settings. Capabilities can change as a result of local or remote actions.
Public eventDeliveryStateChanged
Notifies the application that the delivery state of the message has changed.
Public eventDoNotForwardStatusChanged
Notifies the application that the "do not forward" status of the message has changed.
Public eventHasAttachmentStatusChanged
Notifies the application that the list of attachments associated with the message has changed.
Public eventHasUnreadAttachmentStatusChanged
Notifies the application that the unread attachment status of the message has changed.
Public eventImportanceChanged
Notifies the application that the importance of the message has changed.
Public eventInReplyToChanged
Notifies the application that the message's InReplyTo property has changed in response to a local SetInReplyTo(Message, MessageCompletionHandler) operation.
Public eventLastModifiedDateChanged
Public eventReadStateChanged
Notifies the application that the read state of the message has changed.
Public eventStatusChanged
Notifies the application that the status of the message has changed.
Top
Remarks

Message is a crucial part of the conversation. It can store not only text content or attachments, but is also used to inform about any event that occurred in the conversation, like a new participant or subject change. It is important to notice that the body cannot be empty for a usual message, unless an attachment is present.

To create a new message, call the Conversation.CreateMessage() method, which will return a new object. After filling out the message and its other parameters, use the Send operation in order to send a message.

An important part of the message is also attachments. In order to create a new attachment in a message object, use the CreateAttachment method.

Besides normal messages with text body there are also messages informing about events. MessageType is informing about an event type and these objects do not contain any text body. They can have some additional data about an event, i.e. AddedParticipants, RemovedParticipants, etc.

See Also