info method

Future<DynamiteResponse<ShareInfo, void>> info({
  1. required String t,
  2. String? password,
  3. String? dir,
  4. int? depth,
})

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:

Implementation

Future<DynamiteResponse<ShareInfo, void>> info({
  required String t,
  String? password,
  String? dir,
  int? depth,
}) async {
  final rawResponse = infoRaw(
    t: t,
    password: password,
    dir: dir,
    depth: depth,
  );

  return rawResponse.future;
}