infoRaw method

  1. @experimental
DynamiteRawResponse<ShareInfo, void> infoRaw({
  1. required String t,
  2. String? password,
  3. String? dir,
  4. int? depth,
})

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:

Implementation

@experimental
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) {
      DynamiteHttpBearerAuthentication() || 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 = UriTemplate('/index.php/apps/files_sharing/shareinfo{?t*,password*,dir*,depth*}').expand(_parameters);
  return DynamiteRawResponse<ShareInfo, void>(
    response: _rootClient.executeRequest(
      'post',
      _path,
      _headers,
      null,
      const {200},
    ),
    bodyType: const FullType(ShareInfo),
    headersType: null,
    serializers: jsonSerializers,
  );
}