API Docs for: 0.0.57
Show:

BrowseDescription Class

A request to browse the the references from a node.

Constructor

BrowseDescription

(
  • options
)

Parameters:

  • options Object
    • [nodeId] NodeId optional

      The id of the node to browse.

    • [browseDirection] BrowseDirection optional

      The direction of the references to return.

    • [referenceTypeId] NodeId optional

      The type of references to return.Specifies the NodeId of the ReferenceType to follow. Only instances of this ReferenceType or its subtype are returned.If not specified then all ReferenceTypes are returned and includeSubtypes is ignored.

    • [includeSubtypes] Boolean optional

      Includes subtypes of the reference type.

    • [nodeClassMask] UInt32 optional

      A mask indicating which node classes to return. 0 means return all nodes.

    • [resultMask= 0] UInt32 optional

      A mask indicating which fields in the ReferenceDescription should be returned in the results.

Methods

binaryStoreSize

() Number
Calculate the required size to store this object in a binary stream.

Returns:

Number:

decode_debug

()

encode

(
  • stream
)

encode the object into a binary stream

Parameters:

isValid

() Boolean
verify that all object attributes values are valid according to schema

Returns:

Boolean:

toString

() String

Returns:

String:

Properties

browseDirection

BrowseDirection

The direction of the references to return.

includeSubtypes

Boolean

Includes subtypes of the reference type.

nodeClassMask

UInt32

A mask indicating which node classes to return. 0 means return all nodes.

nodeId

NodeId

The id of the node to browse.

referenceTypeId

NodeId

The type of references to return.Specifies the NodeId of the ReferenceType to follow. Only instances of this ReferenceType or its subtype are returned.If not specified then all ReferenceTypes are returned and includeSubtypes is ignored.

resultMask

UInt32

A mask indicating which fields in the ReferenceDescription should be returned in the results.

Default: 0