FileStorageReference class

A reference to one file in the CAWS file storage of a study.

Obtained from CarpService.getFileStorageReference or CarpService.getFileStorageReferenceByName. Used to:

• upload a local File to CAWS (upload)
• download a CAWS file to a local File (download)
• get the CarpFileResponse metadata of the file (get)
• delete the file in CAWS (delete)

download, get and delete need a known id; upload sets it.

Inheritance

• Object
• CarpReference
• FileStorageReference

Properties

fileEndpointUri → String

The URL for the file end point for this FileStorageReference.

no setter

hashCode → int

The hash code for this object.

no setter, inherited

headers → Map<String, String>

The authenticated HTTP headers of service.

no setter, inherited

id ↔ int

The CARP server-side ID of this file.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

service ↔ CarpBaseService

The service this reference sends its requests through.

getter/setter pair, inherited

studyId → String

The id of the study this file belongs to.

no setter

Methods

delete() → Future<void>

Deletes the file at this FileStorageReference.

download(File file) → FileDownloadTask

Starts a download of this file into the local file and returns the running FileDownloadTask.

get() → Future<CarpFileResponse>

Gets the metadata of this file from CAWS.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

upload(File file, [Map<String, String>? metadata]) → FileUploadTask

Starts an upload of file with optional metadata and returns the running FileUploadTask.

Operators

operator ==(Object other) → bool

The equality operator.

inherited