Avaya Client Services API Reference (Windows)
Avaya Client Services API Reference (Windows)
Avaya.ClientServices
MessagingService Class
MessagingService Methods
ClearAllLocalData Method
CreateConversation Method
GetAutomaticallyUpdateLastAccessTimeCapability Method
GetClearLocalDataCapability Method
GetCreateConversationCapability Method
GetHtmlCapability Method
GetMessageDeliveryReadStateMonitoringCapability Method
GetMessageReadReportingCapability Method
GetMessagingLimits Method
GetNumberOfConversationsWithUnreadContent Method
GetNumberOfConversationsWithUnreadContentSinceLastAccess Method
GetRemoveConversationCapability Method
GetRetrieveConversationCapability Method
GetRetrieveOlderConversationCapability Method
GetRoutableDomains Method
GetSearchConversationCapability Method
GetSelfAddress Method
GetUpdateRefreshModeCapability Method
GetValidateParticipantAddressesCapability Method
LeaveAllConversations Method
LeaveConversations Method
MarkMessagesAsRead Method
Refresh Method
RemoveConversation Method
RemoveConversationCapability Method
RetrieveActiveConversations Method
RetrieveActiveConversationsForContact Method
SearchConversations Method
ServiceAvailable Method
SetRefreshMode Method
ValidateAddresses Method

# MessagingService Methods

The MessagingService type exposes the following members.

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
See Also

#### Reference

MessagingService Class
Avaya.ClientServices Namespace

© 2017 Avaya LLC. All Rights Reserved.