BinMessage

Overview

Implements BinMessage format. Doesn't support compression at the moment, so using compression should be turned off on the server side.

Location

RemObjectsSDK.js * Ancestry: Message | BinMessage

Instance Methods


constructor BinMessage

Creates an instance.

function constructor BinMessage()

constructor Message    (declared in Message)

No need to create an instance of abstract class.

function constructor Message()

clone

Returns new message object with the same ClienID.

function clone()

finalize

Finishes writing the data. Usually called by auto-generated code.

function finalize()

getClientID

Returns string with ClientID.

var message = new RemObjects.SDK.BinMessage();
....
setCookie("MyAppClientID", message.getClientID());
function getClientID()

getErrorMessage

Returns error message as a string.

function getErrorMessage()

initialize

Starts writing the data. Usually called by auto-generated code.

function initialize(aServiceName, aMethodName, aMessageType)

Parameters:

  • aServiceName: string
  • aMethodName: string
  • aMessageType: number (RemObjects.SDK.Enum.MessageType)

read

Reads a value from the data stream.

function read(aName, aType)

Parameters:

  • aName: string
  • aType: string

readVariant

Used internally to read Variant value from the stream.

function readVariant()

requestStream

Data stream to be sent to the server.

function requestStream()

setClientID

Sets ClientID.

var message = new RemObjects.SDK.BinMessage();
message.setClientID(getCookie("MyAppClientID"));
function setClientID(aValue)

Parameters:

  • aValue: string

write

Writes a value to the data stream.

function write(aName, aType, aValue)

Parameters:

  • aName: string
  • aType: string
  • aValue: object