Click or drag to resize
PresenceService Class
The class encapsulates all of presence related features available to the user.
Inheritance Hierarchy
SystemObject
  Avaya.ClientServicesPresenceService

Namespace: Avaya.ClientServices
Assembly: AvayaClientServices (in AvayaClientServices.dll) Version: 493.0.70.0
Syntax
C#
public class PresenceService

The PresenceService type exposes the following members.

Properties
  NameDescription
Public propertyAutoAwayTimeout
The user inactivity timeout period in milliseconds. Used to set up the inactivity timer in runtime.
Public propertyAutomaticModeCapability
Capability describing whether the Presence service supports automatic mode for self-presence.
Public propertyAutomaticPresenceStates
Returns the collection of supported automatic self-presence states.
Public propertyIsSendAllCallsOnDoNotDisturbEnabled
A Boolean value controlling a linkage between "Do not Disturb" presence state and "Send All Calls" call service feature at runtime.
Public propertyIsServiceAvailable
Property exposing current service availability status.
Public propertyIsServiceConfigured
Property exposing current service configuration status.
Public propertyManualPresenceStates
Returns the collection of supported manual self-presence states.
Public propertyPresenceAccessControlList
Property representing PresenceAccessControlList.
Public propertyPresenceAccessControlListCapability
Capability describing whether the Presence service supports presence Access Control List(ACL).
Public propertyPresenceNoteMaxTextLength
Returns the maximum text length value (in characters) accepted for presence note.
Public propertySelfPresence
Property to get current self-presence information.
Top
Methods
  NameDescription
Public methodCreatePresenceListSubscription
Creates a new empty ad-hoc presence subscription object.
Public methodPublishPresence
Publishes presence state, location mode and optional note for the local user.
Public methodRemovePresenceListSubscription
Removes the specified ad-hoc presence list subscription.
Top
Events
  NameDescription
Public eventPresencePublishFailed
Reported when request has failed.
Public eventPresencePublishSuccessful
Reported when request has successfully completed.
Public eventPresenceServiceAvailable
Reported when presence service becomes available.
Public eventPresenceServiceUnavailable
Reported when presence service becomes unavailable.
Public eventSelfPresenceReceived
Reported when information has been updated.
Top
Remarks
The service is configured with a presence configuration object created by the client application as part of the user configuration object. In order to get the service object and leverage the available presence features the presence service property of the user object is used. The presence service encapsulates such features as publishing presence, subscribing for self-presence update events, creating presence list subscriptions to watch presence of other users.
See Also