Avaya Client SDK

< Back to Package Overview

Configuring the SDK for Avaya Aura®

Configuration of the iOS Communications Package is defined by using a number of Configuration objects. This approach provides flexibility to configure services within a package as required.

Client Configuration

The CSClientConfiguration class is the most fundamental configuration object for the package. It is used to describe properties of your application such as Product Name, Product Version and Vendor Name. Additional optional parameters that are accessed through this class include Security Policy, Media parameters, User Agent Name and Instance ID for SIP.

User Configuration

The CSUserConfiguration class defines the desired services for the user. It encapsulates configuration data for each individual service (e.g., CSSIPUserConfiguration for Call Service, CSWCSConfiguration for Collaboration Service, CSPresenceConfiguration for Presence Service...). Configuration of a service includes specifying whether the service should be enabled/disabled, specifying operating parameters (e.g., target server address, port number) and other supporting components (e.g., credential provider).

Related Configuration Classes

Following is the list of configuration classes that are encapsulated in the CSUserConfiguration class :

Making Configuration Changes at Runtime

Configuration data are critical for initializing the Client SDK. Services will be created and initialized according to their corresponding configuration data during initialization.

Once the Client SDK has been initialized, if there is a need to change any configuration options for any services or to enable/disable certain services, the Client SDK needs to be re-initialized with the updated configuration data. Dynamic changes of configuration options are not supported.