Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UserRoleService

description

This service allows for fetch user roles.

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

detail

  • Gets the details of given role.

    example
    
   const roleId: number = 1;

   (async () => {
     const {data, res} = await userRoleService.detail(roleId);
  })();

    Parameters

    • entityOrId: string | number | IRole

      Roles's id or role object.

    Returns Promise<IResult<IRole>>

    Returns promise object that is resolved with the IRole wrapped by IResult.

list

  • Gets the list of user roles filtered by parameters.

    example
    
 const filter: object = {
    severity: Severity.MAJOR,
    pageSize: 100,
    withTotalPages: true
  };

  (async () => {
    const {data, res, paging} = await userRoleService.list(filter);
  })();

    Parameters

    • Default value filter: object = {}

      Object containing filters for querying roles.

    Returns Promise<IResultList<IRole>>

    Returns promise object that is resolved with the IRole wrapped by IResultList.

Generated using TypeDoc