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

Configuration information for Location and HELD (HTTP-Enabled Location Delivery). More...

#import <CSLocationConfiguration.h>

Inherits NSObject.

Properties

NSURL * serverURL
 The URL for the Location Information Server is where the client sends the HELD request to ascertain its physical location. More...
 
id< CSCredentialProvidercredentialProvider
 The credential provider. More...
 
NSUInteger retryIntervalInSeconds
 Specifies the number of seconds the client should wait before attempting to retry the HELD request in the event of an error. More...
 
NSUInteger periodicTimerIntervalInMinutes
 The interval, specified in minutes, determines how frequently location requests are sent to the LIS for updated location data. More...
 
CSLocationInfoMode locationInfoMode
 Indicates the approach for selecting the data to be utilized when querying location information. More...
 

Detailed Description

Configuration information for Location and HELD (HTTP-Enabled Location Delivery).

The HELD protocol is designed to accurately ascertain the geographic location of a device. It enables a device to request its location data from a Location Information Server (LIS). This location information can be utilized across a range of applications, including VoIP services.

Property Documentation

- (id<CSCredentialProvider>) credentialProvider
readwritenonatomicweak

The credential provider.

- (CSLocationInfoMode) locationInfoMode
readwritenonatomicassign

Indicates the approach for selecting the data to be utilized when querying location information.

See also
CSLocationInfoMode Default: Disabled
- (NSUInteger) periodicTimerIntervalInMinutes
readwritenonatomicassign

The interval, specified in minutes, determines how frequently location requests are sent to the LIS for updated location data.

Valid values: 30 to 1440 minutes Default: 60 minutes

- (NSUInteger) retryIntervalInSeconds
readwritenonatomicassign

Specifies the number of seconds the client should wait before attempting to retry the HELD request in the event of an error.

Valid values: 60-3600 seconds Default: 60 seconds

- (NSURL*) serverURL
readwritenonatomiccopy

The URL for the Location Information Server is where the client sends the HELD request to ascertain its physical location.

Default: empty.


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