IBasicSession | NodeOPCUA reference documentation

Hierarchy

IBasicSession

Implemented by

Index

Methods

browse

browse(nodeToBrowse: BrowseDescriptionLike, callback: ResponseCallback<BrowseResult>): void
browse(nodesToBrowse: BrowseDescriptionLike[], callback: ResponseCallback<BrowseResult[]>): void
browse(nodeToBrowse: BrowseDescriptionLike): Promise<BrowseResult>
browse(nodesToBrowse: BrowseDescriptionLike[]): Promise<BrowseResult[]>

- Defined in packages/node-opcua-pseudo-session/dist/basic_session_interface.d.ts:15
Parameters
- nodeToBrowse: BrowseDescriptionLike
- callback: ResponseCallback<BrowseResult>
Returns void
- Defined in packages/node-opcua-pseudo-session/dist/basic_session_interface.d.ts:16
Parameters
- nodesToBrowse: BrowseDescriptionLike[]
- callback: ResponseCallback<BrowseResult[]>
Returns void
- Defined in packages/node-opcua-pseudo-session/dist/basic_session_interface.d.ts:17
Parameters
- nodeToBrowse: BrowseDescriptionLike
Returns Promise<BrowseResult>
- Defined in packages/node-opcua-pseudo-session/dist/basic_session_interface.d.ts:18
Parameters
- nodesToBrowse: BrowseDescriptionLike[]
Returns Promise<BrowseResult[]>

browseNext

browseNext(continuationPoint: Buffer, releaseContinuationPoints: boolean, callback: ResponseCallback<BrowseResult>): void
browseNext(continuationPoints: Buffer[], releaseContinuationPoints: boolean, callback: ResponseCallback<BrowseResult[]>): void
browseNext(continuationPoint: Buffer, releaseContinuationPoints: boolean): Promise<BrowseResult>
browseNext(continuationPoints: Buffer[], releaseContinuationPoints: boolean): Promise<BrowseResult[]>

- Defined in packages/node-opcua-pseudo-session/dist/basic_session_interface.d.ts:36
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.
- callback: ResponseCallback<BrowseResult>
Returns void
- Defined in packages/node-opcua-pseudo-session/dist/basic_session_interface.d.ts:37
Parameters
- continuationPoints: Buffer[]
- releaseContinuationPoints: boolean
- callback: ResponseCallback<BrowseResult[]>
Returns void
- Defined in packages/node-opcua-pseudo-session/dist/basic_session_interface.d.ts:38
Parameters
- continuationPoint: Buffer
- releaseContinuationPoints: boolean
Returns Promise<BrowseResult>
- Defined in packages/node-opcua-pseudo-session/dist/basic_session_interface.d.ts:39
Parameters
- continuationPoints: Buffer[]
- releaseContinuationPoints: boolean
Returns Promise<BrowseResult[]>

call

call(methodToCall: CallMethodRequestOptions, callback: (err: Error, result?: CallMethodResult) => void): void
call(methodsToCall: CallMethodRequestOptions[], callback: (err: Error, results?: CallMethodResult[]) => void): void
call(methodToCall: CallMethodRequestOptions): Promise<CallMethodResult>
call(methodsToCall: CallMethodRequestOptions[]): Promise<CallMethodResult[]>

- Defined in packages/node-opcua-pseudo-session/dist/basic_session_interface.d.ts:55
Parameters
- methodToCall: CallMethodRequestOptions
- callback: (err: Error, result?: CallMethodResult) => void
  - - (err: Error, result?: CallMethodResult): void
    - Parameters
      - err: Error
      - Optional result: CallMethodResult
      Returns void
Returns void
- Defined in packages/node-opcua-pseudo-session/dist/basic_session_interface.d.ts:56
Parameters
- methodsToCall: CallMethodRequestOptions[]
- callback: (err: Error, results?: CallMethodResult[]) => void
  - - (err: Error, results?: CallMethodResult[]): void
    - Parameters
      - err: Error
      - Optional results: CallMethodResult[]
      Returns void
Returns void
- Defined in packages/node-opcua-pseudo-session/dist/basic_session_interface.d.ts:57
Parameters
- methodToCall: CallMethodRequestOptions
Returns Promise<CallMethodResult>
- Defined in packages/node-opcua-pseudo-session/dist/basic_session_interface.d.ts:58
Parameters
- methodsToCall: CallMethodRequestOptions[]
Returns Promise<CallMethodResult[]>

getArgumentDefinition

getArgumentDefinition(methodId: NodeIdLike): Promise<ArgumentDefinition>
getArgumentDefinition(methodId: NodeIdLike, callback: (err: Error, args?: ArgumentDefinition) => void): void

- Defined in packages/node-opcua-pseudo-session/dist/basic_session_interface.d.ts:59
Parameters
- methodId: NodeIdLike
Returns Promise<ArgumentDefinition>
- Defined in packages/node-opcua-pseudo-session/dist/basic_session_interface.d.ts:60
Parameters
- methodId: NodeIdLike
- callback: (err: Error, args?: ArgumentDefinition) => void
  - - (err: Error, args?: ArgumentDefinition): void
    - Parameters
      - err: Error
      - Optional args: ArgumentDefinition
      Returns void
Returns void

read

read(nodeToRead: ReadValueIdOptions, maxAge: number, callback: ResponseCallback<DataValue>): void
read(nodesToRead: ReadValueIdOptions[], maxAge: number, callback: ResponseCallback<DataValue[]>): void
read(nodeToRead: ReadValueIdOptions, callback: ResponseCallback<DataValue>): void
read(nodesToRead: ReadValueIdOptions[], callback: ResponseCallback<DataValue[]>): void
read(nodeToRead: ReadValueIdOptions, maxAge?: number): Promise<DataValue>
read(nodesToRead: ReadValueIdOptions[], maxAge?: number): Promise<DataValue[]>

- Defined in packages/node-opcua-pseudo-session/dist/basic_session_interface.d.ts:42
Parameters
- nodeToRead: ReadValueIdOptions
- maxAge: number
- callback: ResponseCallback<DataValue>
Returns void
- Defined in packages/node-opcua-pseudo-session/dist/basic_session_interface.d.ts:43
Parameters
- nodesToRead: ReadValueIdOptions[]
- maxAge: number
- callback: ResponseCallback<DataValue[]>
Returns void
- Defined in packages/node-opcua-pseudo-session/dist/basic_session_interface.d.ts:44
Parameters
- nodeToRead: ReadValueIdOptions
- callback: ResponseCallback<DataValue>
Returns void
- Defined in packages/node-opcua-pseudo-session/dist/basic_session_interface.d.ts:45
Parameters
- nodesToRead: ReadValueIdOptions[]
- callback: ResponseCallback<DataValue[]>
Returns void
- Defined in packages/node-opcua-pseudo-session/dist/basic_session_interface.d.ts:46
Parameters
- nodeToRead: ReadValueIdOptions
- Optional maxAge: number
Returns Promise<DataValue>
- Defined in packages/node-opcua-pseudo-session/dist/basic_session_interface.d.ts:47
Parameters
- nodesToRead: ReadValueIdOptions[]
- Optional maxAge: number
Returns Promise<DataValue[]>

translateBrowsePath

translateBrowsePath(browsesPath: BrowsePath[], callback: ResponseCallback<BrowsePathResult[]>): void
translateBrowsePath(browsePath: BrowsePath, callback: ResponseCallback<BrowsePathResult>): void
translateBrowsePath(browsePath: BrowsePath): Promise<BrowsePathResult>
translateBrowsePath(browsePaths: BrowsePath[]): Promise<BrowsePathResult[]>

- Defined in packages/node-opcua-pseudo-session/dist/basic_session_interface.d.ts:63
Parameters
- browsesPath: BrowsePath[]
- callback: ResponseCallback<BrowsePathResult[]>
Returns void
- Defined in packages/node-opcua-pseudo-session/dist/basic_session_interface.d.ts:64
Parameters
- browsePath: BrowsePath
- callback: ResponseCallback<BrowsePathResult>
Returns void
- Defined in packages/node-opcua-pseudo-session/dist/basic_session_interface.d.ts:65
Parameters
- browsePath: BrowsePath
Returns Promise<BrowsePathResult>
- Defined in packages/node-opcua-pseudo-session/dist/basic_session_interface.d.ts:66
Parameters
- browsePaths: BrowsePath[]
Returns Promise<BrowsePathResult[]>

write

write(nodeToWrite: WriteValueOptions, callback: ResponseCallback<StatusCode>): void
write(nodesToWrite: WriteValueOptions[], callback: ResponseCallback<StatusCode[]>): void
write(nodeToWrite: WriteValueOptions): Promise<StatusCode>
write(nodesToWrite: WriteValueOptions[]): Promise<StatusCode[]>

- Defined in packages/node-opcua-pseudo-session/dist/basic_session_interface.d.ts:69
Parameters
- nodeToWrite: WriteValueOptions
- callback: ResponseCallback<StatusCode>
Returns void
- Defined in packages/node-opcua-pseudo-session/dist/basic_session_interface.d.ts:70
Parameters
- nodesToWrite: WriteValueOptions[]
- callback: ResponseCallback<StatusCode[]>
Returns void
- Defined in packages/node-opcua-pseudo-session/dist/basic_session_interface.d.ts:71
Parameters
- nodeToWrite: WriteValueOptions
Returns Promise<StatusCode>
- Defined in packages/node-opcua-pseudo-session/dist/basic_session_interface.d.ts:72
Parameters
- nodesToWrite: WriteValueOptions[]
Returns Promise<StatusCode[]>

subscribe now with sterfive to access the online-user manual

Hierarchy

Implemented by

Index

Methods

Methods

browse

Parameters

nodeToBrowse: BrowseDescriptionLike

callback: ResponseCallback<BrowseResult>

Returns void

Parameters

nodesToBrowse: BrowseDescriptionLike[]

callback: ResponseCallback<BrowseResult[]>

Returns void

Parameters

nodeToBrowse: BrowseDescriptionLike

Returns Promise<BrowseResult>

Parameters

nodesToBrowse: BrowseDescriptionLike[]

Returns Promise<BrowseResult[]>

browseNext

Parameters

continuationPoint: Buffer

releaseContinuationPoints: boolean

callback: ResponseCallback<BrowseResult>

Returns void

Parameters

continuationPoints: Buffer[]

releaseContinuationPoints: boolean

callback: ResponseCallback<BrowseResult[]>

Returns void

Parameters

continuationPoint: Buffer

releaseContinuationPoints: boolean

Returns Promise<BrowseResult>

Parameters

continuationPoints: Buffer[]

releaseContinuationPoints: boolean

Returns Promise<BrowseResult[]>

call

Parameters

methodToCall: CallMethodRequestOptions

callback: (err: Error, result?: CallMethodResult) => void

Parameters

err: Error

Optional result: CallMethodResult

Returns void

Returns void

Parameters

methodsToCall: CallMethodRequestOptions[]

callback: (err: Error, results?: CallMethodResult[]) => void

Parameters

err: Error

Optional results: CallMethodResult[]

Returns void

Returns void

Parameters

methodToCall: CallMethodRequestOptions

Returns Promise<CallMethodResult>

Parameters

methodsToCall: CallMethodRequestOptions[]

Returns Promise<CallMethodResult[]>

getArgumentDefinition

Parameters

methodId: NodeIdLike

Returns Promise<ArgumentDefinition>

Parameters

methodId: NodeIdLike

callback: (err: Error, args?: ArgumentDefinition) => void

Parameters

err: Error

Optional args: ArgumentDefinition

Returns void

Returns void

read

Parameters

nodeToRead: ReadValueIdOptions

maxAge: number

callback: ResponseCallback<DataValue>