NodeOPCUA API Documentation
    Preparing search index...

    Interface ClientSessionBrowseService

    Browse service — navigate the OPC UA address space.

    The browse() and browseNext() methods are inherited from node-opcua-pseudo-session!IBasicSessionBrowse.

    interface ClientSessionBrowseService {
        requestedMaxReferencesPerNode: number;
        browse(nodeToBrowse: BrowseDescriptionLike): Promise<BrowseResult>;
        browse(nodesToBrowse: BrowseDescriptionLike[]): Promise<BrowseResult[]>;
        browse(
            nodeToBrowse: BrowseDescriptionLike,
            callback: ResponseCallback<BrowseResult>,
        ): void;
        browse(
            nodesToBrowse: BrowseDescriptionLike[],
            callback: ResponseCallback<BrowseResult[]>,
        ): void;
        browseNext(
            continuationPoint: Buffer,
            releaseContinuationPoints: boolean,
        ): Promise<BrowseResult>;
        browseNext(
            continuationPoints: Buffer<ArrayBufferLike>[],
            releaseContinuationPoints: boolean,
        ): Promise<BrowseResult[]>;
        browseNext(
            continuationPoint: Buffer,
            releaseContinuationPoints: boolean,
            callback: ResponseCallback<BrowseResult>,
        ): void;
        browseNext(
            continuationPoints: Buffer<ArrayBufferLike>[],
            releaseContinuationPoints: boolean,
            callback: ResponseCallback<BrowseResult[]>,
        ): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    requestedMaxReferencesPerNode

    Methods

    browse browseNext

    Properties

    requestedMaxReferencesPerNode: number

    The maximum number of references the server should return per browse result. If the server has more, it returns a continuation point to retrieve the rest with browseNext().

    Methods

    • Parameters

      • continuationPoint: Buffer
      • releaseContinuationPoints: boolean

        a Boolean parameter with the following values: * true passed continuationPoints shall be reset to free resources in the Server. The continuation points are released and the results and diagnosticInfos arrays are empty. * false passed continuationPoints shall be used to get the next set of browse information.

        A Client shall always use the continuation point returned by a Browse or BrowseNext response to free the resources for the continuation point in the Server. If the Client does not want to get the next set of browse information, BrowseNext shall be called with this parameter set to true.

      Returns Promise<BrowseResult>

    • Parameters

      • continuationPoints: Buffer<ArrayBufferLike>[]
      • releaseContinuationPoints: boolean

      Returns Promise<BrowseResult[]>

    • Parameters

      Returns void

    • Parameters

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods