OnSystemRequest Class Reference
Constructors
Instance Methods
- getFileType() ⇒
FileType - getLength() ⇒
Number - getOffset() ⇒
Number - getRequestSubType() ⇒
String - getRequestType() ⇒
RequestType - getTimeout() ⇒
Number - getUrl() ⇒
String - setFileType(type) ⇒
OnSystemRequest - setLength(length) ⇒
OnSystemRequest - setOffset(offset) ⇒
OnSystemRequest - setRequestSubType(type) ⇒
OnSystemRequest - setRequestType(type) ⇒
OnSystemRequest - setTimeout(timeout) ⇒
OnSystemRequest - setUrl(url) ⇒
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.
| Param | Type | Description |
|---|---|---|
| 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.
| Param | Type | Description |
|---|---|---|
| length | Number |
Optional length in bytes for resuming partial data chunks - The desired Length. {'num_min_value': 0, 'num_max_value': 100000000000} |
onSystemRequest.setOffset(offset) ⇒ OnSystemRequest
Set the Offset
Kind: Instance method of OnSystemRequest
Returns: OnSystemRequest - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| offset | Number |
Optional offset in bytes for resuming partial data chunks - The desired Offset. {'num_min_value': 0, 'num_max_value': 100000000000} |
onSystemRequest.setRequestSubType(type) ⇒ OnSystemRequest
Set the RequestSubType
Kind: Instance method of OnSystemRequest
Returns: OnSystemRequest - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| type | String |
This parameter is filled for supporting OEM proprietary data exchanges. - The desired RequestSubType. {'string_min_length': 1, 'string_max_length': 255} |
onSystemRequest.setRequestType(type) ⇒ OnSystemRequest
Set the RequestType
Kind: Instance method of OnSystemRequest
Returns: OnSystemRequest - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| 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.
| Param | Type | Description |
|---|---|---|
| timeout | Number |
Optional timeout for HTTP requests Required if a URL is provided - The desired Timeout. {'num_min_value': 0, 'num_max_value': 2000000000} |
onSystemRequest.setUrl(url) ⇒ OnSystemRequest
Set the Url
Kind: Instance method of OnSystemRequest
Returns: OnSystemRequest - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| url | String |
Optional URL for HTTP requests. If blank, the binary data shall be forwarded to the app. If not blank, the binary data shall be forwarded to the url with a provided timeout in seconds. - The desired Url. {'string_min_length': 1} |