| Package | org.igniterealtime.xiff.data.register |
| Class | public class RegisterExtension |
| Inheritance | RegisterExtension  Extension XMLStanza ExtensionContainer Object |
| Implements | IExtension |
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
| Property | Defined By | ||
|---|---|---|---|
| address : String | RegisterExtension | ||
| city : String | RegisterExtension | ||
| date : String | RegisterExtension | ||
| email : String | RegisterExtension | ||
| first : String | RegisterExtension | ||
| instructions : String
Use null to remove. | RegisterExtension | ||
| key : String
This element is obsolete, but is included here for historical completeness. | RegisterExtension | ||
| last : String | RegisterExtension | ||
| misc : String | RegisterExtension | ||
| nick : String | RegisterExtension | ||
| password : String
The 'jabber:iq:register' namespace enables a user to change his or her
password with a server or service. | RegisterExtension | ||
| phone : String | RegisterExtension | ||
| state : String | RegisterExtension | ||
| text : String | RegisterExtension | ||
| unregister : Boolean
The 'jabber:iq:register' namespace also makes it possible for an entity to cancel a
registration with a host by sending a remove element in an IQ set. | RegisterExtension | ||
| url : String | RegisterExtension | ||
| username : String
The 'jabber:iq:register' namespace enables a user to change his or her
password with a server or service. | RegisterExtension | ||
 | xml : XML [override]
Override in order to take care of setting the Namespace and
checking for containing extensions. | Extension | |
| zip : String | RegisterExtension | ||
| Method | Defined By | ||
|---|---|---|---|
RegisterExtension(parent:XML = null) | RegisterExtension | ||
|
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 | RegisterExtension | ||
| 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 | RegisterExtension | ||
getRequiredFieldNames():Array
In order to determine which fields are required for registration with a host,
an entity SHOULD first send an IQ get to the host. | RegisterExtension | ||
| remove():void
Removes the extension from its parent. | Extension | |
| 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 = query [static] | RegisterExtension | ||
| FLASH_NS : Namespace [static]
| XMLStanza | |
| NS : String = jabber:iq:register [static] | RegisterExtension | ||
| STREAM_NS : Namespace [static]
| XMLStanza | |
| address | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesaddress:String
public function get address():String public function set address(value:String):void| city | property |
city:String
public function get city():String public function set city(value:String):void| date | property |
date:String
public function get date():String public function set date(value:String):void| property |
email:String
public function get email():String public function set email(value:String):void| first | property |
first:String
public function get first():String public function set first(value:String):void| instructions | property |
instructions:String
Use null to remove.
public function get instructions():String public function set instructions(value:String):void| key | property |
key:StringThis element is obsolete, but is included here for historical completeness.
The key element was used as a "transaction key" in certain IQ interactions in order to verify the identity of the sender. In particular, it was used by servers (but generally not services) during in-band registration, since normally a user does not yet have a 'from' address before registering.
Use null to remove.
public function get key():String public function set key(value:String):void| last | property |
last:String
public function get last():String public function set last(value:String):void| misc | property |
misc:String
public function get misc():String public function set misc(value:String):void| nick | property |
nick:String
public function get nick():String public function set nick(value:String):void| password | property |
password:String
The 'jabber:iq:register' namespace enables a user to change his or her
password with a server or service. Once registered, the user can
change passwords by setting username and password.
public function get password():String public function set password(value:String):voidSee also
| phone | property |
phone:String
public function get phone():String public function set phone(value:String):void| state | property |
state:String
public function get state():String public function set state(value:String):void| text | property |
text:String
public function get text():String public function set text(value:String):void| unregister | property |
unregister:BooleanThe 'jabber:iq:register' namespace also makes it possible for an entity to cancel a registration with a host by sending a remove element in an IQ set. The host MUST determine the identity of the requesting entity based on the 'from' address of the IQ get.
public function get unregister():Boolean public function set unregister(value:Boolean):void| url | property |
url:String
public function get url():String public function set url(value:String):void| username | property |
username:String
The 'jabber:iq:register' namespace enables a user to change his or her
password with a server or service. Once registered, the user can
change passwords by setting username and password.
public function get username():String public function set username(value:String):voidSee also
| zip | property |
zip:String
public function get zip():String public function set zip(value:String):void| RegisterExtension | () | Constructor |
public function RegisterExtension(parent:XML = null)Parameters
parent:XML (default = null) |
| getElementName | () | method |
public function getElementName():StringReturnsString |
| getNS | () | method |
public function getNS():StringReturnsString |
| getRequiredFieldNames | () | method |
public function getRequiredFieldNames():ArrayIn order to determine which fields are required for registration with a host, an entity SHOULD first send an IQ get to the host. The entity SHOULD NOT attempt to guess at the required fields by first sending an IQ set, since the nature of the required data is subject to service provisioning.
All fields available in this XML, except "key" and "instructions" are required.
ReturnsArray — Names of the required fields
|
| ELEMENT_NAME | Constant |
public static const ELEMENT_NAME:String = query| NS | Constant |
public static const NS:String = jabber:iq:register