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

Definition of the delegate interface that will receive push notification service status. More...

#import <CSPushNotificationService.h>

Inherits <NSObjectNSObject>.

Instance Methods

(void) - pushNotificationService:didEnableServiceType:
 Sent when the push notification service for a service type (e.g. More...
 
(void) - pushNotificationService:didDisableServiceType:
 Sent when the push notification service for a service type (e.g. More...
 
(void) - pushNotificationService:didFailToEnableNotificationsForServiceType:error:willRetry:
 Sent when the ClientSDK is unable to setup the push notification service type successfully. More...
 
(void) - pushNotificationService:didReceivePushNotificationsEncryptionInfo:
 Sent after the encryption key is received from the telephony server. More...
 

Detailed Description

Definition of the delegate interface that will receive push notification service status.

Method Documentation

- (void) pushNotificationService: (CSPushNotificationService *)  service
didDisableServiceType: (CSPushNotificationServiceType type 

Sent when the push notification service for a service type (e.g.

telephony) is disabled. For example, telephony notifications are disabled when a user logs out of the SIP server, or when a push notification about a server failure is received.

Parameters
servicePush notification service instance.
typeService type. Currently, only CSPushNotificationTelephonyService is supported.
- (void) pushNotificationService: (CSPushNotificationService *)  service
didEnableServiceType: (CSPushNotificationServiceType type 

Sent when the push notification service for a service type (e.g.

telephony) is enabled.

Parameters
servicePush notification service instance.
typeService type. Currently, only CSPushNotificationTelephonyService is supported.
- (void) pushNotificationService: (CSPushNotificationService *)  service
didFailToEnableNotificationsForServiceType: (CSPushNotificationServiceType type
error: (NSError *)  error
willRetry: (BOOL)  willRetry 

Sent when the ClientSDK is unable to setup the push notification service type successfully.

The failure may be due to an issue on the network server side or local. For example, an error is reported when connectivity to the telephony push notification network server is lost, or when the service could not be started due to missing or invalid configuration information.

Parameters
servicePush notification service instance.
typeService type. Currently, only CSPushNotificationTelephonyService is supported.
errorError object describing the reason for the failure.
willRetryBoolean indicating whether service reactivation is automatically reattempted by the ClientSDK.
- (void) pushNotificationService: (CSPushNotificationService *)  service
didReceivePushNotificationsEncryptionInfo: (CSPushNotificationsEncryptionInfo *)  encryptionInfo 

Sent after the encryption key is received from the telephony server.

This method is normally called after ClientSDK calls didEnablePushNotification() to inform that the push notification is now active.

Parameters
serviceThe CSPushNotificationService object that the callback is associated with.
encryptionInfoEncryption information received from the server.

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