Packageorg.igniterealtime.xiff.bookmark
Classpublic class GroupChatBookmark
InheritanceGroupChatBookmark Inheritance XMLStanza Inheritance ExtensionContainer Inheritance Object
Implements INodeProxy

XEP-0048: Bookmarks

See also

http://xmpp.org/extensions/xep-0048.html


Public Properties
 PropertyDefined By
  autoJoin : Boolean
Whether the client should automatically join the conference room on login.
GroupChatBookmark
  jid : EscapedJID
[read-only] The JabberID of the chat room.
GroupChatBookmark
  name : String
[read-only] A friendly name for the bookmark.
GroupChatBookmark
  nickname : String
[read-only] The user's preferred roomnick for the chatroom.
GroupChatBookmark
  password : String
[read-only] Unencrypted string for the password needed to enter a password-protected room.
GroupChatBookmark
 Inheritedxml : XML
The XML node that should be used for this stanza's internal XML representation, base of the XMLStanza, XML element.
ExtensionContainer
Public Methods
 MethodDefined By
  
GroupChatBookmark(jid:EscapedJID, name:String = null, autoJoin:Boolean = false, nickname:String = null, password:String = null)
A common use case is bookmarking of multi-user chat rooms.
GroupChatBookmark
 Inherited
Add extension to the list of the given namespace and insert to the XML element as a child.
ExtensionContainer
 Inherited
ExtensionContainer
 Inherited
getAllExtensionsByNS(nameSpace:String):Array
ExtensionContainer
 Inherited
getAttribute(name:String):String
Convinience method for getting element value from the XML.
XMLStanza
 Inherited
getChildAttribute(elem:String, name:String):String
Convinience method for getting child element attribute value from the XML.
XMLStanza
 Inherited
getChildField(elem:String, name:String):String
Convinience method for getting child element value from the XML.
XMLStanza
  
GroupChatBookmark
 Inherited
getExtension(elementName:String):IExtension
Get the extension having the given element name.
ExtensionContainer
 Inherited
getField(name:String):String
Convinience method for getting element value from the XML.
XMLStanza
  
getNS():String
GroupChatBookmark
 Inherited
removeAllExtensions(nameSpace:String):void
ExtensionContainer
 Inherited
removeExtension(extension:IExtension):Boolean
ExtensionContainer
 Inherited
removeFields(name:String):void
Helper method for removing all child elements that have the given name.
XMLStanza
 Inherited
setAttribute(name:String, value:String):void
Convinience method for setting a value to a element in the XML.
XMLStanza
 Inherited
setChildAttribute(elem:String, name:String, value:String):void
Convinience method for setting an attribute for a child element of the XML.
XMLStanza
 Inherited
setChildField(elem:String, name:String, value:String):void
Convinience method for setting a value for a child element of the XML.
XMLStanza
 Inherited
setField(name:String, value:String):void
Convinience method for setting a value to a element in the XML.
XMLStanza
 Inherited
toString():String
Converts the base stanza XML to a string.
XMLStanza
Public Constants
 ConstantDefined By
 InheritedDEFAULT_NS : Namespace
[static] Default XML namespace.
XMLStanza
  ELEMENT_NAME : String = conference
[static]
GroupChatBookmark
 InheritedFLASH_NS : Namespace
[static]
XMLStanza
 InheritedSTREAM_NS : Namespace
[static]
XMLStanza
Property Detail
autoJoinproperty
autoJoin:Boolean

Whether the client should automatically join the conference room on login.


Implementation
    public function get autoJoin():Boolean
    public function set autoJoin(value:Boolean):void
jidproperty 
jid:EscapedJID  [read-only]

The JabberID of the chat room.


Implementation
    public function get jid():EscapedJID
nameproperty 
name:String  [read-only]

A friendly name for the bookmark.


Implementation
    public function get name():String
nicknameproperty 
nickname:String  [read-only]

The user's preferred roomnick for the chatroom.


Implementation
    public function get nickname():String
passwordproperty 
password:String  [read-only]

Unencrypted string for the password needed to enter a password-protected room.

For security reasons, use of this element is NOT RECOMMENDED.


Implementation
    public function get password():String
Constructor Detail
GroupChatBookmark()Constructor
public function GroupChatBookmark(jid:EscapedJID, name:String = null, autoJoin:Boolean = false, nickname:String = null, password:String = null)

A common use case is bookmarking of multi-user chat rooms. A room is bookmarked using the conference child element.

Most of the properties can be set only via constructor or by setting the XML.

Parameters
jid:EscapedJID — REQUIRED
 
name:String (default = null) — RECOMMENDED
 
autoJoin:Boolean (default = false) — OPTIONAL
 
nickname:String (default = null) — OPTIONAL
 
password:String (default = null) — NOT RECOMMENDED

See also

Method Detail
getElementName()method
public function getElementName():String

Returns
String
getNS()method 
public function getNS():String

Returns
String
Constant Detail
ELEMENT_NAMEConstant
public static const ELEMENT_NAME:String = conference