Avaya Client Services API Reference (iOS)
Classes | Enumerations
CSPresence.h File Reference
#import <Foundation/Foundation.h>

Classes

class  CSPresence
 Presence information for a user. More...
 

Enumerations

enum  CSPresenceState {
  CSPresenceStateUnspecified,
  CSPresenceStateUnknown,
  CSPresenceStateAvailable,
  CSPresenceStateOnACall,
  CSPresenceStateBusy,
  CSPresenceStateAway,
  CSPresenceStateDoNotDisturb,
  CSPresenceStateOutOfOffice,
  CSPresenceStateOffline
}
 Enumeration representing presence state of a user. More...
 
enum  CSPresenceLocationMode {
  CSPresenceLocationModeUnspecified,
  CSPresenceLocationModeOffice,
  CSPresenceLocationModeHome,
  CSPresenceLocationModeMobile,
  CSPresenceLocationModeTraveling
}
 Enumeration representing the location-based "mode" of a user. More...
 
enum  CSPresenceOptions {
  CSPresenceOptionNone = 0,
  CSPresenceOptionManualState = 1U << 0,
  CSPresenceOptionLocationMode = 1U << 1,
  CSPresenceOptionNote = 1U << 2
}
 Optional elements of a presence object. More...
 

Enumeration Type Documentation

Enumeration representing the location-based "mode" of a user.

The Location-based "mode" of a user is used when the user wants to publish their location to other users, i.e. make it publicly available.

Enumerator
CSPresenceLocationModeUnspecified 

Location mode is not specified.

CSPresenceLocationModeOffice 

Location mode indicating that the user is in the office.

CSPresenceLocationModeHome 

Location mode indicating that the user is at home.

CSPresenceLocationModeMobile 

Location mode indicating that the user is online via a mobile device.

CSPresenceLocationModeTraveling 

Location mode indicating that the user is out of office traveling.

Optional elements of a presence object.

Enumerator
CSPresenceOptionNone 

Indicates none of the options are supported.

CSPresenceOptionManualState 

Indicates support for a manual (user-assigned) presence state.

CSPresenceOptionLocationMode 

Indicates support for presence location modes.

CSPresenceOptionNote 

Indicates support for presence notes.

Enumeration representing presence state of a user.

Enumerator
CSPresenceStateUnspecified 

Presence state is not specified.

CSPresenceStateUnknown 

Presence state is unknown.

CSPresenceStateAvailable 

Presence state is available.

CSPresenceStateOnACall 

Presence state indicating that the user is currently on a call.

CSPresenceStateBusy 

Presence state indicating that the user is busy, e.g.

in a meeting.

CSPresenceStateAway 

Presence state indicating that the user is away from their client.

CSPresenceStateDoNotDisturb 

Presence state indicating that currently the user does not want other people to contact them.

CSPresenceStateOutOfOffice 

Presence state indicating that the user is not in the office.

CSPresenceStateOffline 

Presence state indicating that the user is offline, i.e.

not using any client.