Avaya Client Services API Reference (Windows)
Avaya Client Services API Reference (Windows)
Avaya.ClientServices
ClientConfiguration Class
ClientConfiguration Properties
AnalyticsEnabled Property
AudioDeviceCallControlEnabled Property
AvayaModel Property
BuildNumber Property
DataDirectory Property
MediaConfiguration Property
OSVersion Property
Platform Property
ProductName Property
ProductVersion Property
ProxyCredentialProvider Property
ProxyFallbackEnabled Property
ProxyMode Property
SecurityPolicyConfiguration Property
UserAgentInstanceId Property
UserAgentName Property
VendorName Property

# ClientConfiguration Properties

The ClientConfiguration type exposes the following members.

Properties

| Name | Description
--- | --- | ---
| AnalyticsEnabled | Used to control the collection of analytics data by the SDK.
| AudioDeviceCallControlEnabled | Enable the audio device call control feature. When true, allows the user to answer, end, mute, unmute, hold, and unhold calls using buttons on certain Avaya - branded audio devices(L1xx headsets, B109 speakerphone). Button control is enabled automatically when the same supported headset is selected for use as the microphone and earphone device. Button control is disabled when either the microphone or earphone is an unsupported device. This feature is independent of headset control by the App or External API, and those services should continue to work with the devices that they support. Defaults to true.
| AvayaModel | Optional model string for publishing endpoint type via "+avaya.model" parameter to other endpoints. For instance, if this client is configured as Shared Control controllable endpoint, it may publish self endpoint type (e.g. 'AvayaSoftClient' or 'AvayaDeskPhone') to other shared control capable endpoints, registered with the same extension. So that control-capable client application could display this model information to the user who is going to activate shared control. This model information may help user to identify this endpoint in case multiple endpoints are available.
| BuildNumber |
| DataDirectory | The location to use for the storage of persistent data.
| MediaConfiguration | Configuration data containing the media (audio, video) data.
| OSVersion |
| Platform |
| ProductName |
| ProductVersion |
| ProxyCredentialProvider | If proxy server needs authentication, this credential provider will be used to get them.
| ProxyFallbackEnabled | Defines if proxy fallback feature should be enabled or not. Proxy fallback is a feature that will allow Client SDK to connect directly to given endpoint despite proxy settings. First, connection is made via proxy (if set in Operating System) and if there's a failure (except wrong credentials), another attempt is made to establish a connection, only this time bypassing proxy settings.
| ProxyMode | Defines how proxy settings are used.
| SecurityPolicyConfiguration | Configuration data containing security policy (i.e. Certificate) data.
| UserAgentInstanceId | A unique instance id of the user agent. This is the instance.id defined in RFC 5626. According to RFC 5626, each UA MUST have an Instance Identifier Uniform Resource Name (URN) [RFC2141] that uniquely identifies the device. Usage of a URN provides a persistent and unique name for the UA instance. It also provides an easy way to guarantee uniqueness within the AOR. This URN MUST be persistent across power cycles of the device. The instance ID MUST NOT change as the device moves from one network to another. A device like a "soft phone", when first installed, can generate a UUID [RFC4122] and then save this in persistent storage for all future use.
| UserAgentName | The product-identifying string used in the User-Agent header.
| VendorName |

Top
See Also

#### Reference

ClientConfiguration Class
Avaya.ClientServices Namespace

© 2017 Avaya LLC. All Rights Reserved.