SOSSessionManager

@interface SOSSessionManager : NSObject

The SOSSessionManager class is the main interface to the SOS framework.

This object manages the flow of SOS sessions throughout the lifetime of the app. Configuration and customization of the SOS framework is handled through the public properties on the SOSSessionManager instance.

SOSSessionManager conforms to a multicast delegate model for messaging. Any class which implements the SOSDelegate protocol can be added to a list of delegates to receive messages asynchronously.

To get an instance of this class, use the SCServiceCloud.sos property on +[SCServiceCloud sharedInstance].

SOS Management Objects

  • Public reference to the SOSScreenAnnotations instance used by the SOS framework.

    Declaration

    Objective-C

    @property (readonly, atomic) SOSScreenAnnotations *annotations;

    Swift

    var annotations: SOSScreenAnnotations! { get }

  • Public reference to the SOSMasking instance used by the SOS framework.

    Declaration

    Objective-C

    @property (readonly, atomic) SOSMasking *masking;

    Swift

    var masking: SOSMasking! { get }

  • Public reference to the SOSAgentAvailability object used for checking availability of SOS agents.

    Declaration

    Objective-C

    @property (readonly, atomic) SOSAgentAvailability *agentAvailability;

    Swift

    var agentAvailability: SOSAgentAvailability! { get }

  • Public reference to the SOSNetworkReporter object. This object will accept delegates to listen to audio and video network traffic events.

    See

    SOSNetworkReportDelegate

    Declaration

    Objective-C

    @property (readonly, atomic) SOSNetworkReporter *networkReporter;

    Swift

    var networkReporter: SOSNetworkReporter! { get }

Other Properties

Session Management

Delegate Management

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

    Declaration

    Objective-C

    - (void)addDelegate:(id<SOSDelegate>)delegate;

    Swift

    func add(_ delegate: SOSDelegate!)

    Parameters

    delegate

    NSObject instance to add.

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

    Declaration

    Objective-C

    - (void)removeDelegate:(id<SOSDelegate>)delegate;

    Swift

    func remove(_ delegate: SOSDelegate!)

    Parameters

    delegate

    NSObject instance to remove.

Class Methods

  • Returns the NSString containing the current version of the framework.

    Declaration

    Objective-C

    + (NSString *)frameworkVersion;

    Swift

    class func frameworkVersion() -> String!

    Return Value

    An NSString containing the framework version.