Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UserInventoryRoleService

Hierarchy

Index

Constructors

constructor

Methods

create

  • Parameters

    Returns Promise<IResult<IUserInventoryRole>>

    Returns promise object that is resolved with the details of newly assigned inventory role.

    Example

    
     const inventoryRoleObject: IUserInventoryRole = {
       ...
     };
    
       (async () => {
         const {data, res} = await userInventoryRoleService.create(inventoryRoleObject);
      })();
    

delete

  • Parameters

    Returns Promise<IResult<null>>

    Returns promise object that is resolved with the IResult.

    Example

    
       const inventoryRoleId: number = 1;
    
       (async () => {
         const {data, res} = await userInventoryRoleService.delete(inventoryRoleId);
      })();
    

detail

  • Parameters

    Returns Promise<IResult<IUserInventoryRole>>

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

    Example

    
       const inventoryRoleId: number = 1;
    
       (async () => {
         const {data, res} = await userInventoryRoleService.detail(inventoryRoleId);
      })();
    

    Required role: ROLE_TENANT_MANAGEMENT_READ

    User password is never returned in GET response. Authentication mechanism is provided by another interface.

list

  • Parameters

    • Default value filter: object = {}

    Returns Promise<IResultList<IUserInventoryRole>>

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

    Example

    
     const filter: object = {
        severity: Severity.MAJOR,
        pageSize: 100,
        withTotalPages: true
      };
    
      (async () => {
        const {data, res, paging} = await userInventoryRoleService.list(filter);
      })();
    

list$

  • Parameters

    Returns Observable<IUserInventoryRole[]>

    Data wrapped as ObservableList

    Example

    
      const list$ = userInventoryRoleService.list$();
      list$.subscribe((data) => console.log(data));
    

    Deprecated This function will be removed soon in favor of decoupling this library from rxjs. Use Realtime for realtime connection and rxjs defer() or from() to composite an observable on your own.

update

Generated using TypeDoc