Appearition Platform JS

Namespace: Alarms

Appearition.Alarms

Use the functions under this module to add alarms into your solution

Version:
  • 1.0.0
Author:
  • Appearition Pty Ltd
Copyright:
  • Copyright (c) 2019. All rights reserved

Methods

Appearition.Alarms.CheckForAlarms (request, requestOptions) static

Checks if any alarms have occured as configured on the Appearition platform

Name Type Description
request Appearition.Alarms.CheckForAlarmsRequest

contains a collection of categories and their probability of being true
requestOptions Appearition.RequestOptions

configure callbacks

Type Definitions

Appearition.Alarms.CheckForAlarmsRequest

Holds the collection of categories and their probability to check if any alarms have been tripped

Properties:
Name Type Description
categories Array.<Appearition.Alarms.CheckForAlarmsRequestParam>

A collection of categories and their probability of being true

Appearition.Alarms.CheckForAlarmsRequestParam

A Key Value pair that is used in the paras member of the EventLoggerRequest

Properties:
Name Type Description
category string

any string value that represents a category
probability number

a float value representing the likelihood if the category is true