Hierarchy

  • UserGroupApi

Index

Methods

create

  • Creates and returns new user group.

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

    Parameters

    • name: string

    Returns UserGroup

get

  • Returns user group with given id.

    Parameters

    • groupId: number

    Returns UserGroup

  • Returns user group object with given name.

    Parameters

    • name: string

    Returns UserGroup

getAll

  • Returns all user groups of LUY.

    Returns UserGroup[]

remove

  • remove(groupId: number): boolean
  • remove(name: string): boolean
  • Delete the user group

    remark

    This will remove the group from all users. User objects that were previously obtained via UserApi.get will not have their group attribute updated though.

    Parameters

    • groupId: number

      The id of the group to delete

    Returns boolean

  • Delete the user group

    remark

    This will remove the group from all users. User objects that were previously obtained via UserApi.get will not have their group attribute updated though.

    Parameters

    • name: string

      The name of the group to delete

    Returns boolean

Legend

Generated using TypeDoc