UAMethod | NodeOPCUA reference documentation

Hierarchy

BaseNode
- UAMethod

Index

Constructors

constructor

Methods

Constructors

constructor

new UAMethod(options?: EventEmitterOptions): UAMethod

Inherited from BaseNode.constructor
- Defined in node_modules/@types/node/events.d.ts:23
Parameters
- Optional options: EventEmitterOptions
Returns UAMethod

Properties

Optional _getExecutableFlag

_getExecutableFlag: (sessionContext: SessionContext) => boolean

Type declaration

- (sessionContext: SessionContext): boolean
- Parameters
  - sessionContext: SessionContext
  Returns boolean

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

Inherited from BaseNode.addListener
- Defined in node_modules/@types/node/events.d.ts:62
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns UAMethod

addReference

addReference(options: AddReferenceOpts): void

Inherited from BaseNode.addReference
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:158
Parameters
- options: AddReferenceOpts
Returns void

allReferences

allReferences(): Reference[]

Inherited from BaseNode.allReferences
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:199
Returns Reference[]

bindMethod

bindMethod(methodFunction: MethodFunctor): void

- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:825
Parameters
- methodFunction: MethodFunctor
Returns void

browseNode

browseNode(browseDescription: BrowseDescriptionOptions, session?: SessionContext): ReferenceDescription[]

Inherited from BaseNode.browseNode
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:220
browse the node to extract information requested in browseDescription

method

browseNode

Parameters
- browseDescription: BrowseDescriptionOptions
- Optional session: SessionContext
Returns ReferenceDescription[]

clone

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

- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:843
Parameters
- options: any
- Optional optionalFilter: any
- Optional extraInfo: any
Returns UAMethod

emit

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

Inherited from BaseNode.emit
- Defined in node_modules/@types/node/events.d.ts:72
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): (string | symbol)[]

Inherited from BaseNode.eventNames
- Defined in node_modules/@types/node/events.d.ts:77
Returns (string | symbol)[]

execute

execute(inputArguments: VariantOptions[], context: SessionContext, callback: MethodFunctorCallback): void
execute(inputArguments: VariantOptions[], context: SessionContext): Promise<CallMethodResultOptions>

- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:839
async

Parameters
- inputArguments: VariantOptions[]
- context: SessionContext
- callback: MethodFunctorCallback
Returns void
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:841
Parameters
- inputArguments: VariantOptions[]
- context: SessionContext
Returns Promise<CallMethodResultOptions>

findReference

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

Inherited from BaseNode.findReference
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:193
Parameters
- strReference: string
- Optional isForward: boolean
Returns UAReference

findReferences

findReferences(referenceType: string | NodeId | UAReferenceType, isForward?: boolean): UAReference[]

Inherited from BaseNode.findReferences
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:191
Parameters
- referenceType: string | NodeId | UAReferenceType
- Optional isForward: boolean
Returns UAReference[]

findReferencesAsObject

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

Inherited from BaseNode.findReferencesAsObject
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:197
Parameters
- strReference: string
- isForward: boolean
Returns BaseNode[]

findReferencesEx

findReferencesEx(strReference: string, browseDirection?: BrowseDirection): UAReference[]

Inherited from BaseNode.findReferencesEx
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:189
Parameters
- strReference: string
- Optional browseDirection: BrowseDirection
Returns UAReference[]

findReferencesExAsObject

findReferencesExAsObject(strReference: string, browseDirection?: BrowseDirection): BaseNode[]

Inherited from BaseNode.findReferencesExAsObject
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:195
Parameters
- strReference: string
- Optional browseDirection: BrowseDirection
Returns BaseNode[]

fullName

fullName(): string

Inherited from BaseNode.fullName
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:156
return a complete name of this object by pre-pending name of its parent(s) to its own name

Returns string

getChildByName

getChildByName(browseName: string | QualifiedName): BaseNode

Inherited from BaseNode.getChildByName
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:201
Parameters
- browseName: string | QualifiedName
Returns BaseNode

getEventSourceOfs

getEventSourceOfs(): BaseNode[]

Inherited from BaseNode.getEventSourceOfs
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:185
return a array of the objects for which this node is an EventSource nodes = HasEventSource => self

Returns BaseNode[]

getEventSources

getEventSources(): BaseNode[]

Inherited from BaseNode.getEventSources
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:179
return a array with the event source of this object. self = HasEventSource => nodes

Returns BaseNode[]

getExecutableFlag

getExecutableFlag(context: ISessionContext): boolean

- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:827
Parameters
- context: ISessionContext
Returns boolean

getInputArguments

getInputArguments(): Argument[]

- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:829
Returns Argument[]

getMaxListeners

getMaxListeners(): number

Inherited from BaseNode.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:69
Returns number

getOutputArguments

getOutputArguments(): Argument[]

- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:831
Returns Argument[]

install_extra_properties

install_extra_properties(): void

Inherited from BaseNode.install_extra_properties
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:187
Returns void

isBound

isBound(): boolean

- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:845
Returns boolean

listenerCount

listenerCount(event: string | symbol): number

Inherited from BaseNode.listenerCount
- Defined in node_modules/@types/node/events.d.ts:73
Parameters
- event: string | symbol
Returns number

listeners

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

Inherited from BaseNode.listeners
- Defined in node_modules/@types/node/events.d.ts:70
Parameters
- event: string | symbol
Returns Function[]

off

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

Inherited from BaseNode.off
- Defined in node_modules/@types/node/events.d.ts:66
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

Inherited from BaseNode.on
- Defined in node_modules/@types/node/events.d.ts:63
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

Inherited from BaseNode.once
- Defined in node_modules/@types/node/events.d.ts:64
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

Inherited from BaseNode.prependListener
- Defined in node_modules/@types/node/events.d.ts:75
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

Inherited from BaseNode.prependOnceListener
- Defined in node_modules/@types/node/events.d.ts:76
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

Inherited from BaseNode.propagate_back_references
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:207
this methods propagates the forward references to the pointed node by inserting backward references to the counter part node

Returns void

rawListeners

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

Inherited from BaseNode.rawListeners
- Defined in node_modules/@types/node/events.d.ts:71
Parameters
- event: string | symbol
Returns Function[]

readAttribute

readAttribute(context: SessionContext, attributeId: AttributeIds, indexRange?: NumericRange, dataEncoding?: QualifiedNameLike): DataValue

Inherited from BaseNode.readAttribute
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:162
Parameters
- context: SessionContext
- attributeId: AttributeIds
- Optional indexRange: NumericRange
- Optional dataEncoding: QualifiedNameLike
Returns DataValue

removeAllListeners

removeAllListeners(event?: string | symbol): UAMethod

Inherited from BaseNode.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:67
Parameters
- Optional event: string | symbol
Returns UAMethod

removeListener

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

Inherited from BaseNode.removeListener
- Defined in node_modules/@types/node/events.d.ts:65
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns UAMethod

removeReference

removeReference(referenceOpts: AddReferenceOpts): void

Inherited from BaseNode.removeReference
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:160
Parameters
- referenceOpts: AddReferenceOpts
Returns void

setMaxListeners

setMaxListeners(n: number): UAMethod

Inherited from BaseNode.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:68
Parameters
- n: number
Returns UAMethod

setPermissions

setPermissions(permissions: Permissions): void

- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:823
Parameters
- permissions: Permissions
Returns void

writeAttribute

writeAttribute(context: SessionContext, writeValue: any, callback: (err: Error, statusCode?: StatusCode) => void): void

Inherited from BaseNode.writeAttribute
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:169
Parameters
- context: SessionContext
- writeValue: any
- callback: (err: Error, statusCode?: StatusCode) => void
  - - (err: Error, statusCode?: StatusCode): void
    - Parameters
      - err: Error
      - Optional statusCode: StatusCode
      Returns void
Returns void

Static listenerCount

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

Inherited from BaseNode.listenerCount
- Defined in node_modules/@types/node/events.d.ts:31
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Static on

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

Inherited from BaseNode.on
- Defined in node_modules/@types/node/events.d.ts:28
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[]>

Inherited from BaseNode.once
- Defined in node_modules/@types/node/events.d.ts:26
Parameters
- emitter: NodeEventTarget
- event: string | symbol
Returns Promise<any[]>
Inherited from BaseNode.once
- Defined in node_modules/@types/node/events.d.ts:27
Parameters
- emitter: DOMEventTarget
- event: string
Returns Promise<any[]>

subscribe now with sterfive to access the online-user manual

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional options: EventEmitterOptions

Returns UAMethod

Properties

Optional _getExecutableFlag

Type declaration

Parameters

sessionContext: SessionContext

Returns boolean

Readonly addressSpace

Readonly browseName

Readonly description

Readonly displayName

Optional Readonly inputArguments

Readonly methodDeclarationId

Optional Readonly modellingRule

Readonly namespace

Readonly namespaceIndex

Readonly namespaceUri

Readonly nodeClass

Readonly nodeId

Optional onFirstBrowseAction

Type declaration

Returns Promise<void>

Optional Readonly outputArguments

Readonly parent

Optional Readonly parentNodeId

Readonly typeDefinitionObj

Readonly Static captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Readonly Static errorMonitor

Methods

addListener

Parameters

event: string | symbol

listener: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Returns UAMethod

addReference

Parameters

options: AddReferenceOpts

Returns void

allReferences

Returns Reference[]

bindMethod

Parameters

methodFunction: MethodFunctor

Returns void

browseNode

Parameters

browseDescription: BrowseDescriptionOptions

Optional session: SessionContext

Returns ReferenceDescription[]

clone

Parameters

options: any

Optional optionalFilter: any

Optional extraInfo: any

Returns UAMethod

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames

Returns (string | symbol)[]

execute

Parameters

inputArguments: VariantOptions[]