Skip to content

Uploads.md

Latest commit

 

History

History
53 lines (39 loc) · 1.78 KB

Uploads.md

File metadata and controls

53 lines (39 loc) · 1.78 KB

Uploads

Uploads module is used to upload files to Box. It supports uploading files from an InputStream. For now, it only supports uploading small files without chunked upload.

Upload a File

To upload a small file from an InputStream, call client.uploads.uploadFile(requestBody:queryParams:headers) method. This method returns a Files object which contains information about the uploaded files.

// Create InputStream for a file based on URL
guard let fileStream = InputStream(url: URL(string: "<URL_TO_YOUR_FILE>")!) else {
    fatalError("Could not read a file")
}

// Create a request body with the required parameters
let requestBody = UploadFileRequestBodyArg(
    attributes: UploadFileRequestBodyArgAttributesField(
        name: "filename.txt",
        parent: UploadFileRequestBodyArgAttributesFieldParentField(id: "0")
    ),
    file: fileStream
)

// Call uploadFile method
let files = try await client.uploads.uploadFile(requestBody: requestBody)

// Print some data from the reponse
if let file = files.entries?[0] {
    print("File uploaded with id \(file.id), name \(file.name!)")
}

If we want to upload a file based on the String type, we need to create an input stream as follows:

let stringContent: String = "File content from String"
let data: Data = stringContent.data(using: .utf8)!
let stream: InputStream = InputStream(data: data)

Then we just pass the created stream to the file argument when initializing the UploadFileRequestBodyArg object.