SOSMasking

@interface SOSMasking : NSObject <SOSDelegate>

The SOSMasking class is responsible for managing the field masking applied during an SOS session. Sensitive fields or sections of the application may be masked to prevent them from appearing to the customer service agent in the video feed.

You can retrieve a reference to this class from the SOSSessionManager instance, and then use the APIs provided below to add or remove parts of your application to be masked on an as-needed basis.

See

SOSSessionManager

See

SOSDelegate

KVO-compliant properties

  • The current state of the masks. This state is driven by the state of the SOS session and SOS screen sharing.

    Declaration

    Objective-C

    @property (readonly, atomic) SOSMaskState state;

    Swift

    var state: SOSMaskState { get }

Adding Masks

  • Register an object conforming to the SOSMaskable protocol to receive messages regarding the current masking state.

    This object is not retained by the SOSMasking class.

    Declaration

    Objective-C

    - (void)registerView:(id<SOSMaskable>)view;

    Swift

    func registerView(_ view: SOSMaskable!)

    Parameters

    view

    The maskable object.

Removing Masks

  • Register the delegates required for the session.

    Declaration

    Objective-C

    - (void)registerDelegates;

    Swift

    func registerDelegates()

  • Remove the delegates required for the session.

    Declaration

    Objective-C

    - (void)removeDelegates;

    Swift

    func removeDelegates()