OpentokError

public class OpentokError

Defines errors thrown by the OpenTok Android SDK.

Check the values returned by getErrorCode() and getMessage() for details on the error.

Nested types: OpentokError.ErrorCode, OpentokError.Domain

Properties

Name Type Description
errorDomain OpentokError.Domain protected
errorCode OpentokError.ErrorCode protected
errorMessage String protected
exception Exception protected

Methods

Name Description
OpentokError(errorDomain, errorCode, msg) Builds an OpentokError based on its domain, error code and message.
OpentokError(errorDomain, errorCode, exception) Builds an OpentokError based on its domain, error code and message.
getErrorCode() → {OpentokError.ErrorCode} Returns the error code.
getErrorDomain() → {OpentokError.Domain} Returns the error domain.
getException() → {Exception}
getMessage() → {String}

OpentokError(errorDomain, errorCode, msg)

Builds an OpentokError based on its domain, error code and message.

Parameters:
Name Type Description
errorDomain OpentokError.Domain
errorCode int
msg String

OpentokError(errorDomain, errorCode, exception)

Builds an OpentokError based on its domain, error code and message.

Parameters:
Name Type Description
errorDomain OpentokError.Domain
errorCode int
exception Exception

getErrorCode() → {OpentokError.ErrorCode}

Returns the error code. Values for the error code are defined by the ErrorCode enum.

Call the getMessage() method to get more details on the error.

Returns:

OpentokError.ErrorCode

getErrorDomain() → {OpentokError.Domain}

Returns the error domain. Values for the error domain are defined by the Domain enum.

Returns:

OpentokError.Domain

getException() → {Exception}

Returns:

Exception

getMessage() → {String}

Returns:

String