Avaya Client Services API Reference (OS X)
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 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) 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.


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