com.tealium.internal.tagbridge

Class RemoteCommand

java.lang.Object

com.tealium.internal.tagbridge.RemoteCommand

public abstract class RemoteCommand
extends java.lang.Object

A RemoteCommand is a code block that can be invoked by Tealium's TagBridge. These RemoteCommands are added using Tealium.addRemoteCommand(RemoteCommand).

Since:

2014-09-30

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RemoteCommand.Response This class allows a RemoteCommand respond to a TagBridge request.

Constructor Summary

Constructors

Constructor and Description
RemoteCommand(java.lang.String commandId, java.lang.String description) Remote command constructor.

Method Summary

Modifier and Type	Method and Description
protected abstract void	onInvoke(RemoteCommand.Response remoteCommandResponse) Execution block for the TagBridge command.

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteCommand

public RemoteCommand(java.lang.String commandId,
                     java.lang.String description)

Remote command constructor. The command name-mDescription pair are made visible in both Mobile Companion and in LogCat.

Parameters:

commandId - a URL domain name compliant command id to be called from TagBridge. This will be lower-cased.

description - a brief explanation of the purpose behind the remote command to be viewed in LogCat and Mobile Companion.

Throws:

java.lang.IllegalArgumentException - When mCommandId is null or mCommandId does not match the Regex "^[\w-]*$".

Method Detail

onInvoke

protected abstract void onInvoke(RemoteCommand.Response remoteCommandResponse)
                          throws java.lang.Exception

Execution block for the TagBridge command.

This method will need to call RemoteCommand.Response.send() for the TealiumIQ callback can be invoked. If an exception is thrown inside of this implementation, the library will perform the callback, so please only call send() on completion.

Parameters:

remoteCommandResponse - a RemoteCommand.Response object. It's methods possess request arguments and response capabilities.

Throws:

java.lang.Throwable - the library will call RemoteCommand.Response.send() with a status of 555 and provide a stack-trace as the body.

java.lang.Exception