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

OnSystemRequest Class Reference

Constructors

Instance Methods

Constructors

new OnSystemRequest(parameters)

Initalizes an instance of OnSystemRequest.

Instance Methods

onSystemRequest.getFileType() ⇒ FileType

Get the FileType

Kind: Instance method of OnSystemRequest
Returns: FileType - the KEY_FILE_TYPE value

onSystemRequest.getLength() ⇒ Number

Get the Length

Kind: Instance method of OnSystemRequest
Returns: Number - the KEY_LENGTH value

onSystemRequest.getOffset() ⇒ Number

Get the Offset

Kind: Instance method of OnSystemRequest
Returns: Number - the KEY_OFFSET value

onSystemRequest.getRequestSubType() ⇒ String

Get the RequestSubType

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

onSystemRequest.getRequestType() ⇒ RequestType

Get the RequestType

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

onSystemRequest.getTimeout() ⇒ Number

Get the Timeout

Kind: Instance method of OnSystemRequest
Returns: Number - the KEY_TIMEOUT value

onSystemRequest.getUrl() ⇒ String

Get the Url

Kind: Instance method of OnSystemRequest
Returns: String - the KEY_URL value

onSystemRequest.setFileType(type) ⇒ OnSystemRequest

Set the FileType

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

ParamTypeDescription
type FileType Optional file type (meant for HTTP file requests). - The desired FileType.

onSystemRequest.setLength(length) ⇒ OnSystemRequest

Set the Length

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

ParamTypeDescription
length Number Optional length in bytes for resuming partial data chunks - The desired Length.

onSystemRequest.setOffset(offset) ⇒ OnSystemRequest

Set the Offset

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

ParamTypeDescription
offset Number Optional offset in bytes for resuming partial data chunks - The desired Offset.

onSystemRequest.setRequestSubType(type) ⇒ OnSystemRequest

Set the RequestSubType

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

ParamTypeDescription
type String This parameter is filled for supporting OEM proprietary data exchanges. - The desired RequestSubType.

onSystemRequest.setRequestType(type) ⇒ OnSystemRequest

Set the RequestType

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

ParamTypeDescription
type RequestType The type of system request. - The desired RequestType.

onSystemRequest.setTimeout(timeout) ⇒ OnSystemRequest

Set the Timeout

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

ParamTypeDescription
timeout Number Optional timeout for HTTP requests Required if a URL is provided - The desired Timeout.

onSystemRequest.setUrl(url) ⇒ OnSystemRequest

Set the Url

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

ParamTypeDescription
url String Optional URL for HTTP requests. If blank, the binary data shall be forwarded to the app. If - The desired Url. not blank, the binary data shall be forwarded to the url with a provided timeout in seconds.
View on GitHub.com
Previous Section Next Section