⚠️ You are reading documentation for an OLD version (v2.68.0). The current released version is v2.173.1. View latest documentation →

Class ClientAlarm

subscribe now with sterfive to access the online-user manual

describes a OPCUA Alarm as seen in the client side

Hierarchy

EventEmitter
- ClientAlarm

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ClientAlarm(eventFields: EventStuff): ClientAlarm

- Defined in node-opcua-client/dist/alarms_and_conditions/client_alarm.d.ts:37
Parameters
- eventFields: EventStuff
Returns ClientAlarm

Properties

conditionId

conditionId: NodeId

eventId

eventId: Buffer

eventType

eventType: NodeId

fields

fields: EventStuff

Methods

acknowledge

acknowledge(session: ClientSession, comment: string): Promise<StatusCode>

- Defined in node-opcua-client/dist/alarms_and_conditions/client_alarm.d.ts:27
Parameters
- session: ClientSession
- comment: string
Returns Promise<StatusCode>

confirm

confirm(session: ClientSession, comment: string): Promise<StatusCode>

- Defined in node-opcua-client/dist/alarms_and_conditions/client_alarm.d.ts:38
Parameters
- session: ClientSession
- comment: string
Returns Promise<StatusCode>

getRetain

getRetain(): boolean

- Defined in node-opcua-client/dist/alarms_and_conditions/client_alarm.d.ts:40
Returns boolean

on

on(eventName: "changed", eventHandler: () => void): ClientAlarm

- Defined in node-opcua-client/dist/alarms_and_conditions/client_alarm.d.ts:26
Parameters
- eventName: "changed"
- eventHandler: () => void
  - - (): void
    - Returns void
Returns ClientAlarm

update

update(eventFields: EventStuff): void

- Defined in node-opcua-client/dist/alarms_and_conditions/client_alarm.d.ts:39
Parameters
- eventFields: EventStuff
Returns void

Generated using TypeDoc