Packageorg.igniterealtime.xiff.im
Interfacepublic interface IRoster extends ICollection, flash.events.IEventDispatcher
Implementors Roster



Public Properties
 PropertyDefined By
  connection : IXMPPConnection
IRoster
 Inheritedlength : int
[read-only]
ICollection
Public Methods
 MethodDefined By
  
addContact(id:UnescapedJID, nickname:String, groupName:String = null, requestSubscription:Boolean = true):void
IRoster
 Inherited
addItem(item:*):void
ICollection
 Inherited
addItemAt(item:*, index:int):void
ICollection
 Inherited
ICollection
 Inherited
contains(item:*):Boolean
ICollection
  
IRoster
  
IRoster
  
IRoster
  
getGroup(name:String):IRosterGroup
IRoster
 Inherited
getItemAt(index:int):*
ICollection
 Inherited
getItemIndex(item:*):int
ICollection
  
IRoster
  
grantSubscription(tojid:UnescapedJID, requestAfterGrant:Boolean = true):void
IRoster
 Inherited
itemUpdated(item:*):void
ICollection
 Inherited
removeAll():void
ICollection
  
removeContact(rosterItem:IRosterItemVO):void
IRoster
 Inherited
removeItem(item:*):Boolean
ICollection
 Inherited
removeItemAt(index:int):*
ICollection
  
requestSubscription(id:UnescapedJID, isResponse:Boolean = false):void
IRoster
 Inherited
setItemAt(item:*, index:int):*
ICollection
  
setPresence(show:String, status:String, priority:int):void
IRoster
 Inherited
toString():String
ICollection
  
updateContactGroups(rosterItem:IRosterItemVO, newGroupNames:Array):void
IRoster
  
updateContactName(rosterItem:IRosterItemVO, newName:String):void
IRoster
Property Detail
connectionproperty
connection:IXMPPConnection


Implementation
    public function get connection():IXMPPConnection
    public function set connection(value:IXMPPConnection):void
Method Detail
addContact()method
public function addContact(id:UnescapedJID, nickname:String, groupName:String = null, requestSubscription:Boolean = true):void

Parameters

id:UnescapedJID
 
nickname:String
 
groupName:String (default = null)
 
requestSubscription:Boolean (default = true)

denySubscription()method 
public function denySubscription(tojid:UnescapedJID):void

Parameters

tojid:UnescapedJID

fetchRoster()method 
public function fetchRoster():void

getContainingGroups()method 
public function getContainingGroups(item:IRosterItemVO):Array

Parameters

item:IRosterItemVO

Returns
Array
getGroup()method 
public function getGroup(name:String):IRosterGroup

Parameters

name:String

Returns
IRosterGroup
getPresence()method 
public function getPresence(jid:UnescapedJID):IPresence

Parameters

jid:UnescapedJID

Returns
IPresence
grantSubscription()method 
public function grantSubscription(tojid:UnescapedJID, requestAfterGrant:Boolean = true):void

Parameters

tojid:UnescapedJID
 
requestAfterGrant:Boolean (default = true)

removeContact()method 
public function removeContact(rosterItem:IRosterItemVO):void

Parameters

rosterItem:IRosterItemVO

requestSubscription()method 
public function requestSubscription(id:UnescapedJID, isResponse:Boolean = false):void

Parameters

id:UnescapedJID
 
isResponse:Boolean (default = false)

setPresence()method 
public function setPresence(show:String, status:String, priority:int):void

Parameters

show:String
 
status:String
 
priority:int

updateContactGroups()method 
public function updateContactGroups(rosterItem:IRosterItemVO, newGroupNames:Array):void

Parameters

rosterItem:IRosterItemVO
 
newGroupNames:Array

updateContactName()method 
public function updateContactName(rosterItem:IRosterItemVO, newName:String):void

Parameters

rosterItem:IRosterItemVO
 
newName:String