| Package | org.igniterealtime.xiff.core |
| Class | public class InBandRegistrator |
| Inheritance | InBandRegistrator  flash.events.EventDispatcher |
Once the connection has been established and the server has provided feature
information, check XMPPConnection.registrationSupported before trying to use
the registration.
See also
| Property | Defined By | ||
|---|---|---|---|
| connection : IXMPPConnection
The instance of the XMPPConnection class to use for sending and
receiving data. | InBandRegistrator | ||
| Method | Defined By | ||
|---|---|---|---|
InBandRegistrator(aConnection:IXMPPConnection = null)
Manage client registration and password changing. | InBandRegistrator | ||
changePassword(newPassword:String):void
Changes the user's account password on the server. | InBandRegistrator | ||
getRegistrationFields():void
Issues a request for the information that must be submitted for registration with the server. | InBandRegistrator | ||
sendRegistrationFields(fieldMap:Object, key:String = null):void
Registers a new account with the server, sending the registration data as specified in the fieldMap | InBandRegistrator | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when a password change is successful. | InBandRegistrator | |||
| Dispatched on when new user account registration is successful. | InBandRegistrator | |||
| Dispatched on when new user account registration is successful. | InBandRegistrator | |||
| connection | property |
connection:IXMPPConnectionThe instance of the XMPPConnection class to use for sending and receiving data.
public function get connection():IXMPPConnection public function set connection(value:IXMPPConnection):void| InBandRegistrator | () | Constructor |
public function InBandRegistrator(aConnection:IXMPPConnection = null)Manage client registration and password changing.
ParametersaConnection:IXMPPConnection (default = null)XMPPConnection instance to use.
|
| changePassword | () | method |
public function changePassword(newPassword:String):void
Changes the user's account password on the server. If the password change is successful,
the class will broadcast a ChangePasswordSuccessEvent.PASSWORD_SUCCESS event.
Parameters
newPassword:String — The new password
|
| getRegistrationFields | () | method |
public function getRegistrationFields():void
Issues a request for the information that must be submitted for registration with the server.
When the data returns, a RegistrationFieldsEvent.REG_FIELDS event is dispatched
containing the requested data.
| sendRegistrationFields | () | method |
public function sendRegistrationFields(fieldMap:Object, key:String = null):voidRegisters a new account with the server, sending the registration data as specified in the fieldMap
Parameters
fieldMap:Object — An object map containing the data to use for registration. The map should be composed of
attribute:value pairs for each registration data item.
| |
key:String (default = null) |
| changePasswordSuccess | Event |
org.igniterealtime.xiff.events.ChangePasswordSuccessEventorg.igniterealtime.xiff.events.ChangePasswordSuccessEvent.PASSWORD_SUCCESSDispatched when a password change is successful.
| registrationFields | Event |
org.igniterealtime.xiff.events.RegistrationFieldsEventorg.igniterealtime.xiff.events.RegistrationFieldsEvent.REG_FIELDSDispatched on when new user account registration is successful.
| registrationSuccess | Event |
org.igniterealtime.xiff.events.RegistrationSuccessEventorg.igniterealtime.xiff.events.RegistrationSuccessEvent.REGISTRATION_SUCCESSDispatched on when new user account registration is successful.