The interface describing a user identity.

interface IIdentity {
    avatar_url?: string;
    color: string;
    display_name: string;
    initials: string;
    name: string;
    username: string;
}

Hierarchy

  • PartialJSONObject
    • IIdentity

Properties

avatar_url?: string

User's avatar url. The url to the user's image for the icon.

color: string

User's cursor color and icon color if avatar_url is undefined (there is no image).

display_name: string

Shorter version of the name for displaying it on the UI.

initials: string

User's name initials.

name: string

User's full name.

username: string

User's unique identifier.