APIs

Show:

Activates a session with the server.

Constructor

ActivateSessionRequest

(
  • options
)

Parameters:

  • options Object

Methods

binaryStoreSize

() Number

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

Returns:

Number:

decode

(
  • stream
)

decode the object from a binary stream

Parameters:

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

clientSignature

SignatureData

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

clientSoftwareCertificates

SignedSoftwareCertificate[]

The software certificates owned by the client.

expired

Boolean - True if the security token has expired.

localeIds

LocaleId

The locales to use with the session.

requestHeader

RequestHeader

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

userIdentityToken

ExtensionObject

The user identity to use with the session.

userTokenSignature

SignatureData

A digital signature created with the user identity token.