$getUserProxyAvatar_Request method

@experimental Request $getUserProxyAvatar_Request({ required String cloudId, required String token, required AvatarGetUserProxyAvatarSize size, AvatarGetUserProxyAvatarDarkTheme? darkTheme, AvatarGetUserProxyAvatarApiVersion? apiVersion, bool? oCSAPIRequest, })

Get the avatar of a cloudId user.

Returns a DynamiteRequest backing the getUserProxyAvatar 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".
• token
• size Avatar size.
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: User avatar returned

See:

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

Implementation

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

  final $token = _$jsonSerializers.serialize(token, specifiedType: const FullType(String));
  _i4.checkString(
    $token,
    'token',
    pattern: RegExp(r'^[a-z0-9]{4,30}$'),
  );
  _parameters['token'] = $token;

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

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

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

  final _path = _i5.UriTemplate(
    '/ocs/v2.php/apps/spreed/api/{apiVersion}/proxy/{token}/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,
    );
  }

// 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;
}