SOSAgentAvailability Class Reference

Inherits from NSObject
Declared in SOSAgentAvailability.h

Overview

The SOSAgentAvailability class allows you to configure periodic polling against a single SOS deployment for your organization.

When the availability changes, an [SOSAgentAvailabilityDelegate agentAvailability:didChange:] event is fired.

Other Methods

– startPollingWithOrganizationId:deploymentId:liveAgentPod:

Initializes the agent polling. With the given credentials this will begin polling to determine agent availability. This can be leveraged to provide context to modify application UI depending on agent availability.

- (void)startPollingWithOrganizationId:(NSString *)organizationId deploymentId:(NSString *)deploymentID liveAgentPod:(NSString *)liveAgentPod

Parameters

organizationId

The Salesforce organization id.

deploymentID

The unique id of the deployment for this session.

liveAgentPod

The hostname for the LiveAgent pod that your organization has been assigned.

Discussion

Note: Currently we can only support polling a single deployment at a time.

Declared In

SOSAgentAvailability.h

– stopPolling

Discontinues polling operations. It is recommended that you stop polling in situations or views where no SOS functionality is appropriate/implemented.

- (void)stopPolling

Declared In

SOSAgentAvailability.h

  availabilityStatus

The current availability status.

@property (nonatomic) SOSAgentAvailabilityStatusType availabilityStatus

Declared In

SOSAgentAvailability.h

Delegate Management

– addDelegate:

Adds an instance of an NSObject implementing the SOSAgentAvailabilityDelegate protocol to the list of delegates to notify.

- (void)addDelegate:(id<SOSAgentAvailabilityDelegate>)delegate

Parameters

delegate

NSObject instance to add.

Declared In

SOSAgentAvailability.h

– removeDelegate:

Removes an instance of an NSObject implementing the SOSAgentAvailabilityDelegate protocol to the list of delegates to notify.

- (void)removeDelegate:(id<SOSAgentAvailabilityDelegate>)delegate

Parameters

delegate

NSObject instance to remove.

Declared In

SOSAgentAvailability.h