com.smartdevicelink.proxy.rpc

Class ResetGlobalProperties

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.RPCMessage

com.smartdevicelink.proxy.RPCRequest

com.smartdevicelink.proxy.rpc.ResetGlobalProperties

All Implemented Interfaces:

Cloneable

public class ResetGlobalProperties
extends RPCRequest

Resets the passed global properties to their default values as defined by SDL

The HELPPROMPT global property default value is generated by SDL consists of the first vrCommand of each Command Menu item defined at the moment PTT is pressed

The TIMEOUTPROMPT global property default value is the same as the HELPPROMPT global property default value

HMILevel needs to be FULL, LIMITED or BACKGROUND

Parameter List

Param Name	Type	Description	Req.	Notes	Version Available
properties	GlobalProperty	An array of one or more GlobalProperty enumeration elements indicating which global properties to reset to their default value.	Y	Array must have at least one element.; minsize:1; maxsize:100	SmartDeviceLink 1.0

Response

Indicates whether the Global Properties were successfully set to their default values.

Non-default Result Codes:

SUCCESS

INVALID_DATA

OUT_OF_MEMORY

TOO_MANY_PENDING_REQUESTS

APPLICATION_NOT_REGISTERED

GENERIC_ERROR

REJECTED

DISALLOWED

Since:

SmartDeviceLink 1.0

See Also:

SetGlobalProperties

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_PROPERTIES

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
ResetGlobalProperties() Constructs a new ResetGlobalProperties object
ResetGlobalProperties(Hashtable<String,Object> hash) Constructs a new ResetGlobalProperties object indicated by the Hashtable parameter
ResetGlobalProperties(List<GlobalProperty> properties) Constructs a new ResetGlobalProperties object

Method Summary

Modifier and Type	Method and Description
List<GlobalProperty>	getProperties() Gets an array of one or more GlobalProperty enumeration elements indicating which global properties to reset to their default value
ResetGlobalProperties	setProperties(List<GlobalProperty> properties) Sets an array of one or more GlobalProperty enumeration elements indicating which global properties to reset to their default value

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_PROPERTIES

public static final String KEY_PROPERTIES

See Also:

Constant Field Values

Constructor Detail

ResetGlobalProperties

public ResetGlobalProperties()

Constructs a new ResetGlobalProperties object

ResetGlobalProperties

public ResetGlobalProperties(Hashtable<String,Object> hash)

Constructs a new ResetGlobalProperties object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

ResetGlobalProperties

public ResetGlobalProperties(@NonNull
                             List<GlobalProperty> properties)

Constructs a new ResetGlobalProperties object

Parameters:

properties - a List An array of one or more GlobalProperty enumeration elements indicating which global properties to reset to their default value
Notes: Array must have at least one element

Method Detail

getProperties

public List<GlobalProperty> getProperties()

Gets an array of one or more GlobalProperty enumeration elements indicating which global properties to reset to their default value

Returns:

List -an array of one or more GlobalProperty enumeration elements

setProperties

public ResetGlobalProperties setProperties(@NonNull
                                           List<GlobalProperty> properties)

Sets an array of one or more GlobalProperty enumeration elements indicating which global properties to reset to their default value

Parameters:

properties - a List An array of one or more GlobalProperty enumeration elements indicating which global properties to reset to their default value

Notes: Array must have at least one element