NodeOPCUA API Documentation
    Preparing search index...

    Interface UAMethod<T>

    interface UAMethod<
        T extends UAMethodEvents & ListenerSignature<T> = UAMethodEvents,
    > {
        _getExecutableFlag?: (sessionContext: ISessionContext | null) => boolean;
        browseName: QualifiedName;
        inputArguments?: UAVariable<UAVariableEvents>;
        methodDeclarationId: NodeId;
        nodeClass: Method;
        nodeId: NodeId;
        onFirstBrowseAction?: (this: BaseNode) => Promise<void>;
        outputArguments?: UAVariable<UAVariableEvents>;
        parent: UAObject<UAObjectEvents> | null;
        typeDefinition: NodeId;
        typeDefinitionObj: UAObjectType;
        get accessRestrictions(): AccessRestrictionsFlag | undefined;
        get addressSpace(): IAddressSpace;
        get description(): LocalizedText;
        get displayName(): LocalizedText[];
        get modellingRule(): ModellingRuleType | undefined;
        get namespace(): INamespace;
        get namespaceIndex(): number;
        get namespaceUri(): string;
        get parentNodeId(): NodeId | undefined;
        get rolePermissions(): RolePermissionType[] | undefined;
        addReference(options: AddReferenceOpts): void;
        allReferences(): UAReference[];
        bindMethod(methodFunction: MethodFunctor): void;
        browseNode(
            browseDescription: BrowseDescriptionOptions2,
            session?: ISessionContext,
        ): ReferenceDescription[];
        browseNodeByTargetName(
            relativePathElement: RelativePathElement,
            isLast: boolean,
        ): NodeId[];
        clone(
            options: CloneOptions,
            optionalFilter?: CloneFilter,
            extraInfo?: CloneExtraInfo,
        ): UAMethod;
        emit<K extends string | number | symbol>(
            event: K,
            ...args: Parameters<T[K]>,
        ): boolean;
        execute(
            object: UAObjectType | UAObject<UAObjectEvents> | null,
            inputArguments: VariantOptions[] | null,
            context: ISessionContext,
            callback: CallbackT<CallMethodResultOptions>,
        ): void;
        execute(
            object: UAObjectType | UAObject<UAObjectEvents> | null,
            inputArguments: VariantOptions[] | null,
            context: ISessionContext,
        ): Promise<CallMethodResultOptions>;
        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;
        getDisplayName(locale?: string): string;
        getEventSourceOfs(): BaseNode<BaseNodeEvents>[];
        getEventSources(): BaseNode<BaseNodeEvents>[];
        getExecutableFlag(context: ISessionContext): boolean;
        getInputArguments(): Argument[];
        getNodeVersion(): UAProperty<UAString, String> | null;
        getOutputArguments(): Argument[];
        getRolePermissions(inherited: boolean): RolePermissionType[] | null;
        install_extra_properties(): void;
        isBound(): boolean;
        isDisposed(): boolean;
        listenerCount<K extends string | number | symbol>(event: K): number;
        off<K extends string | number | symbol>(event: K, listener: T[K]): this;
        on<K extends string | number | symbol>(event: K, listener: T[K]): this;
        once<K extends string | number | symbol>(event: K, listener: T[K]): this;
        readAttribute(
            context: ISessionContext | null,
            attributeId: AttributeIds,
            indexRange?: NumericRange,
            dataEncoding?: QualifiedNameLike | null,
        ): DataValue;
        removeAllListeners(): void;
        removeListener<K extends string | number | symbol>(
            event: K,
            listener: T[K],
        ): void;
        removeReference(referenceOpts: AddReferenceOpts): void;
        setAccessRestrictions(accessRestrictions: AccessRestrictionsFlag): void;
        setDescription(value: LocalizedTextLike | null): void;
        setDisplayName(value: LocalizedTextLike | LocalizedTextLike[]): void;
        setMaxListeners(n: number): void;
        setRolePermissions(rolePermissions: RolePermissionTypeOptions[]): void;
        writeAttribute(
            context: ISessionContext | null,
            writeValue: WriteValueOptions,
            callback: (err: Error | null, statusCode?: StatusCode) => void,
        ): void;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    _getExecutableFlag? browseName inputArguments? methodDeclarationId nodeClass nodeId onFirstBrowseAction? outputArguments? parent typeDefinition typeDefinitionObj

    Accessors

    accessRestrictions addressSpace description displayName modellingRule namespace namespaceIndex namespaceUri parentNodeId rolePermissions

    Methods

    addReference allReferences bindMethod browseNode browseNodeByTargetName clone emit execute findReference findReferences findReferencesAsObject findReferencesEx findReferencesExAsObject fullName getAccessRestrictions getAggregates getChildByName getDisplayName getEventSourceOfs getEventSources getExecutableFlag getInputArguments getNodeVersion getOutputArguments getRolePermissions install_extra_properties isBound isDisposed listenerCount off on once readAttribute removeAllListeners removeListener removeReference setAccessRestrictions setDescription setDisplayName setMaxListeners setRolePermissions writeAttribute

    Properties

    Optional_getExecutableFlag

    _getExecutableFlag?: (sessionContext: ISessionContext | null) => boolean
    browseName: QualifiedName
    inputArguments?: UAVariable<UAVariableEvents>
    methodDeclarationId: NodeId
    nodeClass: Method
    nodeId: NodeId
    onFirstBrowseAction?: (this: BaseNode) => Promise<void>
    outputArguments?: UAVariable<UAVariableEvents>
    parent: UAObject<UAObjectEvents> | null
    typeDefinition: NodeId
    typeDefinitionObj: UAObjectType

    Accessors

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods