getInitials method

Future<Uint8List> getInitials({ String? name, int? width, int? height, String? background, })

Get User Initials

Use this endpoint to show your user initials avatar icon on your website or app. By default, this route will try to print your logged-in user name or email initials. You can also overwrite the user name if you pass the 'name' parameter. If no name is given and no user is logged, an empty avatar will be returned.

You can use the color and background params to change the avatar colors. By default, a random theme will be selected. The random theme will persist for the user's initials when reloading the same theme will always return for the same initials.

When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.

Implementation

Future<Uint8List> getInitials(
    {String? name, int? width, int? height, String? background}) async {
  const String path = '/avatars/initials';

  final Map<String, dynamic> params = {
    'name': name,
    'width': width,
    'height': height,
    'background': background,
    'project': client.config['project'],
  };

  final res = await client.call(HttpMethod.get,
      path: path, params: params, responseType: ResponseType.bytes);
  return res.data;
}