Package io.agora.rtm

Class ErrorInfo

java.lang.Object

io.agora.rtm.ErrorInfo

public class ErrorInfo
extends Object

The warning or error code and description.

Constructor Summary

Constructors

Constructor	Description
ErrorInfo(RtmConstants.RtmErrorCode errorCode)	Constructs a new instance of RtmErrorCode with the specified errorCode.
ErrorInfo(RtmConstants.RtmErrorCode errorCode, String reason)	Constructs a new instance of RtmErrorCode with the specified errorCode and specified reason detail.
ErrorInfo(RtmConstants.RtmErrorCode errorCode, String reason, String operation)	Constructs a new instance of RtmErrorCode with the specified errorCode, specified reason detail and specified operation.

Method Summary

Modifier and Type	Method	Description
RtmConstants.RtmErrorCode	getErrorCode()	Retrieves the warning or error code.
String	getErrorReason()	Retrieves the warning or error reason.
String	getOperation()	Retrieves current operation.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

ErrorInfo

public ErrorInfo(RtmConstants.RtmErrorCode errorCode)

Constructs a new instance of RtmErrorCode with the specified errorCode.

Parameters:

errorCode - The error code of ErrorInfo(which is saved for later retrieval by the getErrorCode() method)

ErrorInfo

public ErrorInfo(RtmConstants.RtmErrorCode errorCode,
 String reason)

Constructs a new instance of RtmErrorCode with the specified errorCode and specified reason detail.

Parameters:

errorCode - The error code of ErrorInfo (which is saved for later retrieval by the getErrorCode() method)

reason - A string describing the reason for operation operation failure(which is saved for later retrieval by the getErrorReason() method)

ErrorInfo

public ErrorInfo(RtmConstants.RtmErrorCode errorCode,
 String reason,
 String operation)

Constructs a new instance of RtmErrorCode with the specified errorCode, specified reason detail and specified operation.

Parameters:

errorCode - The error code of ErrorInfo (which is saved for later retrieval by the getErrorCode() method)

reason - A string describing the reason for operation failure(which is saved for later retrieval by the getErrorReason() method)

operation - Current operation(which is saved for later retrieval by the getOperation() method)

Method Details

getErrorCode

public RtmConstants.RtmErrorCode getErrorCode()

Retrieves the warning or error code.

Returns:

The warning or error code. See RtmConstants.RtmErrorCode for a list of warning or error codes.

getErrorReason

public String getErrorReason()

Retrieves the warning or error reason.

Returns:

The warning or error reason. See RtmConstants.RtmErrorCode for a list of warning or error codes.

getOperation

public String getOperation()

Retrieves current operation.

Returns:

current operation.

toString

public String toString()

Overrides:

toString in class Object