FileStorageReference class

Provide a file endpoint reference to a CARP web service. Used to:

  • upload a local File to the CARP server
  • download a CARP file to a local File
  • get a CarpFileResponse file object from the CARP sever
  • get all file object as a list of CarpFileResponses from the CARP sever
  • delete a file at CARP
Inheritance

Properties

fileEndpointUri → String
The URL for the file end point for this FileStorageReference.
read-only
hashCode → int
The hash code for this object. [...]
read-only, inherited
headers → Future<Map<String, String>>
read-only, inherited
id ↔ int
The CARP server-side ID of this file. [...]
read / write
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited
service CarpService
read / write, inherited

Methods

delete() → Future<int>
Deletes the file at this FileStorageReference.
download(File file) FileDownloadTask
Asynchronously downloads the object at this FileStorageReference to a specified local file.
get() → Future<CarpFileResponse>
Get the file object at the server for this FileStorageReference.
getAll() → Future<List<CarpFileResponse>>
Get all file objects for the Study in this FileStorageReference.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
toString() → String
Returns a string representation of this object.
inherited
upload(File file, [Map<String, String> metadata]) FileUploadTask
Asynchronously uploads a file to the currently specified FileStorageReference, with optional metadata.

Operators

operator ==(Object other) → bool
The equality operator. [...]
inherited