Plugin API

Api for accessing information about users of LUY

Hierarchy

  • UserApi

Index

Methods

Methods

create

  • create(loginName: string, firstName: string, lastName: string): User

  • Creates and returns new User with given login name.

    When the loginName parameter is empty or user with the given loginName already exist will throw exception with an appropriate message.

    Parameters

    • loginName: string
    • firstName: string
    • lastName: string

    Returns User

get

  • get(userId: number): User
  • get(loginName: string): User

  • Returns user with given id.

    Parameters

    • userId: number

    Returns User

  • Returns User object with given login name.

    Parameters

    • loginName: string

    Returns User

getAll

  • Returns all users of LUY.

    Returns User[]

Legend

Generated using TypeDoc