Package com.opentok.android

Class OpentokError

java.lang.Object

com.opentok.android.OpentokError

public class OpentokError
extends java.lang.Object

Defines errors thrown by the OpenTok Android SDK.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpentokError.Domain	Defines error domains values for OpentokError objects.
static class	OpentokError.ErrorCode	Defines error code values for OpentokError objects.

Field Summary

Fields

Modifier and Type	Field	Description
protected OpentokError.ErrorCode	errorCode
protected OpentokError.Domain	errorDomain
protected java.lang.String	errorMessage
protected java.lang.Exception	exception

Constructor Summary

Constructors

Constructor	Description
OpentokError(OpentokError.Domain errorDomain, int errorCode, java.lang.Exception exception)	Builds an OpentokError based on its domain, error code and message.
OpentokError(OpentokError.Domain errorDomain, int errorCode, java.lang.String msg)	Builds an OpentokError based on its domain, error code and message.

Method Summary

Modifier and Type	Method	Description
OpentokError.ErrorCode	getErrorCode()	Returns the error code.
OpentokError.Domain	getErrorDomain()	Returns the error domain.
java.lang.Exception	getException()
java.lang.String	getMessage()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

errorDomain

protected OpentokError.Domain errorDomain

errorCode

protected OpentokError.ErrorCode errorCode

errorMessage

protected java.lang.String errorMessage

exception

protected java.lang.Exception exception

Constructor Detail

OpentokError

public OpentokError(OpentokError.Domain errorDomain,
                    int errorCode,
                    java.lang.String msg)

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

OpentokError

public OpentokError(OpentokError.Domain errorDomain,
                    int errorCode,
                    java.lang.Exception exception)

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

Method Detail

getErrorDomain

public OpentokError.Domain getErrorDomain()

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

getErrorCode

public OpentokError.ErrorCode getErrorCode()

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

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

getMessage

public java.lang.String getMessage()

getException

public java.lang.Exception getException()