com.smartdevicelink.proxy.rpc

Class GetAppServiceData

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.RPCMessage

com.smartdevicelink.proxy.RPCRequest

com.smartdevicelink.proxy.rpc.GetAppServiceData

All Implemented Interfaces:

Cloneable

public class GetAppServiceData
extends RPCRequest

This request asks the module for current data related to the specific service. It also includes an option to subscribe to that service for future updates

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_SERVICE_TYPE
static String	KEY_SUBSCRIBE

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
GetAppServiceData() Constructs a new GetAppServiceData object
GetAppServiceData(Hashtable<String,Object> hash) Constructs a new GetAppServiceData object indicated by the Hashtable parameter
GetAppServiceData(String appServiceType) Constructs a new GetAppServiceData object with the mandatory appServiceType parameter

Method Summary

Modifier and Type	Method and Description
String	getServiceType()
Boolean	getSubscribe() If true, the consumer is requesting to subscribe to all future updates from the service publisher.
GetAppServiceData	setServiceType(String appServiceType)
GetAppServiceData	setSubscribe(Boolean subscribe) If true, the consumer is requesting to subscribe to all future updates from the service publisher.

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_SERVICE_TYPE

public static final String KEY_SERVICE_TYPE

See Also:

Constant Field Values

KEY_SUBSCRIBE

public static final String KEY_SUBSCRIBE

See Also:

Constant Field Values

Constructor Detail

GetAppServiceData

public GetAppServiceData()

Constructs a new GetAppServiceData object

GetAppServiceData

public GetAppServiceData(Hashtable<String,Object> hash)

Constructs a new GetAppServiceData object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

GetAppServiceData

public GetAppServiceData(@NonNull
                         String appServiceType)

Constructs a new GetAppServiceData object with the mandatory appServiceType parameter

Parameters:

appServiceType - - The appServiceType

Method Detail

setServiceType

public GetAppServiceData setServiceType(@NonNull
                                        String appServiceType)

Parameters:

appServiceType - - the appServiceType

getServiceType

public String getServiceType()

Returns:

appServiceType

setSubscribe

public GetAppServiceData setSubscribe(Boolean subscribe)

If true, the consumer is requesting to subscribe to all future updates from the service publisher. If false, the consumer doesn't wish to subscribe and should be unsubscribed if it was previously subscribed.

Parameters:

subscribe - -

getSubscribe

public Boolean getSubscribe()

If true, the consumer is requesting to subscribe to all future updates from the service publisher. If false, the consumer doesn't wish to subscribe and should be unsubscribed if it was previously subscribed.

Returns:

subscribe