$ShareapiClient class

Constructors

$ShareapiClient($Client _rootClient)

Creates a new DynamiteClient for shareapi requests.

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

$acceptShare_Request({required String id, bool? oCSAPIRequest}) → Request

Accept a share.

$acceptShare_Serializer() → DynamiteSerializer<ShareapiAcceptShareResponseApplicationJson, void>

Builds a serializer to parse the response of $acceptShare_Request.

$createShare_Request({bool? oCSAPIRequest, ShareapiCreateShareRequestApplicationJson? $body}) → Request

Create a share.

$createShare_Serializer() → DynamiteSerializer<ShareapiCreateShareResponseApplicationJson, void>

Builds a serializer to parse the response of $createShare_Request.

$deleteShare_Request({required String id, bool? oCSAPIRequest}) → Request

Delete a share.

$deleteShare_Serializer() → DynamiteSerializer<ShareapiDeleteShareResponseApplicationJson, void>

Builds a serializer to parse the response of $deleteShare_Request.

$getInheritedShares_Request({required String path, bool? oCSAPIRequest}) → Request

Get all shares relative to a file, including parent folders shares rights.

$getInheritedShares_Serializer() → DynamiteSerializer<ShareapiGetInheritedSharesResponseApplicationJson, void>

Builds a serializer to parse the response of $getInheritedShares_Request.

$getShare_Request({required String id, ShareapiGetShareIncludeTags? includeTags, bool? oCSAPIRequest}) → Request

Get a specific share by id.

$getShare_Serializer() → DynamiteSerializer<ShareapiGetShareResponseApplicationJson, void>

Builds a serializer to parse the response of $getShare_Request.

$getShares_Request({String? sharedWithMe, String? reshares, String? subfiles, String? path, String? includeTags, bool? oCSAPIRequest}) → Request

Get shares of the current user.

$getShares_Serializer() → DynamiteSerializer<ShareapiGetSharesResponseApplicationJson, void>

Builds a serializer to parse the response of $getShares_Request.

$pendingShares_Request({bool? oCSAPIRequest}) → Request

Get all shares that are still pending.

$pendingShares_Serializer() → DynamiteSerializer<ShareapiPendingSharesResponseApplicationJson, void>

Builds a serializer to parse the response of $pendingShares_Request.

$sendShareEmail_Request({required String id, bool? oCSAPIRequest, ShareapiSendShareEmailRequestApplicationJson? $body}) → Request

Send a mail notification again for a share. The mail_send option must be enabled for the given share.

$sendShareEmail_Serializer() → DynamiteSerializer<ShareapiSendShareEmailResponseApplicationJson, void>

Builds a serializer to parse the response of $sendShareEmail_Request.

$updateShare_Request({required String id, bool? oCSAPIRequest, ShareapiUpdateShareRequestApplicationJson? $body}) → Request

Update a share.

$updateShare_Serializer() → DynamiteSerializer<ShareapiUpdateShareResponseApplicationJson, void>

Builds a serializer to parse the response of $updateShare_Request.

acceptShare({required String id, bool? oCSAPIRequest}) → Future<DynamiteResponse<ShareapiAcceptShareResponseApplicationJson, void>>

Accept a share.

createShare({bool? oCSAPIRequest, ShareapiCreateShareRequestApplicationJson? $body}) → Future<DynamiteResponse<ShareapiCreateShareResponseApplicationJson, void>>

Create a share.

deleteShare({required String id, bool? oCSAPIRequest}) → Future<DynamiteResponse<ShareapiDeleteShareResponseApplicationJson, void>>

Delete a share.

getInheritedShares({required String path, bool? oCSAPIRequest}) → Future<DynamiteResponse<ShareapiGetInheritedSharesResponseApplicationJson, void>>

Get all shares relative to a file, including parent folders shares rights.

getShare({required String id, ShareapiGetShareIncludeTags? includeTags, bool? oCSAPIRequest}) → Future<DynamiteResponse<ShareapiGetShareResponseApplicationJson, void>>

Get a specific share by id.

getShares({String? sharedWithMe, String? reshares, String? subfiles, String? path, String? includeTags, bool? oCSAPIRequest}) → Future<DynamiteResponse<ShareapiGetSharesResponseApplicationJson, void>>

Get shares of the current user.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

pendingShares({bool? oCSAPIRequest}) → Future<DynamiteResponse<ShareapiPendingSharesResponseApplicationJson, void>>

Get all shares that are still pending.

sendShareEmail({required String id, bool? oCSAPIRequest, ShareapiSendShareEmailRequestApplicationJson? $body}) → Future<DynamiteResponse<ShareapiSendShareEmailResponseApplicationJson, void>>

Send a mail notification again for a share. The mail_send option must be enabled for the given share.

toString() → String

A string representation of this object.

inherited

updateShare({required String id, bool? oCSAPIRequest, ShareapiUpdateShareRequestApplicationJson? $body}) → Future<DynamiteResponse<ShareapiUpdateShareResponseApplicationJson, void>>

Update a share.

Operators

operator ==(Object other) → bool

The equality operator.

inherited