Package | org.igniterealtime.xiff.conference |
Interface | public interface IRoom extends ICollection, flash.events.IEventDispatcher |
Implementors | Room |
Property | Defined By | ||
---|---|---|---|
active : Boolean [read-only] | IRoom | ||
affiliation : String [read-only] | IRoom | ||
anonymous : Boolean [read-only] | IRoom | ||
conferenceServer : String | IRoom | ||
connection : IXMPPConnection | IRoom | ||
![]() | length : int [read-only] | 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 |
Method | Defined By | ||
---|---|---|---|
![]() | addItem(item:*):void | ICollection | |
![]() | addItemAt(item:*, index:int):void | ICollection | |
allow(jids:Array):void | IRoom | ||
ban(jids:Array):void | IRoom | ||
cancelConfiguration():void | IRoom | ||
changeSubject(newSubject:String):void | IRoom | ||
![]() | clearSource():void | ICollection | |
configure(fieldmap:Object):void | IRoom | ||
![]() | contains(item:*):Boolean | ICollection | |
decline(jid:UnescapedJID, reason:String):void | IRoom | ||
destroy(reason:String, alternateJID:UnescapedJID = null, callback:Function = null):void | IRoom | ||
![]() | getItemAt(index:int):* | ICollection | |
![]() | getItemIndex(item:*):int | ICollection | |
getMessage(body:String = null, htmlBody:String = null):IMessage | IRoom | ||
getOccupantNamed(name:String):IRoomOccupant | 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 | ||
![]() | 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 | ||
![]() | removeAll():void | ICollection | |
![]() | removeItem(item:*):Boolean | ICollection | |
![]() | removeItemAt(index:int):* | ICollection | |
requestAffiliations(affiliation:String):void | IRoom | ||
requestConfiguration():void | IRoom | ||
revoke(jids:Array):void | IRoom | ||
sendMessage(body:String = null, htmlBody:String = null):void | IRoom | ||
sendMessageWithExtension(message:IMessage):void | IRoom | ||
sendPrivateMessage(recipientNickname:String, body:String = null, htmlBody:String = null):void | IRoom | ||
![]() | setItemAt(item:*, index:int):* | ICollection | |
setOccupantVoice(occupantNick:String, voice:Boolean):void | IRoom | ||
![]() | toString():String | ICollection |
active | property |
active:Boolean
[read-only] public function get active():Boolean
affiliation | property |
affiliation:String
[read-only] public function get affiliation():String
anonymous | property |
anonymous:Boolean
[read-only] public function get anonymous():Boolean
conferenceServer | property |
conferenceServer:String
public function get conferenceServer():String
public function set conferenceServer(value:String):void
connection | property |
connection:IXMPPConnection
public function get connection():IXMPPConnection
public function set connection(value:IXMPPConnection):void
nickname | property |
nickname:String
public function get nickname():String
public function set nickname(value:String):void
password | property |
password:String
public function get password():String
public function set password(value:String):void
role | property |
role:String
[read-only] public function get role():String
roomJID | property |
roomJID:UnescapedJID
public function get roomJID():UnescapedJID
public function set roomJID(value:UnescapedJID):void
roomName | property |
roomName:String
public function get roomName():String
public function set roomName(value:String):void
subject | property |
subject:String
[read-only] public function get subject():String
userJID | property |
allow | () | method |
public function allow(jids:Array):void
Parameters
jids:Array |
ban | () | method |
public function ban(jids:Array):void
Parameters
jids:Array |
cancelConfiguration | () | method |
public function cancelConfiguration():void
changeSubject | () | method |
public function changeSubject(newSubject:String):void
Parameters
newSubject:String |
configure | () | method |
public function configure(fieldmap:Object):void
Parameters
fieldmap:Object |
decline | () | method |
public function decline(jid:UnescapedJID, reason:String):void
Parameters
jid:UnescapedJID | |
reason:String |
destroy | () | method |
public function destroy(reason:String, alternateJID:UnescapedJID = null, callback:Function = null):void
Parameters
reason:String | |
alternateJID:UnescapedJID (default = null )
| |
callback:Function (default = null )
|
getMessage | () | method |
public function getMessage(body:String = null, htmlBody:String = null):IMessage
Parameters
body:String (default = null )
| |
htmlBody:String (default = null )
|
IMessage |
getOccupantNamed | () | method |
public function getOccupantNamed(name:String):IRoomOccupant
Parameters
name:String |
IRoomOccupant |
grant | () | method |
public function grant(affiliation:String, jids:Array):void
Parameters
affiliation:String | |
jids:Array |
invite | () | method |
public function invite(jid:UnescapedJID, reason:String):void
Parameters
jid:UnescapedJID | |
reason:String |
isThisRoom | () | method |
public function isThisRoom(sender:UnescapedJID):Boolean
Parameters
sender:UnescapedJID |
Boolean |
isThisUser | () | method |
public function isThisUser(sender:UnescapedJID):Boolean
Parameters
sender:UnescapedJID |
Boolean |
join | () | method |
public function join(createReserved:Boolean = false, joinPresenceExtensions:Array = null):Boolean
Parameters
createReserved:Boolean (default = false )
| |
joinPresenceExtensions:Array (default = null )
|
Boolean |
joinWithExplicitMUCExtension | () | method |
public function joinWithExplicitMUCExtension(createReserved:Boolean, mucExtension:IMUCExtension, joinPresenceExtensions:Array = null):Boolean
Parameters
createReserved:Boolean | |
mucExtension:IMUCExtension | |
joinPresenceExtensions:Array (default = null )
|
Boolean |
kickOccupant | () | method |
public function kickOccupant(occupantNick:String, reason:String):void
Parameters
occupantNick:String | |
reason:String |
leave | () | method |
public function leave():void
requestAffiliations | () | method |
public function requestAffiliations(affiliation:String):void
Parameters
affiliation:String |
requestConfiguration | () | method |
public function requestConfiguration():void
revoke | () | method |
public function revoke(jids:Array):void
Parameters
jids:Array |
sendMessage | () | method |
public function sendMessage(body:String = null, htmlBody:String = null):void
Parameters
body:String (default = null )
| |
htmlBody:String (default = null )
|
sendMessageWithExtension | () | method |
sendPrivateMessage | () | method |
public function sendPrivateMessage(recipientNickname:String, body:String = null, htmlBody:String = null):void
Parameters
recipientNickname:String | |
body:String (default = null )
| |
htmlBody:String (default = null )
|
setOccupantVoice | () | method |
public function setOccupantVoice(occupantNick:String, voice:Boolean):void
Parameters
occupantNick:String | |
voice:Boolean |