Session
This section lists the constructor, fields, methods, callback event methods, and returns (if applicable) associated with this class.
Constructor
| Constructor | Returns |
|---|---|
|
Session(serverID) |
Session object |
Fields
| Field | Type |
|---|---|
|
addresses |
Associative array |
|
buddies |
Associative array |
|
groups |
Associative array |
|
id |
String |
|
intervalBetweenReqs |
Number |
|
numberRegsPerBulkReq |
Number |
|
serverID |
String |
|
state |
String of the following constants:
|
|
user |
User object |
Methods
| Method | Returns |
|---|---|
|
broadcastSubscribe(cluster, queue, task, state, presence, method) |
None |
|
broadcastUnsubscribe(type) |
None |
|
close() |
None |
|
open() |
None |
|
registerAddress(address) |
None |
|
registerBuddy(buddy) |
None |
|
registerBuddiesBulk(buddies, numRegsPerBulkReq, intervalBetweenReqs) |
None |
|
registerGroup(group) |
None |
|
registerGroupsBulk(groups, numRegsPerBulkReq, intervalBetweenReqs) |
None |
|
registerUser(user) |
None |
|
setAutoRecovery(autoRecover) |
None |
|
statPublish(userStat, userStat) |
None |
|
unregisterAddress(address) |
None |
|
unregisterBuddy(buddy) |
None |
|
unregisterGroup(group) |
None |
|
unregisterUser(user) |
None |
Callback Event Methods
| Callback Event Method | Returns |
|---|---|
|
onAddressRegistered(event) |
None |
|
onAddressUnregistered(event) |
None |
|
onBuddyRegistered(event) |
None |
|
onBuddyUnregistered(event) |
None |
|
onClosed(event) |
None |
|
onError(event) |
None |
|
onGroupRegistered(event) |
None |
|
onGroupUnregistered(event) |
None |
|
onInfo(event) |
None |
|
onOpened(event) |
None |
|
onUserRegistered(event) |
None |
|
onUserUnregistered(event) |
None |