Click or drag to resize

MessagingService Class

The MessagingService object is accessible from the User object, and provides access to messaging related capabilities and actions.
Inheritance Hierarchy
SystemObject
  Avaya.ClientServicesMessagingService

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

The MessagingService type exposes the following members.

Properties
  NameDescription
Public propertyAutomaticallyUpdateLastAccessTimeCapability
Returns a Capability object that indicates if conversation last access timestamps will be updated automatically.
Public propertyClearLocalDataCapability
Returns a Capability object that indicates if local data can be cleared.
Public propertyCreateConversationCapability
Returns a Capability object allowing the client application to determine if it is currently possible to create a new conversation.
Public propertyHtmlCapability
Returns a Capability object allowing the client application to determine HTML capability.
Public propertyIsMessageDeliveryReadStateMonitoringSupported
A Boolean value indicating whether the last connected messaging service supported message delivery read state monitoring.
Public propertyIsMessageReadReportingSupported
A Boolean value indicating whether the last connected messaging service supported message read reporting.
Public propertyIsServiceAvailable
A Boolean value indicating whether the messaging service is available. This value is closely connected with capabilities - if the service is not running, usually all of the capabilities related to the service won't be allowed.
Public propertyMessageDeliveryReadStateMonitoringCapability
Returns a Capability object allowing the client application to determine if it is currently possible to report delivery state updates for sent messages.
Public propertyMessageReadReportingCapability
Returns a Capability object allowing the client application to determine if it is currently possible to report read state updates for sent messages.
Public propertyMessagingLimits
Returns Messaging Limits, which are containing information about the limits of the messaging component.
Public propertyNumberOfConversationsWithUnreadContent
Number of conversations with unread content for current user.
Public propertyNumberOfConversationsWithUnreadContentSinceLastAccess
Number of conversations with unread content since last access of current user.
Public propertyRefreshMode
Refresh mode for polling.
Public propertyRetrieveConversationCapability
Returns a Capability object that indicates if conversations can be retrieved from the server.
Public propertyRetrieveOlderConversationCapability
Returns a Capability object that indicates if older conversations can be retrieved from the server.
Public propertyRoutableDomains
Generic list of all routable domains presented as strings.
Public propertySearchConversationCapability
Returns a Capability object that indicates if conversations can be searched.
Public propertySelfAddress
String value containing address of currently logged in user. This value must be provided in the user configuration. Note that this address can be different than in other services.
Public propertyUpdateRefreshModeCapability
Returns a Capability object that indicates if the refresh mode can be changed.
Public propertyValidateParticipantAddressesCapability
Returns a Capability object that indicates if participant addresses can be validated.
Top
Methods
  NameDescription
Public methodClearAllLocalData(MessagingServiceCompletionHandler)
Removes all local data - messages, conversations and attachments.
Public methodClearAllLocalData(MessagingServiceCompletionHandler, MessagingProviderType)
Removes all local data - messages, conversations and attachments.
Public methodCreateConversation
Creates a new draft conversation.
Public methodCreateConversation(MessagingProviderType)
Creates a new draft conversation.
Public methodGetAutomaticallyUpdateLastAccessTimeCapability
Returns a Capability object that indicates if conversation last access timestamps will be updated automatically.
Public methodGetClearLocalDataCapability
Returns a Capability object that indicates if local data can be cleared.
Public methodGetCreateConversationCapability
Returns a Capability object allowing the client application to determine if it is currently possible to create a new conversation.
Public methodGetHtmlCapability
Returns a Capability object allowing the client application to determine HTML capability for the specified provider.
Public methodGetMessageDeliveryReadStateMonitoringCapability
Returns a Capability object allowing the client application to determine if it is currently possible to report delivery state updates for sent messages for the specific messaging provider.
Public methodGetMessageReadReportingCapability
Returns a Capability object allowing the client application to determine if it is currently possible to report read state updates for sent messages for the specific messaging provider.
Public methodGetMessagingLimits
Returns Messaging Limits, which are containing information about the limits of the messaging component.
Public methodGetNumberOfConversationsWithUnreadContent
Number of conversations with unread content for current user.
Public methodGetNumberOfConversationsWithUnreadContentSinceLastAccess
Number of conversations with unread content since last access of current user.
Public methodGetRemoveConversationCapability
Returns a Capability object that indicates if a specified conversation can be removed.
Public methodGetRetrieveConversationCapability
Returns a Capability object that indicates if conversations can be retrieved from the server.
Public methodGetRetrieveOlderConversationCapability
Returns a Capability object that indicates if older conversations can be retrieved from the server.
Public methodGetRoutableDomains
Generic list of all routable domains presented as strings.
Public methodGetSearchConversationCapability
Returns a Capability object that indicates if conversations can be searched.
Public methodGetSelfAddress
String value containing address of currently logged in user. This value must be provided in the user configuration. Note that this address can be different than in other services.
Public methodGetUpdateRefreshModeCapability
Returns a Capability object that indicates if the refresh mode can be changed.
Public methodGetValidateParticipantAddressesCapability
Returns a Capability object that indicates if participant addresses can be validated.
Public methodLeaveAllConversations
Leave all conversations for the currently logged in user.
Public methodLeaveConversations
Leave a specified list of conversations.
Public methodMarkMessagesAsRead
Mark multiple messages as read.
Public methodRefresh(MessagingServiceCompletionHandler)
Perform a manual refresh of messaging data from the server. This method is meant to be used when RefreshMode parameter is set to manual.
Public methodRefresh(MessagingServiceCompletionHandler, MessagingProviderType)
Perform a manual refresh of messaging data from the server. This method is meant to be used when RefreshMode parameter is set to manual.
Public methodRemoveConversation
Removes a conversation.
Public methodRemoveConversationCapability
Returns a Capability object that indicates if a specified conversation can be removed.
Public methodRetrieveActiveConversations
Performs a retrieval of all active conversations for the currently logged in user and watches for changes to this collection.
Public methodRetrieveActiveConversationsForContact
Retrieves the list of active conversations for a specified contact.
Public methodSearchConversations
Searches the user's conversations using specified filter criteria.
Public methodServiceAvailable
A Boolean value indicating whether the messaging provider is available. This value is closely connected with capabilities - if the service is not running, usually all of the capabilities related to the service won't be allowed.
Public methodSetRefreshMode
Sets refresh mode with completion handler. Using this method and changing refresh mode will impact how often client gets updates from the server.
Public methodValidateAddresses(AddressValidationWatcher, Contact)
Validates a list of supplied addresses to determine if they are valid messaging addresses.
Public methodValidateAddresses(AddressValidationWatcher, ListString)
Validates a list of supplied addresses to determine if they are valid messaging addresses.
Public methodValidateAddresses(AddressValidationWatcher, Contact, MessagingProviderType)
Validates a list of supplied addresses to determine if they are valid messaging addresses.
Public methodValidateAddresses(AddressValidationWatcher, ListString, MessagingProviderType)
Validates a list of supplied addresses to determine if they are valid messaging addresses.
Top
Events
  NameDescription
Public eventMessagingFailed
Notifies the application that messaging has failed.
Remarks
When messaging recovers from error state, MessagingServiceAvailable event will be raised.
Public eventMessagingMessageLimitsChanged
Notifies the application when messaging limits have changed.
Public eventMessagingParticipantMatchedContactsChanged
Notifies the application when a messaging participant matched contacts changed. This could be a result of change on contact list (i.e. a new contact was added which was present in an existing conversation). The matched contact can be used for an additional operation, which is not available on the messaging participant - for example making a call, etc.
Public eventMessagingProviderAvailable
Notifies the application that the messaging provider has successfully started or restored.
Public eventMessagingProviderCapabilitiesChanged
Notifies the application that messaging provider capabilities have changed.
Public eventMessagingProviderConversationsAdded
Notifies the application when provider conversations have been added.
Public eventMessagingProviderConversationsRemoved
Notifies the application when provider conversations have been removed.
Public eventMessagingProviderFailed
Notifies the application that messaging provider has failed.
Public eventMessagingProviderLimitsChanged
Notifies the application when messaging provider limits have changed.
Public eventMessagingProviderNumberOfConversationsWithUnreadContentChanged
Notifies the application when provider NumberOfConversationsWithUnreadContent has changed.
Public eventMessagingProviderNumberOfConversationsWithUnreadContentSinceLastAccessChanged
Notifies the application when provider NumberOfConversationsWithUnreadContentSinceLastAccess has changed.
Public eventMessagingProviderRemoveConversationFailed
Notifies the application when provider conversation has failed to remove.
Public eventMessagingProviderRemoveConversationSucceeded
Notifies the application when provider conversation has been removed successfully.
Public eventMessagingProviderRoutableDomainsChanged
Notifies the application that messaging provider capabilities have changed.
Public eventMessagingProviderUnavailable
Notifies the application that the messaging provider has been successfully closed or its work was interrupted, for example by a network or server problem.
Public eventMessagingServiceAvailable
Notifies the application that the messaging service has successfully started or restored.
Public eventMessagingServiceCapabilitiesChanged
Notifies the application that messaging service capabilities have changed.
Public eventMessagingServiceUnavailable
Notifies the application that the messaging service has been successfully closed or its work was interrupted, for example by a network or server problem.
Public eventNumberOfConversationsWithUnreadContentChanged
Notifies the application when a NumberOfConversationsWithUnreadContent has changed.
Public eventNumberOfConversationsWithUnreadContentSinceLastAccessChanged
Notifies the application when a NumberOfConversationsWithUnreadContentSinceLastAccess has changed.
Public eventRoutableDomainsChanged
Notifies the application when a messaging routable domains have changed.
Top
Remarks
The MessagingService object provides a set of APIs that allow application developers to manage text conversations along with rich media attachments.

In general, the capabilities and the set of allowed operations are dependent on the capabilities of the messaging server. A messaging conversation doesn't have any moderator once it is started by any user.

The client application is notified about status updates reported by the messaging server through event handlers that the application has registered on the MessagingService object's events. These updates may be the result of local operations on the MessagingService object as well as remote changes initiated by either the server or other participants of any conversation.

See Also