Skip to content

Latest commit

 

History

History
467 lines (312 loc) · 13.2 KB

chunkedUploads.md

File metadata and controls

467 lines (312 loc) · 13.2 KB

ChunkedUploadsManager

This is a manager for chunked uploads (allowed for files at least 20MB).

Create upload session

Creates an upload session for a new file.

This operation is performed by calling function createFileUploadSession.

See the endpoint docs at API Reference.

await client.chunkedUploads.createFileUploadSession({
  fileName: fileName,
  fileSize: fileSize,
  folderId: parentFolderId,
} satisfies CreateFileUploadSessionRequestBody);

Arguments

  • requestBody CreateFileUploadSessionRequestBody
    • Request body of createFileUploadSession method

  • optionalsInput CreateFileUploadSessionOptionalsInput

Returns

This function returns a value of type UploadSession.

Returns a new upload session.

Create upload session for existing file

Creates an upload session for an existing file.

This operation is performed by calling function createFileUploadSessionForExistingFile.

See the endpoint docs at API Reference.

Currently we don't have an example for calling createFileUploadSessionForExistingFile in integration tests

Arguments

  • fileId string
    • The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123. Example: "12345"
  • requestBody CreateFileUploadSessionForExistingFileRequestBody
    • Request body of createFileUploadSessionForExistingFile method

  • optionalsInput CreateFileUploadSessionForExistingFileOptionalsInput

Returns

This function returns a value of type UploadSession.

Returns a new upload session.

Get upload session by URL

Return information about an upload session.

The actual endpoint URL is returned by the Create upload session endpoint.

This operation is performed by calling function getFileUploadSessionByUrl.

See the endpoint docs at API Reference.

await client.chunkedUploads.getFileUploadSessionByUrl(statusUrl);

Arguments

  • url string
    • URL of getFileUploadSessionById method

  • optionalsInput GetFileUploadSessionByUrlOptionalsInput

Returns

This function returns a value of type UploadSession.

Returns an upload session object.

Get upload session

Return information about an upload session.

The actual endpoint URL is returned by the Create upload session endpoint.

This operation is performed by calling function getFileUploadSessionById.

See the endpoint docs at API Reference.

await client.chunkedUploads.getFileUploadSessionById(uploadSessionId);

Arguments

  • uploadSessionId string
    • The ID of the upload session. Example: "D5E3F7A"

  • optionalsInput GetFileUploadSessionByIdOptionalsInput

Returns

This function returns a value of type UploadSession.

Returns an upload session object.

Upload part of file by URL

Uploads a chunk of a file for an upload session.

The actual endpoint URL is returned by the Create upload session and Get upload session endpoints.

This operation is performed by calling function uploadFilePartByUrl.

See the endpoint docs at API Reference.

await client.chunkedUploads.uploadFilePartByUrl(
  acc.uploadPartUrl,
  generateByteStreamFromBuffer(chunkBuffer),
  {
    digest: digest,
    contentRange: contentRange,
  } satisfies UploadFilePartByUrlHeadersInput,
);

Arguments

  • url string
    • URL of uploadFilePart method
  • requestBody ByteStream
    • Request body of uploadFilePart method
  • headersInput UploadFilePartByUrlHeadersInput
    • Headers of uploadFilePart method

  • optionalsInput UploadFilePartByUrlOptionalsInput

Returns

This function returns a value of type UploadedPart.

Chunk has been uploaded successfully.

Upload part of file

Uploads a chunk of a file for an upload session.

The actual endpoint URL is returned by the Create upload session and Get upload session endpoints.

This operation is performed by calling function uploadFilePart.

See the endpoint docs at API Reference.

await client.chunkedUploads.uploadFilePart(
  acc.uploadSessionId,
  generateByteStreamFromBuffer(chunkBuffer),
  {
    digest: digest,
    contentRange: contentRange,
  } satisfies UploadFilePartHeadersInput,
);

Arguments

  • uploadSessionId string
    • The ID of the upload session. Example: "D5E3F7A"
  • requestBody ByteStream
    • Request body of uploadFilePart method
  • headersInput UploadFilePartHeadersInput
    • Headers of uploadFilePart method

  • optionalsInput UploadFilePartOptionalsInput

Returns

This function returns a value of type UploadedPart.

Chunk has been uploaded successfully.

Remove upload session by URL

Abort an upload session and discard all data uploaded.

This cannot be reversed.

The actual endpoint URL is returned by the Create upload session and Get upload session endpoints.

This operation is performed by calling function deleteFileUploadSessionByUrl.

See the endpoint docs at API Reference.

await client.chunkedUploads.deleteFileUploadSessionByUrl(abortUrl);

Arguments

  • url string
    • URL of deleteFileUploadSessionById method

  • optionalsInput DeleteFileUploadSessionByUrlOptionalsInput

Returns

This function returns a value of type undefined.

A blank response is returned if the session was successfully aborted.

Remove upload session

Abort an upload session and discard all data uploaded.

This cannot be reversed.

The actual endpoint URL is returned by the Create upload session and Get upload session endpoints.

This operation is performed by calling function deleteFileUploadSessionById.

See the endpoint docs at API Reference.

await client.chunkedUploads.deleteFileUploadSessionById(uploadSessionId);

Arguments

  • uploadSessionId string
    • The ID of the upload session. Example: "D5E3F7A"

  • optionalsInput DeleteFileUploadSessionByIdOptionalsInput

Returns

This function returns a value of type undefined.

A blank response is returned if the session was successfully aborted.

List parts by URL

Return a list of the chunks uploaded to the upload session so far.

The actual endpoint URL is returned by the Create upload session and Get upload session endpoints.

This operation is performed by calling function getFileUploadSessionPartsByUrl.

See the endpoint docs at API Reference.

await client.chunkedUploads.getFileUploadSessionPartsByUrl(listPartsUrl);

Arguments

  • url string
    • URL of getFileUploadSessionParts method

  • optionalsInput GetFileUploadSessionPartsByUrlOptionalsInput

Returns

This function returns a value of type UploadParts.

Returns a list of parts that have been uploaded.

List parts

Return a list of the chunks uploaded to the upload session so far.

The actual endpoint URL is returned by the Create upload session and Get upload session endpoints.

This operation is performed by calling function getFileUploadSessionParts.

See the endpoint docs at API Reference.

await client.chunkedUploads.getFileUploadSessionParts(uploadSessionId);

Arguments

  • uploadSessionId string
    • The ID of the upload session. Example: "D5E3F7A"

  • optionalsInput GetFileUploadSessionPartsOptionalsInput

Returns

This function returns a value of type UploadParts.

Returns a list of parts that have been uploaded.

Commit upload session by URL

Close an upload session and create a file from the uploaded chunks.

The actual endpoint URL is returned by the Create upload session and Get upload session endpoints.

This operation is performed by calling function createFileUploadSessionCommitByUrl.

See the endpoint docs at API Reference.

await client.chunkedUploads.createFileUploadSessionCommitByUrl(
  commitUrl,
  { parts: parts } satisfies CreateFileUploadSessionCommitByUrlRequestBody,
  { digest: digest } satisfies CreateFileUploadSessionCommitByUrlHeadersInput,
);

Arguments

  • url string
    • URL of createFileUploadSessionCommit method
  • requestBody CreateFileUploadSessionCommitByUrlRequestBody
    • Request body of createFileUploadSessionCommit method
  • headersInput CreateFileUploadSessionCommitByUrlHeadersInput
    • Headers of createFileUploadSessionCommit method

  • optionalsInput CreateFileUploadSessionCommitByUrlOptionalsInput

Returns

This function returns a value of type undefined | Files.

Returns the file object in a list.Returns when all chunks have been uploaded but not yet processed.

Inspect the upload session to get more information about the progress of processing the chunks, then retry committing the file when all chunks have processed.

Commit upload session

Close an upload session and create a file from the uploaded chunks.

The actual endpoint URL is returned by the Create upload session and Get upload session endpoints.

This operation is performed by calling function createFileUploadSessionCommit.

See the endpoint docs at API Reference.

await client.chunkedUploads.createFileUploadSessionCommit(
  uploadSessionId,
  { parts: parts } satisfies CreateFileUploadSessionCommitRequestBody,
  { digest: digest } satisfies CreateFileUploadSessionCommitHeadersInput,
);

Arguments

  • uploadSessionId string
    • The ID of the upload session. Example: "D5E3F7A"
  • requestBody CreateFileUploadSessionCommitRequestBody
    • Request body of createFileUploadSessionCommit method
  • headersInput CreateFileUploadSessionCommitHeadersInput
    • Headers of createFileUploadSessionCommit method

  • optionalsInput CreateFileUploadSessionCommitOptionalsInput

Returns

This function returns a value of type undefined | Files.

Returns the file object in a list.Returns when all chunks have been uploaded but not yet processed.

Inspect the upload session to get more information about the progress of processing the chunks, then retry committing the file when all chunks have processed.

Upload big file

Starts the process of chunk uploading a big file. Should return a File object representing uploaded file.

This operation is performed by calling function uploadBigFile.

await client.chunkedUploads.uploadBigFile(
  fileByteStream,
  fileName,
  fileSize,
  parentFolderId,
);

Arguments

  • file ByteStream
    • The stream of the file to upload.
  • fileName string
    • The name of the file, which will be used for storage in Box.
  • fileSize number
    • The total size of the file for the chunked upload in bytes.
  • parentFolderId string
    • The ID of the folder where the file should be uploaded.
  • cancellationToken undefined | CancellationToken
    • Token used for request cancellation.

Returns

This function returns a value of type FileFull.