Package version
Creates an instance of FileDownloadResponse.
Indicates that the service supports requests for partial file content.
Returnes if it was previously specified for the file.
The response body as a browser Blob. Always undefined in node.js.
Returns the value that was specified for the 'x-ms-content-disposition' header and specifies how to process the response.
Returns the value that was specified for the Content-Encoding request header.
Returns the value that was specified for the Content-Language request header.
The number of bytes present in the response body.
If the file has an MD5 hash and the request is to read the full file, this response header is returned so that the client can check for message content integrity. If the request is to read a specified range and the 'x-ms-range-get-content-md5' is set to true, then the request returns an MD5 hash for the range, as long as the range size is less than or equal to 4 MB. If neither of these sets of conditions is true, then no value is returned for the 'Content-MD5' header.
Indicates the range of bytes returned if the client requested a subset of the file by setting the Range request header.
The content type specified for the file. The default content type is 'application/octet-stream'
Conclusion time of the last attempted Copy File operation where this file was the destination file. This value can specify the time of a completed, aborted, or failed copy attempt.
String identifier for the last attempted Copy File operation where this file was the destination file.
Contains the number of bytes copied and the total bytes in the source in the last attempted Copy File operation where this file was the destination file. Can show between 0 and Content-Length bytes copied.
URL up to 2KB in length that specifies the source file used in the last attempted Copy File operation where this file was the destination file.
State of the copy operation identified by 'x-ms-copy-id'. Possible values include: 'pending', 'success', 'aborted', 'failed'
Only appears when x-ms-copy-status is failed or pending. Describes cause of fatal or non-fatal copy operation failure.
A UTC date/time value generated by the service that indicates the time at which the response was initiated.
The ETag contains a value that you can use to perform operations conditionally, in quotes.
Attributes set for the file.
Change time for the file.
If the file has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the whole file's MD5 value. This value may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the requested range.
Creation time for the file.
The fileId of the file.
Last write time for the file.
The parent fileId of the file.
Key of the permission set for the file.
The value of this header is set to true if the file data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the file is unencrypted, or if only parts of the file/application metadata are encrypted).
Returns the date and time the file was last modified. Any operation that modifies the file or its properties updates the last modified time.
When a file is leased, specifies whether the lease is of infinite or fixed duration. Possible values include: 'infinite', 'fixed'
Lease state of the file. Possible values include: 'available', 'leased', 'expired', 'breaking', 'broken'
The current lease status of the file. Possible values include: 'locked', 'unlocked'
A name-value pair to associate with a file storage object.
The response body as a node.js Readable stream. Always undefined in the browser.
It will automatically retry when internal read stream unexpected ends.
This header uniquely identifies the request that was made and can be used for troubleshooting the request.
Indicates the version of the File service used to execute the request.
Generated using TypeDoc
Contains response data for the download operation. ONLY AVAILABLE IN NODE.JS RUNTIME.
FileDownloadResponse implements the
FileDownloadResponseModelinterface, and in a Node.js runtime it will automatically retry when its internal read stream unexpectedly ends. (This kind of unexpected end cannot trigger retries defined in the pipeline retry policy.)The readableStreamBody stream will retry beneath the
ReadableStreamlayer, so you can just use it as a normal Node.js Readable stream.{FileDownloadResponseModel}