Avaya Client Services API Reference (iOS)
Instance Methods | List of all members
<CSMessagingServiceDelegate> Protocol Reference

Protocol of delegate that can be used to retrieve status updates from the CSMessagingService. More...

#import <CSMessagingService.h>

Inherits <NSObjectNSObject>.

Instance Methods

(void) - messagingServiceAvailable:
 Report that the messaging service has successfully started or restored. More...
 
(void) - messagingServiceUnavailable:
 Report that the messaging service has been successfully closed or its work was interrupted, for example by a network or server problem. More...
 
(void) - messagingServiceDidChangeCapabilities:
 Report that messaging service capabilities have changed. More...
 
(void) - messagingService:didChangeMessagingLimits:
 Called to report that the messaging limits have changed. More...
 
(void) - messagingService:didChangeRoutableDomains:
 Called to report that messaging routable domains have changed. More...
 
(void) - messagingService:didChangeNumberOfConversationsWithUnreadContent:
 Called to report that a NumberOfConversationsWithUnreadContent has changed. More...
 
(void) - messagingService:didChangeNumberOfConversationsWithUnreadContentSinceLastAccess:
 Called to report that the NumberOfConversationsWithUnreadContentSinceLastAccess has changed. More...
 
(void) - messagingService:didFailWithError:
 Called to report that messaging has failed. More...
 
(void) - messagingService:providerAvailable:
 Report that the messaging provider has successfully started or restored. More...
 
(void) - messagingService:providerUnavailable:
 Report that the messaging provider has been successfully closed or its work was interrupted, for example by a network or server problem. More...
 
(void) - messagingService:providerDidChangeCapabilities:
 Report that messaging provider capabilities have changed. More...
 
(void) - messagingService:provider:didChangeMessagingLimits:
 Called to report that the messaging provider limits have changed. More...
 
(void) - messagingService:provider:didChangeRoutableDomains:
 Called to report that messaging provider routable domains have changed. More...
 
(void) - messagingService:provider:didChangeNumberOfConversationsWithUnreadContent:
 Called to report that a NumberOfConversationsWithUnreadContent has changed for the provider. More...
 
(void) - messagingService:provider:didChangeNumberOfConversationsWithUnreadContentSinceLastAccess:
 Called to report that the NumberOfConversationsWithUnreadContentSinceLastAccess has changed for the provider. More...
 
(void) - messagingService:provider:didFailWithError:
 Called to report that provider has failed. More...
 
(void) - messagingServiceParticipantMatchedContactsChanged:
 Called to report the messaging participant matched contacts changed. More...
 
(void) - messagingService:didAddConversations:
 Sent to indicate that conversations are added. More...
 
(void) - messagingService:didRemoveConversations:
 Sent to indicate that conversations are removed. More...
 

Detailed Description

Protocol of delegate that can be used to retrieve status updates from the CSMessagingService.

Method Documentation

- (void) messagingService: (CSMessagingService *)  messagingService
didAddConversations: (NSArray *)  addedConversations 
optional

Sent to indicate that conversations are added.

Parameters
messagingServiceThe CSMessagingService object that the callback is associated with.
addedConversationsThe conversations which got added
Deprecated:
THIS SELECTOR WILL BE REMOVED IN RELEASE VERSION 3.3. Applications should use a CSDataRetrievalWatcher object passed to the retrieveActiveConversationsWithWatcher: (CSMessagingService) method to be notified of new conversations instead.
- (void) messagingService: (CSMessagingService *)  messagingService
didChangeMessagingLimits: (CSMessagingLimits *)  messagingLimits 

Called to report that the messaging limits have changed.

Parameters
messagingServiceThe CSMessagingService object that the callback is associated with.
messagingLimitsThe updated limits.
See also
CSMessagingService::messagingLimits
- (void) messagingService: (CSMessagingService *)  messagingService
didChangeNumberOfConversationsWithUnreadContent: (NSUInteger)  numberOfConversationsWithUnreadContent 

Called to report that a NumberOfConversationsWithUnreadContent has changed.

Parameters
messagingServiceThe CSMessagingService object that the callback is associated with.
numberOfConversationsWithUnreadContentThe number of conversations with unread content.
See also
CSMessagingService::numberOfConversationsWithUnreadContent
- (void) messagingService: (CSMessagingService *)  messagingService
didChangeNumberOfConversationsWithUnreadContentSinceLastAccess: (NSUInteger)  numberOfConversationsWithUnreadContentSinceLastAccess 

Called to report that the NumberOfConversationsWithUnreadContentSinceLastAccess has changed.

Parameters
messagingServiceThe CSMessagingService object that the callback is associated with.
numberOfConversationsWithUnreadContentSinceLastAccessThe number representing the number of conversations with unread content since the last time the user accessed them
See also
CSMessagingService::numberOfConversationsWithUnreadContent
- (void) messagingService: (CSMessagingService *)  messagingService
didChangeRoutableDomains: (NSArray *)  supportedDomains 

Called to report that messaging routable domains have changed.

Parameters
messagingServiceThe CSMessagingService object that the callback is associated with.
supportedDomainsList of routable domains.
See also
CSMessagingService::routableDomains
- (void) messagingService: (CSMessagingService *)  messagingService
didFailWithError: (NSError *)  error 

Called to report that messaging has failed.

Parameters
messagingServiceThe CSMessagingService object that the callback is associated with.
errorThe messaging fail reason
- (void) messagingService: (CSMessagingService *)  messagingService
didRemoveConversations: (NSArray *)  removedConversations 
optional

Sent to indicate that conversations are removed.

Parameters
messagingServiceThe CSMessagingService object that the callback is associated with.
removedConversationsThe conversations which got removed
Deprecated:
THIS SELECTOR WILL BE REMOVED IN RELEASE VERSION 3.3. Applications should use a CSDataRetrievalWatcher object passed to the retrieveActiveConversationsWithWatcher: (CSMessagingService) method to be notified of removed conversations instead.
- (void) messagingService: (CSMessagingService *)  messagingService
provider: (CSMessagingProviderType messagingProviderType
didChangeMessagingLimits: (CSMessagingLimits *)  messagingLimits 
optional

Called to report that the messaging provider limits have changed.

Parameters
messagingServiceThe CSMessagingService object that the callback is associated with.
messagingProviderTypetype of the providerlink CSMessagingProviderType}.
messagingLimitsThe updated limits.
See also
CSMessagingService::messagingLimits
- (void) messagingService: (CSMessagingService *)  messagingService
provider: (CSMessagingProviderType messagingProviderType
didChangeNumberOfConversationsWithUnreadContent: (NSUInteger)  numberOfConversationsWithUnreadContent 
optional

Called to report that a NumberOfConversationsWithUnreadContent has changed for the provider.

Parameters
messagingServiceThe CSMessagingService object that the callback is associated with.
messagingProviderTypetype of the providerlink CSMessagingProviderType}.
numberOfConversationsWithUnreadContentThe number of conversations with unread content.
See also
CSMessagingService::numberOfConversationsWithUnreadContent
- (void) messagingService: (CSMessagingService *)  messagingService
provider: (CSMessagingProviderType messagingProviderType
didChangeNumberOfConversationsWithUnreadContentSinceLastAccess: (NSUInteger)  numberOfConversationsWithUnreadContentSinceLastAccess 
optional

Called to report that the NumberOfConversationsWithUnreadContentSinceLastAccess has changed for the provider.

Parameters
messagingServiceThe CSMessagingService object that the callback is associated with.
messagingProviderTypetype of the providerlink CSMessagingProviderType}.
numberOfConversationsWithUnreadContentSinceLastAccessThe number representing the number of conversations with unread content since the last time the user accessed them
See also
CSMessagingService::numberOfConversationsWithUnreadContent
- (void) messagingService: (CSMessagingService *)  messagingService
provider: (CSMessagingProviderType messagingProviderType
didChangeRoutableDomains: (NSArray *)  supportedDomains 
optional

Called to report that messaging provider routable domains have changed.

This is not supported for Zang provider.

Parameters
messagingServiceThe CSMessagingService object that the callback is associated with.
messagingProviderTypetype of the providerlink CSMessagingProviderType}.
supportedDomainsList of routable domains.
See also
CSMessagingService::routableDomains
- (void) messagingService: (CSMessagingService *)  messagingService
provider: (CSMessagingProviderType messagingProviderType
didFailWithError: (NSError *)  error 
optional

Called to report that provider has failed.

Parameters
messagingServiceThe CSMessagingService object that the callback is associated with.
messagingProviderTypetype of the providerlink CSMessagingProviderType}.
errorThe messaging fail reason
- (void) messagingService: (CSMessagingService *)  messagingService
providerAvailable: (CSMessagingProviderType messagingProviderType 
optional

Report that the messaging provider has successfully started or restored.

Parameters
messagingServicethe CSMessagingService object that the callback is associated with.
messagingProviderTypetype of the providerlink CSMessagingProviderType}.
See also
-[messagingServiceUnavailable]
-[CSMessagingService serviceAvailable]
- (void) messagingService: (CSMessagingService *)  messagingService
providerDidChangeCapabilities: (CSMessagingProviderType messagingProviderType 
optional

Report that messaging provider capabilities have changed.

Parameters
messagingServicethe CSMessagingService object that the callback is associated with.
messagingProviderTypetype of the providerlink CSMessagingProviderType}.
See also
-[CSMessagingService createConversationCapability]
-[CSMessagingService retrieveConversationCapability]
-[CSMessagingService searchConversationCapability]
-[CSMessagingService updateRefreshModeCapability]
-[CSMessagingService validateParticipantAddressesCapability]
-[CSMessagingService clearLocalDataCapability]
-[CSMessagingService automaticallyUpdateLastAccessTimeCapability]
-[CSMessagingService removeConversationCapability]
- (void) messagingService: (CSMessagingService *)  messagingService
providerUnavailable: (CSMessagingProviderType messagingProviderType 
optional

Report that the messaging provider has been successfully closed or its work was interrupted, for example by a network or server problem.

Parameters
messagingServicethe CSMessagingService object that the callback is associated with.
messagingProviderTypetype of the providerlink CSMessagingProviderType}.
See also
-[messagingServiceAvailable]
-[CSMessagingService serviceAvailable]
- (void) messagingServiceAvailable: (CSMessagingService *)  messagingService

Report that the messaging service has successfully started or restored.

Parameters
messagingServicethe CSMessagingService object that the callback is associated with.
See also
-[messagingServiceUnavailable]
-[CSMessagingService serviceAvailable]
- (void) messagingServiceDidChangeCapabilities: (CSMessagingService *)  messagingService

Report that messaging service capabilities have changed.

Parameters
messagingServicethe CSMessagingService object that the callback is associated with.
See also
-[CSMessagingService createConversationCapability]
-[CSMessagingService retrieveConversationCapability]
-[CSMessagingService searchConversationCapability]
-[CSMessagingService updateRefreshModeCapability]
-[CSMessagingService validateParticipantAddressesCapability]
-[CSMessagingService clearLocalDataCapability]
-[CSMessagingService automaticallyUpdateLastAccessTimeCapability]
-[CSMessagingService removeConversationCapability]
- (void) messagingServiceParticipantMatchedContactsChanged: (CSMessagingService *)  messagingService
optional

Called to report the 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.

Parameters
messagingServiceThe CSMessagingService object that the callback is associated with.
Deprecated:
THIS SELECTOR WILL BE REMOVED IN RELEASE VERSION 3.3.
- (void) messagingServiceUnavailable: (CSMessagingService *)  messagingService

Report that the messaging service has been successfully closed or its work was interrupted, for example by a network or server problem.

Parameters
messagingServicethe CSMessagingService object that the callback is associated with.
See also
-[messagingServiceAvailable]
-[CSMessagingService serviceAvailable]

The documentation for this protocol was generated from the following file: