Package | org.igniterealtime.xiff.data.im |
Class | public class RosterItem |
Inheritance | RosterItem ![]() ![]() |
Implements | ISerializable |
See also
Property | Defined by | ||
---|---|---|---|
askType : String
The ask type for this roster item.
| RosterItem | ||
![]() | _exts : Object | ExtensionContainer | |
groupCount : uint [read-only]
| 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 | ||
![]() | XMLData : XML [static]
| XMLStanza | |
![]() | XMLFactory : XMLDocument [static]
| XMLStanza |
Method | Defined by | ||
---|---|---|---|
RosterItem(parent:XMLNode = null)
| RosterItem | ||
![]() | ExtensionContainer | ||
addGroupNamed(groupName:String):void
Adds a group to the roster item.
| RosterItem | ||
![]() |
addTextNode(parent:XMLNode, elementName:String, value:String):XMLNode
Adds a simple text node to the parent node specified.
| XMLStanza | |
deserialize(node:XMLNode):Boolean
Deserializes the RosterItem data.
| RosterItem | ||
![]() |
ensureNode(node:XMLNode, elementName:String):XMLNode
Ensures that a node with a specific element name exists in the stanza.
| XMLStanza | |
![]() |
exists(value:*):Boolean
[static]
A helper method to determine if a value is both not null
and not undefined.
| XMLStanza | |
![]() |
getAllExtensions():Array
| ExtensionContainer | |
![]() |
getAllExtensionsByNS(ns:String):Array
| ExtensionContainer | |
![]() |
getExtension(name:String):Extension
| ExtensionContainer | |
![]() |
getNode():XMLNode
| XMLStanza | |
![]() |
removeAllExtensions(ns:String):void
| ExtensionContainer | |
removeAllGroups():void
| RosterItem | ||
![]() |
removeExtension(ext:IExtension):Boolean
| ExtensionContainer | |
removeGroupByName(groupName:String):Boolean
| RosterItem | ||
![]() |
replaceTextNode(parent:XMLNode, original:XMLNode, elementName:String, value:String):XMLNode
Replaces one node in the stanza with another simple text node.
| XMLStanza | |
serialize(parent:XMLNode):Boolean
Serializes the RosterItem data to XML for sending.
| RosterItem | ||
![]() |
setNode(node:XMLNode):Boolean
Sets the XML node that should be used for this stanza's internal XML representation.
| XMLStanza |
Constant | Defined by | ||
---|---|---|---|
ELEMENT_NAME : String = "item" [static]
| RosterItem |
askType | property |
askType:String
[read-write]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:uint
[read-only]Implementation
public function get groupCount():uint
groupNames | property |
groupNames:Array
[read-only]Gets a list of all the groups associated with this roster item.
Implementation public function get groupNames():Array
jid | property |
jid:EscapedJID
[read-write]The JID for this roster item.
Implementation public function get jid():EscapedJID
public function set jid(value:EscapedJID):void
name | property |
name:String
[read-write]The display name for this roster item.
Implementation 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.
Implementation public function get pending():Boolean
subscription | property |
subscription:String
[read-write]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
RosterItem | () | constructor |
public function RosterItem(parent:XMLNode = null)
Parameters
parent:XMLNode (default = null )
|
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.
ParametersgroupName:String — The name of the group to add
|
deserialize | () | method |
public function deserialize(node:XMLNode):Boolean
Deserializes the RosterItem data.
Parametersnode:XMLNode — The XML node associated this data
|
Boolean — An indicator as to whether deserialization was successful
|
removeAllGroups | () | method |
public function removeAllGroups():void
removeGroupByName | () | method |
public function removeGroupByName(groupName:String):Boolean
Parameters
groupName:String |
Boolean |
serialize | () | method |
public function serialize(parent:XMLNode):Boolean
Serializes the RosterItem data to XML for sending.
Parametersparent:XMLNode — The parent node that this item should be serialized into
|
Boolean — An indicator as to whether serialization was successful
|
ELEMENT_NAME | constant |
public static const ELEMENT_NAME:String = "item"