Built-In Namespace _global_

Method Summary
Method Attributes	Method Name and Description
{Error}	httpError(r) httpError returns an error that encapsulates the status of the response r.
{string}	newLocalId() newLocalId returns a string that is unique in this session.
{string}	newRandomId() newRandomId returns a random string of 32 hex digits (16 bytes).
{Date}	parseTime(value) Protocol version 1 uses integers for dates, later versions use dates in ISO 8601 format.
{boolean}	recomputeUserStreams(sc, id) recomputeUserStreams recomputes the user.streams array for a given user.
{string}	toHex(array) toHex formats an array as a hexadecimal string.

Method Detail

{Error} httpError(r)

httpError returns an error that encapsulates the status of the response r.
Defined in: management.js.

Parameters:
{Response} r

Returns:: {Error}

{string} newLocalId()

newLocalId returns a string that is unique in this session.
Defined in: protocol.js.

Returns:: {string}

{string} newRandomId()

newRandomId returns a random string of 32 hex digits (16 bytes).
Defined in: protocol.js.

Returns:: {string}

{Date} parseTime(value)

Protocol version 1 uses integers for dates, later versions use dates in ISO 8601 format. This function takes a date in either format and returns a Date object.
Defined in: protocol.js.

Parameters:
{string|number} value

Returns:: {Date}

{boolean} recomputeUserStreams(sc, id)

recomputeUserStreams recomputes the user.streams array for a given user. It returns true if anything changed.
Defined in: protocol.js.

Parameters:
{ServerConnection} sc
{string} id

Returns:: {boolean}

{string} toHex(array)

toHex formats an array as a hexadecimal string.
Defined in: protocol.js.

Parameters:
{number[]|Uint8Array} array: - the array to format

Returns:: {string} - the hexadecimal representation of array

Classes

Methods

Built-In Namespace _global_