APIs

Show:

Closes a session with the server.

Constructor

CloseSessionRequest

(
  • options
)

Parameters:

  • options Object
    • [requestHeader] RequestHeader optional

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

    • [deleteSubscriptions] Boolean optional

      If TRUE all subscriptions are deleted when the session is closed.

Methods

binaryStoreSize

() Number

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

Returns:

Number:

decode

(
  • stream
  • [option]
)

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

deleteSubscriptions

Boolean

If TRUE all subscriptions are deleted when the session is closed.

requestHeader

RequestHeader

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