GetFile Class Reference
Constructors
Instance Methods
- getAppServiceId() ⇒
String - getFileName() ⇒
String - getFileType() ⇒
FileType - getLength() ⇒
Number - getOffset() ⇒
Number - setAppServiceId(id) ⇒
GetFile - setFileName(name) ⇒
GetFile - setFileType(type) ⇒
GetFile - setLength(length) ⇒
GetFile - setOffset(offset) ⇒
GetFile
Instance Methods
getFile.getAppServiceId() ⇒ String
Get the AppServiceId
Kind: Instance method of GetFile
Returns: String - the KEY_APP_SERVICE_ID value
getFile.getFileName() ⇒ String
Get the FileName
Kind: Instance method of GetFile
Returns: String - the KEY_FILE_NAME value
getFile.getFileType() ⇒ FileType
Get the FileType
Kind: Instance method of GetFile
Returns: FileType - the KEY_FILE_TYPE value
getFile.getLength() ⇒ Number
Get the Length
Kind: Instance method of GetFile
Returns: Number - the KEY_LENGTH value
getFile.getOffset() ⇒ Number
Get the Offset
Kind: Instance method of GetFile
Returns: Number - the KEY_OFFSET value
getFile.setAppServiceId(id) ⇒ GetFile
Set the AppServiceId
Kind: Instance method of GetFile
Returns: GetFile - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| id | String |
ID of the service that should have uploaded the requested file. - The desired AppServiceId. {'string_min_length': 1} |
getFile.setFileName(name) ⇒ GetFile
Set the FileName
Kind: Instance method of GetFile
Returns: GetFile - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| name | String |
File name that should be retrieved - The desired FileName. {'string_min_length': 1, 'string_max_length': 255} |
getFile.setFileType(type) ⇒ GetFile
Set the FileType
Kind: Instance method of GetFile
Returns: GetFile - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| type | FileType |
Selected file type. - The desired FileType. |
getFile.setLength(length) ⇒ GetFile
Set the Length
Kind: Instance method of GetFile
Returns: GetFile - 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 retrieved - The desired Length. {'num_min_value': 0, 'num_max_value': 2000000000} |
getFile.setOffset(offset) ⇒ GetFile
Set the Offset
Kind: Instance method of GetFile
Returns: GetFile - 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} |