Skip to content

Commit

Permalink
[docs] Explain download progress event when no Content-Length speci…
Browse files Browse the repository at this point in the history
…fied (#7530)

* [docs] Explain download progress event when no `Content-Length` specified

* [docs] Add missing header explanation
  • Loading branch information
IjzerenHein committed Apr 6, 2020
1 parent bdcd7c2 commit 0be684a
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/pages/versions/unversioned/sdk/filesystem.md
Original file line number Diff line number Diff line change
Expand Up @@ -304,7 +304,7 @@ Create a `DownloadResumable` object which can start, pause, and resume a downloa
This function is called on each data write to update the download progress. An object with the following fields are passed:

- **totalBytesWritten (_number_)** -- The total bytes written by the download operation.
- **totalBytesExpectedToWrite (_number_)** -- The total bytes expected to be written by the download operation.
- **totalBytesExpectedToWrite (_number_)** -- The total bytes expected to be written by the download operation. A value of `-1` means that the server did not return the `Content-Length` header and the total size is unknown. Without this header, you won't be able to track the download progress.

- **resumeData (_string_)** -- The string which allows the api to resume a paused download. This is set on the `DownloadResumable` object automatically when a download is paused. When initializing a new `DownloadResumable` this should be `null`.

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/versions/v36.0.0/sdk/filesystem.md
Original file line number Diff line number Diff line change
Expand Up @@ -304,7 +304,7 @@ Create a `DownloadResumable` object which can start, pause, and resume a downloa
This function is called on each data write to update the download progress. An object with the following fields are passed:

- **totalBytesWritten (_number_)** -- The total bytes written by the download operation.
- **totalBytesExpectedToWrite (_number_)** -- The total bytes expected to be written by the download operation.
- **totalBytesExpectedToWrite (_number_)** -- The total bytes expected to be written by the download operation. A value of `-1` means that the server did not return the `Content-Length` header and the total size is unknown.

- **resumeData (_string_)** -- The string which allows the api to resume a paused download. This is set on the `DownloadResumable` object automatically when a download is paused. When initializing a new `DownloadResumable` this should be `null`.

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/versions/v37.0.0/sdk/filesystem.md
Original file line number Diff line number Diff line change
Expand Up @@ -304,7 +304,7 @@ Create a `DownloadResumable` object which can start, pause, and resume a downloa
This function is called on each data write to update the download progress. An object with the following fields are passed:

- **totalBytesWritten (_number_)** -- The total bytes written by the download operation.
- **totalBytesExpectedToWrite (_number_)** -- The total bytes expected to be written by the download operation.
- **totalBytesExpectedToWrite (_number_)** -- The total bytes expected to be written by the download operation. A value of `-1` means that the server did not return the `Content-Length` header and the total size is unknown. Without this header, you won't be able to track the download progress.

- **resumeData (_string_)** -- The string which allows the api to resume a paused download. This is set on the `DownloadResumable` object automatically when a download is paused. When initializing a new `DownloadResumable` this should be `null`.

Expand Down

0 comments on commit 0be684a

Please sign in to comment.