$getUserProxyAvatarWithoutRoom_Request method

@experimental Request $getUserProxyAvatarWithoutRoom_Request({ required String cloudId, required AvatarGetUserProxyAvatarWithoutRoomSize size, AvatarGetUserProxyAvatarWithoutRoomDarkTheme? darkTheme, AvatarGetUserProxyAvatarWithoutRoomApiVersion? apiVersion, bool? oCSAPIRequest, })

Get the avatar of a cloudId user when inviting users while creating a conversation.

Returns a DynamiteRequest backing the getUserProxyAvatarWithoutRoom operation. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

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

Status codes:

• 200: User avatar returned

See:

• getUserProxyAvatarWithoutRoom for a method executing this request and parsing the response.
• $getUserProxyAvatarWithoutRoom_Serializer for a converter to parse the Response from an executed this request.

Implementation

@_i2.experimental
_i3.Request $getUserProxyAvatarWithoutRoom_Request({
  required String cloudId,
  required AvatarGetUserProxyAvatarWithoutRoomSize size,
  AvatarGetUserProxyAvatarWithoutRoomDarkTheme? darkTheme,
  AvatarGetUserProxyAvatarWithoutRoomApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  final $cloudId = _$jsonSerializers.serialize(cloudId, specifiedType: const FullType(String));
  _parameters['cloudId'] = $cloudId;

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

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

  var $apiVersion = _$jsonSerializers.serialize(
    apiVersion,
    specifiedType: const FullType(AvatarGetUserProxyAvatarWithoutRoomApiVersion),
  );
  $apiVersion ??= 'v1';
  _parameters['apiVersion'] = $apiVersion;

  final _path =
      _i5.UriTemplate('/ocs/v2.php/apps/spreed/api/{apiVersion}/proxy/new/user-avatar/{size}{?cloudId*,darkTheme*}')
          .expand(_parameters);
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('get', _uri);
  _request.headers['Accept'] = '*/*';
// coverage:ignore-start
  final authentication = _rootClient.authentications?.firstWhereOrNull(
    (auth) => switch (auth) {
      _i1.DynamiteHttpBearerAuthentication() || _i1.DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

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

// coverage:ignore-end
  var $oCSAPIRequest = _$jsonSerializers.serialize(oCSAPIRequest, specifiedType: const FullType(bool));
  $oCSAPIRequest ??= true;
  _request.headers['OCS-APIRequest'] = const _i4.HeaderEncoder().convert($oCSAPIRequest);

  return _request;
}