com.tealium.internal.tagbridge

Class RemoteCommand.Response

java.lang.Object

com.tealium.internal.tagbridge.RemoteCommand.Response

Enclosing class:

RemoteCommand

public static class RemoteCommand.Response
extends java.lang.Object

This class allows a RemoteCommand respond to a TagBridge request.

This class can only send a single response, if multiple responses are attempted an IllegalStateException will be thrown on any send and set operations.

Since:

2014-12-08

Field Summary

Fields

Modifier and Type	Field and Description
static int	STATUS_BAD_REQUEST Suggested value for setStatus(int) when getRequestPayload() does not provide the expected arguments.
static int	STATUS_OK Suggested value for setStatus(int) when the operation was performed successfully.

Constructor Summary

Constructors

Constructor and Description
Response(java.lang.String commandId, java.lang.String responseId, org.json.JSONObject requestPayload)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBody()
java.lang.String	getCommandId()
java.lang.String	getId()
org.json.JSONObject	getRequestPayload()
int	getStatus()
boolean	isSent()
void	send() Invokes the TagBridge callback.
RemoteCommand.Response	setBody(java.lang.String body)
RemoteCommand.Response	setStatus(int status)

Methods inherited from class java.lang.Object

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

Field Detail

STATUS_BAD_REQUEST

public static final int STATUS_BAD_REQUEST

Suggested value for setStatus(int) when getRequestPayload() does not provide the expected arguments.

See Also:

Constant Field Values

STATUS_OK

public static final int STATUS_OK

Suggested value for setStatus(int) when the operation was performed successfully.

This is the default value.

See Also:

Constant Field Values

Constructor Detail

Response

public Response(java.lang.String commandId,
                java.lang.String responseId,
                org.json.JSONObject requestPayload)

Parameters:

commandId - The TagBridge request command id.

responseId - A response id or null.

requestPayload - A parsed JSONObject of the TagBridge Request Payload or null. If null, an empty JSONObject is returned by getRequestPayload().

Throws:

java.lang.IllegalArgumentException - when mCommandId is null.

Method Detail

getCommandId

public final java.lang.String getCommandId()

Returns:

the command id of the TagBridge request, this will match the RemoteCommand instance's command name this object has been passed to.

getId

public final java.lang.String getId()

Returns:

the response_id if specified; otherwise, null.

isSent

public final boolean isSent()

Returns:

whether send() was called.

getRequestPayload

public final org.json.JSONObject getRequestPayload()

Returns:

the payload (arguments used to invoke the RemoteCommand) passed by the request; if there were none, an empty JSONObject is provided.

getStatus

public final int getStatus()

Returns:

the current status set by setStatus(int), STATUS_OK by default.

setStatus

public final RemoteCommand.Response setStatus(int status)

Parameters:

status - to be returned to the TagBridge callback, typically STATUS_OK or STATUS_BAD_REQUEST.

Returns:

this for method chaining.

Throws:

java.lang.IllegalStateException - when send() has already been called.

getBody

public final java.lang.String getBody()

Returns:

the currently set body, may be null.

setBody

public final RemoteCommand.Response setBody(java.lang.String body)

Parameters:

body - to be returned to the TagBridge callback, can be any string or null.

Returns:

this for method chaining.

Throws:

java.lang.IllegalStateException - when send() has already been called.

send

public void send()

Invokes the TagBridge callback.

The status and body as specified by setStatus(int) and setBody(String) are passed as the argument to the callback.

Throws:

java.lang.IllegalStateException - when multiple calls of this method are attempted.