package

com.salesforce.android.sos.api

Contains public API classes for interfacing with the Android SDK.

Contains most public consumable interfaces for SOS. Most other packages under the com.salesforce.android.sos tree are not intended for public use. Views packaged with the Android SOS SDK that implement SosMaskedField are the exception to this rule.

The primary point of interest for integrating SOS into an app is the Sos class, which contains a static interface for initiating and controlling an SOS session.

Interfaces

SosAvailability.Listener The Listener interface is used to receive updates about the SOS availability status. 
SosAVListener Interface to listen for changes in the sessions audio or video status. 
SosConnectionListener Interface for listening to changes in the SOS connection strength. 
SosHoldListener Listener interface for receiving changes to the session hold state. 
SosListener Interface for listeners for the events that occur in an SOS session. 
SosMaskingListener Interface for listening for changes to the state of the masked fields during an SOS session. 
SosNetworkTestListener Interface for listening to the status of the network test conducted at the beginning of a session. 
SosShareTypeListener Interface for listening to the current share type. 

Classes

ContainerPosition Used to set the default position of the Agent Container. 
Sos The main API to interface with the session lifecycle. 
Sos.SessionBuilder SessionBuilder is used to aid in the construction of an SOS session. 
SosAvailability API used for monitoring the SOS system for agent availability updates. 
SosConfiguration Configuration class for SOS sessions. 
SosConfiguration.Builder Builder for SosConfiguration instances. 
SosOptions Encapsulates the information required to start a session. 

Enums

SosAvailability.Status Enumerates the possible availability statuses for SOS. 
SosEndReason Enumeration of the various causes of the end of the session. 
SosHoldState Enumeration for all possible session hold states. 
SosShareType Enumeration of the various Share Types that can occur within a session. 
SosState Enumeration of the various states of an SOS session. 
SosToast Enumeration of the various Toasts that are shown by the SOS framework during a session. 

Exceptions

Sos.SessionExistsException Thrown when caller attempts to start an SOS session while one already exists.