Avaya Client Services API Reference (iOS)

- Main Page
- Classes
- Files
- Related Pages

- Class List
- Class Index
- Class Hierarchy
- Class Members

Instance Methods | List of all members
<CSUserRegistrationDelegate> Protocol Reference

`#import <CSUser.h>`

Inherits <NSObject>.

## Instance Methods
(void) | - user:didStartRegistrationWithServer:
| Sent when a registration attempt is started. More...
(void) | - user:didRegisterWithServer:
| Sent when the user has been successfully registered. More...
(void) | - user:didFailToRegisterWithServer:error:
| Sent when a registration attempt has failed. More...
(void) | - userDidRegisterWithAllServers:
| Sent when all registrations have been successful. More...
(void) | - userDidFailToRegisterWithAllServers:willRetry:
| Sent when all registrations have failed. More...
(void) | - user:didStartUnregistrationWithServer:
| Sent when an unregistration attempt is started. More...
(void) | - user:didUnregisterWithServer:
| Sent when the user has been successfully unregistered. More...
(void) | - user:didFailToUnregisterWithServer:error:
| Sent when an unregistration attempt has failed. More...
(void) | - userDidCompleteUnregistrationWithAllServers:
| Sent when unregistration is complete. More...
(void) | - user:didReceiveRegistrationResponsePayload:fromServer:
| Occurs when the registration response payload is received from network. More...

## Method Documentation

- (void) user: |  | (CSUser *) | user
didFailToRegisterWithServer: |  | (CSSignalingServer *) | server
error: |  | (NSError *) | error

Sent when a registration attempt has failed.

If error.code is CSErrorRedirected, the next registration/unregistration methods (for example didRegisterWithServer or didFailToRegisterWithServer) will be called with a new CSSignalingServer that will be different from the initially configured one.

Parameters

  user | The user sending the message.
  server | The server being contacted.
  error | An error object describing the failure.

- (void) user: |  | (CSUser *) | user
didFailToUnregisterWithServer: |  | (CSSignalingServer *) | server
error: |  | (NSError *) | error

Sent when an unregistration attempt has failed.

Parameters

  user | The user sending the message.
  server | The server being contacted.
  error | An error object describing the failure.

- (void) user: |  | (CSUser *) | user
didReceiveRegistrationResponsePayload: |  | (NSArray *) | payloadParts
fromServer: |  | (CSSignalingServer *) | server

Occurs when the registration response payload is received from network.

Parameters

  user | user that the callback is associated with.
  payloadParts | an array which contains message parts of type CSMessageBodyPart.
  server | is a server which has sent registration response payload after registration request.

- (void) user: |  | (CSUser *) | user
didRegisterWithServer: |  | (CSSignalingServer *) | server

Sent when the user has been successfully registered.

Parameters

  user | The user sending the message.
  server | The server being contacted.

- (void) user: |  | (CSUser *) | user
didStartRegistrationWithServer: |  | (CSSignalingServer *) | server

Sent when a registration attempt is started.

Parameters

  user | The user sending the message.
  server | The server being contacted.

- (void) user: |  | (CSUser *) | user
didStartUnregistrationWithServer: |  | (CSSignalingServer *) | server

Sent when an unregistration attempt is started.

Parameters

  user | The user sending the message.
  server | The server being contacted.

- (void) user: |  | (CSUser *) | user
didUnregisterWithServer: |  | (CSSignalingServer *) | server

Sent when the user has been successfully unregistered.

Parameters

  user | The user sending the message.
  server | The server being contacted.

- (void) userDidCompleteUnregistrationWithAllServers: |  | (CSUser *) | user |

Sent when unregistration is complete.

Parameters

  user | The user sending the message.

- (void) userDidFailToRegisterWithAllServers: |  | (CSUser *) | user
willRetry: |  | (BOOL) | flag

Sent when all registrations have failed.

Parameters

  user | The user sending the message.
  flag | Indicates that if Client SDK will retry the failed registration request; False means registration failure is fatal and application must start a new registration after resolving the issue that blocked the registrations from succeeding.

- (void) userDidRegisterWithAllServers: |  | (CSUser *) | user |

Sent when all registrations have been successful.

Parameters

  user | The user sending the message.

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

- CSUser.h