ClientSession | NodeOPCUA reference documentation

Hierarchy

Index

Properties

Methods

Properties

Optional authenticationToken

authenticationToken: NodeId

endpoint

endpoint: EndpointDescription

isReconnecting

isReconnecting: boolean

lastRequestSentTime

lastRequestSentTime: Date

the time of the latest request sent by the client to the server

lastResponseReceivedTime

lastResponseReceivedTime: Date

the time of the latest response received by the client

name

name: string

the session name

requestedMaxReferencesPerNode

requestedMaxReferencesPerNode: number

the maximum number of reference that the server should return per browseResult Continuous points will be return by server to allow retrieving remaining references with browseNext

serverCertificate

serverCertificate: Buffer

the server certificate as provided by the server

sessionId

sessionId: NodeId

subscriptionCount

subscriptionCount: number

timeout

timeout: number

the session Id

Methods

acknowledgeCondition

acknowledgeCondition(conditionId: NodeId, eventId: Buffer, comment: string | LocalizedTextOptions, callback: Callback<StatusCode>): void
acknowledgeCondition(conditionId: NodeId, eventId: Buffer, comment: string | LocalizedTextOptions): Promise<StatusCode>

Inherited from ClientSessionConditionService.acknowledgeCondition
- Defined in packages/node-opcua-client/dist/client_session.d.ts:451
helper to acknowledge a condition

from Spec 1.03 Part 9 : page 27

The Acknowledge Method is used to acknowledge an Event Notification for a Condition instance state where AckedState is false.

Normally, the NodeId of the object instance as the ObjectId is passed to the Call Service.

However, some Servers do not expose Condition instances in the AddressSpace.

Therefore all Servers shall also allow Clients to call the Acknowledge Method by specifying ConditionId as the ObjectId.

The Method cannot be called with an ObjectId of the AcknowledgeableConditionType Node.

A Condition instance may be an Object that appears in the Server Address Space. If this is the case the ConditionId is the NodeId for the Object.

The EventId identifies a specific Event Notification where a state to be acknowledged was reported.

Acknowledgement and the optional comment will be applied to the state identified with the EventId. If the comment field is NULL (both locale and text are empty) it will be ignored and any existing comments will remain unchanged. If the comment is to be reset, an empty text with a locale shall be provided.

A valid EventId will result in an Event Notification where AckedState/Id is set to TRUE and the Comment Property contains the text of the optional comment argument. If a previous state is acknowledged, the BranchId and all Condition values of this branch will be reported.

Parameters
- conditionId: NodeId
- eventId: Buffer
- comment: string | LocalizedTextOptions
- callback: Callback<StatusCode>
Returns void
Inherited from ClientSessionConditionService.acknowledgeCondition
- Defined in packages/node-opcua-client/dist/client_session.d.ts:452
Parameters
- conditionId: NodeId
- eventId: Buffer
- comment: string | LocalizedTextOptions
Returns Promise<StatusCode>

addCommentCondition

addCommentCondition(conditionId: NodeIdLike, eventId: Buffer, comment: string | LocalizedTextOptions, callback: Callback<StatusCode>): void
addCommentCondition(conditionId: NodeIdLike, eventId: Buffer, comment: string | LocalizedTextOptions): Promise<StatusCode>

Inherited from ClientSessionConditionService.addCommentCondition
- Defined in packages/node-opcua-client/dist/client_session.d.ts:390
helper to add a comment to a condition

The AddComment Method is used to apply a comment to a specific state of a Condition instance.

Normally, the NodeId of the object instance as the ObjectId is passed to the Call Service.

However, some Servers do not expose Condition instances in the AddressSpace. Therefore all Servers shall also allow Clients to call the AddComment Method by specifying ConditionId as the ObjectId.

The Method cannot be called with an ObjectId of the ConditionType Node.

Notes:
- Comments are added to Event occurrences identified via an EventId. EventIds where the related EventType is not a ConditionType (or subtype of it) and thus does not support Comments are rejected.
- A ConditionEvent – where the Comment Variable contains this text – will be sent for the identified state. If a comment is added to a previous state (i.e. a state for which the Server has created a branch), the BranchId and all Condition values of this branch will be reported/.
Parameters
- conditionId: NodeIdLike
- eventId: Buffer
- comment: string | LocalizedTextOptions
- callback: Callback<StatusCode>
Returns void
Inherited from ClientSessionConditionService.addCommentCondition
- Defined in packages/node-opcua-client/dist/client_session.d.ts:391
Parameters
- conditionId: NodeIdLike
- eventId: Buffer
- comment: string | LocalizedTextOptions
Returns Promise<StatusCode>

addListener

addListener(event: string | symbol, listener: (...args: any[]) => void): ClientSession

- Defined in node_modules/@types/node/events.d.ts:62
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ClientSession

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[]>

Inherited from IBasicSession.browse
- Defined in packages/node-opcua-client/dist/client_session.d.ts:112
Parameters
- nodeToBrowse: BrowseDescriptionLike
- callback: ResponseCallback<BrowseResult>
Returns void
Inherited from IBasicSession.browse
- Defined in packages/node-opcua-client/dist/client_session.d.ts:113
Parameters
- nodesToBrowse: BrowseDescriptionLike[]
- callback: ResponseCallback<BrowseResult[]>
Returns void
Inherited from IBasicSession.browse
- Defined in packages/node-opcua-client/dist/client_session.d.ts:114
Parameters
- nodeToBrowse: BrowseDescriptionLike
Returns Promise<BrowseResult>
Inherited from IBasicSession.browse
- Defined in packages/node-opcua-client/dist/client_session.d.ts:115
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[]>

Inherited from IBasicSession.browseNext
- Defined in packages/node-opcua-client/dist/client_session.d.ts:116
Parameters
- continuationPoint: Buffer
- releaseContinuationPoints: boolean
- callback: ResponseCallback<BrowseResult>
Returns void
Inherited from IBasicSession.browseNext
- Defined in packages/node-opcua-client/dist/client_session.d.ts:117
Parameters
- continuationPoints: Buffer[]
- releaseContinuationPoints: boolean
- callback: ResponseCallback<BrowseResult[]>
Returns void
Inherited from IBasicSession.browseNext
- Defined in packages/node-opcua-client/dist/client_session.d.ts:118
Parameters
- continuationPoint: Buffer
- releaseContinuationPoints: boolean
Returns Promise<BrowseResult>
Inherited from IBasicSession.browseNext
- Defined in packages/node-opcua-client/dist/client_session.d.ts:119
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[]>

method

call

example

const methodToCall = {
    objectId: "ns=2;i=12",
    methodId: "ns=2;i=13",
    inputArguments: [
        new Variant({...}),
        new Variant({...}),
    ]
}
session.call(methodToCall,function(err,callResult) {
   if (!err) {
        console.log(" statusCode = ",callResult.statusCode);
        console.log(" inputArgumentResults[0] = ",callResult.inputArgumentResults[0].toString());
        console.log(" inputArgumentResults[1] = ",callResult.inputArgumentResults[1].toString());
        console.log(" outputArgument[0]       = ",callResult.outputArgument[0].toString()); // array of variant
   }
});

method

call

example

const methodsToCall = [ {
    objectId: "ns=2;i=12",
    methodId: "ns=2;i=13",
    inputArguments: [
        new Variant({...}),
        new Variant({...}),
    ]
}];
session.call(methodsToCall,function(err,callResutls) {
   if (!err) {
        const callResult = callResutls[0];
        console.log(" statusCode = ",rep.statusCode);
        console.log(" inputArgumentResults[0] = ",callResult.inputArgumentResults[0].toString());
        console.log(" inputArgumentResults[1] = ",callResult.inputArgumentResults[1].toString());
        console.log(" outputArgument[0]       = ",callResult.outputArgument[0].toString()); // array of variant
   }
});

Parameters

methodToCall: CallMethodRequestOptions

the call method request
callback: (err: Error, result?: CallMethodResult) => void
- - (err: Error, result?: CallMethodResult): void
  - Parameters
    - err: Error
    - Optional result: CallMethodResult
    Returns void

Returns void

Inherited from IBasicSession.call
- Defined in packages/node-opcua-client/dist/client_session.d.ts:189
Parameters
- methodsToCall: CallMethodRequestOptions[]
- callback: (err: Error, results?: CallMethodResult[]) => void
  - - (err: Error, results?: CallMethodResult[]): void
    - Parameters
      - err: Error
      - Optional results: CallMethodResult[]
      Returns void
Returns void
Inherited from IBasicSession.call
- Defined in packages/node-opcua-client/dist/client_session.d.ts:190
Parameters
- methodToCall: CallMethodRequestOptions
Returns Promise<CallMethodResult>
Inherited from IBasicSession.call
- Defined in packages/node-opcua-client/dist/client_session.d.ts:191
Parameters
- methodsToCall: CallMethodRequestOptions[]
Returns Promise<CallMethodResult[]>

close

close(callback: ErrorCallback): void
close(deleteSubscription: boolean, callback: ErrorCallback): void
close(deleteSubscription?: boolean): Promise<void>

Inherited from ClientSessionBase.close
- Defined in packages/node-opcua-client/dist/client_session.d.ts:88
Parameters
- callback: ErrorCallback
Returns void
Inherited from ClientSessionBase.close
- Defined in packages/node-opcua-client/dist/client_session.d.ts:89
Parameters
- deleteSubscription: boolean
- callback: ErrorCallback
Returns void
Inherited from ClientSessionBase.close
- Defined in packages/node-opcua-client/dist/client_session.d.ts:90
Parameters
- Optional deleteSubscription: boolean
Returns Promise<void>

confirmCondition

confirmCondition(conditionId: NodeIdLike, eventId: Buffer, comment: string | LocalizedTextOptions, callback: Callback<StatusCode>): void
confirmCondition(conditionId: NodeIdLike, eventId: Buffer, comment: string | LocalizedTextOptions): Promise<StatusCode>

Inherited from ClientSessionConditionService.confirmCondition
- Defined in packages/node-opcua-client/dist/client_session.d.ts:412
helper to confirm a condition

from Spec 1.03 Part 9 : page 27 The Confirm Method is used to confirm an Event Notifications for a Condition instance state where ConfirmedState is FALSE.

Normally, the NodeId of the object instance as the ObjectId is passed to the Call Service.

However, some Servers do not expose Condition instances in the AddressSpace.

Therefore all Servers shall also allow Clients to call the Confirm Method by specifying ConditionId as the ObjectId.

The Method cannot be called with an ObjectId of the AcknowledgeableConditionType Node.

Parameters
- conditionId: NodeIdLike
- eventId: Buffer
- comment: string | LocalizedTextOptions
- callback: Callback<StatusCode>
Returns void
Inherited from ClientSessionConditionService.confirmCondition
- Defined in packages/node-opcua-client/dist/client_session.d.ts:413
Parameters
- conditionId: NodeIdLike
- eventId: Buffer
- comment: string | LocalizedTextOptions
Returns Promise<StatusCode>

constructExtensionObject

constructExtensionObject(dataType: NodeId, pojo: any): Promise<ExtensionObject>

Inherited from ClientSessionExtensionObjectService.constructExtensionObject
- Defined in packages/node-opcua-client/dist/client_session.d.ts:364
Parameters
- dataType: NodeId
- pojo: any
Returns Promise<ExtensionObject>

createSubscription2

createSubscription2(createSubscriptionRequest: CreateSubscriptionRequestOptions): Promise<ClientSubscription>
createSubscription2(createSubscriptionRequest: CreateSubscriptionRequestOptions, callback: ResponseCallback<ClientSubscription>): void

Inherited from ClientSessionSubscriptionService.createSubscription2
- Defined in packages/node-opcua-client/dist/client_session.d.ts:283
Parameters
- createSubscriptionRequest: CreateSubscriptionRequestOptions
Returns Promise<ClientSubscription>
Inherited from ClientSessionSubscriptionService.createSubscription2
- Defined in packages/node-opcua-client/dist/client_session.d.ts:284
Parameters
- createSubscriptionRequest: CreateSubscriptionRequestOptions
- callback: ResponseCallback<ClientSubscription>
Returns void

disableCondition

disableCondition(): void

Inherited from ClientSessionConditionService.disableCondition
- Defined in packages/node-opcua-client/dist/client_session.d.ts:368
Returns void

emit

emit(event: string | symbol, ...args: any[]): boolean

- Defined in node_modules/@types/node/events.d.ts:72
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

enableCondition

enableCondition(): void

Inherited from ClientSessionConditionService.enableCondition
- Defined in packages/node-opcua-client/dist/client_session.d.ts:369
Returns void

eventNames

eventNames(): (string | symbol)[]

- Defined in node_modules/@types/node/events.d.ts:77
Returns (string | symbol)[]

extractNamespaceDataType

extractNamespaceDataType(): Promise<ExtraDataTypeManager>

Inherited from ClientSessionExtensionObjectService.extractNamespaceDataType
- Defined in packages/node-opcua-client/dist/client_session.d.ts:365
Returns Promise<ExtraDataTypeManager>

findMethodId

findMethodId(nodeId: NodeIdLike, methodName: string, callback: ResponseCallback<NodeId>): void
findMethodId(nodeId: NodeIdLike, methodName: string): Promise<NodeId>

Inherited from ClientSessionConditionService.findMethodId
- Defined in packages/node-opcua-client/dist/client_session.d.ts:460
method

findMethodId

Parameters
- nodeId: NodeIdLike
  
  the nodeId of the parent Object
- methodName: string
  
  the method name
- callback: ResponseCallback<NodeId>
Returns void
Inherited from ClientSessionConditionService.findMethodId
- Defined in packages/node-opcua-client/dist/client_session.d.ts:461
Parameters
- nodeId: NodeIdLike
- methodName: string
Returns Promise<NodeId>

getArgumentDefinition

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

Inherited from IBasicSession.getArgumentDefinition
- Defined in packages/node-opcua-client/dist/client_session.d.ts:192
Parameters
- methodId: NodeIdLike
Returns Promise<ArgumentDefinition>
Inherited from IBasicSession.getArgumentDefinition
- Defined in packages/node-opcua-client/dist/client_session.d.ts:193
Parameters
- methodId: NodeIdLike
- callback: (err: Error, args?: ArgumentDefinition) => void
  - - (err: Error, args?: ArgumentDefinition): void
    - Parameters
      - err: Error
      - Optional args: ArgumentDefinition
      Returns void
Returns void

getBuiltInDataType

getBuiltInDataType(nodeId: NodeId): Promise<DataType>
getBuiltInDataType(nodeId: NodeId, callback: (err: Error, dataType?: DataType) => void): void

retrieve the built-in DataType of a Variable, from its DataType attribute.

this method is useful to determine which DataType to use when constructing a Variant

async

example

const session = ...; // ClientSession
const nodeId = opcua.VariableIds.Server_ServerStatus_CurrentTime;
session.getBuildInDataType(nodeId,function(err,dataType) {
  assert(dataType === opcua.DataType.DateTime);
});
// or
nodeId = opcua.coerceNodeId("ns=2;s=Scalar_Static_ImagePNG");
const dataType: await session.getBuildInDataType(nodeId);
assert(dataType === opcua.DataType.ByteString);

Parameters

nodeId: NodeId

the node id of the variable to query

Returns Promise<DataType>

Inherited from ClientSessionDataTypeService.getBuiltInDataType
- Defined in packages/node-opcua-client/dist/client_session.d.ts:356
Parameters
- nodeId: NodeId
- callback: (err: Error, dataType?: DataType) => void
  - - (err: Error, dataType?: DataType): void
    - Parameters
      - err: Error
      - Optional dataType: DataType
      Returns void
Returns void

getMaxListeners

getMaxListeners(): number

- Defined in node_modules/@types/node/events.d.ts:69
Returns number

getNamespaceIndex

getNamespaceIndex(namespaceUri: string): number

Inherited from ClientSessionNamespaceService.getNamespaceIndex
- Defined in packages/node-opcua-client/dist/client_session.d.ts:359
Parameters
- namespaceUri: string
Returns number

listenerCount

listenerCount(event: string | symbol): number

- Defined in node_modules/@types/node/events.d.ts:73
Parameters
- event: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

- Defined in node_modules/@types/node/events.d.ts:70
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: (...args: any[]) => void): ClientSession

- Defined in node_modules/@types/node/events.d.ts:66
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ClientSession

on

on(event: "keepalive", eventHandler: (lastKnownServerState: ServerState) => void): ClientSession
on(event: "keepalive_failure", eventHandler: (state: any) => void): ClientSession
on(event: "session_closed", eventHandler: (statusCode: StatusCode) => void): ClientSession
on(event: "session_restored", eventHandler: () => void): ClientSession
on(event: string | symbol, listener: (...args: any[]) => void): ClientSession

- Defined in packages/node-opcua-client/dist/client_session.d.ts:95
Parameters
- event: "keepalive"
- eventHandler: (lastKnownServerState: ServerState) => void
  - - (lastKnownServerState: ServerState): void
    - Parameters
      - lastKnownServerState: ServerState
      Returns void
Returns ClientSession
- Defined in packages/node-opcua-client/dist/client_session.d.ts:96
Parameters
- event: "keepalive_failure"
- eventHandler: (state: any) => void
  - - (state: any): void
    - Parameters
      - state: any
      Returns void
Returns ClientSession
- Defined in packages/node-opcua-client/dist/client_session.d.ts:97
Parameters
- event: "session_closed"
- eventHandler: (statusCode: StatusCode) => void
  - - (statusCode: StatusCode): void
    - Parameters
      - statusCode: StatusCode
      Returns void
Returns ClientSession
- Defined in packages/node-opcua-client/dist/client_session.d.ts:102
session_restored is raised when the session and realted subscription have been fullt repaired after a reconnection.

Parameters
- event: "session_restored"
- eventHandler: () => void
  - - (): void
    - Returns void
Returns ClientSession
- Defined in packages/node-opcua-client/dist/client_session.d.ts:103
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ClientSession

once

once(event: string | symbol, listener: (...args: any[]) => void): ClientSession

- Defined in node_modules/@types/node/events.d.ts:64
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ClientSession

prependListener

prependListener(event: string | symbol, listener: (...args: any[]) => void): ClientSession

- Defined in node_modules/@types/node/events.d.ts:75
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ClientSession

prependOnceListener

prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): ClientSession

- Defined in node_modules/@types/node/events.d.ts:76
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ClientSession

queryFirst

queryFirst(queryFirstRequest: QueryFirstRequestOptions): Promise<QueryFirstResponse>
queryFirst(queryFirstRequest: QueryFirstRequestOptions, callback: ResponseCallback<QueryFirstResponse>): void

Inherited from ClientSessionQueryService.queryFirst
- Defined in packages/node-opcua-client/dist/client_session.d.ts:128
Parameters
- queryFirstRequest: QueryFirstRequestOptions
Returns Promise<QueryFirstResponse>
Inherited from ClientSessionQueryService.queryFirst
- Defined in packages/node-opcua-client/dist/client_session.d.ts:129
Parameters
- queryFirstRequest: QueryFirstRequestOptions
- callback: ResponseCallback<QueryFirstResponse>
Returns void

rawListeners

rawListeners(event: string | symbol): Function[]

- Defined in node_modules/@types/node/events.d.ts:71
Parameters
- event: string | symbol
Returns Function[]

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[]>

Inherited from IBasicSession.read
- Defined in packages/node-opcua-client/dist/client_session.d.ts:202
Parameters
- nodeToRead: ReadValueIdOptions
- maxAge: number
- callback: ResponseCallback<DataValue>
Returns void
Inherited from IBasicSession.read
- Defined in packages/node-opcua-client/dist/client_session.d.ts:203
Parameters
- nodesToRead: ReadValueIdOptions[]
- maxAge: number
- callback: ResponseCallback<DataValue[]>
Returns void
Inherited from IBasicSession.read
- Defined in packages/node-opcua-client/dist/client_session.d.ts:204
Parameters
- nodeToRead: ReadValueIdOptions
- callback: ResponseCallback<DataValue>
Returns void
Inherited from IBasicSession.read
- Defined in packages/node-opcua-client/dist/client_session.d.ts:205
Parameters
- nodesToRead: ReadValueIdOptions[]
- callback: ResponseCallback<DataValue[]>
Returns void
Inherited from IBasicSession.read
- Defined in packages/node-opcua-client/dist/client_session.d.ts:206
Parameters
- nodeToRead: ReadValueIdOptions
- Optional maxAge: number
Returns Promise<DataValue>
Inherited from IBasicSession.read
- Defined in packages/node-opcua-client/dist/client_session.d.ts:207
Parameters
- nodesToRead: ReadValueIdOptions[]
- Optional maxAge: number
Returns Promise<DataValue[]>

readAggregateValue

readAggregateValue(nodesToRead: HistoryReadValueIdOptions[], startTime: DateTime, endTime: DateTime, aggregateFn: AggregateFunction[], processingInterval: number, callback: Callback<HistoryReadResult[]>): void
readAggregateValue(nodesToRead: HistoryReadValueIdOptions[], startTime: DateTime, endTime: DateTime, aggregateFn: AggregateFunction[], processingInterval: number): Promise<HistoryReadResult[]>
readAggregateValue(nodeToRead: HistoryReadValueIdOptions, startTime: DateTime, endTime: DateTime, aggregateFn: AggregateFunction, processingInterval: number, callback: Callback<HistoryReadResult>): void
readAggregateValue(nodeToRead: HistoryReadValueIdOptions, startTime: DateTime, endTime: DateTime, aggregateFn: AggregateFunction, processingInterval: number): Promise<HistoryReadResult>

method

readAggregateValue

async

example

//  es5
session.readAggregateValue(
  {nodeId: "ns=5;s=Simulation Examples.Functions.Sine1" },
  new Date("2015-06-10T09:00:00.000Z"),
  new Date("2015-06-10T09:01:00.000Z"),
 AggregateFunction.Average, 3600000, (err,dataValues)  => {

});

//  es6
const dataValues = await session.readAggregateValue(
  { nodeId: "ns=5;s=Simulation Examples.Functions.Sine1" },
  new Date("2015-06-10T09:00:00.000Z"),
  new Date("2015-06-10T09:01:00.000Z"),
  AggregateFunction.Average, 3600000);

Parameters

nodesToRead: HistoryReadValueIdOptions[]
startTime: DateTime

the start time in UTC format
endTime: DateTime

the end time in UTC format
aggregateFn: AggregateFunction[]
processingInterval: number

in milliseconds
callback: Callback<HistoryReadResult[]>

Returns void

Inherited from ClientSessionReadHistoryService.readAggregateValue
- Defined in packages/node-opcua-client/dist/client_session.d.ts:327
Parameters
- nodesToRead: HistoryReadValueIdOptions[]
- startTime: DateTime
- endTime: DateTime
- aggregateFn: AggregateFunction[]
- processingInterval: number
Returns Promise<HistoryReadResult[]>
Inherited from ClientSessionReadHistoryService.readAggregateValue
- Defined in packages/node-opcua-client/dist/client_session.d.ts:328
Parameters
- nodeToRead: HistoryReadValueIdOptions
- startTime: DateTime
- endTime: DateTime
- aggregateFn: AggregateFunction
- processingInterval: number
- callback: Callback<HistoryReadResult>
Returns void
Inherited from ClientSessionReadHistoryService.readAggregateValue
- Defined in packages/node-opcua-client/dist/client_session.d.ts:329
Parameters
- nodeToRead: HistoryReadValueIdOptions
- startTime: DateTime
- endTime: DateTime
- aggregateFn: AggregateFunction
- processingInterval: number
Returns Promise<HistoryReadResult>

readHistoryValue

readHistoryValue(nodesToRead: NodeIdLike[] | HistoryReadValueIdOptions2[], start: DateTime, end: DateTime, callback: (err: Error, results?: HistoryReadResult[]) => void): void
readHistoryValue(nodesToRead: NodeIdLike[] | HistoryReadValueIdOptions2[], start: DateTime, end: DateTime): Promise<HistoryReadResult[]>
readHistoryValue(nodeToRead: string | number | NodeId | HistoryReadValueIdOptions2, start: DateTime, end: DateTime, callback: (err: Error, result?: HistoryReadResult) => void): void
readHistoryValue(nodeToRead: string | number | NodeId | HistoryReadValueIdOptions2, start: DateTime, end: DateTime): Promise<HistoryReadResult>

Inherited from ClientSessionReadHistoryService.readHistoryValue
- Defined in packages/node-opcua-client/dist/client_session.d.ts:290
Parameters
- nodesToRead: NodeIdLike[] | HistoryReadValueIdOptions2[]
- start: DateTime
- end: DateTime
- callback: (err: Error, results?: HistoryReadResult[]) => void
  - - (err: Error, results?: HistoryReadResult[]): void
    - Parameters
      - err: Error
      - Optional results: HistoryReadResult[]
      Returns void
Returns void
Inherited from ClientSessionReadHistoryService.readHistoryValue
- Defined in packages/node-opcua-client/dist/client_session.d.ts:291
Parameters
- nodesToRead: NodeIdLike[] | HistoryReadValueIdOptions2[]
- start: DateTime
- end: DateTime
Returns Promise<HistoryReadResult[]>
Inherited from ClientSessionReadHistoryService.readHistoryValue
- Defined in packages/node-opcua-client/dist/client_session.d.ts:292
Parameters
- nodeToRead: string | number | NodeId | HistoryReadValueIdOptions2
- start: DateTime
- end: DateTime
- callback: (err: Error, result?: HistoryReadResult) => void
  - - (err: Error, result?: HistoryReadResult): void
    - Parameters
      - err: Error
      - Optional result: HistoryReadResult
      Returns void
Returns void
Inherited from ClientSessionReadHistoryService.readHistoryValue
- Defined in packages/node-opcua-client/dist/client_session.d.ts:293
Parameters
- nodeToRead: string | number | NodeId | HistoryReadValueIdOptions2
- start: DateTime
- end: DateTime
Returns Promise<HistoryReadResult>

readNamespaceArray

readNamespaceArray(): Promise<string[]>
readNamespaceArray(callback: (err: Error, namespaceArray?: string[]) => void): void

Inherited from ClientSessionNamespaceService.readNamespaceArray
- Defined in packages/node-opcua-client/dist/client_session.d.ts:360
Returns Promise<string[]>
Inherited from ClientSessionNamespaceService.readNamespaceArray
- Defined in packages/node-opcua-client/dist/client_session.d.ts:361
Parameters
- callback: (err: Error, namespaceArray?: string[]) => void
  - - (err: Error, namespaceArray?: string[]): void
    - Parameters
      - err: Error
      - Optional namespaceArray: string[]
      Returns void
Returns void

readVariableValue

readVariableValue(nodeId: NodeIdLike, callback: ResponseCallback<DataValue>): void
readVariableValue(nodeId: NodeIdLike): Promise<DataValue>
readVariableValue(nodeIds: NodeIdLike[], callback: ResponseCallback<DataValue[]>): void
readVariableValue(nodeIds: NodeIdLike[]): Promise<DataValue[]>

Inherited from ClientSessionReadService.readVariableValue
- Defined in packages/node-opcua-client/dist/client_session.d.ts:211
deprecated

Parameters
- nodeId: NodeIdLike
- callback: ResponseCallback<DataValue>
Returns void
Inherited from ClientSessionReadService.readVariableValue
- Defined in packages/node-opcua-client/dist/client_session.d.ts:215
deprecated

Parameters
- nodeId: NodeIdLike
Returns Promise<DataValue>
Inherited from ClientSessionReadService.readVariableValue
- Defined in packages/node-opcua-client/dist/client_session.d.ts:219
deprecated

Parameters
- nodeIds: NodeIdLike[]
- callback: ResponseCallback<DataValue[]>
Returns void
Inherited from ClientSessionReadService.readVariableValue
- Defined in packages/node-opcua-client/dist/client_session.d.ts:223
deprecated

Parameters
- nodeIds: NodeIdLike[]
Returns Promise<DataValue[]>

registerNodes

registerNodes(nodesToRegister: NodeIdLike[]): Promise<NodeId[]>
registerNodes(nodesToRegister: NodeIdLike[], callback: (err: Error, registeredNodeIds?: NodeId[]) => void): void

Inherited from ClientSessionRegisterService.registerNodes
- Defined in packages/node-opcua-client/dist/client_session.d.ts:196
Parameters
- nodesToRegister: NodeIdLike[]
Returns Promise<NodeId[]>
Inherited from ClientSessionRegisterService.registerNodes
- Defined in packages/node-opcua-client/dist/client_session.d.ts:197
Parameters
- nodesToRegister: NodeIdLike[]
- callback: (err: Error, registeredNodeIds?: NodeId[]) => void
  - - (err: Error, registeredNodeIds?: NodeId[]): void
    - Parameters
      - err: Error
      - Optional registeredNodeIds: NodeId[]
      Returns void
Returns void

removeAllListeners

removeAllListeners(event?: string | symbol): ClientSession

- Defined in node_modules/@types/node/events.d.ts:67
Parameters
- Optional event: string | symbol
Returns ClientSession

removeListener

removeListener(event: string | symbol, listener: (...args: any[]) => void): ClientSession

- Defined in node_modules/@types/node/events.d.ts:65
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ClientSession

setMaxListeners

setMaxListeners(n: number): ClientSession

- Defined in node_modules/@types/node/events.d.ts:68
Parameters
- n: number
Returns ClientSession

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[]>

Inherited from IBasicSession.translateBrowsePath
- Defined in packages/node-opcua-client/dist/client_session.d.ts:122
Parameters
- browsesPath: BrowsePath[]
- callback: ResponseCallback<BrowsePathResult[]>
Returns void
Inherited from IBasicSession.translateBrowsePath
- Defined in packages/node-opcua-client/dist/client_session.d.ts:123
Parameters
- browsePath: BrowsePath
- callback: ResponseCallback<BrowsePathResult>
Returns void
Inherited from IBasicSession.translateBrowsePath
- Defined in packages/node-opcua-client/dist/client_session.d.ts:124
Parameters
- browsePath: BrowsePath
Returns Promise<BrowsePathResult>
Inherited from IBasicSession.translateBrowsePath
- Defined in packages/node-opcua-client/dist/client_session.d.ts:125
Parameters
- browsePaths: BrowsePath[]
Returns Promise<BrowsePathResult[]>

unregisterNodes

unregisterNodes(nodesToRegister: NodeIdLike[]): Promise<void>
unregisterNodes(nodesToRegister: NodeIdLike[], callback: (err?: Error) => void): void

Inherited from ClientSessionRegisterService.unregisterNodes
- Defined in packages/node-opcua-client/dist/client_session.d.ts:198
Parameters
- nodesToRegister: NodeIdLike[]
Returns Promise<void>
Inherited from ClientSessionRegisterService.unregisterNodes
- Defined in packages/node-opcua-client/dist/client_session.d.ts:199
Parameters
- nodesToRegister: NodeIdLike[]
- callback: (err?: Error) => void
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns void

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[]>

Inherited from IBasicSession.write
- Defined in packages/node-opcua-pseudo-session/dist/basic_session_interface.d.ts:69
Parameters
- nodeToWrite: WriteValueOptions
- callback: ResponseCallback<StatusCode>
Returns void
Inherited from IBasicSession.write
- Defined in packages/node-opcua-pseudo-session/dist/basic_session_interface.d.ts:70
Parameters
- nodesToWrite: WriteValueOptions[]
- callback: ResponseCallback<StatusCode[]>
Returns void
Inherited from IBasicSession.write
- Defined in packages/node-opcua-pseudo-session/dist/basic_session_interface.d.ts:71
Parameters
- nodeToWrite: WriteValueOptions
Returns Promise<StatusCode>
Inherited from IBasicSession.write
- 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

Index

Properties

Methods

Properties

Optional authenticationToken

endpoint

isReconnecting

lastRequestSentTime

lastResponseReceivedTime

name

requestedMaxReferencesPerNode

serverCertificate

sessionId

subscriptionCount

timeout

Methods

acknowledgeCondition

Parameters

conditionId: NodeId

eventId: Buffer

comment: string | LocalizedTextOptions

callback: Callback<StatusCode>

Returns void

Parameters

conditionId: NodeId

eventId: Buffer

comment: string | LocalizedTextOptions

Returns Promise<StatusCode>

addCommentCondition

Notes:

Parameters

conditionId: NodeIdLike

eventId: Buffer

comment: string | LocalizedTextOptions

callback: Callback<StatusCode>

Returns void

Parameters

conditionId: NodeIdLike

eventId: Buffer

comment: string | LocalizedTextOptions

Returns Promise<StatusCode>

addListener

Parameters

event: string | symbol

listener: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Returns ClientSession

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