Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Documentation
Sidebar

Class CancelInteraction

Hierarchy

java.lang.Object
     com.smartdevicelink.proxy.RPCStruct
         com.smartdevicelink.proxy.RPCMessage
             com.smartdevicelink.proxy.RPCRequest

Package
com.smartdevicelink.proxy.rpc

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

From Class Fields
com.smartdevicelink.proxy.RPCRequest onResponseListener
com.smartdevicelink.proxy.RPCMessage KEY_REQUEST, KEY_RESPONSE, KEY_NOTIFICATION, KEY_FUNCTION_NAME, KEY_PARAMETERS, KEY_CORRELATION_ID, messageType, parameters, function
com.smartdevicelink.proxy.RPCStruct KEY_BULK_DATA, KEY_PROTECTED, store

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)

Parameters

hash
The Hashtable to use

CancelInteraction( Integer functionID )

Convenience init for dismissing an interaction type.

public CancelInteraction(Integer functionID)

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)

Parameters

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

Methods

getInteractionFunctionID()

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

public java.lang.Integer getInteractionFunctionID()

setInteractionFunctionID( Integer functionID )

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

public void setInteractionFunctionID(Integer functionID)

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 void setCancelID(Integer cancelID)

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, deserializeJSONObject, serializeJSON, serializeJSON, format, getBulkData, setBulkData, setPayloadProtected, isPayloadProtected, getMessageTypeName, hasKey, setValue, getValue, getObject, formatObject, getValueForString, getString, getInteger, getDouble, getFloat, getBoolean, getLong
java.lang.Object getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize
View on GitHub.com
Previous Section Next Section