NodeOPCUA API Documentation
    Preparing search index...

    Interface UABaseLogEvent

    namespace http://opcfoundation.org/UA/
    nodeClass ObjectType
    typedDefinition BaseLogEventType i=19362
    isAbstract true
    interface UABaseLogEvent {
        accessRestrictions: AccessRestrictionsFlag | undefined;
        addressSpace: IAddressSpace;
        browseName: QualifiedName;
        conditionClassId: UAProperty<NodeId, NodeId>;
        conditionClassName: UAProperty<LocalizedText, LocalizedText>;
        conditionSubClassId?: UAProperty<NodeId[], NodeId>;
        conditionSubClassName?: UAProperty<LocalizedText[], LocalizedText>;
        description: LocalizedText;
        displayName: LocalizedText[];
        errorCode?: UAProperty<StatusCode, StatusCode>;
        errorCodeNode?: UAProperty<NodeId, NodeId>;
        eventId: UAProperty<Buffer<ArrayBufferLike>, ByteString>;
        eventNotifier: EventNotifierFlags;
        eventType: UAProperty<NodeId, NodeId>;
        hasMethods: boolean;
        localTime?: UAProperty<DTTimeZone, ExtensionObject>;
        message: UAProperty<LocalizedText, LocalizedText>;
        modellingRule: ModellingRuleType | undefined;
        namespace: INamespace;
        namespaceIndex: number;
        namespaceUri: string;
        nodeClass: Object;
        nodeId: NodeId;
        onFirstBrowseAction?: (this: BaseNode) => Promise<void>;
        parent: BaseNode<BaseNodeEvents> | null;
        parentNodeId: NodeId | undefined;
        receiveTime: UAProperty<Date, DateTime>;
        rolePermissions: RolePermissionType[] | undefined;
        severity: UAProperty<number, UInt16>;
        sourceName: UAProperty<UAString, String>;
        sourceNode: UAProperty<NodeId, NodeId>;
        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

    Properties

    accessRestrictions: AccessRestrictionsFlag | undefined
    addressSpace: IAddressSpace
    browseName: QualifiedName
    conditionClassId: UAProperty<NodeId, NodeId>
    conditionClassName: UAProperty<LocalizedText, LocalizedText>
    conditionSubClassId?: UAProperty<NodeId[], NodeId>
    conditionSubClassName?: UAProperty<LocalizedText[], LocalizedText>
    description: LocalizedText
    displayName: LocalizedText[]
    errorCodeNode?: UAProperty<NodeId, NodeId>
    eventId: UAProperty<Buffer<ArrayBufferLike>, ByteString>
    eventNotifier: EventNotifierFlags
    eventType: UAProperty<NodeId, NodeId>
    hasMethods: boolean
    modellingRule: ModellingRuleType | undefined
    namespace: INamespace
    namespaceIndex: number
    namespaceUri: string
    nodeClass: Object
    nodeId: NodeId
    onFirstBrowseAction?: (this: BaseNode) => Promise<void>
    parent: BaseNode<BaseNodeEvents> | null
    parentNodeId: NodeId | undefined
    receiveTime: UAProperty<Date, DateTime>
    rolePermissions: RolePermissionType[] | undefined
    severity: UAProperty<number, UInt16>
    sourceName: UAProperty<UAString, String>
    sourceNode: UAProperty<NodeId, NodeId>
    time: UAProperty<Date, DateTime>
    typeDefinition: NodeId
    typeDefinitionObj: UAObjectType

    Methods

    • 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

      • inherited: boolean

      Returns RolePermissionType[] | null

    • private

      Returns void

    • Returns boolean

    • Type Parameters

      Parameters

      • event: K

      Returns number

    • 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