Avaya Client Services API Reference (Windows)
Avaya Client Services API Reference (Windows)
Avaya.ClientServices
User Class
User Properties
User Methods
User Events

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
System
Object
Avaya.ClientServices
User

Namespace: Avaya.ClientServices
Assembly: AvayaClientServices (in AvayaClientServices.dll) Version: 592.1.30.0
Syntax
C#
Copy

    public class User

The User type exposes the following members.

Properties

| Name | Description
--- | --- | ---
| AgentService | Service providing access to agent features for this local user.
| AgentServiceStatus | Returns a ServiceStatus object that indicates if an agent service is enabled.
| ButtonModuleService | Service providing access to button module features for this local user.
| ButtonModuleServiceStatus | Returns a ServiceStatus object that indicates if Button Module service is enabled.
| CallFeatureService | Service providing access to telephony features for this user.
| CallFeatureServiceStatus | Returns a ServiceStatus object that indicates if the call feature service is enabled.
| CallLogService | Service providing access to call logs for this user.
| CallLogServiceStatus | Returns a ServiceStatus object that indicates if the call log service is enabled.
| CallService | Service providing access to calls for this user.
| CallServiceStatus | Returns a ServiceStatus object that indicates if the call service is enabled.
| CollaborationService | Service providing access to collaboration for this user.
| CollaborationServiceStatus | Returns a ServiceStatus object that indicates if the collaboration service is enabled.
| ContactService | Service providing access to contact features for this user.
| ContactServiceStatus | Returns a ServiceStatus object that indicates if the contact service is enabled.
| ExchangeService | Service providing access to Exchange features for this user.
| ExchangeServiceStatus | Returns a ServiceStatus object that indicates if the Exchange service is enabled.
| ExportService | Service providing access to export service for this user.
| ExportServiceStatus | Returns a ServiceStatus object that indicates if an Export service is enabled.
| ExternalAppIds | External Application IDs for applications that have registered via the ExternalAppInterface.
| HIDService | The service providing access to HID service for this user.
| HIDServiceStatus | Returns a ServiceStatus object that indicates if the Human Interface Device (HID) service is enabled.
| MessagingService | Service providing access to messaging features for this user.
| MessagingServiceStatus | Returns a ServiceStatus object that indicates if the messaging service is enabled.
| OtherPhoneService | The service providing access to other phone mode for this user.
| OtherPhoneServiceStatus | Returns a ServiceStatus object that indicates if the Other Phone service is enabled.
| PresenceService | Service providing access to presence features for this user.
| PresenceServiceStatus | Returns a ServiceStatus object that indicates if the presence service is enabled.
| SharedControlService | Service providing access to shared control features for this user.
| SharedControlServiceStatus | Returns a ServiceStatus object that indicates if the shared control service is enabled.
| SignalingServerGroup | 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.
| SpacesService | Service providing access to spaces features for this user.
| SpacesServiceStatus | Returns a ServiceStatus object that indicates if the spaces service is enabled.
| UnifiedPortalService | Service providing access to Unified Portal features for this user.
| UnifiedPortalServiceStatus | Returns a ServiceStatus object that indicates if the unified portal service is enabled.
| UserId | The user ID of the user.
| VisualVoiceMailService | Service providing access to visual voice mail for this user.
| VisualVoiceMailServiceStatus | Returns a ServiceStatus object that indicates if the visual voice mail service is enabled.
| VoiceMessagingService | Service providing access to voice messaging for this user.
| VoiceMessagingServiceStatus | Returns a ServiceStatus object that indicates if the voice messaging service is enabled.

Top
Methods

| Name | Description
--- | --- | ---
| Start | Starts all configured services.
| Stop | Stops all configured services.

Top
Events

| Name | Description
--- | --- | ---
| AllRegistrationsFailed | Occurs when all registrations have failed
| AllRegistrationsSuccessful | Occurs when registrations to all call servers have been established.
| ConfigurationGroupIdReceived | 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.
| ConfigurationReloadRequested | Occurs when a server is requesting reload of the configuration profile.
| ExternalAppRegistered | An external application has registered to the external app interface in order to monitor, place and/or control calls on this user's behalf.
| ExternalAppUnregistered | A previously registered external application has unregistered from the external app interface.
| RebootRequested | Occurs when a server is requesting reboot.
| RegistrationFailed | 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.
| RegistrationInProgress | Occurs when a registration attempt is started.
| RegistrationResponsePayloadReceived | Occurs when the registration response payload is received from server after registration.
| RegistrationSuccessful | Occurs when a registration attempt to a call server has succeeded.
| ResourceDiscovered | 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.
| SignalingServerGroupReceived | 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
| UnregistrationComplete | Occurs when the user has been completely unregistered.
| UnregistrationFailed | Occurs when an unregistration attempt has failed.
| UnregistrationInProgress | Occurs when an unregistration attempt is started.
| UnregistrationSuccessful | Occurs when the user has been successfully unregistered.

Top
See Also

#### Reference

Avaya.ClientServices Namespace

© 2017 Avaya LLC. All Rights Reserved.