infoRaw method
Get the info about a share.
This method and the response it returns is experimental. The API might change without a major version bump.
Returns a Future containing a DynamiteRawResponse
with the raw HttpClientResponse
and serialization helpers.
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 for an operation that returns a
DynamiteResponse
with a stable API.
Implementation
@_i4.experimental
_i1.DynamiteRawResponse<ShareInfo, void> infoRaw({
required String t,
String? password,
String? dir,
int? depth,
}) {
final _parameters = <String, dynamic>{};
final _headers = <String, String>{'Accept': 'application/json'};
// coverage:ignore-start
final authentication = _rootClient.authentications?.firstWhereOrNull(
(auth) => switch (auth) {
_i1.DynamiteHttpBearerAuthentication() || _i1.DynamiteHttpBasicAuthentication() => true,
_ => false,
},
);
if (authentication != null) {
_headers.addAll(
authentication.headers,
);
}
// coverage:ignore-end
final $t = _$jsonSerializers.serialize(t, specifiedType: const FullType(String));
_parameters['t'] = $t;
final $password = _$jsonSerializers.serialize(password, specifiedType: const FullType(String));
_parameters['password'] = $password;
final $dir = _$jsonSerializers.serialize(dir, specifiedType: const FullType(String));
_parameters['dir'] = $dir;
var $depth = _$jsonSerializers.serialize(depth, specifiedType: const FullType(int));
$depth ??= -1;
_parameters['depth'] = $depth;
final _path =
_i3.UriTemplate('/index.php/apps/files_sharing/shareinfo{?t*,password*,dir*,depth*}').expand(_parameters);
return _i1.DynamiteRawResponse<ShareInfo, void>(
response: _rootClient.executeRequest(
'post',
_path,
headers: _headers,
validStatuses: const {200},
),
bodyType: const FullType(ShareInfo),
headersType: null,
serializers: _$jsonSerializers,
);
}