Interface UserEntityInterface

interface UserEntityInterface {
    email: string;
    firstName: string;
    id: number;
    lastName: string;
    username: string;
    isAdmin(): boolean;
    isGuest(): boolean;
    isSiteAdmin(site: SiteInterface): boolean;
}

Properties

email firstName id lastName username

Methods

isAdmin isGuest isSiteAdmin

Properties

Readonlyemail

email: string

Optional email address of the user.

ReadonlyfirstName

firstName: string

Optional first name of the user.

Readonlyid

id: number

ID of the user.

ReadonlylastName

lastName: string

Optional last name of the user

Readonlyusername

username: string

Login name of the user.

Methods

isAdmin

  • isAdmin(): boolean

  • Checks if the user is a global administrator.

    Returns boolean

isGuest

  • isGuest(): boolean

  • Checks if the user is a guest, i.e. not logged in.

    Returns boolean

isSiteAdmin

  • isSiteAdmin(site): boolean

  • Checks if the user is a site adminstrator on the provided site.

    Parameters

    Returns boolean

Settings

Member Visibility

On This Page

Properties
Methods