SOSMasking Class Reference

Inherits from NSObject
Conforms to SOSDelegate
Declared in SOSMasking.h

Overview

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.

KVO-compliant properties

  state

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

@property (readonly, atomic) SOSMaskState state

Declared In

SOSMasking.h

Adding Masks

– registerView:

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

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

Parameters

view

The maskable object.

Discussion

This object is not retained by the SOSMasking class.

Declared In

SOSMasking.h

Removing Masks

– registerDelegates

Register the delegates required for the session.

- (void)registerDelegates

Declared In

SOSMasking.h

– removeDelegates

Remove the delegates required for the session.

- (void)removeDelegates

Declared In

SOSMasking.h