Class jabberwerx.MUCInvite
Extends
jabberwerx.JWModel.
Holds MUC Invite properties.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
jabberwerx.MUCInvite(stanza, room, invitor, reason, password)
Holds MUC Invite properties.
|
| Method Attributes | Method Name and Description |
|---|---|
|
Retrieves the invitor property.
|
|
|
Retrieves the reason property.
|
|
|
Retrieves the reason property.
|
|
|
getRoom()
Retrieves the room property.
|
|
|
Retries the stanza property.
|
|
|
setInvitor(invitor)
Sets the invitor property.
|
|
|
setPassword(password)
Sets the password property.
|
|
|
setReason(reason)
Sets the reason property.
|
|
|
setRoom(room)
Sets the room property.
|
|
|
setStanza(stanza)
Sets the stanza property.
|
- Methods borrowed from class jabberwerx.JWModel:
- applyEvent, event, shouldBeSavedWithGraph
- Methods borrowed from class jabberwerx.JWBase:
- destroy, getClassName, graphUnserialized, init, invocation, shouldBeSerializedInline, toString, wasUnserialized, willBeSerialized
Class Detail
jabberwerx.MUCInvite(stanza, room, invitor, reason, password)
Holds MUC Invite properties. MUC invites are described in XEP-0045 and XEP-0249. The room
property must be present; all other properties are optional.
- Parameters:
- {jabberwerx.Stanza} stanza
- The stanza containing the invite
- {jabberwerx.JID | String} room
- The room for which the invite is extended
- {jabberwerx.JID | String} invitor Optional
- The user who extended the invitation
- {String} reason Optional
- The reason for the invite
- {String} password Optional
- The password for the room
- Throws:
- {TypeError}
- if any of the parameters are not valid
Method Detail
{jabberwerx.JID}
getInvitor()
Retrieves the invitor property.
- Returns:
- {jabberwerx.JID}
{String}
getPassword()
Retrieves the reason property.
- Returns:
- {String}
{String}
getReason()
Retrieves the reason property.
- Returns:
- {String}
{jabberwerx.JID}
getRoom()
Retrieves the room property.
- Returns:
- {jabberwerx.JID}
{jabberwerx.Stanza}
getStanza()
Retries the stanza property.
- Returns:
- {jabberwerx.Stanza}
setInvitor(invitor)
Sets the invitor property.
- Parameters:
- {jabberwerx.JID | String} invitor
- The invitor property is set to this value if not null or empty.
- Throws:
- {TypeError}
- If {invitor} is not valid
setPassword(password)
Sets the password property.
- Parameters:
- {jabberwerx.JID | String} password
- The password property is set to this value if not null or empty.
- Throws:
- {TypeError}
- If {password} is not valid
setReason(reason)
Sets the reason property.
- Parameters:
- {jabberwerx.JID | String} reason
- The reason property is set to this value if not null or empty.
- Throws:
- {TypeError}
- If {reason} is not valid
setRoom(room)
Sets the room property.
- Parameters:
- {jabberwerx.JID | String} room
- The room property is set to this value if not null or empty.
- Throws:
- {TypeError}
- If {room} is not valid
setStanza(stanza)
Sets the stanza property.
- Parameters:
- {jabberwerx.Stanza} stanza
- The stanza property is set to this value if not null or empty.
- Throws:
- {TypeError}
- If {stanza} is not valid