Options
All
  • Public
  • Public/Protected
  • All
Menu

  subscribe now with sterfive to access the online-user manual

The Properties and Methods of the Role contain sensitive security related information and shall only be browse-able, writeable and callable by authorized administrators through an encrypted channel.

Hierarchy

Index

Properties

Optional addApplication

addApplication: UAMethod

The AddApplication Method adds an Application Instance Certificate to the list of. If the Server does not enforce application restrictions or does not allow changes to the mapping rules for the Role the Method is not present.

Optional addEndpoint

addEndpoint: UAMethod

Optional addIdentity

addIdentity: UAMethod

The AddIdentity Method adds a rule used to map a UserIdentityToken to the Role. If the Server does not allow changes to the mapping rules, then the Method is not present. A Server should prevent certain rules from being added to particular Roles. For example, a Server should refuse to allow an ANONYMOUS_5 (see F.3.2) mapping rule to be added to Roles with administrator privileges.

Readonly addressSpace

addressSpace: AddressSpace

Optional applications

applications: UAVariableT<string, String>

The Applications Property specifies the Application Instance Certificates of Clients which shall be included or excluded from this Role. Each element in the array is an ApplicationUri from a Client Certificate which is trusted by the Server.

Optional applicationsExclude

applicationsExclude: UAVariableT<boolean, Boolean>

The ApplicationsExclude Property defines the Applications Property as an include list or exclude list. If this Property is not provided or has a value of FALSE then only Application Instance Certificates included in the Applications Property shall be included in this Role. All other Application Instance Certificates shall not be included in this Role. If this Property has a value of TRUE then all Application Instance Certificates included in the Applications Property shall be excluded from this Role. All other Application Instance Certificates shall be included in this Role.

Readonly browseName

browseName: QualifiedName

Readonly description

description: LocalizedText

Readonly displayName

displayName: LocalizedText[]

Optional endpoints

endpoints: UAVariable

The Endpoints Property specifies the Endpoints which shall be included or excluded from this Role. The value is an EndpointType array which contains one or more Endpoint descriptions. The EndpointType DataType is defined in 12.22.

Optional endpointsExclude

endpointsExclude: UAVariableT<boolean, Boolean>

The EndpointsExclude Property defines the Endpoints Property as an include list or exclude list. If this Property is not provided or has a value of FALSE then only Endpoints included in the Endpoints Property shall be included in this Role. All other Endpoints shall not be include this Role. If this Property has a value of TRUE then all Endpoints included in the Endpoints Property shall be excluded from this Role. All other Endpoints shall be included in this Role.

Readonly hasMethods

hasMethods: boolean

identities

The Identities Property specifies the currently configured rules for mapping a UserIdentityToken to the Role. If this Property is an empty array, then the Role cannot be granted to any Session.

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

Optional removeApplication

removeApplication: UAMethod

The RemoveApplication Method removes an Application Instance Certificate from the list of applications. If the Server does not enforce application restrictions or does not allow changes to the mapping rules for the Role the Method is not present.

Optional removeEndpoint

removeEndpoint: UAMethod

Optional removeIdentity

removeIdentity: UAMethod

The RemoveIdentity Method removes a mapping rule used to map a UserIdentityToken to the Role. If the Server does not allow changes to the mapping rules, then the Method is not present

typeDefinition

typeDefinition: NodeId

typeDefinitionObj

typeDefinitionObj: UAObjectType

Methods

addListener

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

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

          • Rest ...args: any[]

          Returns void

    Returns Role

addReference

allReferences

browseNode

clone

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

emit

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

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

    Returns boolean

eventNames

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

findReference

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

findReferences

findReferencesAsObject

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

findReferencesEx

findReferencesExAsObject

fullName

  • fullName(): string

getAggregates

getChildByName

getComponentByName

getComponents

getEventSourceOfs

getEventSources

getFolderElementByName

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

getMaxListeners

  • getMaxListeners(): number

getMethodById

getMethodByName

  • getMethodByName(methodName: string): UAMethod

getMethods

getNotifiers

getProperties

getPropertyByName

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

install_extra_properties

  • install_extra_properties(): void

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): Role
  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns Role

on

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

once

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

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

          • Rest ...args: any[]

          Returns void

    Returns Role

prependListener

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

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

          • Rest ...args: any[]

          Returns void

    Returns Role

prependOnceListener

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

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

          • Rest ...args: any[]

          Returns void

    Returns Role

propagate_back_references

  • propagate_back_references(): void

raiseEvent

rawListeners

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

    • event: string | symbol

    Returns Function[]

readAttribute

removeAllListeners

  • removeAllListeners(event?: string | symbol): Role
  • Parameters

    • Optional event: string | symbol

    Returns Role

removeListener

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

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

          • Rest ...args: any[]

          Returns void

    Returns Role

removeReference

setMaxListeners

  • setMaxListeners(n: number): Role

writeAttribute

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

Generated using TypeDoc