Interface UARoleSet

subscribe now with sterfive to access the online-user manual

Hierarchy

UAObject
- UARoleSet

Index

Properties

Methods

Properties

addRole

addRole: UAMethod

The AddRole Method allows configuration Clients to add a new Role to the Server.

Readonly addressSpace

addressSpace: AddressSpace

Readonly browseName

browseName: QualifiedName

Readonly description

description: LocalizedText

Readonly displayName

displayName: LocalizedText[]

Readonly hasMethods

hasMethods: boolean

Optional Readonly modellingRule

modellingRule: ModellingRuleType

Readonly namespace

namespace: Namespace

Readonly namespaceIndex

namespaceIndex: number

Readonly namespaceUri

namespaceUri: string

Readonly nodeClass

nodeClass: Object

Readonly nodeId

nodeId: NodeId

Optional onFirstBrowseAction

onFirstBrowseAction: () => Promise<void>

Type declaration

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

parent

parent: BaseNode

Optional Readonly parentNodeId

parentNodeId: NodeId

removeRole

removeRole: UAMethod

The RemoveRole Method allows configuration Clients to remove a Role from the Server

typeDefinition

typeDefinition: NodeId

typeDefinitionObj

typeDefinitionObj: UAObjectType

Methods

addListener

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

Inherited from UAObject.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 UARoleSet

addReference

addReference(options: AddReferenceOpts): void

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

allReferences

allReferences(): Reference[]

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

browseNode

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

Inherited from UAObject.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): UAObject

Inherited from UAObject.clone
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:788
Parameters
- options: any
- Optional optionalFilter: any
- Optional extraInfo: any
Returns UAObject

emit

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

Inherited from UAObject.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 UAObject.eventNames
- Defined in node_modules/@types/node/events.d.ts:77
Returns (string | symbol)[]

findReference

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

Inherited from UAObject.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 UAObject.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 UAObject.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 UAObject.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 UAObject.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 UAObject.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

getAggregates

getAggregates(): BaseNode[]

Inherited from UAObject.getAggregates
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:281
Returns BaseNode[]

getChildByName

getChildByName(browseName: string | QualifiedName): BaseNode

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

getComponentByName

getComponentByName(componentName: QualifiedNameLike, namespaceIndex?: number): UAObject | UAVariable

Inherited from UAObject.getComponentByName
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:277
Parameters
- componentName: QualifiedNameLike
- Optional namespaceIndex: number
Returns UAObject | UAVariable

getComponents

getComponents(): BaseNode[]

Inherited from UAObject.getComponents
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:283
Returns BaseNode[]

getEventSourceOfs

getEventSourceOfs(): BaseNode[]

Inherited from UAObject.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 UAObject.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[]

getFolderElementByName

getFolderElementByName(browseName: string, namespaceIndex?: number): BaseNode

Inherited from UAObject.getFolderElementByName
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:775
Parameters
- browseName: string
- Optional namespaceIndex: number
Returns BaseNode

getMaxListeners

getMaxListeners(): number

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

getMethodById

getMethodById(nodeId: NodeId): UAMethod

Inherited from UAObject.getMethodById
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:778
Parameters
- nodeId: NodeId
Returns UAMethod

getMethodByName

getMethodByName(methodName: string): UAMethod

Inherited from UAObject.getMethodByName
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:780
Parameters
- methodName: string
Returns UAMethod

getMethods

getMethods(): UAMethod[]

Inherited from UAObject.getMethods
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:782
Returns UAMethod[]

getNotifiers

getNotifiers(): BaseNode[]

Inherited from UAObject.getNotifiers
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:287
Returns BaseNode[]

getProperties

getProperties(): BaseNode[]

Inherited from UAObject.getProperties
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:285
Returns BaseNode[]

getPropertyByName

getPropertyByName(browseName: string, namespaceIndex?: number): UAVariable

Inherited from UAObject.getPropertyByName
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:279
Parameters
- browseName: string
- Optional namespaceIndex: number
Returns UAVariable

install_extra_properties

install_extra_properties(): void

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

listenerCount

listenerCount(event: string | symbol): number

Inherited from UAObject.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 UAObject.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): UARoleSet

Inherited from UAObject.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 UARoleSet

on

on(eventName: "event", eventHandler: (eventData: IEventData) => void): UARoleSet

Inherited from UAObject.on
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:786
Parameters
- eventName: "event"
- eventHandler: (eventData: IEventData) => void
  - - (eventData: IEventData): void
    - Parameters
      - eventData: IEventData
      Returns void
Returns UARoleSet

once

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

Inherited from UAObject.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 UARoleSet

prependListener

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

Inherited from UAObject.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 UARoleSet

prependOnceListener

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

Inherited from UAObject.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 UARoleSet

propagate_back_references

propagate_back_references(): void

Inherited from UAObject.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

raiseEvent

raiseEvent(eventType: EventTypeLike, eventData: RaiseEventData): void

Inherited from UAObject.raiseEvent
- Defined in packages/node-opcua-address-space/source/address_space_ts.ts:784
Parameters
- eventType: EventTypeLike
- eventData: RaiseEventData
Returns void

rawListeners

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

Inherited from UAObject.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 UAObject.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): UARoleSet

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

removeListener

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

Inherited from UAObject.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 UARoleSet

removeReference

removeReference(referenceOpts: AddReferenceOpts): void

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

setMaxListeners

setMaxListeners(n: number): UARoleSet

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

writeAttribute

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

Inherited from UAObject.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

Generated using TypeDoc