Avaya Client Services API Reference (OS X)
Instance Methods | Properties | List of all members
CSClientConfiguration Class Reference

#import <CSClientConfiguration.h>

Inherits NSObject.

Instance Methods

(instancetype) - initWithDataDirectory:
 Initialize with configuration detail with directory for storing persistent data. More...
 
(instancetype) - initWithDataDirectory:productName:productVersion:platform:osVersion:buildNumber:vendorName:
 Initialize with configuration details like name and version of the product, platform, operating system version, and build number, vendor name and device handle. More...
 

Properties

NSString * productName
 Product name. More...
 
NSString * productVersion
 Product version. More...
 
NSString * platform
 Platform. More...
 
NSString * osVersion
 Operating system version. More...
 
NSString * buildNumber
 Build number. More...
 
NSString * vendorName
 Vendor name. More...
 
NSString * userAgentName
 The product-identifying string used in the User-Agent header. More...
 
NSString * userAgentInstanceId
 A unique instance id of the user agent. More...
 
CSSecurityPolicyConfigurationsecurityPolicyConfiguration
 Configuration data containing security policy. More...
 
CSMediaConfigurationmediaConfiguration
 Configuration data containing the media (audio, video) data. More...
 
NSString * dataDirectory
 The directory for storing persistent data. More...
 
BOOL analyticsEnabled
 Used to control the collection of analytics data by the SDK. More...
 
CSProxyMode proxyMode
 Proxy mode to use with network connections. More...
 
id< CSCredentialProviderproxyCredentialProvider
 Credential provider for proxy authentication. More...
 
BOOL proxyFallbackEnabled
 Defines if proxy fallback feature is enabled or not. More...
 
BOOL audioDeviceCallControlEnabled
 A Boolean value indicating whether the audio device call control feature is enabled. More...
 

Method Documentation

- (instancetype) initWithDataDirectory: (NSString *)  dataDirectory

Initialize with configuration detail with directory for storing persistent data.

- (instancetype) initWithDataDirectory: (NSString *)  dataDirectory
productName: (NSString *)  productName
productVersion: (NSString *)  productVersion
platform: (NSString *)  platform
osVersion: (NSString *)  osVersion
buildNumber: (NSString *)  buildNumber
vendorName: (NSString *)  vendorName 

Initialize with configuration details like name and version of the product, platform, operating system version, and build number, vendor name and device handle.

Property Documentation

- (BOOL) analyticsEnabled
readwritenonatomicassign

Used to control the collection of analytics data by the SDK.

The analytics information collected by the SDK is for internal Avaya use only and contains no personally identifiable information. These analytics are used solely by Avaya for the purposes of improving its products and will not be shared with anyone outside of Avaya.

Note that changes to this setting are not effective after the CSClient object has been created.

The default value is NO (the collection of analytics is disabled).

- (BOOL) audioDeviceCallControlEnabled
readwritenonatomicassign

A Boolean value indicating whether the audio device call control feature is enabled.

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 YES.

- (NSString*) buildNumber
readwritenonatomiccopy

Build number.

- (NSString*) dataDirectory
readwritenonatomiccopy

The directory for storing persistent data.

- (CSMediaConfiguration*) mediaConfiguration
readwritenonatomicstrong

Configuration data containing the media (audio, video) data.

- (NSString*) osVersion
readwritenonatomiccopy

Operating system version.

- (NSString*) platform
readwritenonatomiccopy

Platform.

- (NSString*) productName
readwritenonatomiccopy

Product name.

- (NSString*) productVersion
readwritenonatomiccopy

Product version.

- (id<CSCredentialProvider>) proxyCredentialProvider
readwritenonatomicweak

Credential provider for proxy authentication.

- (BOOL) proxyFallbackEnabled
readwritenonatomicassign

Defines if proxy fallback feature is 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.

- (CSProxyMode) proxyMode
readwritenonatomicassign

Proxy mode to use with network connections.

- (CSSecurityPolicyConfiguration*) securityPolicyConfiguration
readwritenonatomicstrong

Configuration data containing security policy.

- (NSString*) userAgentInstanceId
readwritenonatomiccopy

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.

This is typically a string representation of a UUID.

- (NSString*) userAgentName
readwritenonatomiccopy

The product-identifying string used in the User-Agent header.

- (NSString*) vendorName
readwritenonatomiccopy

Vendor name.


The documentation for this class was generated from the following file: