com.mixer.interactive.protocol

Class InteractiveError

java.lang.Object

com.mixer.interactive.protocol.InteractiveError

public class InteractiveError
extends Object

A InteractiveError represents the error object that could be returned as part of a ReplyPacket. In the event an error is returned, a InteractiveReplyWithErrorException is thrown, which will contain this object.

Since:

1.0.0

Author:

Microsoft Corporation

See Also:

InteractiveReplyWithErrorException

Constructor Summary

Constructors

Constructor and Description
InteractiveError(int code, String message, String path) Initializes a new InteractiveError.

Method Summary

Modifier and Type	Method and Description
int	getErrorCode() Returns the Interactive service error code.
String	getErrorMessage() Returns the error message.
String	getPath() Returns the path to the property which caused the error.

Methods inherited from class java.lang.Object

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

Constructor Detail

InteractiveError

public InteractiveError(int code,
                        String message,
                        String path)

Initializes a new InteractiveError.

Parameters:

code - Interactive service error code

message - Error message

path - Path to the property which caused the error

Since:

1.0.0

Method Detail

getErrorCode

public int getErrorCode()

Returns the Interactive service error code. Refer to the Interactive 2.0 protocol specification for a list of all possible error codes the Interactive service may respond with.

Returns:

The Interactive service error code

Since:

1.0.0

getErrorMessage

public String getErrorMessage()

Returns the error message.

Returns:

The error message

Since:

1.0.0

getPath

public String getPath()

Returns the path to the property which caused the error. This will be expressed in dot notation relative to the reply params. This may return null if no path was provided by the Interactive service for this error.

Returns:

The path to the property which caused the error

Since:

1.0.0