$getAvatar_Request method
- @experimental
- required String guestName,
- required String size,
- GuestAvatarGetAvatarDarkTheme? darkTheme,
Returns a guest avatar image response.
Returns a DynamiteRequest
backing the getAvatar operation.
Throws a DynamiteApiException
if the API call does not return an expected status code.
Parameters:
darkTheme
Return dark avatar. Defaults to0
.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:
- getAvatar for a method executing this request and parsing the response.
- $getAvatar_Serializer for a converter to parse the
Response
from an executed this request.
Implementation
@_i2.experimental
_i3.Request $getAvatar_Request({
required String guestName,
required String size,
GuestAvatarGetAvatarDarkTheme? darkTheme,
}) {
final _parameters = <String, Object?>{};
final $guestName = _$jsonSerializers.serialize(guestName, specifiedType: const FullType(String));
_parameters['guestName'] = $guestName;
final $size = _$jsonSerializers.serialize(size, specifiedType: const FullType(String));
_parameters['size'] = $size;
var $darkTheme =
_$jsonSerializers.serialize(darkTheme, specifiedType: const FullType(GuestAvatarGetAvatarDarkTheme));
$darkTheme ??= 0;
_parameters['darkTheme'] = $darkTheme;
final _path = _i5.UriTemplate('/index.php/avatar/guest/{guestName}/{size}{?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
return _request;
}