Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Properties

Methods

Constructors

constructor

  • Parameters

    Returns ClientAlarm

Properties

conditionId

conditionId: NodeId

eventId

eventId: Buffer

eventType

eventType: NodeId

fields

fields: EventStuff

Readonly Static captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Readonly Static errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Methods

acknowledge

  • Parameters

    Returns Promise<StatusCode>

addListener

  • addListener(event: string | symbol, listener: (...args: any[]) => void): ClientAlarm

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ClientAlarm

confirm

  • Parameters

    Returns Promise<StatusCode>

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]

  • Returns (string | symbol)[]

getMaxListeners

  • getMaxListeners(): number

  • Returns number

getRetain

  • getRetain(): boolean

  • Returns boolean

listenerCount

  • listenerCount(event: string | symbol): number

  • Parameters

    • event: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

off

  • off(event: string | symbol, listener: (...args: any[]) => void): ClientAlarm

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ClientAlarm

on

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

  • Parameters

    • eventName: "changed"
    • eventHandler: () => void
        • (): void

        • Returns void

    Returns ClientAlarm

once

  • once(event: string | symbol, listener: (...args: any[]) => void): ClientAlarm

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ClientAlarm

prependListener

  • prependListener(event: string | symbol, listener: (...args: any[]) => void): ClientAlarm

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ClientAlarm

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): ClientAlarm

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ClientAlarm

rawListeners

  • rawListeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

  • removeAllListeners(event?: string | symbol): ClientAlarm

  • Parameters

    • Optional event: string | symbol

    Returns ClientAlarm

removeListener

  • removeListener(event: string | symbol, listener: (...args: any[]) => void): ClientAlarm

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ClientAlarm

setMaxListeners

  • Parameters

    • n: number

    Returns ClientAlarm

update

  • Parameters

    Returns void

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Static on

  • on(emitter: EventEmitter, event: string): AsyncIterableIterator<any>

  • Parameters

    • emitter: EventEmitter
    • event: string

    Returns AsyncIterableIterator<any>

Static once

  • once(emitter: NodeEventTarget, event: string | symbol): Promise<any[]>
  • once(emitter: DOMEventTarget, event: string): Promise<any[]>

  • Parameters

    • emitter: NodeEventTarget
    • event: string | symbol

    Returns Promise<any[]>

  • Parameters

    • emitter: DOMEventTarget
    • event: string

    Returns Promise<any[]>

Generated using TypeDoc