NodeOPCUA API Documentation
    Preparing search index...

    Interface UAAcknowledgeableCondition
    namespace http://opcfoundation.org/UA/
    nodeClass ObjectType
    typedDefinition AcknowledgeableConditionType i=2881
    isAbstract false
    interface UAAcknowledgeableCondition {
        accessRestrictions: AccessRestrictionsFlag | undefined;
        ackedState: UATwoStateVariable<LocalizedText>;
        acknowledge: UAMethod;
        addComment: UAMethod;
        addressSpace: IAddressSpace;
        branchId: UAProperty<NodeId, NodeId>;
        browseName: QualifiedName;
        clientUserId: UAProperty<UAString, String>;
        comment: UAConditionVariable<LocalizedText, LocalizedText>;
        conditionClassId: UAProperty<NodeId, NodeId>;
        conditionClassName: UAProperty<LocalizedText, LocalizedText>;
        conditionName: UAProperty<UAString, String>;
        conditionRefresh: UAMethod;
        conditionRefresh2: UAMethod;
        conditionSubClassId?: UAProperty<NodeId[], NodeId>;
        conditionSubClassName?: UAProperty<LocalizedText[], LocalizedText>;
        confirm?: UAMethod<UAMethodEvents>;
        confirmedState?: UATwoStateVariable<LocalizedText>;
        declaredAccessRestrictions?: string;
        description: LocalizedText;
        designToolOnly?: boolean;
        disable: UAMethod;
        displayName: LocalizedText[];
        enable: UAMethod;
        enabledState: UATwoStateVariable<LocalizedText>;
        eventId: UAProperty<Buffer<ArrayBufferLike>, ByteString>;
        eventNotifier: EventNotifierFlags;
        eventType: UAProperty<NodeId, NodeId>;
        hasMethods: boolean;
        lastSeverity: UAConditionVariable<number, UInt16>;
        localTime?: UAProperty<DTTimeZone, ExtensionObject>;
        message: UAProperty<LocalizedText, LocalizedText>;
        modellingRule: ModellingRuleType | undefined;
        namespace: INamespace;
        namespaceIndex: number;
        namespaceUri: string;
        nodeClass: Object;
        nodeId: NodeId;
        nodesetCategory?: string[];
        nodesetDocumentation?: string;
        onFirstBrowseAction?: (this: BaseNode) => Promise<void>;
        parent: BaseNode<BaseNodeEvents> | null;
        parentNodeId: NodeId | undefined;
        quality: UAConditionVariable<StatusCode, StatusCode>;
        receiveTime: UAProperty<Date, DateTime>;
        releaseStatus?: "Draft" | "Deprecated";
        retain: UAProperty<boolean, Boolean>;
        rolePermissions: RolePermissionType[] | undefined;
        severity: UAProperty<number, UInt16>;
        sourceName: UAProperty<UAString, String>;
        sourceNode: UAProperty<NodeId, NodeId>;
        supportsFilteredRetain: UAProperty<boolean, Boolean>;
        time: UAProperty<Date, DateTime>;
        typeDefinition: NodeId;
        typeDefinitionObj: UAObjectType;
        addReference(options: AddReferenceOpts): void;
        allReferences(): UAReference[];
        browseNode(
            browseDescription: BrowseDescriptionOptions2,
            session?: ISessionContext,
        ): ReferenceDescription[];
        browseNodeByTargetName(
            relativePathElement: RelativePathElement,
            isLast: boolean,
        ): NodeId[];
        clone(
            options: CloneOptions,
            optionalFilter?: CloneFilter,
            extraInfo?: CloneExtraInfo,
        ): UAObject;
        emit<K extends keyof UAObjectEvents>(
            event: K,
            ...args: Parameters<UAObjectEvents[K]>,
        ): boolean;
        findReference(
            referenceType: string | NodeId | UAReferenceType,
            isForward?: boolean,
        ): UAReference | null;
        findReferences(
            referenceType: string | NodeId | UAReferenceType,
            isForward?: boolean,
        ): UAReference[];
        findReferencesAsObject(
            referenceType: string | NodeId | UAReferenceType,
            isForward?: boolean,
        ): BaseNode<BaseNodeEvents>[];
        findReferencesEx(
            referenceType: string | NodeId | UAReferenceType,
            browseDirection?: BrowseDirection,
        ): UAReference[];
        findReferencesExAsObject(
            referenceType: string | NodeId | UAReferenceType,
            browseDirection?: BrowseDirection,
        ): BaseNode<BaseNodeEvents>[];
        fullName(): string;
        getAccessRestrictions(inherited: boolean): AccessRestrictionsFlag;
        getAggregates(): BaseNode<BaseNodeEvents>[];
        getChildByName(
            browseName: QualifiedNameOptions,
        ): BaseNode<BaseNodeEvents> | null;
        getChildByName(
            browseName: string,
            namespaceIndex?: number,
        ): BaseNode<BaseNodeEvents> | null;
        getComponentByName(
            componentName: QualifiedNameOptions,
        ): UAObject<UAObjectEvents> | UAVariable<UAVariableEvents> | null;
        getComponentByName(
            componentName: string,
            namespaceIndex?: number,
        ): UAObject<UAObjectEvents> | UAVariable<UAVariableEvents> | null;
        getComponents(): BaseNode<BaseNodeEvents>[];
        getDisplayName(locale?: string): string;
        getEventSourceOfs(): BaseNode<BaseNodeEvents>[];
        getEventSources(): BaseNode<BaseNodeEvents>[];
        getFolderElementByName(
            browseName: QualifiedNameOptions,
        ): BaseNode<BaseNodeEvents> | null;
        getFolderElementByName(
            browseName: string,
            namespaceIndex?: number,
        ): BaseNode<BaseNodeEvents> | null;
        getMethodById(nodeId: NodeId): UAMethod<UAMethodEvents> | null;
        getMethodByName(
            methodName: QualifiedNameOptions,
        ): UAMethod<UAMethodEvents> | null;
        getMethodByName(
            methodName: string,
            namespaceIndex?: number,
        ): UAMethod<UAMethodEvents> | null;
        getMethods(): UAMethod<UAMethodEvents>[];
        getNodeVersion(): UAProperty<UAString, String> | null;
        getNotifiers(): BaseNode<BaseNodeEvents>[];
        getProperties(): BaseNode<BaseNodeEvents>[];
        getPropertyByName(
            propertyName: QualifiedNameOptions,
        ): UAVariable<UAVariableEvents> | null;
        getPropertyByName(
            propertyName: string,
            namespaceIndex?: number,
        ): UAVariable<UAVariableEvents> | null;
        getRolePermissions(inherited: boolean): RolePermissionType[] | null;
        install_extra_properties(): void;
        isDisposed(): boolean;
        listenerCount<K extends keyof UAObjectEvents>(event: K): number;
        off<K extends keyof UAObjectEvents>(
            event: K,
            listener: UAObjectEvents[K],
        ): this;
        on<K extends keyof UAObjectEvents>(
            event: K,
            listener: UAObjectEvents[K],
        ): this;
        once<K extends keyof UAObjectEvents>(
            event: K,
            listener: UAObjectEvents[K],
        ): this;
        raiseEvent(
            eventType: BaseNode<BaseNodeEvents> | EventTypeLike,
            eventData: RaiseEventData,
        ): void;
        readAttribute(
            context: ISessionContext | null,
            attributeId: AttributeIds,
            indexRange?: NumericRange,
            dataEncoding?: QualifiedNameLike | null,
        ): DataValue;
        removeAllListeners(): void;
        removeListener<K extends keyof UAObjectEvents>(
            event: K,
            listener: UAObjectEvents[K],
        ): void;
        removeReference(referenceOpts: AddReferenceOpts): void;
        setAccessRestrictions(accessRestrictions: AccessRestrictionsFlag): void;
        setDescription(value: LocalizedTextLike | null): void;
        setDisplayName(value: LocalizedTextLike | LocalizedTextLike[]): void;
        setEventNotifier(eventNotifierFlags: EventNotifierFlags): void;
        setMaxListeners(n: number): void;
        setRolePermissions(rolePermissions: RolePermissionTypeOptions[]): void;
        writeAttribute(
            context: ISessionContext | null,
            writeValue: WriteValueOptions,
            callback: (err: Error | null, statusCode?: StatusCode) => void,
        ): void;
    }

    Hierarchy (View Summary)

    Index
    accessRestrictions ackedState acknowledge addComment addressSpace branchId browseName clientUserId comment conditionClassId conditionClassName conditionName conditionRefresh conditionRefresh2 conditionSubClassId? conditionSubClassName? confirm? confirmedState? declaredAccessRestrictions? description designToolOnly? disable displayName enable enabledState eventId eventNotifier eventType hasMethods lastSeverity localTime? message modellingRule namespace namespaceIndex namespaceUri nodeClass nodeId nodesetCategory? nodesetDocumentation? onFirstBrowseAction? parent parentNodeId quality receiveTime releaseStatus? retain rolePermissions severity sourceName sourceNode supportsFilteredRetain time typeDefinition typeDefinitionObj
    addReference allReferences browseNode browseNodeByTargetName clone emit findReference findReferences findReferencesAsObject findReferencesEx findReferencesExAsObject fullName getAccessRestrictions getAggregates getChildByName getComponentByName getComponents getDisplayName getEventSourceOfs getEventSources getFolderElementByName getMethodById getMethodByName getMethods getNodeVersion getNotifiers getProperties getPropertyByName getRolePermissions install_extra_properties isDisposed listenerCount off on once raiseEvent readAttribute removeAllListeners removeListener removeReference setAccessRestrictions setDescription setDisplayName setEventNotifier setMaxListeners setRolePermissions writeAttribute
    accessRestrictions: AccessRestrictionsFlag | undefined
    ackedState: UATwoStateVariable<LocalizedText>
    acknowledge: UAMethod
    addComment: UAMethod
    addressSpace: IAddressSpace
    branchId: UAProperty<NodeId, NodeId>
    browseName: QualifiedName
    clientUserId: UAProperty<UAString, String>
    comment: UAConditionVariable<LocalizedText, LocalizedText>
    conditionClassId: UAProperty<NodeId, NodeId>
    conditionClassName: UAProperty<LocalizedText, LocalizedText>
    conditionName: UAProperty<UAString, String>
    conditionRefresh: UAMethod
    conditionRefresh2: UAMethod
    conditionSubClassId?: UAProperty<NodeId[], NodeId>
    conditionSubClassName?: UAProperty<LocalizedText[], LocalizedText>
    confirm?: UAMethod<UAMethodEvents>
    confirmedState?: UATwoStateVariable<LocalizedText>
    declaredAccessRestrictions?: string

    the AccessRestrictions the nodeset declared, verbatim, whether or not this loader was asked to apply them. accessRestrictions above is what is enforced and is gated by the loader's option; this is what the document said, and is documentation only. Without it a document loaded with the default policy cannot be written back out as the document it was.

    description: LocalizedText
    designToolOnly?: boolean

    the nodeset's DesignToolOnly="true": the node is there for design tools only (a name to reuse, such as OPC 10000-100 DI's Configuration, Tuning, ... FunctionalGroups), so nothing is expected to reference it. Documentation only, kept so the node is written back out as declared.

    disable: UAMethod
    displayName: LocalizedText[]
    enable: UAMethod
    enabledState: UATwoStateVariable<LocalizedText>
    eventId: UAProperty<Buffer<ArrayBufferLike>, ByteString>
    eventNotifier: EventNotifierFlags
    eventType: UAProperty<NodeId, NodeId>
    hasMethods: boolean
    lastSeverity: UAConditionVariable<number, UInt16>
    localTime?: UAProperty<DTTimeZone, ExtensionObject>
    message: UAProperty<LocalizedText, LocalizedText>
    modellingRule: ModellingRuleType | undefined
    namespace: INamespace
    namespaceIndex: number
    namespaceUri: string
    nodeClass: Object
    nodeId: NodeId
    nodesetCategory?: string[]

    the <Category> elements of the nodeset, in order: the conformance units or facets the working group filed this node under. Kept, and named, for the same reasons as nodesetDocumentation: I4AAS has types with a Category property.

    nodesetDocumentation?: string

    the <Documentation> element of the nodeset: a link into the specification text that defines this node (https://reference.opcfoundation.org/...), at most one. It is not the Description attribute and no service exposes it; it is kept so that a tool can show where a node comes from, and so that the node can be written back out as the document that created it.

    Named after the element, not documentation: the children of a node are reachable as properties under their browse name, and DI's ISupportInfoType has a Documentation folder.

    onFirstBrowseAction?: (this: BaseNode) => Promise<void>
    parent: BaseNode<BaseNodeEvents> | null
    parentNodeId: NodeId | undefined
    quality: UAConditionVariable<StatusCode, StatusCode>
    receiveTime: UAProperty<Date, DateTime>
    releaseStatus?: "Draft" | "Deprecated"

    the maturity a nodeset declares for this node: "Draft" or "Deprecated", or undefined for the default, "Released". It is documentation rather than behaviour -- nothing in the address space acts on it -- but a NodeSet2 document states it, and a node that has forgotten it cannot be written back out as the document that created it.

    retain: UAProperty<boolean, Boolean>
    rolePermissions: RolePermissionType[] | undefined
    severity: UAProperty<number, UInt16>
    sourceName: UAProperty<UAString, String>
    sourceNode: UAProperty<NodeId, NodeId>
    supportsFilteredRetain: UAProperty<boolean, Boolean>
    time: UAProperty<Date, DateTime>
    typeDefinition: NodeId
    typeDefinitionObj: UAObjectType

    • Parameters

      Returns void

    • Returns UAReference[]

    • Parameters

      Returns NodeId[]

    • Type Parameters

      Parameters

      Returns boolean

    • find the the references that are strictly of type reference.

      The isForward boolean flag specifies the direction of the references to be looked for.

      Forward direction is implied if omitted.

      • will throw an exception if more than one reference exists with the referenceType.
      • will return null if no reference exists.

      Parameters

      Returns UAReference | null

    • find all the references that are strictly of type reference. The isForward boolean flag specifies the direction of the references to be looked for.

      Forward direction is implied if omitted.

      Parameters

      Returns UAReference[]

    • find all the nodes that are referenced by references strictly of type reference.

      The isForward boolean flag specifies the direction of the references to be looked for.

      Forward direction is implied if omitted.

      • will throw an exception if more than one reference exists with the referenceType.
      • will return null if no reference exists.

      Parameters

      Returns BaseNode<BaseNodeEvents>[]

    • find all the references that are of type reference or a sub type of reference, in the direction specified by browseDirection

      • BrowseDirection.Forward direction is implied if browseDirection flags is omitted.

      Parameters

      Returns UAReference[]

    • find all the nodes that are referenced by references of type reference or a sub type of reference, in the direction specified by browseDirection

      • BrowseDirection.Forward direction is implied if browseDirection flags is omitted.

      Parameters

      Returns BaseNode<BaseNodeEvents>[]

    • return a complete name of this object by pre-pending name of its parent(s) to its own name

      Returns string

    • get effective accessRestrictions if (inherited is true) and node has no accessRestrictions, then default accessRestriction from namespace is returned if (inherited is false) and node has no accessRestrictions, then AccessRestrictionsFlag.None is returned

      Parameters

      • inherited: boolean

      Returns AccessRestrictionsFlag

    • Get the Child by name, if browseName is string and namespaceIndex undefined then the search doesn't care about namespace matching

      Parameters

      Returns BaseNode<BaseNodeEvents> | null

    • Parameters

      • browseName: string
      • OptionalnamespaceIndex: number

      Returns BaseNode<BaseNodeEvents> | null

    • Parameters

      • Optionallocale: string

        the locale of the text to return (e.g. en-EN)

      Returns string

    • return a array of the objects for which this node is an EventSource nodes = HasEventSource => self

      Returns BaseNode<BaseNodeEvents>[]

    • return a array with the event source of this object. self = HasEventSource => nodes

      Returns BaseNode<BaseNodeEvents>[]

    • Parameters

      Returns BaseNode<BaseNodeEvents> | null

    • Parameters

      • browseName: string
      • OptionalnamespaceIndex: number

      Returns BaseNode<BaseNodeEvents> | null

    • Parameters

      Returns UAMethod<UAMethodEvents> | null

    • Parameters

      • methodName: string
      • OptionalnamespaceIndex: number

      Returns UAMethod<UAMethodEvents> | null

    • return the versioning node

      Returns UAProperty<UAString, String> | null

    • Parameters

      • inherited: boolean

      Returns RolePermissionType[] | null

    • private

      Returns void

    • Returns boolean

    • Type Parameters

      Parameters

      • event: K

      Returns number

    • Type Parameters

      Parameters

      Returns this

    • Type Parameters

      Parameters

      Returns this

    • Type Parameters

      Parameters

      Returns this

    • Returns void

    • Type Parameters

      Parameters

      Returns void

    • Parameters

      Returns void

    • setAccessRestriction

      Parameters

      Returns void

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Parameters

      • n: number

      Returns void

    • Parameters

      Returns void

    • Parameters

      Returns void

    Settings
    Member Visibility

    On This Page
    Properties
    Methods