ファイルのコンテンツをバイナリ形式で返します。
shared_link=[link]&shared_link_password=[password]
この項目の共有リンクのURL と省略可能なパスワード。
このヘッダーを使用すると、ユーザーと明示的に共有されていない項目にアクセスできます。
shared_link=[link]
形式を使用するか、パスワードが必要な場合はshared_link=[link]&shared_link_password=[password]
を使用します。
このヘッダーは、共有されているファイルまたはフォルダのほか、その項目内にネストされているすべてのファイルやフォルダで使用できます。
bytes=0-1024
ダウンロードするコンテンツのバイト範囲。
bytes={start_byte}-{end_byte}
の形式を使用して、ダウンロードするファイルのセクションを指定できます。
12345
ファイルを表す一意の識別子。
ファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/files/123
の場合、file_id
は123
です。
c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ
このリクエストの事前認証に使用できるアクセストークン (省略可)。つまり、ダウンロードリンクは、認証の処理方法 を知らなくても、ブラウザまたはサードパーティのサービスと共有できます。このパラメータを使用する際は、そのファイルへの読み取りアクセスだけを許可するよう、アクセストークンが十分にダウンスコープされていることを確認してください。
4
ダウンロードするファイルバージョン
クライアントが自動的にリダイレクトとしてHTTP 3xx
レスポンスに従うようにリダイレクトに従う設定を有効にしている場合は、リクエストされたファイルを返します。有効にしていない場合は、代わりに302
が返されます。詳細については、ファイルのダウンロードに関するガイドを参照してください。
ファイルをダウンロードする準備ができていない場合は、クライアントがファイルをダウンロードできるようになるまでの秒数を示すRetry-After
ヘッダーが返されます。
このレスポンスは、ダウンロードリクエストの直前にファイルがアップロードされた場合に発生することがあります。
ファイルがダウンロード可能な場合、レスポンスにはdl.boxcloud.com
上のファイルのLocation
ヘッダーが含まれます。
dl.boxcloud.com
というURLは永続的ではないため、クライアントで実際にファイルをダウンロードするには、リダイレクト指示に従う必要があります。
予期しないクライアントエラー。
curl -i -L -X GET "https://api.box.com/2.0/files/12345/content" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
const fs = require('fs');
const fileContent = await client.downloads.downloadFile('123456789');
const fileWriteStream = fs.createWriteStream('file.pdf');
fileContent.pipe(fileWriteStream);
client.downloads.download_file(uploaded_file.id)
await client.Downloads.DownloadFileAsync(fileId: uploadedFile.Id);
BoxFile file = new BoxFile(api, "id");
BoxFile.Info info = file.getInfo();
FileOutputStream stream = new FileOutputStream(info.getName());
file.download(stream);
stream.close();
file_id = '11111'
file_content = client.file(file_id).content()
Stream fileContents = await client.FilesManager.DownloadStreamAsync(id: "11111");
var fs = require('fs');
client.files.getReadStream('12345', null, function(error, stream) {
if (error) {
// handle error
}
// write the file to disk
var output = fs.createWriteStream('/path/to/file');
stream.pipe(output);
});
let url = FileManager.default.homeDirectoryForCurrentUser
let task: BoxDownloadTask = client.files.download(fileId: "11111", destinationURL: url) { (result: Result<Void, BoxSDKError>) in
guard case .success = result else {
print("Error downloading file")
return
}
print("File downloaded successfully")
}
// To cancel download
if someConditionIsSatisfied {
task.cancel()
}