Packageorg.igniterealtime.xiff.data.register
Classpublic class RegisterExtension
InheritanceRegisterExtension Inheritance Extension Inheritance XMLStanza Inheritance ExtensionContainer
ImplementsIExtension

Implements jabber:iq:register namespace. Use this to create new accounts on the jabber server. Send an empty IQ.TYPE_GET packet with this extension and the return will either be a conflict, or the fields you will need to fill out. Send a IQ.TYPE_SET packet to the server and with the fields that are listed in getRequiredFieldNames set on this extension. Check the result and re-establish the connection with the new account.

See also

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


Public Properties
 PropertyDefined by
  address : String
RegisterExtension
  city : String
RegisterExtension
  date : String
RegisterExtension
  email : String
RegisterExtension
 Inherited_exts : Object
ExtensionContainer
  first : String
RegisterExtension
  instructions : String
RegisterExtension
  key : String
RegisterExtension
  last : String
RegisterExtension
  misc : String
RegisterExtension
  nick : String
RegisterExtension
  password : String
RegisterExtension
  phone : String
RegisterExtension
  state : String
RegisterExtension
  text : String
RegisterExtension
  unregister : Boolean
RegisterExtension
  url : String
RegisterExtension
  username : String
RegisterExtension
 InheritedXMLData : XML
[static]
XMLStanza
 InheritedXMLFactory : XMLDocument
[static]
XMLStanza
  zip : String
RegisterExtension
Public Methods
 MethodDefined by
  
RegisterExtension(parent:XMLNode = null)
RegisterExtension
 Inherited
ExtensionContainer
 Inherited
addTextNode(parent:XMLNode, elementName:String, value:String):XMLNode
Adds a simple text node to the parent node specified.
XMLStanza
  
deserialize(node:XMLNode):Boolean
RegisterExtension
  
enable():void
[static] Performs the registration of this extension into the extension registry.
RegisterExtension
 Inherited
ensureNode(node:XMLNode, elementName:String):XMLNode
Ensures that a node with a specific element name exists in the stanza.
XMLStanza
 Inherited
exists(value:*):Boolean
[static] A helper method to determine if a value is both not null and not undefined.
XMLStanza
 Inherited
ExtensionContainer
 Inherited
getAllExtensionsByNS(ns:String):Array
ExtensionContainer
  
getElementName():String
RegisterExtension
 Inherited
getExtension(name:String):Extension
ExtensionContainer
  
getField(name:String):String
RegisterExtension
 Inherited
getNode():XMLNode
XMLStanza
  
getNS():String
RegisterExtension
  
RegisterExtension
 Inherited
remove():void
Removes the extension from its parent.
Extension
 Inherited
removeAllExtensions(ns:String):void
ExtensionContainer
 Inherited
ExtensionContainer
 Inherited
replaceTextNode(parent:XMLNode, original:XMLNode, elementName:String, value:String):XMLNode
Replaces one node in the stanza with another simple text node.
XMLStanza
  
serialize(parentNode:XMLNode):Boolean
RegisterExtension
  
setField(name:String, value:String):void
RegisterExtension
 Inherited
setNode(node:XMLNode):Boolean
Sets the XML node that should be used for this stanza's internal XML representation.
XMLStanza
 Inherited
toString():String
Converts the extension stanza XML to a string.
Extension
Public Constants
 ConstantDefined by
  ELEMENT_NAME : String = "query"
[static]
RegisterExtension
  NS : String = "jabber:iq:register"
[static]
RegisterExtension
Property detail
addressproperty
address:String  [read-write]

Implementation
    public function get address():String
    public function set address(value:String):void
cityproperty 
city:String  [read-write]

Implementation
    public function get city():String
    public function set city(value:String):void
dateproperty 
date:String  [read-write]

Implementation
    public function get date():String
    public function set date(value:String):void
emailproperty 
email:String  [read-write]

Implementation
    public function get email():String
    public function set email(value:String):void
firstproperty 
first:String  [read-write]

Implementation
    public function get first():String
    public function set first(value:String):void
instructionsproperty 
instructions:String  [read-write]

Implementation
    public function get instructions():String
    public function set instructions(value:String):void
keyproperty 
key:String  [read-write]

Implementation
    public function get key():String
    public function set key(value:String):void
lastproperty 
last:String  [read-write]

Implementation
    public function get last():String
    public function set last(value:String):void
miscproperty 
misc:String  [read-write]

Implementation
    public function get misc():String
    public function set misc(value:String):void
nickproperty 
nick:String  [read-write]

Implementation
    public function get nick():String
    public function set nick(value:String):void
passwordproperty 
password:String  [read-write]

Implementation
    public function get password():String
    public function set password(value:String):void
phoneproperty 
phone:String  [read-write]

Implementation
    public function get phone():String
    public function set phone(value:String):void
stateproperty 
state:String  [read-write]

Implementation
    public function get state():String
    public function set state(value:String):void
textproperty 
text:String  [read-write]

Implementation
    public function get text():String
    public function set text(value:String):void
unregisterproperty 
unregister:Boolean  [read-write]

Implementation
    public function get unregister():Boolean
    public function set unregister(value:Boolean):void
urlproperty 
url:String  [read-write]

Implementation
    public function get url():String
    public function set url(value:String):void
usernameproperty 
username:String  [read-write]

Implementation
    public function get username():String
    public function set username(value:String):void
zipproperty 
zip:String  [read-write]

Implementation
    public function get zip():String
    public function set zip(value:String):void
Constructor detail
RegisterExtension()constructor
public function RegisterExtension(parent:XMLNode = null)

Parameters
parent:XMLNode (default = null) — (Optional) The parent node used to build the XML tree.
Method detail
deserialize()method
public function deserialize(node:XMLNode):Boolean

Parameters
node:XMLNode

Returns
Boolean
enable()method 
public static function enable():void

Performs the registration of this extension into the extension registry.

getElementName()method 
public function getElementName():String

Returns
String
getField()method 
public function getField(name:String):String

Parameters
name:String

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

Returns
String
getRequiredFieldNames()method 
public function getRequiredFieldNames():Array

Returns
Array
serialize()method 
public function serialize(parentNode:XMLNode):Boolean

Parameters
parentNode:XMLNode

Returns
Boolean
setField()method 
public function setField(name:String, value:String):void

Parameters
name:String
 
value:String
Constant detail
ELEMENT_NAMEconstant
public static const ELEMENT_NAME:String = "query"
NSconstant 
public static const NS:String = "jabber:iq:register"