Class CancelInteraction
Hierarchy
java.lang.Object
com.smartdevicelink.proxy.RPCStruct
com.smartdevicelink.proxy.RPCMessage
com.smartdevicelink.proxy.RPCRequest
- Package
- com.smartdevicelink.proxy.rpc
Quick Jump
- Fields
- Constructors
- Methods
Fields
KEY_CANCEL_ID
public static final java.lang.String KEY_CANCEL_ID
- Constant Value
- "cancelID"
KEY_FUNCTION_ID
public static final java.lang.String KEY_FUNCTION_ID
- Constant Value
- "functionID"
Inherited Fields
Constructors
CancelInteraction()
Constructs a new CancelInteraction object
public CancelInteraction()
CancelInteraction( java.util.Hashtable<java.lang.String, java.lang.Object> hash )
Constructs a new CancelInteraction object indicated by the Hashtable parameter
public CancelInteraction(java.util.Hashtable<java.lang.String, java.lang.Object> hash)
Constructor Parameters
- hash
- The Hashtable to use
CancelInteraction( Integer functionID )
Convenience init for dismissing an interaction type.
public CancelInteraction(Integer functionID)
Constructor Parameters
- functionID
- - The ID of the type of interaction to dismiss
CancelInteraction( Integer functionID, Integer cancelID )
Convenience init for dismissing a specific interaction.
public CancelInteraction(Integer functionID,Integer cancelID)
Constructor Parameters
- functionID
- - The ID of the type of interaction to dismiss
- cancelID
- - The ID of the specific interaction to dismiss
Methods
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.
public java.lang.Integer getInteractionFunctionID()
setInteractionFunctionID( 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.
public com.smartdevicelink.proxy.rpc.CancelInteraction setInteractionFunctionID(Integer functionID)
Method Parameters
- functionID
- - the functionID
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.
public java.lang.Integer getCancelID()
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.
public com.smartdevicelink.proxy.rpc.CancelInteraction setCancelID(Integer cancelID)
Method Parameters
- cancelID
- - the cancelID
Inherited Methods
| From Class | Methods |
|---|---|
| com.smartdevicelink.proxy.RPCRequest | getCorrelationID, setCorrelationID, setOnRPCResponseListener, getOnRPCResponseListener |
| com.smartdevicelink.proxy.RPCMessage | getFunctionID, getFunctionName, setFunctionName, getMessageType, setParameters, getParameters, getObject, getString, getInteger, getFloat, getDouble, getBoolean, getLong |
| com.smartdevicelink.proxy.RPCStruct | getStoreValue, getStore, deserializeJSON, serializeJSON, serializeJSON, format, getBulkData, setBulkData, setPayloadProtected, isPayloadProtected, getMessageTypeName, hasKey, setValue, getValue, getObject, formatObject, getValueForString, getString, getInteger, getDouble, getFloat, getBoolean, getLong, clone, equals, hashCode |
| java.lang.Object | getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize |