Documents resource

DocumentsResourceCopy Anchor Link

class DocumentsResource

Uploaded documents and their download URLs. Reached through ovok.documents.

Every request throws an OvokException subclass when it fails.

ConstructorsCopy Anchor Link

DocumentsResource.newCopy Anchor Link

DocumentsResource(HttpClient _http, String _baseUrl)

Built by Ovok; use ovok.documents instead.

MethodsCopy Anchor Link

DocumentsResource.listCopy Anchor Link

Future<JsonMap> list([QueryParams params = const {}])

Lists documents. Calls GET document with params.

Returns Future<Map<String, dynamic>>.

DocumentsResource.createUploadCopy Anchor Link

Future<JsonMap> createUpload(JsonMap body)

Creates a document upload. Calls POST document.

Returns Future<Map<String, dynamic>>.

DocumentsResource.replaceUploadCopy Anchor Link

Future<JsonMap> replaceUpload(String documentId, JsonMap body)

Replaces a document's upload. Calls POST document/{documentId}.

Returns Future<Map<String, dynamic>>.

DocumentsResource.updateMetadataCopy Anchor Link

Future<JsonMap> updateMetadata(String documentId, JsonMap body)

Updates a document's metadata. Calls PATCH document/{documentId}.

Returns Future<Map<String, dynamic>>.

DocumentsResource.deleteCopy Anchor Link

Future<JsonMap> delete(String documentId)

Deletes a document. Calls DELETE document/{documentId}.

Returns Future<Map<String, dynamic>>.

DocumentsResource.downloadUrlCopy Anchor Link

String downloadUrl(String documentId, [QueryParams params = const {}])

The signed-in download URL, document/{documentId}; sends no request.

Fetched with the bearer token, it redirects to a signed download URL.

Returns String.

DocumentsResource.publicDownloadUrlCopy Anchor Link

String publicDownloadUrl(String publicToken, [QueryParams params = const {}])

The public download URL, document/public/{publicToken}; sends no request.

Needs no bearer, so it fits an image, download or media element.

Returns String.