import AlarmActionBuilder from 'opengate-js/src/alarms/actions/AlarmActionBuilder.js'AlarmActionBuilder
Direct Subclass:
Defines the builder to execute alarm actions
Constructor Summary
| Public Constructor | ||
| public |
constructor(ogapi: InternalOpenGateAPI, action: string) |
|
Method Summary
| Public Methods | ||
| public |
addAlarmId(alarmId: string): AlarmActionBuilder Add alarmId to operation |
|
| public |
Build a instance of Operation |
|
| public |
withNotes(notes: string): AlarmActionBuilder Add notes to operation |
|
Public Constructors
public constructor(ogapi: InternalOpenGateAPI, action: string) source
Params:
| Name | Type | Attribute | Description |
| ogapi | InternalOpenGateAPI |
|
this is configuration about Opengate North API. |
| action | string |
|
This action can be ATTEND or CLOSE |
Public Methods
public addAlarmId(alarmId: string): AlarmActionBuilder source
Add alarmId to operation
Params:
| Name | Type | Attribute | Description |
| alarmId | string |
|
AlarmId of Alarm |
Throw:
throw error when alarmId is not typeof string |
Example:
ogapi.alarms.builderFactory.newAlarmCloseBuilder().addAlarmId("")public build(): Operation source
Build a instance of Operation
Throw:
Throw error if there is not alarmId |
Example:
ogapi.operations.builderFactory.newAlarmCloseBuilder().build()public withNotes(notes: string): AlarmActionBuilder source
Add notes to operation
Params:
| Name | Type | Attribute | Description |
| notes | string |
|
Notes about operation |
Throw:
throw error when notes is not typeof string |
Example:
ogapi.operations.builderFactory.newAlarmCloseBuilder().withNotes("")