SOSSessionViewController

@protocol SOSSessionViewController <NSObject>

Protocol which defines properties and methods which are required for all view controllers which will accommodate the role for screen sharing in SOS.

Notifications

  • Message from the backend that the session is attempting to reconnect. You may receive this message in the event that the session is attempting to recover from a network disconnection or in the event of backgrounding the application or after receiving a phone call.

    This method allows your implementation to present a custom message for this event. This is entirely optional as no input is required from the user.

    Declaration

    Objective-C

    - (void)reconnectingNotification;

    Swift

    optional func reconnectingNotification()

  • Message from the backend that the session has successfully reconnected.

    This method allows your implementation to present a custom message for this event. This is entirely optional as no input is required from the user.

    Declaration

    Objective-C

    - (void)reconnectionCompleteNotification;

    Swift

    optional func reconnectionCompleteNotification()

  • Message from the backend that the agent has paused/unpaused their connection. This method will be executed any time the agent pause state has changed.

    Declaration

    Objective-C

    - (void)agentPausedConnectionNotification:(BOOL)paused;

    Swift

    optional func agentPausedConnectionNotification(_ paused: Bool)

    Parameters

    paused

    The current agent paused state. YES means that the agent is currently pausing their connection.

  • Message from the backend that the network connection status has changed. The status is determined by bandwidth tests which are conducted during an SOS session. When the status changes you will receive this method with the current network status.

    Declaration

    Objective-C

    - (void)networkStatusUpdateNotification:(SOSNetworkStatus)networkStatus;

    Swift

    optional func networkStatusUpdateNotification(_ networkStatus: SOSNetworkStatus)

    Parameters

    networkStatus

    The current network status.

  • Message from the backend that the WebRTC provider has changed the reconnect status. The status message is determined by signals from the WebRTC provider. When the status changes, you will receive this method with the current reconnect status.

    Declaration

    Objective-C

    - (void)reconectStatusUpdateNotification:(SOSReconnectStatus)reconnectStatus;

    Swift

    optional func reconectStatusUpdateNotification(_ reconnectStatus: SOSReconnectStatus)

    Parameters

    reconnectStatus

    The current network reconnect status.