Interface User

Represents information about a single user

interface User {
    addGroup(userGroup: string | number | UserGroup): boolean;
    getEmail(): string;
    getFirstName(): string;
    getGroups(): UserGroup[];
    getId(): number;
    getLastName(): string;
    getLoginName(): string;
    isInGroup(userGroup: string | number | UserGroup): boolean;
    removeGroup(userGroup: string | number | UserGroup): boolean;
    setEmail(email: string): boolean;
    setFirstName(firstName: string): boolean;
    setLastName(lastName: string): boolean;
    setLoginName(loginName: string): boolean;
}

Methods

addGroup getEmail getFirstName getGroups getId getLastName getLoginName isInGroup removeGroup setEmail setFirstName setLastName setLoginName

Methods

addGroup

  • addGroup(userGroup: string | number | UserGroup): boolean

    Add this user to the user group

    Parameters

    Returns boolean

    Whether operation was successful or not.

getEmail

  • getEmail(): string

    Returns string

getFirstName

  • getFirstName(): string

    Returns string

getGroups

getId

  • getId(): number

    Returns number

getLastName

  • getLastName(): string

    Returns string

getLoginName

  • getLoginName(): string

    Returns string

isInGroup

  • isInGroup(userGroup: string | number | UserGroup): boolean

    Returns whether this user is in the group

    Parameters

    Returns boolean

removeGroup

  • removeGroup(userGroup: string | number | UserGroup): boolean

    Remove this user from the user group

    Parameters

    Returns boolean

    Whether operation was successful or not.

setEmail

  • setEmail(email: string): boolean

    Sets new email

    Parameters

    • email: string

    Returns boolean

    Whether operation was successful or not.

setFirstName

  • setFirstName(firstName: string): boolean

    Sets new first name.

    Parameters

    • firstName: string

    Returns boolean

    Whether operation was successful or not.

setLastName

  • setLastName(lastName: string): boolean

    Sets new last name

    Parameters

    • lastName: string

    Returns boolean

    Whether operation was successful or not.

setLoginName

  • setLoginName(loginName: string): boolean

    Sets new login name.

    Parameters

    • loginName: string

    Returns boolean

    Whether operation was successful or not.

Settings

Member Visibility

On This Page

Methods