Plugin API

Represents information about a single user

Hierarchy

  • User

Index

Methods

Methods

addGroup

  • addGroup(userGroup: UserGroup | string | number): 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

  • Returns UserGroup[]

getId

  • getId(): number

  • Returns number

getLastName

  • getLastName(): string

  • Returns string

getLoginName

  • getLoginName(): string

  • Returns string

isInGroup

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

  • Returns whether this user is in the group

    Parameters

    Returns boolean

removeGroup

  • removeGroup(userGroup: UserGroup | string | number): 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.

Legend

Generated using TypeDoc