Avaya Client Services API Reference (iOS)

- Main Page
- Classes
- Files
- Related Pages

- Class List
- Class Index
- Class Hierarchy
- Class Members

Properties | List of all members
CSSIPUserConfiguration Class Reference

Configuration information for a `CSSIPSignalingEngine`. More...

`#import <CSSIPUserConfiguration.h>`

Inherits NSObject.

## Properties
BOOL | enabled
| A Boolean value indicating whether the SIP provider is enabled. More...
CSConnectionPolicy * | connectionPolicy
| The connection policy defining the signaling servers to communicate with. More...
NSString * | userId
| The user ID. More...
NSString * | domain
| The SIP domain for the user. More...
id< CSCredentialProvider > | credentialProvider
| The credential provider to be used for SIP authentication. More...
NSString * | displayName
| The display name used to identify the endpoint the user is on. More...
NSString * | language
| The language string to use in Accept-Language header. More...
CSSIPMobilityMode | mobilityMode
| The mobility mode for the user. More...
NSString * | alternateNetwork
| The alternate network type for a dual-mode client. More...
NSString * | alternateAddressOfRecord
| The address-of-record for the user in the alternate network. More...
NSArray * | mediaEncryptionCipherList
| List of enabled ciphersuites for SRTP. More...
BOOL | SRTCPEnabled
| A Boolean value indicating whether encryption is enabled for SRTCP. More...
BOOL | useSIPSURIOverTLS
| Controls whether the SIP endpoint uses sips (secure SIP) URI scheme for all SIP requests it initiates towards the network, including secure media calls. More...
BOOL | MACAddressInfoInSIPRegistrationEnabled
| Controls whether the local MAC address information is provided in the "+av.mac-address" field of the SIP registration contact address or not. More...
CSSIPClientConfiguration * | SIPClientConfiguration
| Configuration information for SIP Client data. More...
CSSIPAgentConfiguration * | SIPAgentConfiguration
| Configuration information for SIP Agent Feature service. More...
CSOutboundSubscriptionConfiguration * | outboundSubscriptionConfiguration
| Configuration information for Outbound Subscription data. More...
CSMediaTransportPreference | voipCallingPreference
| VoIP Calling preference of user. More...
CSSignalingAddressMode | signalingAddressMode
| Indicates the SIP session manager address type preference when the client connects to dual stack server from a dual stack client network. More...
CSMediaAddressMode | mediaAddressMode
| Indicates the IP address type preference to use when negotiating media streams when the client connects to dual stack server from a dual stack client network. More...
BOOL | transferToVoicemailEnabled
| A Boolean value indicating if transfer to voicemail feature is enabled. More...
BOOL | incomingVoipCallsBarred
| A Boolean value indicating that the user doesn't wish to receive incoming calls through VoIP service. More...
NSString * | dialPlan
| It accelerates dialing by eliminating the need to wait for the INTER_DIGIT_TIMEOUT timer to expire. More...
NSSet * | emergencyNumbers
| The emergency phone numbers. More...
NSArray * | emergencyNumbersOrdered
| The emergency phone numbers ordered according to priority. More...
CSCallDenialPolicy | callDenialPolicy
| Specifies the call denial policy. More...
NSUInteger | maxSimultaneousRegistrations
| The maximum number of servers a user can simultaneously register to. More...
NSUInteger | otherPhoneModeRemoteMediaResponseTimeout
| Time period for waiting for completion of initial INVITE transaction with other phone call leg. More...
BOOL | automaticLineReservationEnabled
| Controls whether the Client SDK shall automatically invoke line reservation feature prior to placing an outgoing call. More...
BOOL | srtpRekeyingOnUnholdEnabled
| Controls whether the client should generate new crypto keys on session unhold. More...
BOOL | userToUserInformationEnabled
| Sets the UUI data and encoded information in the User-To-User header. More...

## Detailed Description

Configuration information for a `CSSIPSignalingEngine`.

## Property Documentation

- (NSString*) alternateAddressOfRecord
| readwritenonatomiccopy

The address-of-record for the user in the alternate network.

For a dual-mode client, this specifies the user's cell number.

- (NSString*) alternateNetwork
| readwritenonatomiccopy

The alternate network type for a dual-mode client.

Generally set to "mobile" for dual-mode clients.

- (BOOL) automaticLineReservationEnabled
| readwritenonatomicassign

Controls whether the Client SDK shall automatically invoke line reservation feature prior to placing an outgoing call.

The default value is false, which means automatic line reservation is disabled.

- (CSCallDenialPolicy) callDenialPolicy
| readwritenonatomicassign

Specifies the call denial policy.

If a user denies a call using CSCall::denyWithCompletionHandler: method then the denial reason will be determined based on CallDenialPolicy policy. By default, the property is set to Busy.

- (CSConnectionPolicy*) connectionPolicy
| readwritenonatomicstrong

The connection policy defining the signaling servers to communicate with.

- (id<CSCredentialProvider>) credentialProvider
| readwritenonatomicweak

The credential provider to be used for SIP authentication.

- (NSString*) dialPlan
| readwritenonatomiccopy

It accelerates dialing by eliminating the need to wait for the INTER_DIGIT_TIMEOUT timer to expire.

The value can contain 0 to 1023 characters; the default value is null (""). See the telephone Administrator's Guide for format and setting alternatives. example: "[23]xxxx|91xxxxxxxxxx|9[2-9]xxxxxxxxx"

- (NSString*) displayName
| readwritenonatomiccopy

The display name used to identify the endpoint the user is on.

In SIP this is inserted in the display name portion of SIP Contact header. For example, the display name may be set to "Alice's Flare on iPad". This label is used to identify an endpoint from a list of endpoints that can be registered on behalf of the user (e.g., when SM's parallel forking group feature is enabled).

- (NSString*) domain
| readwritenonatomiccopy

The SIP domain for the user.

- (NSSet*) emergencyNumbers
| readwritenonatomicstrong

The emergency phone numbers.

Used in the Non-Aura environment. In a Aura environment, the identification of emergency numbers occurs automatically.

- (NSArray*) emergencyNumbersOrdered
| readwritenonatomicstrong

The emergency phone numbers ordered according to priority.

Gets the list of configured emergency numbers in priority order. Numbers appearing earlier in the list have higher priority. Used in non-Aura environments. In Aura-enabled environments, emergency numbers are detected automatically.

- (BOOL) enabled
| readwritenonatomicassign

A Boolean value indicating whether the SIP provider is enabled.

- (BOOL) incomingVoipCallsBarred
| readwritenonatomicassign

A Boolean value indicating that the user doesn't wish to receive incoming calls through VoIP service.

- (NSString*) language
| readwritenonatomiccopy

The language string to use in Accept-Language header.

- (BOOL) MACAddressInfoInSIPRegistrationEnabled
| readwritenonatomicassign

Controls whether the local MAC address information is provided in the "+av.mac-address" field of the SIP registration contact address or not.

By default, this property is set to false, indicating that no local MAC address information is provided in the SIP registration message. When this property is set to true and the local operating system allows reading of the MAC address based on the local IP address used for connection to the SIP server, then the local MAC address is provided in the "+av.mac-address" field. The MAC address provided in the "+av.mac-address" field is used by Avaya development partners to determine the location of the machine for E.911 calling.

- (NSUInteger) maxSimultaneousRegistrations
| readwritenonatomicassign

The maximum number of servers a user can simultaneously register to.

The recommended range is from 1 to 5. If the property is not set, Client SDK will continue to simultaneously register to a maximum of three servers, as provided by PPM.

- (CSMediaAddressMode) mediaAddressMode
| readwritenonatomicassign

Indicates the IP address type preference to use when negotiating media streams when the client connects to dual stack server from a dual stack client network.

- (NSArray*) mediaEncryptionCipherList
| readwritenonatomicstrong

List of enabled ciphersuites for SRTP.

- (CSSIPMobilityMode) mobilityMode
| readwritenonatomicassign

The mobility mode for the user.

- (NSUInteger) otherPhoneModeRemoteMediaResponseTimeout
| readwritenonatomicassign

Time period for waiting for completion of initial INVITE transaction with other phone call leg.

If no early or final media response is received from remote party within this time period, then the other phone call leg transaction will be completed with a dummy media response. Dummy media will be updated to real remote media info upon media response from remote party.

Valid values are within 0 to 30 seconds range. Default value is 30. If set to 0, it means there is no wait for completion of the initial INVITE transaction with the telecommuter call leg. If set to more than 30 or less than 0, this variable will be set to the default value of 30.

- (CSOutboundSubscriptionConfiguration*) outboundSubscriptionConfiguration
| readwritenonatomicstrong

Configuration information for Outbound Subscription data.

- (CSSignalingAddressMode) signalingAddressMode
| readwritenonatomicassign

Indicates the SIP session manager address type preference when the client connects to dual stack server from a dual stack client network.

- (CSSIPAgentConfiguration*) SIPAgentConfiguration
| readwritenonatomicstrong

Configuration information for SIP Agent Feature service.

- (CSSIPClientConfiguration*) SIPClientConfiguration
| readwritenonatomicstrong

Configuration information for SIP Client data.

- (BOOL) SRTCPEnabled
| readwritenonatomicassign

A Boolean value indicating whether encryption is enabled for SRTCP.

- (BOOL) srtpRekeyingOnUnholdEnabled
| readwritenonatomicassign

Controls whether the client should generate new crypto keys on session unhold.

The default value is false.

- (BOOL) transferToVoicemailEnabled
| readwritenonatomicassign

A Boolean value indicating if transfer to voicemail feature is enabled.

- (NSString*) userId
| readwritenonatomiccopy

The user ID.

- (BOOL) userToUserInformationEnabled
| readwritenonatomicassign

Sets the UUI data and encoded information in the User-To-User header.

When a DSE/FSE call notification (e.g., Pickup, Teams, Bridge) or a SIP call with UCID information is received, the same UCID will be included in the "User-to-User" header of the outgoing INVITE or REFER message during call operations such as answer a call, call hold/unhold, blind/consultative transfer, etc. Note: This functionality is limited to agent login only.

The default value is false.

- (BOOL) useSIPSURIOverTLS
| readwritenonatomicassign

Controls whether the SIP endpoint uses sips (secure SIP) URI scheme for all SIP requests it initiates towards the network, including secure media calls.

If enabled, SIP endpoint registers a SIPS Contact address with the SIP registrar, and uses SRTP crypto suites as controlled by mediaEncryptionCipherList.

If disabled, SIP endpoint registers a SIP Contact address with the SIP registrar, and uses SRTP crypto suites as controlled by mediaEncryptionCipherList.

- (CSMediaTransportPreference) voipCallingPreference
| readwritenonatomicassign

VoIP Calling preference of user.

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

- CSSIPUserConfiguration.h