Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AlarmService

This class allows for managing alarms.

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

create

  • Creates a new alarm.

    example
    
 const mandantoryObject: IAlarm = {
   severity: Severity.CRITICAL,
   source: device,
   text: 'I am an Alarm!',
   time: '2018-05-02T10:08:00Z',
   type: 'device-type-here',
 };

 (async () => {
   const {data, res} = await alarmService.create(mandantoryObject);
 })();

    Parameters

    • entity: IAlarm

      Alarm object with mandantory fragments.

    Returns Promise<IResult<IAlarm>>

    Response wrapped in IResult

detail

  • Gets the details of selected alarms.

    example
    
   const alarmId: number = 1;

   (async () => {
     const {data, res} = await alarmService.detail(alarmId);
   })();

    Parameters

    • entityOrId: string | number | IIdentified

      Entity or Id of the entity.

    Returns Promise<IResult<IAlarm>>

    Response wrapped in IResult

list

  • Gets the list of alarms filtered by parameters.

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

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

    Parameters

    • Default value filter: object = {}

      Object containing filters for querying alarms.

    Returns Promise<IResultList<IAlarm>>

    Response wrapped in IResultList

list$

  • Gets a list as observable.

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

    Parameters

    • Default value filter: object = {}

      Object containing filters for querying

    • Default value options: IObservableOptions = {}

      To configure the observable

    Returns ObservableList<IAlarm>

    Data wrapped as ObservableList

listBySource$

  • List all events by a given source.

    example
    
  const listBySource$ = alarmService.listBySource$(11);
  listBySource$.subscribe((data) => console.log(data));

    Parameters

    • sourceOrId: string | number | IIdentified

      The source of the event.

    • Default value filter: object = {}

      Object containing filters for querying.

    • Default value options: IObservableOptions = {}

      To configure the observable.

    Returns ObservableList<IAlarm>

    Data wrapped as ObservableList

update

  • Updates alarm data.

    example
    
 const partialUpdateObject: Partial<IAlarm> = {
   severity: Severity.MINOR,
   source: device,
   text: 'Changed Alarm!'
 };

 (async () => {
   const {data, res} = await alarmService.update(partialUpdateObject);
 })();

    Parameters

    • entity: Partial<IAlarm>

      Alarm is partially updatable.

    Returns Promise<IResult<IAlarm>>

    Response wrapped in IResult

Generated using TypeDoc