Interface IIdentity

The interface describing a user identity.

interface IIdentity {
    avatar_url?: string;
    color: string;
    display_name: string;
    initials: string;
    name: string;
    username: string;
    [key: string]: undefined | PartialJSONValue;
}

Hierarchy

  • PartialJSONObject
    • IIdentity

Indexable

Properties

avatar_url? color display_name initials name username

Properties

Optional Readonlyavatar_url

avatar_url?: string

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

Readonlycolor

color: string

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

Readonlydisplay_name

display_name: string

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

Readonlyinitials

initials: string

User's name initials.

Readonlyname

name: string

User's full name.

Readonlyusername

username: string

User's unique identifier.

Settings

Member Visibility

On This Page

Properties