GetFileResponse Class Reference
Constructors
Instance Methods
- getCrc() ⇒
Number - getFileType() ⇒
FileType - getLength() ⇒
Number - getOffset() ⇒
Number - setCrc(crc) ⇒
GetFileResponse - setFileType(type) ⇒
GetFileResponse - setLength(length) ⇒
GetFileResponse - setOffset(offset) ⇒
GetFileResponse
Instance Methods
getFileResponse.getCrc() ⇒ Number
Get the Crc
Kind: Instance method of GetFileResponse
Returns: Number - the KEY_CRC value
getFileResponse.getFileType() ⇒ FileType
Get the FileType
Kind: Instance method of GetFileResponse
Returns: FileType - the KEY_FILE_TYPE value
getFileResponse.getLength() ⇒ Number
Get the Length
Kind: Instance method of GetFileResponse
Returns: Number - the KEY_LENGTH value
getFileResponse.getOffset() ⇒ Number
Get the Offset
Kind: Instance method of GetFileResponse
Returns: Number - the KEY_OFFSET value
getFileResponse.setCrc(crc) ⇒ GetFileResponse
Set the Crc
Kind: Instance method of GetFileResponse
Returns: GetFileResponse - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| crc | Number |
Additional CRC32 checksum to protect data integrity up to 512 Mbits - The desired Crc. {'num_min_value': 0, 'num_max_value': 4294967295} |
getFileResponse.setFileType(type) ⇒ GetFileResponse
Set the FileType
Kind: Instance method of GetFileResponse
Returns: GetFileResponse - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| type | FileType |
File type that is being sent in response. - The desired FileType. |
getFileResponse.setLength(length) ⇒ GetFileResponse
Set the Length
Kind: Instance method of GetFileResponse
Returns: GetFileResponse - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| length | Number |
Optional length in bytes for resuming partial data chunks if offset is set to 0, then length is the total length of the file to be downloaded - The desired Length. {'num_min_value': 0, 'num_max_value': 2000000000} |
getFileResponse.setOffset(offset) ⇒ GetFileResponse
Set the Offset
Kind: Instance method of GetFileResponse
Returns: GetFileResponse - 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': 2000000000} |