OnEncodedSyncPData Class Reference
Constructors
Instance Methods
- getData() ⇒
Array.<String> - getTimeout() ⇒
Number - getURL() ⇒
String - setData(data) ⇒
OnEncodedSyncPData - setTimeout(timeout) ⇒
OnEncodedSyncPData - setURL(url) ⇒
OnEncodedSyncPData
Instance Methods
onEncodedSyncPData.getData() ⇒ Array.<String>
Get the Data
Kind: Instance method of OnEncodedSyncPData
Returns: Array.<String> - the KEY_DATA value
onEncodedSyncPData.getTimeout() ⇒ Number
Get the Timeout
Kind: Instance method of OnEncodedSyncPData
Returns: Number - the KEY_TIMEOUT value
onEncodedSyncPData.getURL() ⇒ String
Get the URL
Kind: Instance method of OnEncodedSyncPData
Returns: String - the KEY_URL value
onEncodedSyncPData.setData(data) ⇒ OnEncodedSyncPData
Set the Data
Kind: Instance method of OnEncodedSyncPData
Returns: OnEncodedSyncPData - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| data | Array.<String> |
Contains base64 encoded string of SyncP packets. - The desired Data. {'array_min_size': 1, 'array_max_size': 100, 'string_min_length': 1, 'string_max_length': 1000000} |
onEncodedSyncPData.setTimeout(timeout) ⇒ OnEncodedSyncPData
Set the Timeout
Kind: Instance method of OnEncodedSyncPData
Returns: OnEncodedSyncPData - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| timeout | Number |
If blank, the SyncP data shall be forwarded to the app. If not blank, the SyncP data shall be forwarded with the provided timeout in seconds. - The desired Timeout. {'num_min_value': 0, 'num_max_value': 2000000000} |
onEncodedSyncPData.setURL(url) ⇒ OnEncodedSyncPData
Set the URL
Kind: Instance method of OnEncodedSyncPData
Returns: OnEncodedSyncPData - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| url | String |
If blank, the SyncP data shall be forwarded to the app. If not blank, the SyncP data shall be forwarded to the provided URL. - The desired URL. {'string_min_length': 1, 'string_max_length': 1000} |