ActivateSessionRequest - The NodeOPCUA API

APIs

Extends BaseUAObject

Defined in: packages\node-opcua-service-session\index.js:16

Module: services.session

Activates a session with the server.

Constructor

`ActivateSessionRequest`

(

options

)

Defined in packages\node-opcua-service-session\index.js:16

Parameters:

options Object
- [requestHeader] RequestHeader optional
  
  A standard header included in all requests sent to a server.
- [clientSignature] SignatureData optional
  
  A signature created with the client certificate from the last server nonce returned by the server.
- [clientSoftwareCertificates] SignedSoftwareCertificate[] optional
  
  The software certificates owned by the client.
- [localeIds] LocaleId optional
  
  The locales to use with the session.
- [userIdentityToken] ExtensionObject optional
  
  The user identity to use with the session.
- [userTokenSignature] SignatureData optional
  
  A digital signature created with the user identity token.

Item Index

Methods

Properties

Methods

`binaryStoreSize`

() Number

Inherited from BaseUAObject: packages\node-opcua-factory\src\factories_baseobject.js:49

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

Returns:

Number:

`decode`

(

stream
[option]

)

Provided by the opcua.address_space.types module.

Defined in packages\node-opcua-service-session\_generated_\_auto_generated_ActivateSessionRequest.js:128

decode the object from a binary stream

Parameters:

stream BinaryStream
[option] Object optional

`decode_debug`

()

Inherited from BaseUAObject: packages\node-opcua-factory\src\factories_baseobject.js:126

`encode`

(

stream

)

Provided by the opcua.address_space.types module.

Defined in packages\node-opcua-service-session\_generated_\_auto_generated_ActivateSessionRequest.js:112

encode the object into a binary stream

Parameters:

stream BinaryStream

`isValid`

() Boolean

Inherited from BaseUAObject: packages\node-opcua-factory\src\factories_baseobject.js:83

verify that all object attributes values are valid according to schema

Returns:

Boolean:

`toString`

() String

Inherited from BaseUAObject: packages\node-opcua-factory\src\factories_baseobject.js:61

Returns:

String:

Properties

`clientSignature`

SignatureData

Provided by the opcua.address_space.types module.

Defined in packages\node-opcua-service-session\_generated_\_auto_generated_ActivateSessionRequest.js:62

A signature created with the client certificate from the last server nonce returned by the server.

`clientSoftwareCertificates`

SignedSoftwareCertificate[]

Provided by the opcua.address_space.types module.

Defined in packages\node-opcua-service-session\_generated_\_auto_generated_ActivateSessionRequest.js:69

The software certificates owned by the client.

`expired`

Boolean - True if the security token has expired.

Provided by the services.secure-channel module.

Defined in packages\node-opcua-service-secure-channel\index.js:6

`localeIds`

LocaleId

Provided by the opcua.address_space.types module.

Defined in packages\node-opcua-service-session\_generated_\_auto_generated_ActivateSessionRequest.js:80

The locales to use with the session.

`requestHeader`

RequestHeader

Provided by the opcua.address_space.types module.

Defined in packages\node-opcua-service-session\_generated_\_auto_generated_ActivateSessionRequest.js:55

A standard header included in all requests sent to a server.

`userIdentityToken`

ExtensionObject

Provided by the opcua.address_space.types module.

Defined in packages\node-opcua-service-session\_generated_\_auto_generated_ActivateSessionRequest.js:87

The user identity to use with the session.

`userTokenSignature`

SignatureData

Provided by the opcua.address_space.types module.

Defined in packages\node-opcua-service-session\_generated_\_auto_generated_ActivateSessionRequest.js:94

A digital signature created with the user identity token.