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

Client Class

A Client is the primary interface to the Avaya Client Services library.
Inheritance Hierarchy
System
Object
Avaya.ClientServices
Client

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

    public class Client : IDisposable

The Client type exposes the following members.

Constructors

| Name | Description
--- | --- | ---
| Client(ClientConfiguration) | Constructs a client that delivers events on the main thread.
| Client(ClientConfiguration, Dispatcher) | Constructs a client that delivers events on the thread associated with the specified Dispatcher.

Top
Properties

| Name | Description
--- | --- | ---
| CertificateManager | The certificate manager instance associated with this client.
| ConfiguredCipherSuites | Returns the list of configured SSL cipher suites excluding the blacklisted suites.
| DataTransferService | Service providing access to data transfer services for this user.
| DownloadService | Service providing access to file download services for this user.
| IsFIPSModeEnabled | The current state of FIPS mode.
| LogLevel | The current log level.
| MediaServices | Associated MediaServicesInstance instance.
| Version | The current version of the library.

Top
Methods

| Name | Description
--- | --- | ---
| CreateUser | Creates a new User instance.
| Dispose | Disposes the Client object.
| Dispose(Boolean) | Releases the unmanaged resources used by the Client and optionally releases the managed resources
| Finalize | (Overrides Object Finalize .)
| RemoveUser | Starts an asynchronous removal of a user. The user and its associated sessions will be removed, all sockets closed, all services shut down and other internal resources released. When removal is complete, the UserRemoved will be fired. At that point, it is safe to dispose of the user.
| Shutdown | Starts an asynchronous shutdown of the client. All users and associated sessions will be removed, all sockets closed, all services shut down and other internal resources released. When shutdown is complete, the ShutdownCompleted event will be fired. When this occurs it is safe to dispose of the client.

Top
Events

| Name | Description
--- | --- | ---
| FIPSModeSetFailed | Occurs when the FIPS mode set failed.
| FIPSModeSetSucceeded | Occurs when the FIPS mode set succeeded.
| FIPSModeStateChanged | Occurs when the FIPS mode changed unexpectedly while client is running.
| LogMessage | Occurs when a message is logged by Avaya Client Services.
| ShutdownCompleted | Occurs when the signaling engine has shut down.
| UserCreated | Occurs when the client has added a user.
| UserRemoved | Occurs when the client has removed a user.

Top
Remarks
Each Client operates an event loop on an internal thread, and this loop is used for most of the client's work. In order to simplify handling of events from the client on an application thread (typically the UI thread) the client delivers events via a Dispatcher. By default this is Application.Current.Dispatcher and events are delivered on the main thread, but a different Dispatcher may be specified in the Client's constructor if desired.

Once a Client object has been created, it should not be disposed until it has been properly shutdown via a call to the Shutdown(Boolean) method.

See Also

#### Reference

Avaya.ClientServices Namespace

© 2017 Avaya LLC. All Rights Reserved.