Interface UserApi

Api for accessing information about users of LUY

interface UserApi {
    create(loginName: string, firstName: string, lastName: string): User;
    get(userId: number): User;
    get(loginName: string): User;
    getAll(): User[];
}

Methods

create get getAll

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

    Returns user with given id.

    Parameters

    • userId: number

    Returns User

  • get(loginName: string): User

    Returns User object with given login name.

    Parameters

    • loginName: string

    Returns User

getAll

  • getAll(): User[]

    Returns all users of LUY.

    Returns User[]

Settings

Member Visibility

On This Page

Methods