SOSErrorCode Constants Reference
Declared in | SOSError.h |
---|
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.
Definition
typedef NS_ENUM(NSInteger, SOSErrorCode ) {
SOSGenericError = 1000,
SOSInvalidOptions = 1001,
SOSInvalidOptionsCameraSettings = 1002,
SOSConnectionError = 2000,
SOSSessionIsActiveError = 2001,
SOSNoActiveSessionError = 2002,
SOSNetworkUnavailableError = 2003,
SOSServerError = 3000,
SOSServerMetaDataError = 3001,
SOSServerSessionCreationError = 3002,
SOSAgentAvailabilityError = 3003,
SOSSwitchServerSessionDisconnectError = 3004,
SOSServerSessionEndError = 3005,
SOSCommunicationError = 4000,
SOSNoAgentsAvailableError = 4001,
SOSNetworkTestError = 4002,
SOSInsufficientNetworkError = 4003,
SOSInternalError = 5000,
SOSRTCProviderError = 6000,
SOSRTCProviderAuthenticationError = 6001,
};
Constants
SOSGenericError
-
Unclassified error. This results from an unknown or unexpected error state.
Declared In
SOSError.h
. SOSInvalidOptions
-
Returned from [SOSSessionManager startSessionWithOptions:completion:] if the SOSOptions provided is
nil
or invalid.Declared In
SOSError.h
. SOSInvalidOptionsCameraSettings
-
Returned from [SOSSessionManager startSessionWithOptions:completion:] if SOSOptions contains invalid camera options. (e.g. initialCameraType =
SOSCameraTypeBackFacing
&& [SOSOptions featureClientBackCameraEnabled] ==NO
)Declared In
SOSError.h
. SOSConnectionError
-
Standard connection error. This can be thrown from any part of the SOS Session connection flow.
Declared In
SOSError.h
. SOSSessionIsActiveError
-
Returned from [SOSSessionManager startSessionWithOptions:completion:] if there is a session already active or in progress.
Declared In
SOSError.h
. SOSNoActiveSessionError
-
Returned from [SOSSessionManager stopSessionWithCompletion:] if there is no active session to stop.
Declared In
SOSError.h
. SOSNetworkUnavailableError
-
Returned if the network becomes unavailable.
Declared In
SOSError.h
. SOSServerError
-
Standard server error. This can be returned from operations made to the SOS server.
Declared In
SOSError.h
. SOSServerMetaDataError
-
Server metadata error. This can be returned from operations attempting to update the state of the session.
Declared In
SOSError.h
. SOSServerSessionCreationError
-
Error returned when the session creation request is not successful.
Declared In
SOSError.h
. SOSAgentAvailabilityError
-
Error returned when agent availability API encounters a problem.
Declared In
SOSError.h
. SOSSwitchServerSessionDisconnectError
-
Error occured when attempting to disconnect a session after a switch server occurred.
Declared In
SOSError.h
. SOSServerSessionEndError
-
Error returned when the session end request is not successful.
Declared In
SOSError.h
. SOSCommunicationError
-
Standard communication error. This can be returned from operations dependent on communication between SOS or any other remote system.
Declared In
SOSError.h
. SOSNoAgentsAvailableError
-
Returned by the framework if there are no agents available to serve a session attempt.
Declared In
SOSError.h
. SOSNetworkTestError
-
Returned by the framework if the network test has failed to start.
Declared In
SOSError.h
. SOSInsufficientNetworkError
-
Returned by the framework if the network test has determined that the environment cannot support an SOS session.
Declared In
SOSError.h
. SOSInternalError
-
Standard internal framework error. This can be returned from operations performed within the SOS framework.
Declared In
SOSError.h
. SOSRTCProviderError
-
Standard RTC Provider error. This can be returned as a result of operations performed by the RTC provider.
Declared In
SOSError.h
. SOSRTCProviderAuthenticationError
-
Error returned if there is a problem creating an authentication token with the WebRTC provider.
Declared In
SOSError.h
.
Declared In
SOSError.h