Avaya Client Services API Reference (Windows)
Avaya Client Services API Reference (Windows)
Avaya.ClientServices
MessagingService Class
MessagingService Properties
MessagingService Methods
MessagingService Events

# MessagingService Class

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

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

    public class MessagingService

The MessagingService type exposes the following members.

Properties

| Name | Description
--- | --- | ---
| AutomaticallyUpdateLastAccessTimeCapability | Returns a Capability object that indicates if conversation last access timestamps will be updated automatically.
| ClearLocalDataCapability | Returns a Capability object that indicates if local data can be cleared.
| CreateConversationCapability | Returns a Capability object allowing the client application to determine if it is currently possible to create a new conversation.
| HtmlCapability | Returns a Capability object allowing the client application to determine HTML capability.
| IsMessageDeliveryReadStateMonitoringSupported | A Boolean value indicating whether the last connected messaging service supported message delivery read state monitoring.
| IsMessageReadReportingSupported | A Boolean value indicating whether the last connected messaging service supported message read reporting.
| IsServiceAvailable | 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.
| MessageDeliveryReadStateMonitoringCapability | Returns a Capability object allowing the client application to determine if it is currently possible to report delivery state updates for sent messages.
| MessageReadReportingCapability | Returns a Capability object allowing the client application to determine if it is currently possible to report read state updates for sent messages.
| MessagingLimits | Returns Messaging Limits, which are containing information about the limits of the messaging component.
| NumberOfConversationsWithUnreadContent | Number of conversations with unread content for current user.
| NumberOfConversationsWithUnreadContentSinceLastAccess | Number of conversations with unread content since last access of current user.
| RefreshMode | Refresh mode for polling.
| RetrieveConversationCapability | Returns a Capability object that indicates if conversations can be retrieved from the server.
| RetrieveOlderConversationCapability | Returns a Capability object that indicates if older conversations can be retrieved from the server.
| RoutableDomains | Generic list of all routable domains presented as strings.
| SearchConversationCapability | Returns a Capability object that indicates if conversations can be searched.
| SelfAddress | 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.
| UpdateRefreshModeCapability | Returns a Capability object that indicates if the refresh mode can be changed.
| ValidateParticipantAddressesCapability | Returns a Capability object that indicates if participant addresses can be validated.

Top
Methods

| Name | Description
--- | --- | ---
| ClearAllLocalData(MessagingService CompletionHandler) | Removes all local data - messages, conversations and attachments.
| ClearAllLocalData(MessagingService CompletionHandler, MessagingProviderType) | Removes all local data - messages, conversations and attachments.
| CreateConversation | Creates a new draft conversation.
| CreateConversation(MessagingProviderType) | Creates a new draft conversation.
| GetAutomaticallyUpdateLastAccessTimeCapability | Returns a Capability object that indicates if conversation last access timestamps will be updated automatically.
| GetClearLocalDataCapability | Returns a Capability object that indicates if local data can be cleared.
| GetCreateConversationCapability | Returns a Capability object allowing the client application to determine if it is currently possible to create a new conversation.
| GetHtmlCapability | Returns a Capability object allowing the client application to determine HTML capability for the specified provider.
| GetMessageDeliveryReadStateMonitoringCapability | 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.
| GetMessageReadReportingCapability | 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.
| GetMessagingLimits | Returns Messaging Limits, which are containing information about the limits of the messaging component.
| GetNumberOfConversationsWithUnreadContent | Number of conversations with unread content for current user.
| GetNumberOfConversationsWithUnreadContentSinceLastAccess | Number of conversations with unread content since last access of current user.
| GetRemoveConversationCapability | Returns a Capability object that indicates if a specified conversation can be removed.
| GetRetrieveConversationCapability | Returns a Capability object that indicates if conversations can be retrieved from the server.
| GetRetrieveOlderConversationCapability | Returns a Capability object that indicates if older conversations can be retrieved from the server.
| GetRoutableDomains | Generic list of all routable domains presented as strings.
| GetSearchConversationCapability | Returns a Capability object that indicates if conversations can be searched.
| GetSelfAddress | 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.
| GetUpdateRefreshModeCapability | Returns a Capability object that indicates if the refresh mode can be changed.
| GetValidateParticipantAddressesCapability | Returns a Capability object that indicates if participant addresses can be validated.
| LeaveAllConversations | Leave all conversations for the currently logged in user.
| LeaveConversations | Leave a specified list of conversations.
| MarkMessagesAsRead | Mark multiple messages as read.
| Refresh(MessagingService CompletionHandler) | Perform a manual refresh of messaging data from the server. This method is meant to be used when RefreshMode parameter is set to manual.
| Refresh(MessagingService CompletionHandler, 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.
| RemoveConversation | Removes a conversation.
| RemoveConversationCapability | Returns a Capability object that indicates if a specified conversation can be removed.
| RetrieveActiveConversations | Performs a retrieval of all active conversations for the currently logged in user and watches for changes to this collection.
| RetrieveActiveConversationsForContact | Retrieves the list of active conversations for a specified contact.
| SearchConversations | Searches the user's conversations using specified filter criteria.
| ServiceAvailable | 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.
| SetRefreshMode | Sets refresh mode with completion handler. Using this method and changing refresh mode will impact how often client gets updates from the server.
| ValidateAddresses(AddressValidationWatcher, Contact) | Validates a list of supplied addresses to determine if they are valid messaging addresses.
| ValidateAddresses(AddressValidationWatcher, List String ) | Validates a list of supplied addresses to determine if they are valid messaging addresses.
| ValidateAddresses(AddressValidationWatcher, Contact, MessagingProviderType) | Validates a list of supplied addresses to determine if they are valid messaging addresses.
| ValidateAddresses(AddressValidationWatcher, List String , MessagingProviderType) | Validates a list of supplied addresses to determine if they are valid messaging addresses.

Top
Events

| Name | Description
--- | --- | ---
| MessagingFailed | Notifies the application that messaging has failed. Remarks When messaging recovers from error state, MessagingServiceAvailable event will be raised.
| MessagingMessageLimitsChanged | Notifies the application when messaging limits have changed.
| MessagingParticipantMatchedContactsChanged | 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.
| MessagingProviderAvailable | Notifies the application that the messaging provider has successfully started or restored.
| MessagingProviderCapabilitiesChanged | Notifies the application that messaging provider capabilities have changed.
| MessagingProviderConversationsAdded | Notifies the application when provider conversations have been added.
| MessagingProviderConversationsRemoved | Notifies the application when provider conversations have been removed.
| MessagingProviderFailed | Notifies the application that messaging provider has failed.
| MessagingProviderLimitsChanged | Notifies the application when messaging provider limits have changed.
| MessagingProviderNumberOfConversationsWithUnreadContentChanged | Notifies the application when provider NumberOfConversationsWithUnreadContent has changed.
| MessagingProviderNumberOfConversationsWithUnreadContentSinceLastAccessChanged | Notifies the application when provider NumberOfConversationsWithUnreadContentSinceLastAccess has changed.
| MessagingProviderRemoveConversationFailed | Notifies the application when provider conversation has failed to remove.
| MessagingProviderRemoveConversationSucceeded | Notifies the application when provider conversation has been removed successfully.
| MessagingProviderRoutableDomainsChanged | Notifies the application that messaging provider capabilities have changed.
| MessagingProviderUnavailable | Notifies the application that the messaging provider has been successfully closed or its work was interrupted, for example by a network or server problem.
| MessagingServiceAvailable | Notifies the application that the messaging service has successfully started or restored.
| MessagingServiceCapabilitiesChanged | Notifies the application that messaging service capabilities have changed.
| MessagingServiceUnavailable | Notifies the application that the messaging service has been successfully closed or its work was interrupted, for example by a network or server problem.
| NumberOfConversationsWithUnreadContentChanged | Notifies the application when a NumberOfConversationsWithUnreadContent has changed.
| NumberOfConversationsWithUnreadContentSinceLastAccessChanged | Notifies the application when a NumberOfConversationsWithUnreadContentSinceLastAccess has changed.
| RoutableDomainsChanged | 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

#### Reference

Avaya.ClientServices Namespace

© 2017 Avaya LLC. All Rights Reserved.