Constructor
(package) new PeerGroupEvent(type, isAdmin, properties)
Creates a PeerGroupEvent.
Parameters:
| Name | Type | Description |
|---|---|---|
type |
string | The name of the event type. |
isAdmin |
boolean | true if the peer identified by the userID
property is the peer group leader, and false otherwise.
all members of the peer group are aware of the state change. |
properties |
object | A dictionary of additional properties to add to the object. As a minimum this should include the sessionID, userID and isPrivate properties. |
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
sessionID |
string | The name of the peer group that the event relates to. | |
userID |
string | The user ID of the peer whose action triggered the event. | |
administrator |
boolean | true if the peer described by the userID
property is the peer group leader. |
|
isPrivate |
boolean | true if the cause of the event is known
only to this peer and the peer that caused the event (e.g. receiving a private message),
or false if all members of the peer group are likely aware of the state change. |
|
message |
any |
<optional> |
Additional details that vary according to the type
of event. Contains application specific data for a message event and
a textual description (string) for other events. |
- Source: