com.nexmo.client.request_listener

Class NexmoApiError

java.lang.Object

com.nexmo.client.request_listener.NexmoApiError

public class NexmoApiError
extends java.lang.Object

Nexmo API exception that can be caught and handled.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NexmoApiError(java.lang.String type, java.lang.String message, java.lang.String tid, java.lang.String conversationId)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
static NexmoApiError	fromCoreError(CoreConversationApiError error) Converts CoreConversationApiError to NexmoApiError
java.lang.String	getConversationId() Optional conversation id associated with the request.
java.lang.String	getMessage() Human readable description of the exception.
java.lang.String	getTid() Optional request id for which the error occurred, null if the request was pre-validated client side.
java.lang.String	getType() The error type as received from backend, for example "text:error-not-joined"
int	hashCode()
static NexmoApiError	missingParams(java.lang.String message) Produces NexmoApiError

Methods inherited from class java.lang.Object

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

Constructor Detail

NexmoApiError

protected NexmoApiError(java.lang.String type,
                        java.lang.String message,
                        java.lang.String tid,
                        java.lang.String conversationId)

Method Detail

fromCoreError

public static NexmoApiError fromCoreError(CoreConversationApiError error)

Converts CoreConversationApiError to NexmoApiError

Parameters:

error - error to be converted.

Returns:

converted error.

missingParams

public static NexmoApiError missingParams(java.lang.String message)

Produces NexmoApiError

Parameters:

message - Error message.

Returns:

Nexmo API error with missing params type.

getTid

public java.lang.String getTid()

Optional request id for which the error occurred, null if the request was pre-validated client side.

getConversationId

public java.lang.String getConversationId()

Optional conversation id associated with the request.

getType

public java.lang.String getType()

The error type as received from backend, for example "text:error-not-joined"

getMessage

public java.lang.String getMessage()

Human readable description of the exception. If not present, only type will be used.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object