org.igniterealtime.xiff.conference.Room

	Property	Defined By
		active : Boolean [read-only] Determines whether the connection to the room is active - that is, the user is connected and has joined the room.	Room
		affiliation : String [read-only] Gets the user's affiliation for this room.	Room
		anonymous : Boolean [read-only] Whether the room shows full JIDs or not.	Room
		conferenceServer : String The conference server to use for this room.	Room
		connection : IXMPPConnection A reference to the XMPPConnection being used for incoming/outgoing XMPP data.	Room
		length : int [read-only] The number of items in the ArrayCollection.	ArrayCollection
		nickname : String The nickname to use when joining.	Room
		password : String The password.	Room
		role : String [read-only] Gets the user's role in the conference room.	Room
		roomJID : UnescapedJID The unescaped JID of the room.	Room
		roomName : String The room name that should be used when joining.	Room
		source : Array The source of data in the ArrayCollection.	ArrayCollection
		subject : String [read-only] The subject.	Room
		userJID : UnescapedJID [read-only] Get the JID of the conference room user.	Room

	Property	Defined By
		eventDispatcher : EventDispatcher	ArrayCollection
		_source : Array	ArrayCollection

	Method	Defined By
		Room(aConnection:IXMPPConnection = null)	Room
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	ArrayCollection
		addItem(item:*):void Add the specified item to the end of the list.	ArrayCollection
		addItemAt(item:*, index:int):void Add the specified item at the specified index.	ArrayCollection
		allow(jids:Array):void Allow a previously banned JIDs to enter this room.	Room
		ban(jids:Array):void Bans an array of JIDs from entering the room.	Room
		cancelConfiguration():void Cancels the configuration process.	Room
		changeSubject(newSubject:String):void Changes the subject in the conference room.	Room
		clearSource():void Remove all items from the ArrayCollection without dispatching a RESET event.	ArrayCollection
		configure(fieldmap:Object):void Sends a configuration form to the room.	Room
		contains(item:*):Boolean Returns whether the ArrayCollection contains the specified item.	ArrayCollection
		decline(jid:UnescapedJID, reason:String):void Actively decline an invitation.	Room
		destroy(reason:String, alternateJID:UnescapedJID = null, callback:Function = null):void Destroys a reserved room.	Room
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	ArrayCollection
		getItemAt(index:int):* Get the item at the specified index.	ArrayCollection
		getItemIndex(item:*):int Get the index of the item if it is in the ArrayCollection such that getItemAt( index ) == item.	ArrayCollection
		getMessage(body:String = null, htmlBody:String = null):IMessage Gets an instance of the Message class that has been pre-configured to be sent from this room.	Room
		getOccupantNamed(name:String):IRoomOccupant Gets the RoomOccupant whose nickname matches the name passed in.	Room
		grant(affiliation:String, jids:Array):void Grants permissions on a room to one or more JIDs by setting the affiliation of a user based on their JID.	Room
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	ArrayCollection
		invite(jid:UnescapedJID, reason:String):void Invites a user that is not currently a member of this room to this room.	Room
		isThisRoom(sender:UnescapedJID):Boolean Determines if the sender parameter is the same as the room's JID.	Room
		isThisUser(sender:UnescapedJID):Boolean Determines if the sender param is the same as the user's JID.	Room
		itemUpdated(item:*):void Notifies the view that an item has been updated.	ArrayCollection
		join(createReserved:Boolean = false, joinPresenceExtensions:Array = null):Boolean Joins a conference room based on the parameters specified by the room properties.	Room
		joinWithExplicitMUCExtension(createReserved:Boolean, mucExtension:IMUCExtension, joinPresenceExtensions:Array = null):Boolean Joins a conference room based on the parameters specified by the room properties.	Room
		kickOccupant(occupantNick:String, reason:String):void Kicks an occupant out of the room, assuming that the user has necessary permissions in order to do so.	Room
		leave():void Leaves the current conference room, assuming that the user has joined one.	Room
		removeAll():void Remove all items from the ArrayCollection.	ArrayCollection
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	ArrayCollection
		removeItem(item:*):Boolean Remove the specified item from this list, should it exist.	ArrayCollection
		removeItemAt(index:int):* Removes the item at the specified index and returns it.	ArrayCollection
		requestAffiliations(affiliation:String):void Requests an affiliation list for a given affiliation with with room.	Room
		requestConfiguration():void Requests a configuration form from the room.	Room
		revoke(jids:Array):void Revokes all affiliations from the JIDs.	Room
		sendMessage(body:String = null, htmlBody:String = null):void Sends a message to the conference room.	Room
		sendMessageWithExtension(message:IMessage):void Sends a message to the conference room with an extension attached.	Room
		sendPrivateMessage(recipientNickname:String, body:String = null, htmlBody:String = null):void Sends a private message to a specific participant in the conference room.	Room
		setItemAt(item:, index:int): Places the item at the specified index.	ArrayCollection
		setOccupantVoice(occupantNick:String, voice:Boolean):void In a moderated room, sets voice status to a particular occupant, assuming the user has the necessary permissions to do so.	Room
		toArray():Array Return an Array that is populated in the same order as the ArrayCollection.	ArrayCollection
		toString():String Pretty prints the contents of the ArrayCollection to a string and returns it.	ArrayCollection
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	ArrayCollection

	Method	Defined By
		internalDispatchEvent(kind:String, item:* = null, location:int = -1):void Dispatches a collection event with the specified information.	ArrayCollection

Summary	Defined By
adminError	Dispatched when an administration action failed.	Room
affiliationChangeComplete	Dispatched when an affiliation change has completed.	Room
affiliations	Dispatched when an affiliation list has been requested.	Room
bannedError	Dispatched if the user attempted to join the room but was not allowed to do so because they are banned (i.e., has an affiliation of "outcast").	Room
change	Dispatched when the active, affiliation, or role property changes.	Room
configureRoom	Dispatched when a room configuration form is required.	Room
configureRoomComplete	Dispatched when a room configuration form is complete.	Room
declined	Dispatched when an invite to this room has been declined by the invitee.	Room
groupMessage	Dispatched whenever a new message intented for all room occupants is received.	Room
lockedError	Dispatched if a user attempts to enter a room while it is "locked" (i.e., before the room creator provides an initial configuration and therefore before the room officially exists).	Room
maxUsersError	Dispatched if the room has reached its maximum number of occupants.	Room
nickConflict	Dispatched when the user's preferred nickname already exists in the room.	Room
passwordError	Dispatched when the room requires a password and the user did not supply one (or the password provided is incorrect).	Room
privateMessage	Dispatched whenever a new private message is received.	Room
registrationReqError	Dispatched when the room is members-only and the user is not on the member list.	Room
roomDestroyed	Dispatched when the room is removed.	Room
roomJoin	Dispatched when you have entered the room and messages that are sent will be displayed to other users.	Room
roomLeave	Dispatched when the server acknoledges that you have the left the room.	Room
subjectChange	Dispatched when the room subject changes.	Room
userBanned	Dispatched when a user is banned from the room.	Room
userDeparture	Dispatched whenever an occpant leaves the room.	Room
userJoin	Dispatched whenever an occupant joins the room.	Room
userKicked	Dispatched when a user is kicked from the room.	Room
userPresenceChange	Dispatched when a user's presence changes.	Room

	Constant	Defined By
		AFFILIATION_ADMIN : String = admin [static]	Room
		AFFILIATION_MEMBER : String = member [static]	Room
		AFFILIATION_NONE : String = none [static]	Room
		AFFILIATION_OUTCAST : String = outcast [static]	Room
		AFFILIATION_OWNER : String = owner [static]	Room
		ROLE_MODERATOR : String = moderator [static]	Room
		ROLE_NONE : String = none [static]	Room
		ROLE_PARTICIPANT : String = participant [static]	Room
		ROLE_VISITOR : String = visitor [static]	Room

	Constant	Defined By
		OUT_OF_BOUNDS_MESSAGE : String = The supplied index is out of bounds.	ArrayCollection

Property Detail

active

property

active:Boolean [read-only]

Determines whether the connection to the room is active - that is, the user is connected and has joined the room.

Implementation
public function get active():Boolean

affiliation

property

affiliation:String [read-only]

Gets the user's affiliation for this room. Possible affiliations are "owner", "admin", "member", and "outcast". It is also possible to have no defined affiliation.

Implementation
public function get affiliation():String

anonymous

property

anonymous:Boolean [read-only]

Whether the room shows full JIDs or not.

Implementation
public function get anonymous():Boolean

conferenceServer

property

conferenceServer:String

The conference server to use for this room. Usually, this is a subdomain of the primary XMPP server, like conference.myserver.com.

Implementation
public function get conferenceServer():String
public function set conferenceServer(value:String):void

connection

property

connection:IXMPPConnection

A reference to the XMPPConnection being used for incoming/outgoing XMPP data.

Implementation
public function get connection():IXMPPConnection
public function set connection(value:IXMPPConnection):void

nickname

property

nickname:String

The nickname to use when joining.

Implementation
public function get nickname():String
public function set nickname(value:String):void

password

property

password:String

The password.

Implementation
public function get password():String
public function set password(value:String):void

role

property

role:String [read-only]

Gets the user's role in the conference room.

Possible roles are "visitor", "participant", "moderator" or no defined role.

ROLE_MODERATOR
ROLE_NONE
ROLE_PARTICIPANT
ROLE_VISITOR

Implementation
public function get role():String

roomJID

property

roomJID:UnescapedJID

The unescaped JID of the room. room@conference.server Set this after initiating a new Room.

Implementation
public function get roomJID():UnescapedJID
public function set roomJID(value:UnescapedJID):void

roomName

property

roomName:String

The room name that should be used when joining.

Implementation
public function get roomName():String
public function set roomName(value:String):void

subject

property

subject:String [read-only]

The subject.

Implementation
public function get subject():String

userJID

property

userJID:UnescapedJID [read-only]

Get the JID of the conference room user.

Implementation
public function get userJID():UnescapedJID

Constructor Detail

Room

()

Constructor

public function Room(aConnection:IXMPPConnection = null)

Parameters

aConnection:IXMPPConnection (default = null) — A XMPPConnection instance that is providing the primary server connection

Method Detail

allow

()

method

public function allow(jids:Array):void

Allow a previously banned JIDs to enter this room. This is the same as: Room.grant(AFFILIATION_NONE, jid)

If the process could not be completed, the room will dispatch the event RoomEvent.ADMIN_ERROR

Parameters

jids:Array — An array of unescaped JIDs to allow

See also

grant
revoke

ban

()

method

public function ban(jids:Array):void

Bans an array of JIDs from entering the room.

If the process could not be completed, the room will dispatch the event RoomEvent.ADMIN_ERROR.

Parameters

jids:Array — An arry of unescaped JIDs to ban

cancelConfiguration

()

method

public function cancelConfiguration():void

Cancels the configuration process. The room may still be locked if you cancel the configuration process when attempting to join a reserved room.

You must have joined the room and have the owner affiliation to configure the room.

See also

configureRoom
configure
join

changeSubject

()

method

public function changeSubject(newSubject:String):void

Changes the subject in the conference room. You must have already joined the room before you can change the subject.

Parameters

newSubject:String — The new subject

configure

()

method

public function configure(fieldmap:Object):void

Sends a configuration form to the room. You must be joined and have owner affiliation to configure the room

Parameters

fieldmap:Object — FormExtension, or a hash that is an object with keys being the room configuration form variables and the values being arrays. For single value fields, use a single element array.

decline

()

method

public function decline(jid:UnescapedJID, reason:String):void

Actively decline an invitation. You can optionally ignore invitations but if you choose to decline an invitation, you call this method on a room instance that represents the room the invite originated from.

You do not need to have joined this room to decline an invitation

Note: mu-conference-0.6 does not allow users to send decline messages without joining first. If using this version of conferencing software, it is best to ignore invites.

Parameters

	`jid:UnescapedJID` — An unescaped JID of the user to invite.

	`reason:String` — A string describing why the invitiation was declined

destroy

()

method

public function destroy(reason:String, alternateJID:UnescapedJID = null, callback:Function = null):void

Destroys a reserved room. If the room has been configured to be persistent, then it is optional that the server will permanently remove the room.

Parameters

	`reason:String` — A short description of why the room is being destroyed

	`alternateJID:UnescapedJID` (default = `null`) — A JID for current members to use as an alternate room to join after the room has been destroyed. Like a postal forwarding address.

	`callback:Function` (default = `null`)

getMessage

()

method

public function getMessage(body:String = null, htmlBody:String = null):IMessage

Gets an instance of the Message class that has been pre-configured to be sent from this room. Use this method to get a Message in order to add extensions to outgoing room messages.

Parameters

	`body:String` (default = `null`) — The message body

	`htmlBody:String` (default = `null`) — The message body with HTML formatting

Returns

IMessage — A Message class instance

getOccupantNamed

()

method

public function getOccupantNamed(name:String):IRoomOccupant

Gets the RoomOccupant whose nickname matches the name passed in.

Parameters

name:String

Returns

IRoomOccupant —

grant

()

method

public function grant(affiliation:String, jids:Array):void

Grants permissions on a room to one or more JIDs by setting the affiliation of a user based on their JID.

If the JID currently has an existing affiliation, then the existing affiliation will be replaced with the one passed. If the process could not be completed, the room will dispatch the event RoomEvent.ADMIN_ERROR.

XMPP spec states that the #admin schema should be used for affiliation changes. Unfortunately to this date, Openfire does not match spec and requires the #owner schema. Because of this, if granting privileges fails on the first attempt using the #admin schema, we try again using the #owner schema.

Parameters

	`affiliation:String` — Use one of the following affiliations: `Room.AFFILIATION_MEMBER`, `Room.AFFILIATION_ADMIN`, `Room.AFFILIATION_OWNER`

	`jids:Array` — An array of UnescapedJIDs to grant these permissions to

invite

()

method

public function invite(jid:UnescapedJID, reason:String):void

Invites a user that is not currently a member of this room to this room.

You must have joined the room and have appropriate permissions to invite other memebers, because the server will format and send the invite message to as if it came from the room rather that you sending the invite directly from you.

To listen to invite events, add an event listener on your XMPPConnection to the InviteEvent.INVITED event.

Parameters

	`jid:UnescapedJID` — An unescaped JID of the user to invite.

	`reason:String` — A string describing why you would like to invite the user.

isThisRoom

()

method

public function isThisRoom(sender:UnescapedJID):Boolean

Determines if the sender parameter is the same as the room's JID.

Parameters

sender:UnescapedJID — room JID to test

Returns

Boolean — true if the passed JID matches the getRoomJID

isThisUser

()

method

public function isThisUser(sender:UnescapedJID):Boolean

Determines if the sender param is the same as the user's JID.

Parameters

sender:UnescapedJID — the room JID to test

Returns

Boolean — true if the passed JID matches the userJID

join

()

method

public function join(createReserved:Boolean = false, joinPresenceExtensions:Array = null):Boolean

Joins a conference room based on the parameters specified by the room properties. This call will create an instant room based on a default server configuration if the room doesn't exist.

To create and begin the configuration process of a reserved room, pass true to this method to begin the configuration process. When The configuration is complete, the room will be unlocked for others to join. Listen for the RoomEvent.CONFIGURE_ROOM event to handle and either return or cancel the configuration of the room.

Parameters

	`createReserved:Boolean` (default = `false`) — Set to true if you wish to create and configure a reserved room

	`joinPresenceExtensions:Array` (default = `null`) — An array of additional extensions to send with the initial presence to the room.

Returns

Boolean — A boolean indicating whether the join attempt was successfully sent.

joinWithExplicitMUCExtension

()

method

 public function joinWithExplicitMUCExtension(createReserved:Boolean, mucExtension:IMUCExtension, joinPresenceExtensions:Array = null):Boolean

Joins a conference room based on the parameters specified by the room properties. This call will create an instant room based on a default server configuration if the room doesn't exist.

This function adds an additional parameter to allow the caller to completely customize the MUC extension that gets sent to the room. For example, you can add a history element that specifies how much discussion history you want sent when you join the room (http://xmpp.org/extensions/xep-0045.html#enter-managehistory): var muc:MUCExtension = new MUCExtension(); muc.history = true; muc.maxchars = 0; _room.joinWithExplicitMUCExtension(false, mucExt);

Parameters

	`createReserved:Boolean` — Set to true if you wish to create and configure a reserved room

	`mucExtension:IMUCExtension` — The customized MUC extension to send with initial presence to the room.

	`joinPresenceExtensions:Array` (default = `null`) — An array of additional extensions to send with the initial presence to the room.

Returns

Boolean — A boolean indicating whether the join attempt was successfully sent.

kickOccupant

()

method

public function kickOccupant(occupantNick:String, reason:String):void

Kicks an occupant out of the room, assuming that the user has necessary permissions in order to do so. If the user does not, the server will return an error.

Parameters

	`occupantNick:String` — The nickname of the room occupant to kick

	`reason:String` — The reason for the kick

leave

()

method

public function leave():void

Leaves the current conference room, assuming that the user has joined one. If the user is not currently in a room, this method does nothing.

requestAffiliations

()

method

public function requestAffiliations(affiliation:String):void

Requests an affiliation list for a given affiliation with with room. This will either dispatch the event RoomEvent.AFFILIATIONS or RoomEvent.ADMIN_ERROR depending on the result of the request.

Parameters

affiliation:String — Use one of the following affiliations: Room.AFFILIATION_NONE, Room.AFFILIATION_OUTCAST, Room.AFFILIATION_MEMBER, Room.AFFILIATION_ADMIN, Room.AFFILIATION_OWNER

See also

revoke
grant
affiliations

requestConfiguration

()

method

public function requestConfiguration():void

Requests a configuration form from the room. Listen to configureRoom event to fill out the form then call either configure or cancelConfiguration to complete the configuration process You must be joined to the room and have the owner affiliation to request a configuration form

revoke

()

method

public function revoke(jids:Array):void

Revokes all affiliations from the JIDs. This is the same as: grant( Room.AFFILIATION_NONE, jids )

If the process could not be completed, the room will dispatch the event RoomEvent.ADMIN_ERROR. Note: if the JID is banned from this room, then this will also revoke the banned status.

Parameters

jids:Array — An array of UnescapedJIDs to revoke affiliations from

See also

grant
allow

sendMessage

()

method

public function sendMessage(body:String = null, htmlBody:String = null):void

Sends a message to the conference room.

Parameters

	`body:String` (default = `null`) — The message body

	`htmlBody:String` (default = `null`) — The message body with HTML formatting

sendMessageWithExtension

()

method

public function sendMessageWithExtension(message:IMessage):void

Sends a message to the conference room with an extension attached. Use this method in conjunction with the getMessage method.

Parameters

message:IMessage — The message to send

sendPrivateMessage

()

method

public function sendPrivateMessage(recipientNickname:String, body:String = null, htmlBody:String = null):void

Sends a private message to a specific participant in the conference room.

Parameters

	`recipientNickname:String` — The conference room nickname of the recipient who should receive the private message

	`body:String` (default = `null`) — The message body

	`htmlBody:String` (default = `null`) — The message body with HTML formatting

setOccupantVoice

()

method

public function setOccupantVoice(occupantNick:String, voice:Boolean):void

In a moderated room, sets voice status to a particular occupant, assuming the user has the necessary permissions to do so.

Parameters

	`occupantNick:String` — The nickname of the occupant to give voice

	`voice:Boolean` — Whether to add voice (true) or remove voice (false). Having voice means that the user is actually able to talk. Without voice the user is effectively muted.

Event Detail

adminError

Event

Event Object Type: org.igniterealtime.xiff.events.RoomEvent
RoomEvent.type property = org.igniterealtime.xiff.events.RoomEvent.ADMIN_ERROR

Dispatched when an administration action failed.

See also

org.igniterealtime.xiff.core.XMPPConnection.error

affiliationChangeComplete

Event

Event Object Type: org.igniterealtime.xiff.events.RoomEvent
RoomEvent.type property = org.igniterealtime.xiff.events.RoomEvent.AFFILIATION_CHANGE_COMPLETE

Dispatched when an affiliation change has completed.

affiliations

Event

Event Object Type: org.igniterealtime.xiff.events.RoomEvent
RoomEvent.type property = org.igniterealtime.xiff.events.RoomEvent.AFFILIATIONS

Dispatched when an affiliation list has been requested. The event object contains an array of MUCItems containing the JID and affiliation properties.

To grant or revoke permissions based on this list, only send the changes you wish to make, calling grant/revoke with the new affiliation and existing JID.

bannedError

Event

Event Object Type: org.igniterealtime.xiff.events.RoomEvent
RoomEvent.type property = org.igniterealtime.xiff.events.RoomEvent.BANNED_ERROR

Dispatched if the user attempted to join the room but was not allowed to do so because they are banned (i.e., has an affiliation of "outcast").

change

Event

Event Object Type: org.igniterealtime.xiff.events.PropertyChangeEvent
PropertyChangeEvent.type property = org.igniterealtime.xiff.events.PropertyChangeEvent.CHANGE

Dispatched when the active, affiliation, or role property changes.

configureRoom

Event

Event Object Type: org.igniterealtime.xiff.events.RoomEvent
RoomEvent.type property = org.igniterealtime.xiff.events.RoomEvent.CONFIGURE_ROOM

Dispatched when a room configuration form is required. This can occur during the creation of a room, or if a room configuration is requested. The RoomEvent instance will contain an attribute data that is an instance of an object with the following attributes:

instructions: Instructions for the use of form title: Title of the configuration form label: A friendly name for the field name: A computer readable identifier for the field used to identify this field in the result passed to configure() type: The type of the field to be displayed. Type will be a constant from the FormField class.

configureRoomComplete

Event

Event Object Type: org.igniterealtime.xiff.events.RoomEvent
RoomEvent.type property = org.igniterealtime.xiff.events.RoomEvent.CONFIGURE_ROOM_COMPLETE

Dispatched when a room configuration form is complete.

See also

configure

declined

Event

Event Object Type: org.igniterealtime.xiff.events.RoomEvent
RoomEvent.type property = org.igniterealtime.xiff.events.RoomEvent.DECLINED

Dispatched when an invite to this room has been declined by the invitee. The RoomEvent data property that has the following attributes:

from: The JID of the user initiating the invite reason: A string containing the reason to join the room data: The original message containing the decline

groupMessage

Event

Event Object Type: org.igniterealtime.xiff.events.RoomEvent
RoomEvent.type property = org.igniterealtime.xiff.events.RoomEvent.GROUP_MESSAGE

Dispatched whenever a new message intented for all room occupants is received. The RoomEvent class will contain an attribute data with the group message as an instance of the Message class.

lockedError

Event

Event Object Type: org.igniterealtime.xiff.events.RoomEvent
RoomEvent.type property = org.igniterealtime.xiff.events.RoomEvent.LOCKED_ERROR

Dispatched if a user attempts to enter a room while it is "locked" (i.e., before the room creator provides an initial configuration and therefore before the room officially exists).

maxUsersError

Event

Event Object Type: org.igniterealtime.xiff.events.RoomEvent
RoomEvent.type property = org.igniterealtime.xiff.events.RoomEvent.MAX_USERS_ERROR

Dispatched if the room has reached its maximum number of occupants.

nickConflict

Event

Event Object Type: org.igniterealtime.xiff.events.RoomEvent
RoomEvent.type property = org.igniterealtime.xiff.events.RoomEvent.NICK_CONFLICT

Dispatched when the user's preferred nickname already exists in the room. The RoomEvent will contain an attribute nickname with the nickname already existing in the room.

passwordError

Event

Event Object Type: org.igniterealtime.xiff.events.RoomEvent
RoomEvent.type property = org.igniterealtime.xiff.events.RoomEvent.PASSWORD_ERROR

Dispatched when the room requires a password and the user did not supply one (or the password provided is incorrect).

privateMessage

Event

Event Object Type: org.igniterealtime.xiff.events.RoomEvent
RoomEvent.type property = org.igniterealtime.xiff.events.RoomEvent.PRIVATE_MESSAGE

Dispatched whenever a new private message is received. The RoomEvent class contains an attribute data with the private message as an instance of the Message class.

registrationReqError

Event

Event Object Type: org.igniterealtime.xiff.events.RoomEvent
RoomEvent.type property = org.igniterealtime.xiff.events.RoomEvent.REGISTRATION_REQ_ERROR

Dispatched when the room is members-only and the user is not on the member list.

roomDestroyed

Event

Event Object Type: org.igniterealtime.xiff.events.RoomEvent
RoomEvent.type property = org.igniterealtime.xiff.events.RoomEvent.ROOM_DESTROYED

Dispatched when the room is removed.

roomJoin

Event

Event Object Type: org.igniterealtime.xiff.events.RoomEvent
RoomEvent.type property = org.igniterealtime.xiff.events.RoomEvent.ROOM_JOIN

Dispatched when you have entered the room and messages that are sent will be displayed to other users. The room's role and affiliation will be visible from this point forward.

roomLeave

Event

Event Object Type: org.igniterealtime.xiff.events.RoomEvent
RoomEvent.type property = org.igniterealtime.xiff.events.RoomEvent.ROOM_LEAVE

Dispatched when the server acknoledges that you have the left the room.

subjectChange

Event

Event Object Type: org.igniterealtime.xiff.events.RoomEvent
RoomEvent.type property = org.igniterealtime.xiff.events.RoomEvent.SUBJECT_CHANGE

Dispatched when the room subject changes.

userBanned

Event

Event Object Type: org.igniterealtime.xiff.events.RoomEvent
RoomEvent.type property = org.igniterealtime.xiff.events.RoomEvent.USER_BANNED

Dispatched when a user is banned from the room.

userDeparture

Event

Event Object Type: org.igniterealtime.xiff.events.RoomEvent
RoomEvent.type property = org.igniterealtime.xiff.events.RoomEvent.USER_DEPARTURE

Dispatched whenever an occpant leaves the room. The RoomEvent instance will contain an attribute nickname with the nickname of the occupant who left.

userJoin

Event

Event Object Type: org.igniterealtime.xiff.events.RoomEvent
RoomEvent.type property = org.igniterealtime.xiff.events.RoomEvent.USER_JOIN

Dispatched whenever an occupant joins the room. The RoomEvent instance will contain an attribute nickname with the nickname of the occupant who joined.

userKicked

Event

Event Object Type: org.igniterealtime.xiff.events.RoomEvent
RoomEvent.type property = org.igniterealtime.xiff.events.RoomEvent.USER_KICKED

Dispatched when a user is kicked from the room.

userPresenceChange

Event

Event Object Type: org.igniterealtime.xiff.events.RoomEvent
RoomEvent.type property = org.igniterealtime.xiff.events.RoomEvent.USER_PRESENCE_CHANGE

Dispatched when a user's presence changes.

Constant Detail

AFFILIATION_ADMIN

Constant

public static const AFFILIATION_ADMIN:String = admin

AFFILIATION_MEMBER

Constant

public static const AFFILIATION_MEMBER:String = member

AFFILIATION_NONE

Constant

public static const AFFILIATION_NONE:String = none

AFFILIATION_OUTCAST

Constant

public static const AFFILIATION_OUTCAST:String = outcast

AFFILIATION_OWNER

Constant

public static const AFFILIATION_OWNER:String = owner

ROLE_MODERATOR

Constant

public static const ROLE_MODERATOR:String = moderator

ROLE_NONE

Constant

public static const ROLE_NONE:String = none

ROLE_PARTICIPANT

Constant

public static const ROLE_PARTICIPANT:String = participant

ROLE_VISITOR

Constant

public static const ROLE_VISITOR:String = visitor

Thu Aug 23 2012, 12:09 AM +03:00

API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
Room	Properties \| Methods \| Events \| Constants

Package	org.igniterealtime.xiff.conference
Class	public class Room
Inheritance	Room ArrayCollection flash.utils.Proxy
Implements	IRoom