Options
All
  • Public
  • Public/Protected
  • All
Menu

  subscribe now with sterfive to access the online-user manual

Hierarchy

Index

Constructors

constructor

  • new UAMethod(options?: EventEmitterOptions): UAMethod
  • Parameters

    • Optional options: EventEmitterOptions

    Returns UAMethod

Properties

Optional _getExecutableFlag

_getExecutableFlag: (sessionContext: SessionContext) => boolean

Type declaration

Readonly addressSpace

addressSpace: AddressSpace

Readonly browseName

browseName: QualifiedName

Readonly description

description: LocalizedText

Readonly displayName

displayName: LocalizedText[]

Optional Readonly inputArguments

inputArguments: UAVariable

Readonly methodDeclarationId

methodDeclarationId: NodeId

Optional Readonly modellingRule

modellingRule: ModellingRuleType

Readonly namespace

namespace: Namespace

Readonly namespaceIndex

namespaceIndex: number

Readonly namespaceUri

namespaceUri: string

Readonly nodeClass

nodeClass: Method

Readonly nodeId

nodeId: NodeId

Optional onFirstBrowseAction

onFirstBrowseAction: () => Promise<void>

Type declaration

    • (): Promise<void>
    • Returns Promise<void>

Optional Readonly outputArguments

outputArguments: UAVariable

Readonly parent

parent: UAObject

Optional Readonly parentNodeId

parentNodeId: NodeId

Readonly typeDefinitionObj

typeDefinitionObj: UAObjectType

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

addListener

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

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

          • Rest ...args: any[]

          Returns void

    Returns UAMethod

addReference

allReferences

bindMethod

browseNode

clone

  • clone(options: any, optionalFilter?: any, extraInfo?: any): UAMethod

emit

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

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

    Returns boolean

eventNames

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

execute

findReference

  • findReference(strReference: string, isForward?: boolean): UAReference

findReferences

findReferencesAsObject

  • findReferencesAsObject(strReference: string, isForward: boolean): BaseNode[]

findReferencesEx

findReferencesExAsObject

fullName

  • fullName(): string

getChildByName

getEventSourceOfs

getEventSources

getExecutableFlag

getInputArguments

getMaxListeners

  • getMaxListeners(): number

getOutputArguments

install_extra_properties

  • install_extra_properties(): void

isBound

  • isBound(): 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): UAMethod
  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns UAMethod

on

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

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

          • Rest ...args: any[]

          Returns void

    Returns UAMethod

once

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

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

          • Rest ...args: any[]

          Returns void

    Returns UAMethod

prependListener

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

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

          • Rest ...args: any[]

          Returns void

    Returns UAMethod

prependOnceListener

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

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

          • Rest ...args: any[]

          Returns void

    Returns UAMethod

propagate_back_references

  • propagate_back_references(): void

rawListeners

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

    • event: string | symbol

    Returns Function[]

readAttribute

removeAllListeners

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

removeListener

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

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

          • Rest ...args: any[]

          Returns void

    Returns UAMethod

removeReference

setMaxListeners

setPermissions

writeAttribute

  • writeAttribute(context: SessionContext, writeValue: any, callback: (err: Error, statusCode?: StatusCode) => void): 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