Session Class Fields

The following are the Session class fields.

Description

The associative array of addresses that the session register.

Type: associative array.

Description

The buddy hash table in this session.

Type: associative array.

Description

The group hash table in this session.

Type: associative array.

Description

The session ID generated by the server.

Type: string.

Description

Interval in milliseconds between requests.

Type: number

Description

Number of users or groups to register for one bulk register request.

Type: number

Description

The serverId will be unique for every session. It is used to lookup the protocol objects.

Type: string.

Description

The session state.

Type: string with the following constants.

Value

Description

ST_ACTIVE

The session is in the active state.

ST_CLOSED

The session is in the closed state.

ST_CLOSING

The session is in the closing state.

ST_IDLE

The session is in the idle state.

Description

The current user for the session.

Type: User object.

Related Links

User Class Constructor