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
<CSAgentStateDelegate> Protocol Reference

An interface that the client application needs to implement to receive the result of an agent login or logout operation and agent state updates. More...

`#import <CSAgentService.h>`

Inherits <NSObjectNSObject>.

## Instance Methods
(void) | - agentService:didChangeAgentState:
| Reports agent state changed. More...
(void) | - agentDidLogin:
| Reports agent successfully logged-in. More...
(void) | - agentDidLogout:
| Reports agent successfully logged-out. More...
(void) | - agentAutoLoginSucceeded:
| Reports automatic agent login success. More...
(void) | - agentService:didFailToPerformAgentAutoLoginWithError:
| Reports automatic agent login failure. More...
(void) | - agentAutoLogoutSucceeded:
| Reports automatic agent logout success. More...
(void) | - agentService:didFailToPerformAgentAutoLogoutWithError:
| Reports automatic agent logout failure. More...

## Detailed Description

An interface that the client application needs to implement to receive the result of an agent login or logout operation and agent state updates.

One or more listeners can be registered with an instance of the AgentService object to retrieve updates. All of the callback methods defined in AgentLoginListener interface identify the user the callback is associated with, using the 'user' argument.

## Method Documentation

- (void) agentAutoLoginSucceeded: |  | (CSAgentService *) | agentService |

Reports automatic agent login success.

Parameters

  agentService | Agent service instance the callback is associated with.

- (void) agentAutoLogoutSucceeded: |  | (CSAgentService *) | agentService |

Reports automatic agent logout success.

Parameters

  agentService | Agent service instance the callback is associated with.

- (void) agentDidLogin: |  | (CSAgentService *) | agentService |

Reports agent successfully logged-in.

Parameters

  agentService | instance of Agent service callback is associated with

- (void) agentDidLogout: |  | (CSAgentService *) | agentService |

Reports agent successfully logged-out.

Parameters

  agentService | instance of Agent service callback is associated with

- (void) agentService: |  | (CSAgentService *) | agentService
didChangeAgentState: |  | (CSAgentState) | agentState

Reports agent state changed.

Parameters

  agentService | instance of Agent service callback is associated with
  agentState | new agent state

- (void) agentService: |  | (CSAgentService *) | agentService
didFailToPerformAgentAutoLoginWithError: |  | (NSError *) | error

Reports automatic agent login failure.

Parameters

  agentService | Agent service instance the callback is associated with.
  error | The reason of failure.

- (void) agentService: |  | (CSAgentService *) | agentService
didFailToPerformAgentAutoLogoutWithError: |  | (NSError *) | error

Reports automatic agent logout failure.

Parameters

  agentService | Agent service instance the callback is associated with.
  error | The reason of failure.

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

- CSAgentService.h