com.adobe.cq.screens.device

Interface DeviceCommand

@ProviderType
public interface DeviceCommand

Screens device command

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCommand() Returns the message of the command.
JSONObject	getPayload() Returns the payload of the command or null if no payload specified.
boolean	isAcknowledged() Returns whether the command was acknowledged by the device or not.
boolean	isDelivered() Returns whether the command was delivered to the device or not.
boolean	requiresAck() Returns whether the command needs to be acknowledged by the device or not.

Method Detail

getCommand

@Nonnull
java.lang.String getCommand()

Returns the message of the command.

Returns:

the command message

getPayload

@Nullable
JSONObject getPayload()

Returns the payload of the command or null if no payload specified.

Returns:

the payload of the command or null if no payload

requiresAck

boolean requiresAck()

Returns whether the command needs to be acknowledged by the device or not.

Returns:

true if the command needs to be acknowledged

isAcknowledged

boolean isAcknowledged()

Returns whether the command was acknowledged by the device or not.

Returns:

true if the command was acknowledged

isDelivered

boolean isDelivered()

Returns whether the command was delivered to the device or not.

Returns:

true if the command was delivered