com.smartdevicelink.proxy.rpc

Class CancelInteraction

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.RPCMessage

com.smartdevicelink.proxy.RPCRequest

com.smartdevicelink.proxy.rpc.CancelInteraction

All Implemented Interfaces:

Cloneable

public class CancelInteraction
extends RPCRequest

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_CANCEL_ID
static String	KEY_FUNCTION_ID

Fields inherited from class com.smartdevicelink.proxy.RPCRequest

onResponseListener

Fields inherited from class com.smartdevicelink.proxy.RPCMessage

function, KEY_CORRELATION_ID, KEY_FUNCTION_NAME, KEY_NOTIFICATION, KEY_PARAMETERS, KEY_REQUEST, KEY_RESPONSE, messageType, parameters

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
CancelInteraction() Constructs a new CancelInteraction object
CancelInteraction(Hashtable<String,Object> hash) Constructs a new CancelInteraction object indicated by the Hashtable parameter
CancelInteraction(Integer functionID) Convenience init for dismissing an interaction type.
CancelInteraction(Integer functionID, Integer cancelID) Convenience init for dismissing a specific interaction.

Method Summary

Modifier and Type	Method and Description
Integer	getCancelID() The ID of the specific interaction to dismiss.
Integer	getInteractionFunctionID() Gets the ID of the type of interaction the developer wants to dismiss.
CancelInteraction	setCancelID(Integer cancelID) The ID of the specific interaction to dismiss.
CancelInteraction	setInteractionFunctionID(Integer functionID) Sets the ID of the type of interaction the developer wants to dismiss.

Methods inherited from class com.smartdevicelink.proxy.RPCRequest

getCorrelationID, getOnRPCResponseListener, setCorrelationID, setOnRPCResponseListener

Methods inherited from class com.smartdevicelink.proxy.RPCMessage

getBoolean, getDouble, getFloat, getFunctionID, getFunctionName, getInteger, getLong, getMessageType, getObject, getParameters, getString, setFunctionName, setParameters

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

clone, deserializeJSON, equals, format, formatObject, getBulkData, getMessageTypeName, getStore, getStoreValue, getValue, getValueForString, hashCode, hasKey, isPayloadProtected, serializeJSON, serializeJSON, setBulkData, setPayloadProtected, setValue

Methods inherited from class java.lang.Object

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

Field Detail

KEY_CANCEL_ID

public static final String KEY_CANCEL_ID

See Also:

Constant Field Values

KEY_FUNCTION_ID

public static final String KEY_FUNCTION_ID

See Also:

Constant Field Values

Constructor Detail

CancelInteraction

public CancelInteraction()

Constructs a new CancelInteraction object

CancelInteraction

public CancelInteraction(Hashtable<String,Object> hash)

Constructs a new CancelInteraction object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

CancelInteraction

public CancelInteraction(@NonNull
                         Integer functionID)

Convenience init for dismissing an interaction type.

Parameters:

functionID - - The ID of the type of interaction to dismiss

CancelInteraction

public CancelInteraction(@NonNull
                         Integer functionID,
                         Integer cancelID)

Convenience init for dismissing a specific interaction.

Parameters:

functionID - - The ID of the type of interaction to dismiss

cancelID - - The ID of the specific interaction to dismiss

Method Detail

getInteractionFunctionID

public Integer getInteractionFunctionID()

Gets the ID of the type of interaction the developer wants to dismiss. Only values 10 (PerformInteractionID), 12 (AlertID), 25 (ScrollableMessageID), 26 (SliderID), and 64 (SubtleAlertID) are permitted.

Returns:

- the functionID

setInteractionFunctionID

public CancelInteraction setInteractionFunctionID(@NonNull
                                                  Integer functionID)

Sets the ID of the type of interaction the developer wants to dismiss. Only values 10 (PerformInteractionID), 12 (AlertID), 25 (ScrollableMessageID), 26 (SliderID), and 64 (SubtleAlertID) are permitted.

Parameters:

functionID - - the functionID

getCancelID

public Integer getCancelID()

The ID of the specific interaction to dismiss. If not set, the most recent of the RPC type set in functionID will be dismissed.

Returns:

- the cancelID

setCancelID

public CancelInteraction setCancelID(Integer cancelID)

The ID of the specific interaction to dismiss. If not set, the most recent of the RPC type set in functionID will be dismissed.

Parameters:

cancelID - - the cancelID