ServerApi

ServerApi

Source:

ServerApi provides factory methods to create the data objects sent to the server.

See the Server API tutorial more information.

Members

(static) Types :Object

Source:
Properties:
Name Type Description
Authenticate string

The type string for Authenticate message.

Close string

The type string for Close message.

Resume string

The type string for Resume message.

SocketResume string

The type string for SocketResume message.

Type:
  • Object

Methods

(static) Authenticate(username, password)

Source:

Creates the Authenticate object.

Parameters:
Name Type Description
username string
password string

(static) Close(session, user)

Source:

Creates the Close object.

Parameters:
Name Type Description
session string
user Object

(static) Resume()

Source:

Creates the Resume object.

(static) SocketResume(session, user)

Source:

Creates the SocketResume object.

Parameters:
Name Type Description
session string
user Object