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

Class ResetGlobalProperties

Hierarchy

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

Package
com.smartdevicelink.proxy.rpc

Overview

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

Fields

KEY_PROPERTIES

public static final java.lang.String KEY_PROPERTIES
Constant Value
"properties"

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

ResetGlobalProperties()

Constructs a new ResetGlobalProperties object

public ResetGlobalProperties()

ResetGlobalProperties( java.util.Hashtable<java.lang.String, java.lang.Object> hash )

Constructs a new ResetGlobalProperties object indicated by the Hashtable parameter

public ResetGlobalProperties(java.util.Hashtable<java.lang.String, java.lang.Object> hash)

Parameters

hash
The Hashtable to use

ResetGlobalProperties( java.util.List<com.smartdevicelink.proxy.rpc.enums.GlobalProperty> properties )

Constructs a new ResetGlobalProperties object

public ResetGlobalProperties(java.util.List<com.smartdevicelink.proxy.rpc.enums.GlobalProperty> properties)

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

Methods

getProperties()

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

public java.util.List getProperties()

setProperties( java.util.List<com.smartdevicelink.proxy.rpc.enums.GlobalProperty> properties )

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

public void setProperties(java.util.List<com.smartdevicelink.proxy.rpc.enums.GlobalProperty> properties)

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

Inherited Methods

From Class Methods
com.smartdevicelink.proxy.RPCRequest getCorrelationID, setCorrelationID, setOnRPCResponseListener, getOnRPCResponseListener
com.smartdevicelink.proxy.RPCMessage 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