com.smartdevicelink.proxy.rpc

Class PerformAppServiceInteraction

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.RPCMessage

com.smartdevicelink.proxy.RPCRequest

com.smartdevicelink.proxy.rpc.PerformAppServiceInteraction

All Implemented Interfaces:

Cloneable

public class PerformAppServiceInteraction
extends RPCRequest

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_ORIGIN_APP
static String	KEY_REQUEST_SERVICE_ACTIVE
static String	KEY_SERVICE_ID
static String	KEY_SERVICE_URI

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
PerformAppServiceInteraction()
PerformAppServiceInteraction(Hashtable<String,Object> hash)
PerformAppServiceInteraction(String serviceUri, String appServiceId, String originApp)

Method Summary

Modifier and Type	Method and Description
String	getOriginApp() This string is the appID of the app requesting the app service provider take the specific action.
Boolean	getRequestServiceActive() This string is the appID of the app requesting the app service provider take the specific action.
String	getServiceID() The service ID that the app consumer wishes to send this URI.
String	getServiceUri() Fully qualified URI based on a predetermined scheme provided by the app service.
PerformAppServiceInteraction	setOriginApp(String originApp) This string is the appID of the app requesting the app service provider take the specific action.
PerformAppServiceInteraction	setRequestServiceActive(Boolean requestServiceActive) This flag signals the requesting consumer would like this service to become the active primary service of the destination's type.
PerformAppServiceInteraction	setServiceID(String appServiceId) The service ID that the app consumer wishes to send this URI.
PerformAppServiceInteraction	setServiceUri(String serviceUri) Fully qualified URI based on a predetermined scheme provided by the app service.

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_URI

public static final String KEY_SERVICE_URI

See Also:

Constant Field Values

KEY_SERVICE_ID

public static final String KEY_SERVICE_ID

See Also:

Constant Field Values

KEY_ORIGIN_APP

public static final String KEY_ORIGIN_APP

See Also:

Constant Field Values

KEY_REQUEST_SERVICE_ACTIVE

public static final String KEY_REQUEST_SERVICE_ACTIVE

See Also:

Constant Field Values

Constructor Detail

PerformAppServiceInteraction

public PerformAppServiceInteraction()

PerformAppServiceInteraction

public PerformAppServiceInteraction(Hashtable<String,Object> hash)

PerformAppServiceInteraction

public PerformAppServiceInteraction(@NonNull
                                    String serviceUri,
                                    @NonNull
                                    String appServiceId,
                                    @NonNull
                                    String originApp)

Method Detail

setServiceUri

public PerformAppServiceInteraction setServiceUri(@NonNull
                                                  String serviceUri)

Fully qualified URI based on a predetermined scheme provided by the app service. SDL makes no guarantee that this URI is correct.

Parameters:

serviceUri - -

getServiceUri

public String getServiceUri()

Fully qualified URI based on a predetermined scheme provided by the app service. SDL makes no guarantee that this URI is correct.

Returns:

serviceUri

setServiceID

public PerformAppServiceInteraction setServiceID(@NonNull
                                                 String appServiceId)

The service ID that the app consumer wishes to send this URI.

Parameters:

appServiceId - -

getServiceID

public String getServiceID()

The service ID that the app consumer wishes to send this URI.

Returns:

appServiceId

setOriginApp

public PerformAppServiceInteraction setOriginApp(@NonNull
                                                 String originApp)

This string is the appID of the app requesting the app service provider take the specific action.

Parameters:

originApp - -

getOriginApp

public String getOriginApp()

This string is the appID of the app requesting the app service provider take the specific action.

Returns:

originApp

setRequestServiceActive

public PerformAppServiceInteraction setRequestServiceActive(Boolean requestServiceActive)

This flag signals the requesting consumer would like this service to become the active primary service of the destination's type.

Parameters:

requestServiceActive - -

getRequestServiceActive

public Boolean getRequestServiceActive()

This string is the appID of the app requesting the app service provider take the specific action.

Returns:

requestServiceActive