API Docs for: 0.0.57
Show:

CreateSessionResponse Class

Creates a new session with the server.

Constructor

CreateSessionResponse

(
  • options
)

Parameters:

  • options Object
    • [responseHeader] ResponseHeader optional

      A standard header included in all responses returned by servers.

    • [sessionId] NodeId optional

      A identifier which uniquely identifies the session.

    • [authenticationToken] SessionAuthenticationToken optional

      The token used to authenticate the client in subsequent requests.

    • [revisedSessionTimeout] Duration optional

      The session timeout in milliseconds.

    • [serverNonce] ByteString optional

      A random number generated by the server.

    • [serverCertificate] ByteString optional

      The application certificate for the server.

    • [serverEndpoints] EndpointDescription[] optional

      The endpoints provided by the server.

    • [serverSoftwareCertificates] SignedSoftwareCertificate[] optional

      The software certificates owned by the server.

    • [serverSignature] SignatureData optional

      A signature created with the server certificate.

    • [maxRequestMessageSize] UInt32 optional

      The maximum message size accepted by the server.

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

authenticationToken

SessionAuthenticationToken

The token used to authenticate the client in subsequent requests.

maxRequestMessageSize

UInt32

The maximum message size accepted by the server.

responseHeader

ResponseHeader

A standard header included in all responses returned by servers.

revisedSessionTimeout

Duration

The session timeout in milliseconds.

serverCertificate

ByteString

The application certificate for the server.

serverEndpoints

EndpointDescription[]

The endpoints provided by the server.

serverNonce

ByteString

A random number generated by the server.

serverSignature

SignatureData

A signature created with the server certificate.

serverSoftwareCertificates

SignedSoftwareCertificate[]

The software certificates owned by the server.

sessionId

NodeId

A identifier which uniquely identifies the session.