Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/appwrite/src/services/avatars.ts>Avatars

[READ-ONLY] Official Appwrite Deno SDK 🦕
appwrite/sdk-for-deno
Latest
class Avatars
extends Service
import { Avatars } from "https://deno.land/x/appwrite@12.1.0/src/services/avatars.ts";

Constructors

new
Avatars(client: Client)

Methods

getBrowser(
code: Browser,
width?: number,
height?: number,
quality?: number,
): Promise<ArrayBuffer>

Get browser icon

You can use this endpoint to show different browser icons to your users. The code argument receives the browser code as it appears in your user GET /account/sessions endpoint. Use width, height and quality arguments to change the output settings.

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.

getCreditCard(
code: CreditCard,
width?: number,
height?: number,
quality?: number,
): Promise<ArrayBuffer>

Get credit card icon

The credit card endpoint will return you the icon of the credit card provider you need. Use width, height and quality arguments to change the output settings.

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.

getFavicon(url: string): Promise<ArrayBuffer>

Get favicon

Use this endpoint to fetch the favorite icon (AKA favicon) of any remote website URL.

This endpoint does not follow HTTP redirects.

getFlag(
code: Flag,
width?: number,
height?: number,
quality?: number,
): Promise<ArrayBuffer>

Get country flag

You can use this endpoint to show different country flags icons to your users. The code argument receives the 2 letter country code. Use width, height and quality arguments to change the output settings. Country codes follow the ISO 3166-1 standard.

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.

getImage(
url: string,
width?: number,
height?: number,
): Promise<ArrayBuffer>

Get image from URL

Use this endpoint to fetch a remote image URL and crop it to any image size you want. This endpoint is very useful if you need to crop and display remote images in your app or in case you want to make sure a 3rd party image is properly served using a TLS protocol.

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 400x400px.

This endpoint does not follow HTTP redirects.

getInitials(
name?: string,
width?: number,
height?: number,
background?: string,
): Promise<ArrayBuffer>

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.

getQR(
text: string,
size?: number,
margin?: number,
download?: boolean,
): Promise<ArrayBuffer>

Get QR code

Converts a given plain text to a QR code image. You can use the query parameters to change the size and style of the resulting image.