getUserProxyAvatar method

Future<DynamiteResponse<Uint8List, void>> getUserProxyAvatar({
  1. required String token,
  2. required AvatarGetUserProxyAvatarSize size,
  3. required String cloudId,
  4. AvatarGetUserProxyAvatarApiVersion? apiVersion,
  5. AvatarGetUserProxyAvatarDarkTheme? darkTheme,
  6. bool? oCSAPIRequest,
})

Get the avatar of a cloudId user.

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:

  • apiVersion Defaults to "v1".
  • token
  • size Avatar size.
  • cloudId Federation CloudID to get the avatar for.
  • darkTheme Theme used for background. Defaults to 0.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: User avatar returned

See:

Implementation

Future<_i1.DynamiteResponse<Uint8List, void>> getUserProxyAvatar({
  required String token,
  required AvatarGetUserProxyAvatarSize size,
  required String cloudId,
  AvatarGetUserProxyAvatarApiVersion? apiVersion,
  AvatarGetUserProxyAvatarDarkTheme? darkTheme,
  bool? oCSAPIRequest,
}) async {
  final _request = $getUserProxyAvatar_Request(
    token: token,
    size: size,
    cloudId: cloudId,
    apiVersion: apiVersion,
    darkTheme: darkTheme,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _streamedResponse = await _rootClient.httpClient.send(_request);
  final _response = await _i3.Response.fromStream(_streamedResponse);

  final _serializer = $getUserProxyAvatar_Serializer();
  return _i1.ResponseConverter<Uint8List, void>(_serializer).convert(_response);
}