getAvatar method

Future<DynamiteResponse<Uint8List, void>> getAvatar({
  1. required String guestName,
  2. required String size,
  3. GuestAvatarGetAvatarDarkTheme? darkTheme,
})

Returns a guest avatar image response.

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:

  • 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:

  • getAvatarRaw for an experimental operation that returns a DynamiteRawResponse that can be serialized.

Implementation

Future<_i1.DynamiteResponse<Uint8List, void>> getAvatar({
  required String guestName,
  required String size,
  GuestAvatarGetAvatarDarkTheme? darkTheme,
}) async {
  final rawResponse = getAvatarRaw(
    guestName: guestName,
    size: size,
    darkTheme: darkTheme,
  );

  return rawResponse.future;
}