NavVis IVION API
    Preparing search index...

    Interface UserEntityInterface

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

    Properties

    email firstName id lastName username

    Methods

    isAdmin isGuest isSiteAdmin

    Properties

    email: string

    Optional email address of the user.

    firstName: string

    Optional first name of the user.

    id: number

    ID of the user.

    lastName: string

    Optional last name of the user

    username: string

    Login name of the user.

    Methods

    • Checks if the user is a global administrator.

      Returns boolean

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

      Returns boolean

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

      Parameters

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Properties
    Methods