getAvatar method

Future<DynamiteResponse<Uint8List, void>> getAvatar({
  1. required String token,
  2. AvatarGetAvatarDarkTheme? darkTheme,
  3. AvatarGetAvatarApiVersion? apiVersion,
  4. bool? oCSAPIRequest,
})

Get the avatar of a room.

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 Theme used for background. Defaults to 0.
  • apiVersion Defaults to v1.
  • token
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Room avatar returned

See:

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

Implementation

Future<_i1.DynamiteResponse<Uint8List, void>> getAvatar({
  required String token,
  AvatarGetAvatarDarkTheme? darkTheme,
  AvatarGetAvatarApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = getAvatarRaw(
    token: token,
    darkTheme: darkTheme,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}