Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SystemOptionsService

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

detail

  • Gets the details of given system option.

    example
    
       const option: ISystemOption = {
         category: 'alarm.type.mapping',
         key: 'temp_to_high'
       };
    
       (async () => {
         const {data, res} = await systemOptionsService.detail(option);
      })();
    

    Parameters

    • option: ISystemOption

      System option object with mandantory fragments.

    Returns Promise<IResult<ISystemOption>>

    Response wrapped in IResult

list

  • Gets the list of system options filtered by parameters.

    example
    
     const filter: object = {
        pageSize: 100,
        withTotalPages: true
      };
    
      (async () => {
        const {data, res, paging} = await systemOptionsService.list(filter);
      })();
    

    Parameters

    • Default value filter: object = {}

      Object containing filters for querying system options.

    Returns Promise<IResultList<ISystemOption>>

    Response wrapped in IResultList

Generated using TypeDoc