Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Internet Explorer alert
This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
close alert
Documentation
SystemRequest

SystemRequest Class Reference

Constructors

Instance Methods

Constructors

new SystemRequest(parameters)

Initalizes an instance of SystemRequest.

Instance Methods

systemRequest.getFileName() ⇒ String

Get the FileName

Kind: Instance method of SystemRequest
Returns: String - the KEY_FILE_NAME value

systemRequest.getRequestSubType() ⇒ String

Get the RequestSubType

Kind: Instance method of SystemRequest
Returns: String - the KEY_REQUEST_SUB_TYPE value

systemRequest.getRequestType() ⇒ RequestType

Get the RequestType

Kind: Instance method of SystemRequest
Returns: RequestType - the KEY_REQUEST_TYPE value

systemRequest.setFileName(name) ⇒ SystemRequest

Set the FileName

Kind: Instance method of SystemRequest
Returns: SystemRequest - The class instance for method chaining.

ParamTypeDescription
name String Filename of HTTP data to store in predefined system staging area. Mandatory if requestType is HTTP. PROPRIETARY requestType should ignore this parameter. - The desired FileName. {'string_min_length': 1, 'string_max_length': 255}

systemRequest.setRequestSubType(type) ⇒ SystemRequest

Set the RequestSubType

Kind: Instance method of SystemRequest
Returns: SystemRequest - The class instance for method chaining.

ParamTypeDescription
type String This parameter is filled for supporting OEM proprietary data exchanges. - The desired RequestSubType. {'string_min_length': 1, 'string_max_length': 255}

systemRequest.setRequestType(type) ⇒ SystemRequest

Set the RequestType

Kind: Instance method of SystemRequest
Returns: SystemRequest - The class instance for method chaining.

ParamTypeDescription
type RequestType The type of system request. Note that Proprietary requests should forward the binary data to the known proprietary module on the system. - The desired RequestType.
View on GitHub.com
Previous Section Next Section