Packageorg.igniterealtime.xiff.conference
Interfacepublic interface IRoom extends ICollection, flash.events.IEventDispatcher
ImplementorsRoom, RoomOccupant



Public Properties
 PropertyDefined by
  affiliation : String
[read-only]
IRoom
  anonymous : Boolean
[read-only]
IRoom
  conferenceServer : String
IRoom
  connection : IXMPPConnection
IRoom
  isActive : Boolean
[read-only]
IRoom
 Inheritedlength : int
ICollection
  nickname : String
IRoom
  password : String
IRoom
  role : String
[read-only]
IRoom
  roomJID : UnescapedJID
IRoom
  roomName : String
IRoom
  subject : String
[read-only]
IRoom
  userJID : UnescapedJID
[read-only]
IRoom
Public Methods
 MethodDefined by
 Inherited
addItem(item:*):void
ICollection
 Inherited
addItemAt(item:*, index:int):void
ICollection
  
allow(jids:Array):void
IRoom
  
ban(jids:Array):void
IRoom
  
IRoom
  
changeSubject(newSubject:String):void
IRoom
 Inherited
clearSource():void
ICollection
  
configure(fieldmap:Object):void
IRoom
 Inherited
contains(item:*):Boolean
ICollection
  
decline(jid:UnescapedJID, reason:String):void
IRoom
  
destroy(reason:String, alternateJID:UnescapedJID = null, callback:Function = null):void
IRoom
 Inherited
getItemAt(index:int):*
ICollection
 Inherited
getItemIndex(item:*):int
ICollection
  
getMessage(body:String = null, htmlBody:String = null):IMessage
IRoom
  
IRoom
  
grant(affiliation:String, jids:Array):void
IRoom
  
invite(jid:UnescapedJID, reason:String):void
IRoom
  
isThisRoom(sender:UnescapedJID):Boolean
IRoom
  
isThisUser(sender:UnescapedJID):Boolean
IRoom
 Inherited
itemUpdated(item:*):void
ICollection
  
join(createReserved:Boolean = false, joinPresenceExtensions:Array = null):Boolean
IRoom
  
joinWithExplicitMUCExtension(createReserved:Boolean, mucExtension:IMUCExtension, joinPresenceExtensions:Array = null):Boolean
IRoom
  
kickOccupant(occupantNick:String, reason:String):void
IRoom
  
leave():void
IRoom
 Inherited
removeAll():void
ICollection
 Inherited
removeItem(item:*):Boolean
ICollection
 Inherited
removeItemAt(index:int):*
ICollection
  
requestAffiliations(affiliation:String):void
IRoom
  
IRoom
  
revoke(jids:Array):void
IRoom
  
sendMessage(body:String = null, htmlBody:String = null):void
IRoom
  
IRoom
  
sendPrivateMessage(recipientNickname:String, body:String = null, htmlBody:String = null):void
IRoom
 Inherited
setItemAt(item:*, index:int):*
ICollection
  
setOccupantVoice(occupantNick:String, voice:Boolean):void
IRoom
 Inherited
toString():String
ICollection
Property detail
affiliationproperty
affiliation:String  [read-only]Implementation
    public function get affiliation():String
anonymousproperty 
anonymous:Boolean  [read-only]Implementation
    public function get anonymous():Boolean
conferenceServerproperty 
conferenceServer:String  [read-write]Implementation
    public function get conferenceServer():String
    public function set conferenceServer(value:String):void
connectionproperty 
connection:IXMPPConnection  [read-write]Implementation
    public function get connection():IXMPPConnection
    public function set connection(value:IXMPPConnection):void
isActiveproperty 
isActive:Boolean  [read-only]Implementation
    public function get isActive():Boolean
nicknameproperty 
nickname:String  [read-write]Implementation
    public function get nickname():String
    public function set nickname(value:String):void
passwordproperty 
password:String  [read-write]Implementation
    public function get password():String
    public function set password(value:String):void
roleproperty 
role:String  [read-only]Implementation
    public function get role():String
roomJIDproperty 
roomJID:UnescapedJID  [read-write]Implementation
    public function get roomJID():UnescapedJID
    public function set roomJID(value:UnescapedJID):void
roomNameproperty 
roomName:String  [read-write]Implementation
    public function get roomName():String
    public function set roomName(value:String):void
subjectproperty 
subject:String  [read-only]Implementation
    public function get subject():String
userJIDproperty 
userJID:UnescapedJID  [read-only]Implementation
    public function get userJID():UnescapedJID
Method detail
allow()method
public function allow(jids:Array):voidParameters
jids:Array
ban()method 
public function ban(jids:Array):voidParameters
jids:Array
cancelConfiguration()method 
public function cancelConfiguration():void
changeSubject()method 
public function changeSubject(newSubject:String):voidParameters
newSubject:String
configure()method 
public function configure(fieldmap:Object):voidParameters
fieldmap:Object
decline()method 
public function decline(jid:UnescapedJID, reason:String):voidParameters
jid:UnescapedJID
 
reason:String
destroy()method 
public function destroy(reason:String, alternateJID:UnescapedJID = null, callback:Function = null):voidParameters
reason:String
 
alternateJID:UnescapedJID (default = null)
 
callback:Function (default = null)
getMessage()method 
public function getMessage(body:String = null, htmlBody:String = null):IMessageParameters
body:String (default = null)
 
htmlBody:String (default = null)

Returns
IMessage
getOccupantNamed()method 
public function getOccupantNamed(name:String):IRoomOccupantParameters
name:String

Returns
IRoomOccupant
grant()method 
public function grant(affiliation:String, jids:Array):voidParameters
affiliation:String
 
jids:Array
invite()method 
public function invite(jid:UnescapedJID, reason:String):voidParameters
jid:UnescapedJID
 
reason:String
isThisRoom()method 
public function isThisRoom(sender:UnescapedJID):BooleanParameters
sender:UnescapedJID

Returns
Boolean
isThisUser()method 
public function isThisUser(sender:UnescapedJID):BooleanParameters
sender:UnescapedJID

Returns
Boolean
join()method 
public function join(createReserved:Boolean = false, joinPresenceExtensions:Array = null):BooleanParameters
createReserved:Boolean (default = false)
 
joinPresenceExtensions:Array (default = null)

Returns
Boolean
joinWithExplicitMUCExtension()method 
public function joinWithExplicitMUCExtension(createReserved:Boolean, mucExtension:IMUCExtension, joinPresenceExtensions:Array = null):BooleanParameters
createReserved:Boolean
 
mucExtension:IMUCExtension
 
joinPresenceExtensions:Array (default = null)

Returns
Boolean
kickOccupant()method 
public function kickOccupant(occupantNick:String, reason:String):voidParameters
occupantNick:String
 
reason:String
leave()method 
public function leave():void
requestAffiliations()method 
public function requestAffiliations(affiliation:String):voidParameters
affiliation:String
requestConfiguration()method 
public function requestConfiguration():void
revoke()method 
public function revoke(jids:Array):voidParameters
jids:Array
sendMessage()method 
public function sendMessage(body:String = null, htmlBody:String = null):voidParameters
body:String (default = null)
 
htmlBody:String (default = null)
sendMessageWithExtension()method 
public function sendMessageWithExtension(message:IMessage):voidParameters
message:IMessage
sendPrivateMessage()method 
public function sendPrivateMessage(recipientNickname:String, body:String = null, htmlBody:String = null):voidParameters
recipientNickname:String
 
body:String (default = null)
 
htmlBody:String (default = null)
setOccupantVoice()method 
public function setOccupantVoice(occupantNick:String, voice:Boolean):voidParameters
occupantNick:String
 
voice:Boolean