Method: Appwrite::Avatars#get_initials

Defined in:

lib/appwrite/services/avatars.rb

#get_initials(name: nil, width: nil, height: nil, background: nil) ⇒ Object

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.

Parameters:

• name (String) (defaults to: nil) —

  Full Name. When empty, current user name or email will be used. Max length: 128 chars.

• width (Integer) (defaults to: nil) —

  Image width. Pass an integer between 0 to 2000. Defaults to 100.

• height (Integer) (defaults to: nil) —

  Image height. Pass an integer between 0 to 2000. Defaults to 100.

• background (String) (defaults to: nil) —

  Changes background color. By default a random color will be picked and stay will persistent to the given name.

Returns:

# File 'lib/appwrite/services/avatars.rb', line 234

def get_initials(name: nil, width: nil, height: nil, background: nil)
    api_path = '/avatars/initials'

    api_params = {
        name: name,
        width: width,
        height: height,
        background: background,
    }
    
    api_headers = {
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
    )
end