$info_Request method
- @experimental
Get the info about a share.
Returns a DynamiteRequest
backing the info operation.
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 a method executing this request and parsing the response.
- $info_Serializer for a converter to parse the
Response
from an executed this request.
Implementation
@_i2.experimental
_i3.Request $info_Request({
required String t,
String? password,
String? dir,
int? depth,
}) {
final _parameters = <String, Object?>{};
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 =
_i5.UriTemplate('/index.php/apps/files_sharing/shareinfo{?t*,password*,dir*,depth*}').expand(_parameters);
final _uri = Uri.parse('${_rootClient.baseURL}$_path');
final _request = _i3.Request('post', _uri);
_request.headers['Accept'] = 'application/json';
// coverage:ignore-start
final authentication = _rootClient.authentications?.firstWhereOrNull(
(auth) => switch (auth) {
_i1.DynamiteHttpBearerAuthentication() || _i1.DynamiteHttpBasicAuthentication() => true,
_ => false,
},
);
if (authentication != null) {
_request.headers.addAll(
authentication.headers,
);
}
// coverage:ignore-end
return _request;
}