Package | org.igniterealtime.xiff.data.im |
Class | public class RosterItem |
Inheritance | RosterItem ![]() ![]() ![]() |
Implements | INodeProxy |
See also
Property | Defined By | ||
---|---|---|---|
askType : String
The ask type for this roster item. | RosterItem | ||
groupCount : int [read-only]
Get the number of group elements in this roster item. | RosterItem | ||
groupNames : Array [read-only]
Gets a list of all the groups associated with this roster item. | RosterItem | ||
jid : EscapedJID
The JID for this roster item. | RosterItem | ||
name : String
The display name for this roster item. | RosterItem | ||
pending : Boolean [read-only]
Convenience routine to determine if a roster item is considered "pending" or not. | RosterItem | ||
subscription : String
The subscription type for this roster item. | RosterItem | ||
![]() | xml : XML
The XML node that should be used for this stanza's internal XML representation,
base of the XMLStanza, XML element. | ExtensionContainer |
Method | Defined By | ||
---|---|---|---|
RosterItem(parent:XML = null) | RosterItem | ||
![]() |
Add extension to the list of the given namespace and insert to the XML element as a child. | ExtensionContainer | |
addGroupNamed(groupName:String):void
Adds a group to the roster item. | RosterItem | ||
![]() | getAllExtensions():Array | ExtensionContainer | |
![]() | getAllExtensionsByNS(nameSpace:String):Array | ExtensionContainer | |
![]() | getAttribute(name:String):String
Convinience method for getting element value from the XML. | XMLStanza | |
![]() | getChildAttribute(elem:String, name:String):String
Convinience method for getting child element attribute value from the XML. | XMLStanza | |
![]() | getChildField(elem:String, name:String):String
Convinience method for getting child element value from the XML. | XMLStanza | |
![]() | getExtension(elementName:String):IExtension
Get the extension having the given element name. | ExtensionContainer | |
![]() | getField(name:String):String
Convinience method for getting element value from the XML. | XMLStanza | |
![]() | removeAllExtensions(nameSpace:String):void | ExtensionContainer | |
removeAllGroups():void
Remove all group elements
| RosterItem | ||
![]() | removeExtension(extension:IExtension):Boolean | ExtensionContainer | |
![]() | removeFields(name:String):void
Helper method for removing all child elements that have the given name. | XMLStanza | |
removeGroupByName(groupName:String):Boolean
Remove a single group with the given name
| RosterItem | ||
![]() | setAttribute(name:String, value:String):void
Convinience method for setting a value to a element in the XML. | XMLStanza | |
![]() | setChildAttribute(elem:String, name:String, value:String):void
Convinience method for setting an attribute for a child element of the XML. | XMLStanza | |
![]() | setChildField(elem:String, name:String, value:String):void
Convinience method for setting a value for a child element of the XML. | XMLStanza | |
![]() | setField(name:String, value:String):void
Convinience method for setting a value to a element in the XML. | XMLStanza | |
![]() | toString():String
Converts the base stanza XML to a string. | XMLStanza |
Constant | Defined By | ||
---|---|---|---|
![]() | DEFAULT_NS : Namespace [static]
Default XML namespace. | XMLStanza | |
ELEMENT_NAME : String = item [static] | RosterItem | ||
![]() | FLASH_NS : Namespace [static]
| XMLStanza | |
![]() | STREAM_NS : Namespace [static]
| XMLStanza |
askType | property |
askType:String
The ask type for this roster item. Ask types have been enumerated by static variables in the RosterExtension:
public function get askType():String
public function set askType(value:String):void
groupCount | property |
groupCount:int
[read-only]
Get the number of group
elements in this roster item.
public function get groupCount():int
groupNames | property |
groupNames:Array
[read-only] Gets a list of all the groups associated with this roster item.
public function get groupNames():Array
jid | property |
jid:EscapedJID
The JID for this roster item. Required.
public function get jid():EscapedJID
public function set jid(value:EscapedJID):void
name | property |
name:String
The display name for this roster item.
public function get name():String
public function set name(value:String):void
pending | property |
pending:Boolean
[read-only] Convenience routine to determine if a roster item is considered "pending" or not.
public function get pending():Boolean
subscription | property |
subscription:String
The subscription type for this roster item. Subscription types have been enumerated by static variables in the RosterExtension:
public function get subscription():String
public function set subscription(value:String):void
See also
RosterItem | () | Constructor |
public function RosterItem(parent:XML = null)
Parameters
parent:XML (default = null ) — The parent XML
|
addGroupNamed | () | method |
public function addGroupNamed(groupName:String):void
Adds a group to the roster item. Contacts in the roster can be associated with multiple groups.
Parameters
groupName:String — The name of the group to add
|
removeAllGroups | () | method |
public function removeAllGroups():void
Remove all group elements
removeGroupByName | () | method |
public function removeGroupByName(groupName:String):Boolean
Remove a single group with the given name
Parameters
groupName:String |
Boolean — |
ELEMENT_NAME | Constant |
public static const ELEMENT_NAME:String = item