SOSErrorCode

enum SOSErrorCode {}

SOS ErrorCode definitions.

Errors fall into one of several groups (or series) of errors.

If there is an error thrown by a library dependency it will be included as metadata in the userInfo of the error which is returned to the application code.

General Errors (1000-series)

  • Unclassified error. This results from an unknown or unexpected error state.

    Any other un-grouped errors will be added to the 0-99 series error group.

    Declaration

    Objective-C

    SOSGenericError = 1000

    Swift

    case SOSGenericError = 1000

  • Returned from <[SOSSessionManager startSessionWithOptions:completion:]> if the SOSOptions provided is nil or invalid.

    Declaration

    Objective-C

    SOSInvalidOptions = 1001

    Swift

    case SOSInvalidOptions = 1001

  • Returned from <[SOSSessionManager startSessionWithOptions:completion:]> if SOSOptions contains invalid camera options. (e.g. initialCameraType = SOSCameraTypeBackFacing && <[SOSOptions featureClientBackCameraEnabled]> == NO)

    Declaration

    Objective-C

    SOSInvalidOptionsCameraSettings = 1002

    Swift

    case SOSInvalidOptionsCameraSettings = 1002

Connection Errors (2000-series)

  • Standard connection error. This can be thrown from any part of the SOS Session connection flow.

    All connection related errors will be found in the 100-199 series error group.

    Declaration

    Objective-C

    SOSConnectionError = 2000

    Swift

    case SOSConnectionError = 2000

  • Returned from <[SOSSessionManager startSessionWithOptions:completion:]> if there is a session already active or in progress.

    Declaration

    Objective-C

    SOSSessionIsActiveError = 2001

    Swift

    case SOSSessionIsActiveError = 2001

  • Returned from <[SOSSessionManager stopSessionWithCompletion:]> if there is no active session to stop.

    Declaration

    Objective-C

    SOSNoActiveSessionError = 2002

    Swift

    case SOSNoActiveSessionError = 2002

  • Returned if the network becomes unavailable.

    Declaration

    Objective-C

    SOSNetworkUnavailableError = 2003

    Swift

    case SOSNetworkUnavailableError = 2003

Server Errors (3000-series)

  • Standard server error. This can be returned from operations made to the SOS server.

    All server related errors will be found in the 200-299 series error group.

    Declaration

    Objective-C

    SOSServerError = 3000

    Swift

    case SOSServerError = 3000

  • Server metadata error. This can be returned from operations attempting to update the state of the session.

    Declaration

    Objective-C

    SOSServerMetaDataError = 3001

    Swift

    case SOSServerMetaDataError = 3001

  • Error returned when the session creation request is not successful.

    Declaration

    Objective-C

    SOSServerSessionCreationError = 3002

    Swift

    case SOSServerSessionCreationError = 3002

  • Error returned when agent availability API encounters a problem.

    Declaration

    Objective-C

    SOSAgentAvailabilityError = 3003

    Swift

    case SOSAgentAvailabilityError = 3003

  • Error occured when attempting to disconnect a session after a switch server occurred.

    Declaration

    Objective-C

    SOSSwitchServerSessionDisconnectError = 3004

    Swift

    case SOSSwitchServerSessionDisconnectError = 3004

  • Error returned when the session end request is not successful.

    Declaration

    Objective-C

    SOSServerSessionEndError = 3005

    Swift

    case SOSServerSessionEndError = 3005

Communication Errors (4000-series)

  • Standard communication error. This can be returned from operations dependent on communication between SOS or any other remote system.

    All communication related errors will be found in the 300-399 series error group.

    Declaration

    Objective-C

    SOSCommunicationError = 4000

    Swift

    case SOSCommunicationError = 4000

  • Returned by the framework if there are no agents available to serve a session attempt.

    Declaration

    Objective-C

    SOSNoAgentsAvailableError = 4001

    Swift

    case SOSNoAgentsAvailableError = 4001

  • Returned by the framework if the network test has failed to start.

    Declaration

    Objective-C

    SOSNetworkTestError = 4002

    Swift

    case SOSNetworkTestError = 4002

  • Returned by the framework if the network test has determined that the environment cannot support an SOS session.

    Declaration

    Objective-C

    SOSInsufficientNetworkError = 4003

    Swift

    case SOSInsufficientNetworkError = 4003

Application Errors (5000-series)

  • Standard internal framework error. This can be returned from operations performed within the SOS framework.

    All internal errors will be found in the 400-499 series error group.

    Declaration

    Objective-C

    SOSInternalError = 5000

    Swift

    case SOSInternalError = 5000

RTC Provider Errors (6000-series)

  • Standard RTC Provider error. This can be returned as a result of operations performed by the RTC provider.

    Since the RTC provider is a separate library, error specifics will be wrapped and included in the userInfo of errors returned with this code.

    Declaration

    Objective-C

    SOSRTCProviderError = 6000

    Swift

    case SOSRTCProviderError = 6000

  • Error returned if there is a problem creating an authentication token with the WebRTC provider.

    Declaration

    Objective-C

    SOSRTCProviderAuthenticationError = 6001

    Swift

    case SOSRTCProviderAuthenticationError = 6001