Package | org.igniterealtime.xiff.bookmark |
Class | public class GroupChatBookmark |
Inheritance | GroupChatBookmark ![]() ![]() ![]() |
Implements | INodeProxy |
See also
Property | Defined 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 | ||
![]() | 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 | ||
---|---|---|---|
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 | ||
![]() |
Add extension to the list of the given namespace and insert to the XML element as a child. | ExtensionContainer | |
![]() | 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 | |
getElementName():String | GroupChatBookmark | ||
![]() | 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 | |
getNS():String | GroupChatBookmark | ||
![]() | removeAllExtensions(nameSpace:String):void | ExtensionContainer | |
![]() | removeExtension(extension:IExtension):Boolean | ExtensionContainer | |
![]() | removeFields(name:String):void
Helper method for removing all child elements that have the given name. | XMLStanza | |
![]() | 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 = conference [static] | GroupChatBookmark | ||
![]() | FLASH_NS : Namespace [static]
| XMLStanza | |
![]() | STREAM_NS : Namespace [static]
| XMLStanza |
autoJoin | property |
autoJoin:Boolean
Whether the client should automatically join the conference room on login.
public function get autoJoin():Boolean
public function set autoJoin(value:Boolean):void
jid | property |
jid:EscapedJID
[read-only] The JabberID of the chat room.
public function get jid():EscapedJID
name | property |
name:String
[read-only] A friendly name for the bookmark.
public function get name():String
nickname | property |
nickname:String
[read-only] The user's preferred roomnick for the chatroom.
public function get nickname():String
password | property |
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.
public function get password():String
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.
Parametersjid: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
getElementName | () | method |
public function getElementName():String
ReturnsString |
getNS | () | method |
public function getNS():String
ReturnsString |
ELEMENT_NAME | Constant |
public static const ELEMENT_NAME:String = conference