Packageorg.igniterealtime.xiff.data.im
Classpublic class RosterGroup
InheritanceRosterGroup Inheritance Object
Implements IRosterGroup

Represents the groups in users roster.



Public Properties
 PropertyDefined By
  items : ICollection
[read-only] Roster items in this group.
RosterGroup
  label : String
RosterGroup
  shared : Boolean
RosterGroup
Public Methods
 MethodDefined By
  
RosterGroup(label:String)
Create a new group with the given name
RosterGroup
  
Insert a new roster item if it does not already exist in this group
RosterGroup
  
contains(item:IRosterItemVO):Boolean
Does the given item exist in this group?
RosterGroup
  
Remove the given roster item from this group.
RosterGroup
Property Detail
itemsproperty
items:ICollection  [read-only]

Roster items in this group.


Implementation
    public function get items():ICollection
labelproperty 
label:String


Implementation
    public function get label():String
    public function set label(value:String):void
sharedproperty 
shared:Boolean


Implementation
    public function get shared():Boolean
    public function set shared(value:Boolean):void
Constructor Detail
RosterGroup()Constructor
public function RosterGroup(label:String)

Create a new group with the given name

Parameters
label:String
Method Detail
addItem()method
public function addItem(item:IRosterItemVO):void

Insert a new roster item if it does not already exist in this group

Parameters

item:IRosterItemVO

contains()method 
public function contains(item:IRosterItemVO):Boolean

Does the given item exist in this group?

Parameters

item:IRosterItemVO

Returns
Boolean
removeItem()method 
public function removeItem(item:IRosterItemVO):Boolean

Remove the given roster item from this group.

Parameters

item:IRosterItemVO

Returns
Boolean