downloadRaw method

  1. @experimental
DynamiteRawResponse<Uint8List, LogSettingsLogSettingsDownloadHeaders> downloadRaw()

download logfile.

This endpoint requires admin access.

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.

Status codes:

  • 200: Logfile returned

See:

Implementation

@experimental
DynamiteRawResponse<Uint8List, LogSettingsLogSettingsDownloadHeaders> downloadRaw() {
  final _headers = <String, String>{
    'Accept': 'application/octet-stream',
  };

// coverage:ignore-start
  final authentication = _rootClient.authentications.firstWhereOrNull(
    (auth) => switch (auth) {
      DynamiteHttpBearerAuthentication() || DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

  if (authentication != null) {
    _headers.addAll(
      authentication.headers,
    );
  } else {
    throw Exception('Missing authentication for bearer_auth or basic_auth');
  }

// coverage:ignore-end
  const _path = '/index.php/settings/admin/log/download';
  return DynamiteRawResponse<Uint8List, LogSettingsLogSettingsDownloadHeaders>(
    response: _rootClient.executeRequest(
      'get',
      _path,
      _headers,
      null,
      const {200},
    ),
    bodyType: const FullType(Uint8List),
    headersType: const FullType(LogSettingsLogSettingsDownloadHeaders),
    serializers: jsonSerializers,
  );
}