Avaya Client Services API Reference (iOS)
Properties | List of all members
CSIPOfficeConfiguration Class Reference

Configuration information for IP Office. More...

#import <CSIPOfficeConfiguration.h>

Inherits NSObject.

Properties

BOOL enabled
 A Boolean value indicating whether the IP Office provider is enabled. More...
 
BOOL messagingEnabled
 A Boolean value indicating whether to enable One-X Portal messaging service for IP Office. More...
 
BOOL contactsEnabled
 A Boolean value indicating whether the IP Office contacts provider is enabled. More...
 
BOOL presenceEnabled
 A Boolean value indicating whether the IP Office presence provider is enabled. More...
 
BOOL callLogEnabled
 A Boolean value indicating whether the IP Office Centralized Call Log is enabled. More...
 
BOOL conferenceControlsEnabled
 A Boolean value indicating whether the IP Office Conference controls are enabled. More...
 
BOOL callRecordingEnabled
 A Boolean value indicating whether the IP Office call recording is enabled. More...
 
BOOL callHandoverEnabled
 A Boolean value indicating whether the IP Office call handover is enabled. More...
 
CSServerInfoserver
 The signaling server to connect with. More...
 
id< CSCredentialProvidercredentialProvider
 The credential provider. More...
 
id< CSCredentialProvidermessagingCredentialProvider
 Messaging credential provider. More...
 
NSURL * primaryMessagingServerUrl
 The URL of the primary messaging server. More...
 
NSURL * secondaryMessagingServerUrl
 The URL of the secondary messaging server. More...
 
NSTimeInterval initialReconnectInterval
 The initial time interval between a connection failure and a reconnect attempt. More...
 
NSTimeInterval maxReconnectInterval
 The maximum time interval between a connection failure and a reconnect attempt. More...
 
BOOL messagingPushNotificationEnabled
 A Boolean value indicating whether Push Notifications are enabled. More...
 
NSData * messagingRemoteNotificationDeviceToken
 A unique app-device token assigned by Apple to an application instance running in a specific iOS device. More...
 
BOOL useDevelopmentPushNotificationNetwork
 A Boolean value indicating whether incoming push notification events should be sent through Apple's development push notification network (api.development.push.apple.com) or the production push notification network (api.push.apple.com). More...
 
BOOL monAppsEnabled
 A Boolean value indicating whether the IP Office MonApps service is enabled. More...
 

Detailed Description

Configuration information for IP Office.

Property Documentation

- (BOOL) callHandoverEnabled
readwritenonatomicassign

A Boolean value indicating whether the IP Office call handover is enabled.

- (BOOL) callLogEnabled
readwritenonatomicassign

A Boolean value indicating whether the IP Office Centralized Call Log is enabled.

- (BOOL) callRecordingEnabled
readwritenonatomicassign

A Boolean value indicating whether the IP Office call recording is enabled.

- (BOOL) conferenceControlsEnabled
readwritenonatomicassign

A Boolean value indicating whether the IP Office Conference controls are enabled.

- (BOOL) contactsEnabled
readwritenonatomicassign

A Boolean value indicating whether the IP Office contacts provider is enabled.

- (id<CSCredentialProvider>) credentialProvider
readwritenonatomicweak

The credential provider.

- (BOOL) enabled
readwritenonatomicassign

A Boolean value indicating whether the IP Office provider is enabled.

- (NSTimeInterval) initialReconnectInterval
readwritenonatomicassign

The initial time interval between a connection failure and a reconnect attempt.

If connection attempts continue to fail the reconnect interval will be progressively extended using a backoff algorithm based on this initial reconnect interval. The default is 2 seconds.

Set to zero to disable automatic reconnection attempts. Values < 0 or > 65535 are ignored.

- (NSTimeInterval) maxReconnectInterval
readwritenonatomicassign

The maximum time interval between a connection failure and a reconnect attempt.

The default is 1800 seconds. Values < 0 or > 65535 are ignored.

- (id<CSCredentialProvider>) messagingCredentialProvider
readwritenonatomicweak

Messaging credential provider.

The messaging service and server are not coupled to SIP service.

- (BOOL) messagingEnabled
readwritenonatomicassign

A Boolean value indicating whether to enable One-X Portal messaging service for IP Office.

- (BOOL) messagingPushNotificationEnabled
readwritenonatomicassign

A Boolean value indicating whether Push Notifications are enabled.

- (NSData*) messagingRemoteNotificationDeviceToken
readwritenonatomiccopy

A unique app-device token assigned by Apple to an application instance running in a specific iOS device.

This is used by the OneXPortal server when sending messaging events towards the push notification client.

- (BOOL) monAppsEnabled
readwritenonatomicassign

A Boolean value indicating whether the IP Office MonApps service is enabled.

MonApps are miscellaneous PBX features which are not call features but are still useful for a user application to be able to monitor. Current support is for the monitoring of button MonApp only.

- (BOOL) presenceEnabled
readwritenonatomicassign

A Boolean value indicating whether the IP Office presence provider is enabled.

- (NSURL*) primaryMessagingServerUrl
readwritenonatomiccopy

The URL of the primary messaging server.

- (NSURL*) secondaryMessagingServerUrl
readwritenonatomiccopy

The URL of the secondary messaging server.

- (CSServerInfo*) server
readwritenonatomicstrong

The signaling server to connect with.

- (BOOL) useDevelopmentPushNotificationNetwork
readwritenonatomicassign

A Boolean value indicating whether incoming push notification events should be sent through Apple's development push notification network (api.development.push.apple.com) or the production push notification network (api.push.apple.com).

The Boolean flag is set to YES if the application is built using a development provisioning profile. By default, the property is set to NO, and Apple's production network is used to route push notification messages.


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