info method
Get the info about a share.
Returns a Future containing a DynamiteResponse
with the status code, deserialized body and headers.
Throws a DynamiteApiException
if the API call does not return an expected status code.
Parameters:
t
Token of the share.password
Password of the share.dir
Subdirectory to get info about.depth
Maximum depth to get info about. Defaults to-1
.
Status codes:
- 200: Share info returned
- 403: Getting share info is not allowed
- 404: Share not found
See:
- $info_Request for the request send by this method.
- $info_Serializer for a converter to parse the
Response
from an executed request.
Implementation
Future<_i1.DynamiteResponse<ShareInfo, void>> info({
required String t,
String? password,
String? dir,
int? depth,
}) async {
final _request = $info_Request(
t: t,
password: password,
dir: dir,
depth: depth,
);
final _response = await _rootClient.httpClient.send(_request);
final _serializer = $info_Serializer();
final _rawResponse = await _i1.ResponseConverter<ShareInfo, void>(_serializer).convert(_response);
return _i1.DynamiteResponse.fromRawResponse(_rawResponse);
}