Alarm Action Builder

AlarmActionBuilder

AlarmActionBuilder Objects

class AlarmActionBuilder()

Defines the builder to execute alarm actions

constructor

function constructor()

Arguments:

• ogapi InternalOpenGateAPI - this is configuration about Opengate North API.
• action string - This action can be ATTEND or CLOSE

addAlarmId

function addAlarmId(alarmId: string) -> 'AlarmActionBuilder'

Add alarmId to operation

Arguments:

• alarmId string - AlarmId of Alarm

Returns:

• AlarmActionBuilder

Example:

ogapi.alarms.builderFactory.newAlarmCloseBuilder().addAlarmId("")

build

function build() -> 'Operation'

Build a instance of Operation

Returns:

• Operation

Example:

ogapi.operations.builderFactory.newAlarmCloseBuilder().build()

withNotes

function withNotes(notes: string) -> 'AlarmActionBuilder'

Add notes to operation

Arguments:

• notes string - Notes about operation

Returns:

• AlarmActionBuilder

Example:

ogapi.operations.builderFactory.newAlarmCloseBuilder().withNotes("")