Click or drag to resize
User Class
Represents a user (an extension or user account) for which various services and features can be provided by the Avaya Client Services library.
Inheritance Hierarchy
SystemObject
  Avaya.ClientServicesUser

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

The User type exposes the following members.

Properties
  NameDescription
Public propertyAgentService
Service providing access to agent features for this local user.
Public propertyAgentServiceStatus
Returns a ServiceStatus object that indicates if an agent service is enabled.
Public propertyButtonModuleService
Service providing access to button module features for this local user.
Public propertyButtonModuleServiceStatus
Returns a ServiceStatus object that indicates if Button Module service is enabled.
Public propertyCallFeatureService
Service providing access to telephony features for this user.
Public propertyCallFeatureServiceStatus
Returns a ServiceStatus object that indicates if the call feature service is enabled.
Public propertyCallLogService
Service providing access to call logs for this user.
Public propertyCallLogServiceStatus
Returns a ServiceStatus object that indicates if the call log service is enabled.
Public propertyCallService
Service providing access to calls for this user.
Public propertyCallServiceStatus
Returns a ServiceStatus object that indicates if the call service is enabled.
Public propertyCollaborationService
Service providing access to collaboration for this user.
Public propertyCollaborationServiceStatus
Returns a ServiceStatus object that indicates if the collaboration service is enabled.
Public propertyContactService
Service providing access to contact features for this user.
Public propertyContactServiceStatus
Returns a ServiceStatus object that indicates if the contact service is enabled.
Public propertyExportService
Service providing access to export service for this user.
Public propertyExportServiceStatus
Returns a ServiceStatus object that indicates if an Export service is enabled.
Public propertyExternalAppIds
External Application IDs for applications that have registered via the ExternalAppInterface.
Public propertyHIDService
The service providing access to HID service for this user.
Public propertyHIDServiceStatus
Returns a ServiceStatus object that indicates if the Human Interface Device (HID) service is enabled.
Public propertyMessagingService
Service providing access to messaging features for this user.
Public propertyMessagingServiceStatus
Returns a ServiceStatus object that indicates if the messaging service is enabled.
Public propertyOtherPhoneService
The service providing access to other phone mode for this user.
Public propertyOtherPhoneServiceStatus
Returns a ServiceStatus object that indicates if the Other Phone service is enabled.
Public propertyPresenceService
Service providing access to presence features for this user.
Public propertyPresenceServiceStatus
Returns a ServiceStatus object that indicates if the presence service is enabled.
Public propertySharedControlService
Service providing access to shared control features for this user.
Public propertySharedControlServiceStatus
Returns a ServiceStatus object that indicates if the shared control service is enabled.
Public propertySignalingServerGroup
The signaling server group has the complete call server list used by system. it contains additional servers discovered by system from different source including the servers provided by the user. Client application can persist it and then use it for subsequent registrations for creation of ConnectionPolicy.
Public propertySpacesService
Service providing access to spaces features for this user.
Public propertySpacesServiceStatus
Returns a ServiceStatus object that indicates if the spaces service is enabled.
Public propertyUnifiedPortalService
Service providing access to Unified Portal features for this user.
Public propertyUnifiedPortalServiceStatus
Returns a ServiceStatus object that indicates if the unified portal service is enabled.
Public propertyUserId
The user ID of the user.
Public propertyVisualVoiceMailService
Service providing access to visual voice mail for this user.
Public propertyVisualVoiceMailServiceStatus
Returns a ServiceStatus object that indicates if the visual voice mail service is enabled.
Public propertyVoiceMessagingService
Service providing access to voice messaging for this user.
Public propertyVoiceMessagingServiceStatus
Returns a ServiceStatus object that indicates if the voice messaging service is enabled.
Top
Methods
  NameDescription
Public methodStart
Starts all configured services.
Public methodStop
Stops all configured services.
Top
Events
  NameDescription
Public eventAllRegistrationsFailed
Occurs when all registrations have failed
Public eventAllRegistrationsSuccessful
Occurs when registrations to all call servers have been established.
Public eventConfigurationGroupIdReceived
Occurs when provided PPMConfigGroupId does not match the value configured on server and the application should restart sign in process with the configuration group id received from server.
Public eventConfigurationReloadRequested
Occurs when a server is requesting reload of the configuration profile.
Public eventExternalAppRegistered
An external application has registered to the external app interface in order to monitor, place and/or control calls on this user's behalf.
Public eventExternalAppUnregistered
A previously registered external application has unregistered from the external app interface.
Public eventRebootRequested
Occurs when a server is requesting reboot.
Public eventRegistrationFailed
Occurs when a registration attempt has failed. If RegistrationError is Redirected, the next registration/unregistration events (for example RegistrationSuccessful or RegistrationFailed) will be received with a new SignalingServer that will be different from the initially configured one.
Public eventRegistrationInProgress
Occurs when a registration attempt is started.
Public eventRegistrationResponsePayloadReceived
Occurs when the registration response payload is received from server after registration.
Public eventRegistrationSuccessful
Occurs when a registration attempt to a call server has succeeded.
Public eventResourceDiscovered
Occurs when a resource of interest to the client application is discovered during registration or resource discovery. The client application should register an event handler on this event prior to starting the user.
Public eventSignalingServerGroupReceived
Occurs when a registration response has alternate call server list signaling server group received in this event should be persisted by client application and include them in subsequent registrations
Public eventUnregistrationComplete
Occurs when the user has been completely unregistered.
Public eventUnregistrationFailed
Occurs when an unregistration attempt has failed.
Public eventUnregistrationInProgress
Occurs when an unregistration attempt is started.
Public eventUnregistrationSuccessful
Occurs when the user has been successfully unregistered.
Top
See Also