com.smartdevicelink.proxy.rpc

Class OnTBTClientState

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.RPCMessage

com.smartdevicelink.proxy.RPCNotification

com.smartdevicelink.proxy.rpc.OnTBTClientState

All Implemented Interfaces:

Cloneable

public class OnTBTClientState
extends RPCNotification

Notifies the application of the current TBT client status on the module.

HMI Status Requirements:

HMILevel:
• Can be sent with FULL, LIMITED or BACKGROUND
AudioStreamingState:
• Any
SystemContext:
• Any

Parameter List:

Name	Type	Description	SmartDeviceLink Ver Available
state	TBTState	Current state of TBT client.	SmartDeviceLink 1.0

Since:

SmartDeviceLink 1.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_STATE

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
OnTBTClientState() Constructs a newly allocated OnTBTClientState object
OnTBTClientState(Hashtable<String,Object> hash) Constructs a newly allocated OnTBTClientState object indicated by the Hashtable parameter
OnTBTClientState(TBTState state) Constructs a newly allocated OnTBTClientState object

Method Summary

Modifier and Type	Method and Description
TBTState	getState() Called to get the current state of TBT client
OnTBTClientState	setState(TBTState state) Called to set the current state of TBT client

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_STATE

public static final String KEY_STATE

See Also:

Constant Field Values

Constructor Detail

OnTBTClientState

public OnTBTClientState()

Constructs a newly allocated OnTBTClientState object

OnTBTClientState

public OnTBTClientState(Hashtable<String,Object> hash)

Constructs a newly allocated OnTBTClientState object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

OnTBTClientState

public OnTBTClientState(@NonNull
                        TBTState state)

Constructs a newly allocated OnTBTClientState object

Parameters:

state - current state of TBT client

Method Detail

getState

public TBTState getState()

Called to get the current state of TBT client

Returns:

TBTState the current state of TBT client

setState

public OnTBTClientState setState(TBTState state)

Called to set the current state of TBT client

Parameters:

state - current state of TBT client