Class jabberwerx.MUCRoom

The MUCOccupant representing the current user.

The cache of MUCOccupants for this room. This is the source for the "entityCreated", "entityUpdated", "entityRenamed", and "entityDestroyed" events on MUCOccupants.

Error thrown when attempting to enter a room that is already active.

Error thrown when attempting operations on an inactive room.

Set the room's configuration. Use the given jabberwerx.XDataForm (or a generated cancel form if null) to update the room's configuration. Fires the optional callback on result.

The optional function {configCallback} is expected to match the following signature:

function callback(err) {
    err;       //Error explaining the failure,
                 //undefined if set succeeded
}

Changes the current user's nickname with the room. This method sends the necessary protocol, that ultimately results an "entityRenamed" event being triggered for the user's occupant.

The optional function {cb} is expected to match the following signature:

function callback(err) {
    this;    //refers to this room
    err;     //if entering failed, this is the error
             //explaining the failure, undefined if
             //entering succeeded
}

If the user's nickname in the room is already {nick}, this method does nothing.

Changes or clears the subject in the room. This method sends the necessary protocol, that results in the following events:

1. triggers a "beforeRoomSubjectChanging" event with the candidate jabberwerx.Message, just prior to sending; This allows for the subject changing protocol to be modified.
2. triggers a "roomSubjectChanging" event just after the subject changing protocol is sent.
3. triggers a "roomSubjectChanged" event when the room broadcasts the change to all occupants (including the current user).
4. triggers an "entityUpdated" event after the local subject property is changed.

The optional function {cb} is expected to match the following signature:

function callback(err) {
    this;    //refers to this room
    err;     //if entering failed, this is the error
             //explaining the failure, undefined if
             //entering succeeded
}

Destroys this MUCRoom. This method overrides the base to unbind callbacks.

Enters this MUC room. This method enters existing rooms or creates new ones as needed. New rooms are configurable through this method's callbacks

{enterArgs} may be either a callback function or an object that may contain mapped functions and other room specific entry data like a password . If {enterArgs} is a function it is expected to match the following signature:

function callback(err) {
    this;    //refers to this room
    err;     //if entering failed, this is the jabberwerx.Stanza.ErrorInfo
             //explaining the failure, undefined if
             //entering succeeded
}

If {enterArgs} is an object it may define any of the following:

     successCallback: function() {
         this; //refers to this room
     }
     errorCallback: function(err, aborted) {
         this; //refers to this room
         err; //jabberwerx.Stanza.ErrorInfo
         aborted //Boolean Room creation was user aborted before configuration was complete
     }
     configureCallback: function() {
         this; //refers to this room
     }

{enterArgs} may also contain a String password property that contains a plaintext password. for example:

 room.enter("foo@bar", {password: "foopass"})

The successCallback callback is called and a "roomEntered" event fired once the room has been successfully entered or, if a new room, created and configured. If the configureCallback callback is defined and invoked the callee must call #applyConfig to continue creating the room. A "roomCreated" event is fired when the room has been created but before configuration. Canceling a configuration during room creation cancels the creation of the room. NOTE successCallback and errorCallback are not called if the create is canceled. If {enterArgs} is a function or configureCallback is not defined the default configuration is used to create the room.

If a second enter (with the same nick) is attempted the the method calls successCallback immediately and returns.

Exits this room. This method sends the unavailable presence to the room, and eventually triggers a "roomExited" event.

Fetch the room's configuration. Fetch the room's configuration jabberwerx.XDataForm and fire callback on result. The callback is passed either the fetched form or an error.

The optional function {configCallback} is expected to match the following signature:

function callback(form, err) {
    form;    //the fetched jabberwerx.XDataForm
                 //null if fetch failed
    err;       //Error explaining the failure,
                 //undefined if fetch succeeded
}

Retrieves the display name of this MUCRoom. This method overrides the base to always return the node portion of the room's JID.

Retrieves the primary presence for this entity. This implementation always returns the presence for the current user in the room, or null if the room is not active.

Send an invite from this room to specified jids.

Send an invite to each specified jid using the given reason. Invite may be sent through the room (via XEP 0045 7.5.2) or directly to the given jids (via xep 0249). Invalid jids are ignored. This method will return a list of all jids sent invites. {reason} defaults to jabberwerx.MUCRoom.DefaultInviteReason

Determines if this room is currently active. This implementation returns true an occupant for the current user exists, and has an available presence for that occupant.

Sends a broadcast message to the room. This method sends the necessary protocol, and results in the following events:

1. triggers a "beforeRoomBroadcastSent" event with the candidate jabberwerx.Message, just prior to sending; This allows for the broadcast protocol to be modified.
2. triggers a "roomBroadcastSent" event just after the broadcast protocol is sent.
3. triggers a "roomBroadcastReceived" event when the room broadcasts the message to all occupants (including the current user).

Override of the base to prevent display name changes.

Updates for this Entity. This method overrides the base to update presence for the room's occupants via jabberwerx.MUCOccupant#updatePresence, with the following additional actions:

• If the presence is an available presence for a previously non-existent occupant, a new MUCOccupant is added (resulting in an "entityCreated" event).
• If the presence is an unavailable presence for a previously existent occupant (and is not part of a nickname change), that MUCOccupant is removed (resulting in an "entityDestroyed" event).
• If the presence is for a nickname change, the associated entity's JID is changed, and an "entityRenamed" event triggered.
• If the presence is an available presence for the current user and indicates the room is pending configuration, teh "instant room" (or "accept defaults") protocol from XEP-0045 is sent to unlock the room.
• If the presence is an unavailable presence for the current user, a "roomExited" event is triggered.