Avaya Client Services API Reference (OS X)

- Main Page
- Classes
- Files
- Related Pages

- File List
- File Members

Classes | Enumerations
CSAgentInformation.h File Reference
`#import "CSAgentFeature.h"`
`#import "CSAgentWorkMode.h"`
`#import "CSButtonLampState.h"`

## Classes
class | CSAgentInformation
| Represents an agent information sent from contact center solution to the registered agent's application. More...

## Enumerations
enum | CSAgentReasonCodeMode { CSAgentReasonCodeModeNone = 0, CSAgentReasonCodeModeOptional, CSAgentReasonCodeModeForced }
| Represents policy how agents provide reason codes while performing various agent operations. More...
enum | CSAgentLogoutOverrideType { CSAgentLogoutOverrideTypeUndefined = 0, CSAgentLogoutOverrideTypeNone, CSAgentLogoutOverrideTypeTimedLogout }
| Represents a policy that is configured on contact center solution that whether the agent will be forced to log out at a certain time or the agent is overriding the forced logout. More...
enum | CSAgentReasonCodeLength { CSAgentReasonCodeLengthNotAvailable = 0, CSAgentReasonCodeLengthSingleDigit, CSAgentReasonCodeLengthDoubleDigit }
| Represents the policy used to describe the length of reason codes used by agents for logout and work mode change operations. More...
enum | CSPendingLogoutReason { CSPendingLogoutReasonUndefined = 0, CSPendingLogoutReasonTimed, CSPendingLogoutReasonForced, CSPendingLogoutReasonRequested }
| Represents an agent information sent from signalling server to the Represents the policies used to describe the use of reason codes for pending logout. More...

## Enumeration Type Documentation

enum CSAgentLogoutOverrideType

Represents a policy that is configured on contact center solution that whether the agent will be forced to log out at a certain time or the agent is overriding the forced logout.

Enumerator
CSAgentLogoutOverrideTypeUndefined | Agent is not configured for forced logout.
CSAgentLogoutOverrideTypeNone | Agent is not configured for forced logout.
CSAgentLogoutOverrideTypeTimedLogout | Agent is configured to logout after after certain period of time.

enum CSAgentReasonCodeLength

Represents the policy used to describe the length of reason codes used by agents for logout and work mode change operations.

Enumerator
CSAgentReasonCodeLengthNotAvailable | Reason code length is not defined.
CSAgentReasonCodeLengthSingleDigit | Reason code is administered to use single digit i.e range is between 0-9.
CSAgentReasonCodeLengthDoubleDigit | Reason code is administered to use double digits i.e range is between 0-99.

enum CSAgentReasonCodeMode

Represents policy how agents provide reason codes while performing various agent operations.

Reason code policy is administered on contact center solution.

Enumerator
CSAgentReasonCodeModeNone | Reason code is not required for agent operation.
CSAgentReasonCodeModeOptional | Reason code is requested but not forced. If reason code not provided then default values will be used to complete agent operation.
CSAgentReasonCodeModeForced | Reason code is must for completing agent operation.

enum CSPendingLogoutReason

Represents an agent information sent from signalling server to the Represents the policies used to describe the use of reason codes for pending logout.

Enumerator
CSPendingLogoutReasonUndefined | Reason code is not defined.
CSPendingLogoutReasonTimed | A reason code for logout pending is "timed-logout".
CSPendingLogoutReasonForced | A reason code for logout pending is "forced-logout".
CSPendingLogoutReasonRequested | A reason code for logout pending is "agent-requested".