getAvatarRaw method

  1. @experimental
DynamiteRawResponse<Uint8List, void> getAvatarRaw({
  1. required String guestName,
  2. required String size,
  3. GuestAvatarGetAvatarDarkTheme? darkTheme,
})

Returns a guest avatar image response.

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:

  • darkTheme Return dark avatar. Defaults to 0.
  • guestName The guest name, e.g. "Albert".
  • size The desired avatar size, e.g. 64 for 64x64px.

Status codes:

  • 200: Custom avatar returned
  • 201: Avatar returned
  • 500

See:

  • getAvatar for an operation that returns a DynamiteResponse with a stable API.

Implementation

@_i4.experimental
_i1.DynamiteRawResponse<Uint8List, void> getAvatarRaw({
  required String guestName,
  required String size,
  GuestAvatarGetAvatarDarkTheme? darkTheme,
}) {
  final _parameters = <String, dynamic>{};
  final _headers = <String, String>{'Accept': '*/*'};

// 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 $guestName = _$jsonSerializers.serialize(guestName, specifiedType: const FullType(String));
  _parameters['guestName'] = $guestName;

  final $size = _$jsonSerializers.serialize(size, specifiedType: const FullType(String));
  _parameters['size'] = $size;

  var $darkTheme =
      _$jsonSerializers.serialize(darkTheme, specifiedType: const FullType(GuestAvatarGetAvatarDarkTheme));
  $darkTheme ??= 0;
  _parameters['darkTheme'] = $darkTheme;

  final _path = _i3.UriTemplate('/index.php/avatar/guest/{guestName}/{size}{?darkTheme*}').expand(_parameters);
  return _i1.DynamiteRawResponse<Uint8List, void>(
    response: _rootClient.executeRequest(
      'get',
      _path,
      headers: _headers,
      validStatuses: const {
        200,
        201,
      },
    ),
    bodyType: const FullType(Uint8List),
    headersType: null,
    serializers: _$jsonSerializers,
  );
}