A
Adds a contact to the roster. Remember: All roster data is managed on the server-side, so this contact is added to the server-side roster first, and upon successful addition, reflected in the local client-side copy of the roster.
Used to add listeners for certain events. Event dispatching is handled using Macromedia's EventDispatcher class found in mx.events.EventDispatcher. Listeners can either implement a method with the same name as the event they are listening to, or a method called <code>handleEvent</code> that will handle all incoming event broadcasts. If <code>handleEvent</code> is implemented, the method can examine the event object's <code>type</code> attribute to find out which type of event occured.
These are added by the ExtensionContainer decoration
Adds a group to the roster item. Contacts in the roster can be associated with multiple groups.
If you are generating a browse response to a browse request, then fill out the items list with this method.
Adds a single roster item to the extension payload.
Use this method to create a new item. Either the affiliation or role are requried.
Add new features that are supported if you are responding to a browse request
Another interface to add segments to this extension. Instead of passing an object, you can pass parameters that will be converted into a segment and passed to addSegment
Adds a start point and end point to this path. The points will be rounded to the nearest integer to save serialization space. 10.0000001 takes 4 times as much spaces as 10
Adds a simple text node to the parent node specified.
Allow a previously banned JIDs to enter this room. This is the same as: Room.grant(NO_AFFILIATION, jid) If the process could not be completed, the room will dispatch the event adminError
Implements <a href="http://www.jabber.org/jeps/jep-0078.html">JEP-0078<a> for non SASL authentication.
Static variables for specific type strings
B
Bans an arrya of JIDs from entering the room. This is the same as: Room.grant(OUTCAST_AFFILIATION, jid) If the process could not be completed, the room will dispatch the event adminError
The message body in plain-text format. If a client cannot render HTML-formatted text, this text is typically used instead.
The XHTML body text. Valid XHTML is REQUIRED. Because XMPP operates using valid XML, standard HTML, which is not necessarily XML-parser compliant, will not work.
Implements jabber:iq:browse namespace. Use this extension to request the items of an agent or service such as the rooms of a conference server or the members of a room.
Use the BrowseExtension (jabber:iq:browse namespace) to query a resource for supported features and children.
Class that representes a child resource of a browsed resource.
Static class variables to be overridden in subclasses;
Provides a means of quering for available services on an XMPP server using the Disco protocol extension. For more information on Disco, take a look at <a href="http://www.jabber.org/jeps/jep-0030.html">JEP-0030</a> and <a href="http://www.jabber.org/jeps/jep-0011.html">JEP-0011</a> for the protocol enhancement specifications.
C
Takes a string and returns the hex representation of its SHA1 hash.
Place the remote call. This method serializes the remote procedure call to XML. The call will be made on the remote machine when the stanza containing this extension is sent to the server. If this extension is being returned, then check the result property instead.
The function that will be called when an IQ result or error is received with the same ID as one you send. The function will be called in the scope of the IQ, so if you wish to have this called with the scope of your class wrap your function with a mx.utils.Delegate class. If both <code>callbackName/callbackScope</code> and callback are set then both functions will be called. This is an alternative to the <code>callbackName/callbackScope</code> method of receiving callbacks. Callback functions take one parameter which will be the IQ instance received from the server. This isn't a required property, but is useful if you need to respond to server responses to an IQ.
The name of the callback function to call when a response to the IQ is received. This isn't a required property, but is useful if you need to respond to server responses to an IQ.
The scope of the callback function to call when a response to the IQ is received. This isn't a required property, but is useful if you need to respond to server responses to an IQ.
Cancels the configuration process. The room may still be locked if you cancel the configuration process when attempting to join a reserved room. You must be joined to the room and have the owner affiliation to configure the room
[optional] One of the categories from the list above, or a non-standard category prefixed with the string "x-".
Changes the user's account password on the server. If the password change is successful, the class will broadcast a <code>changePasswordSuccess</code> event.
Changes the subject in the conference room. You must be joined to the room to change the subject
The value of the RGB color. This is the same color format used by MovieClip.lineStyle
The value of the RGB color. This is the same color format used by MovieClip.lineStyle
Computes the SHA1 digest of the password and session ID for use when authenticating with the server.
The conference server to use for this room. Usually, this is a subdomain of the primary XMPP server, like conference.myserver.com.
Sends a configuration form to the room. Accepts a fieldmap hash which is an object with keys being the variables and the values being arrays. For single value fields, use a single element array You must be joined and have owner affiliation to configure the room
Connects to the server.
The instance of the XMPPConnection class to use for sending and receiving data.
The instance of the XMPPConnection class to use for the roster to use for sending and receiving data.
D
Actively decline an invitation. You can optionally ignore invitations but if you choose to decline an invitation, you call this method on a room instance that represents the room the invite originated from. You do not need to be joined to this room to decline an invitation Note: mu-conference-0.6 currently does not allow users to send decline messages without joining first. If using this version of conferencing software, it is best to ignore invites.
Use this extension to decline an invitation
Revokes an existing presence subscription or denies a subscription request. If a user has sent you a subscription request you can use this method to deny that request. Otherwise, if a user already has a granted presence subscription, you can use this method to revoke that subscription.
Deserializes an XML object and populates the IQ instance with its data.
Called when data is retrieved from the XMLSocket, use this method to extract any state into internal state.
Deserializes an XML object and populates the Message instance with its data.
Deserializes an XML object and populates the Presence instance with its data.
Called when data is retrieved from the XMLSocket, use this method to extract any state into internal state.
Called when data is retrieved from the XMLSocket, use this method to extract any state into internal state.
ISerializable implementation which saves this extension to XML
Called when data is retrieved from the XMLSocket, use this method to extract any state into internal state.
Called when data is retrieved from the XMLSocket, use this method to extract any state into internal state.
Called when data is retrieved from the XMLSocket, use this method to extract any state into internal state.
Called when data is retrieved from the XMLSocket, use this method to extract any state into internal state.
Called when data is retrieved from the XMLSocket, use this method to extract any state into internal state.
Deserializes the FormField data.
Deserializes the RosterExtension data.
Deserializes the RosterItem data.
Called when data is retrieved from the XMLSocket, use this method to extract any state into internal state.
Called when data is retrieved from the XMLSocket, use this method to extract any state into internal state.
Called when data is retrieved from the XMLSocket, use this method to extract any state into internal state.
Called when data is retrieved from the XMLSocket, use this method to extract any state into internal state.
Called when data is retrieved from the XMLSocket, use this method to extract any state into internal state.
Called when data is retrieved from the XMLSocket, use this method to extract any state into internal state.
Interface method, returning the namespace for this extension
Extracts the known fill attributes from the node
Deserializes the Path data.
Extracts the known stroke attributes from the node
Deserializes the WhiteboardExtension data.
Destroys a reserved room. If the room has been configured to be persistent, then it is optional that the server will permanently remove the room.
Replaces the <code>destroy</code> node with a new node and sets the <code>reason</code> element and <code>jid</code> attribute
Use this extension to destroy a room
The SHA1 digest to use for authentication.
Base class for service discovery extensions.
Disconnects from the server if currently connected. After disconnect, a <code>disconnection</code> event is broadcast.
E
Static class variables to be overridden in subclasses;
Performs the registration of this extension into the extension registry.
Performs the registration of this extension into the extension registry.
Performs the registration of this extension into the extension registry.
Performs the registration of this extension into the extension registry.
Performs the registration of this extension into the extension registry.
Register the multi-user chat extension capabilities with this method
Performs the registration of this extension into the extension registry.
Performs the registration of this extension into the extension registry.
Performs the registration of this extension into the extension registry.
Performs the registration of this extension into the extension registry.
Ensures that a node with a specific element name exists in the stanza. If it doesn't, then the node is created and returned.
The error code, assuming this stanza contains error information. Error codes are deprecated in standard XMPP, but they are commonly used by older Jabber servers like Jabberd 1.4. For more information on error codes, and corresponding error conditions, see <a href="http://www.jabber.org/jeps/jep-0086.html">http://www.jabber.org/jeps/jep-0086.html</a>.
The error condition, assuming this stanza contains error information. For more information on error conditions, see <a href="http://www.jabber.org/jeps/jep-0086.html">http://www.jabber.org/jeps/jep-0086.html</a>.
The error message, assuming this stanza contains error information.
The error type, assuming this stanza contains error information. For more information on error types, see <a href="http://www.jabber.org/jeps/jep-0086.html">http://www.jabber.org/jeps/jep-0086.html</a>.
This is a base class for all data extensions.
This is a static class that contains class constructors for all extensions that could come from the network.
Contains the implementation for a generic extension container. Use the static method "decorate" to implement the IExtendable interface on a class.
F
The object containing the fault of the remote procedure call. This object could have any properties, as fault results are only structurally defined.
A common result from most RPC servers to describe a fault
A common result from most RPC servers to describe a fault
An array of namespaces this service supports for feature negotiation.
Fetches the roster data from the server. Once the data has been fetched, the Roster's data provider is populated appropriately. If the Roster-XMPPConnection class dependency has been set up before logging in, then this method will be called automatically because the Roster listens for "login" events from the XMPPConnection.
The Fill object that contains the properties describing the fill of this path
A helper class that abstracts the serialization of fills and provides an interface to access the properties providing defaults if no properties were defined in the XML.
Implements the base functionality shared by all MUC extensions
This class is used by the FormExtension class for managing fields as fields have multiple behaviors depending on the type of the form while containing different kinds of data, some optional some not.
The JID of the sender. Most, if not all, server implementations follow the specifications that prevent this from being falsified. Thus, under normal circumstances, you don't need to supply this information because the server will fill it in automatically.
The from property for invite and decline action types
Extract and marshall the XML-RPC response to Flash types.
G
(Static method) Generates a unique ID for the stanza. ID generation is handled using a variety of mechanisms, but the default for the library uses the IncrementalGenerator.
Gets the user's affiliation for this room. Possible affiliations are "owner", "admin", "member", and "outcast". It is also possible to have no defined affiliation.
Item interface to array of fields if they are contained in an "item" element
Item interface to array of fields if they are contained in an "item" element
Get all the items from this roster query.
Item interface to MUCItems if they are contained in this extension
If options are provided for possible selections of the value they are listed here. Applies to the following field types: <code>FormExtension.FIELD_TYPE_JID_MULTI</code> <code>FormExtension.FIELD_TYPE_JID_SINGLE</code> <code>FormExtension.FIELD_TYPE_LIST_MULTI</code> <code>FormExtension.FIELD_TYPE_LIST_SINGLE</code>
The values for this multiple field. In forms with a type <code>FormExtension.REQUEST_TYPE</code> these are typically the existing values of the field. Applies to the following field types: <code>FormExtension.FIELD_TYPE_JID_MULTI</code> <code>FormExtension.FIELD_TYPE_LIST_MULTI</code> <code>FormExtension.FIELD_TYPE_TEXT_MULTI</code>
Gets the bare JID (non-fully qualified: user@server) of the user. The bare JID does not include the resource.
Gets a reference to the XMPPConnection being used for incoming/outgoing XMPP data.
Gets a reference to the XMPPConnection being used for incoming/outgoing XMPP data.
Gets all of the locally-cached information for a certain contact by in the roster.
Gets the element name associated with this extension. The element for this extension is "query".
Gets the element name associated with this extension. The element for this extension is "query".
Gets the element name associated with this extension. The element for this extension is "query".
Interface method, returning the namespace for this extension
Gets the element name associated with this extension. The element for this extension is "x".
Gets the element name associated with this extension. The element for this extension is "html".
This is an accessor to the hidden field type <code>FORM_TYPE</code> easily check what kind of form this is.
Gets the fully qualified room name (room@server) of the current room.
Gets a list of all the groups associated with this roster item.
Gets the generated ID.
Gets the unique ID.
Gets the unique ID.
ddura: I am turning this into a singleton, for more global access. I am trying to work around a Flex bug. Not sure yet?
Gets a roster item at a specific index. Part of the "read-only" implementation of the DataProvider API. Roster items are generic objects with the following attributes: <code>jid</code>, <code>displayName</code>, <code>group</code>, <code>subscribeType</code>, <code>status</code>, <code>show</code>, and <code>priority</code>.
Gets one item from the roster query, returning the first item found with the JID specified. If none is found, then it returns null.
Gets the ID of a roster item at a particular index. Part of the "read-only" implementation of the DataProvider API.
Gets the fully qualified JID (user@server/resource) of the user. A fully-qualified JID includes the resource. A bare JID does not. To get the bare JID, use the <code>getBareJID()</code> method.
Gets the XML node that is being abstracted.
Returns a reference to the stanza in XML form.
Gets the namespace associated with this extension. The namespace for the AuthExtension is "jabber:iq:auth".
Gets the namespace associated with this extension. The namespace for the BrowseExtension is "jabber:iq:browse".
Gets the namespace associated with this extension. The namespace for the RosterExtension is "jabber:iq:roster".
Interface method, returning the namespace for this extension
Gets the namespace associated with this extension. The namespace for the WhiteboardExtension is "xiff:wb".
Gets the namespace associated with this extension. The namespace for the XHTMLExtension is "http://www.w3.org/1999/xhtml".
Issues a request for the information that must be submitted for registration with the server. When the data returns, an event of type "registrationFields" is broadcast containing the requested data.
Array of fields found in individual items due to a search query result
Gets the users role in the conference room. Possible roles are "visitor", "participant", "moderator" or no defined role.
Get the JID of the room like XMPPConnection.getJID() used to send room messages
Retrieves a list of available service information from the server specified. On successful query, the callback specified will be called and passed a single parameter containing a reference to an <code>IQ</code> containing the query results.
Retrieves a list of available services items from the server specified. Items include things such as available transports and user directories. On successful query, the callback specified in the will be called and passed a single parameter containing the query results.
Get the JID of the user in the room like XMPPConnection.getJID() used to receive messages
Grants permissions on a room one or more JIDs by setting the affiliation of a user based * on their JID. Use one of the following affiliations: <code>Room.MEMBER_AFFILIATION</code> <code>Room.ADMIN_AFFILIATION</code> <code>Room.OWNER_AFFILIATION</code> If the JID currenly has an existing affiliation, then the existing affiliation will be replaced with the one passed. If the process could not be completed, the room will dispatch the event adminError
Grants a user or service authorization for subscribing to your presence. Once authorization is granted, the user can see whether you are offline, online, away, etc. Subscriptions can be revoked at any time using the <code>denySubscription()</code> method.
H
This is property allows a user to retrieve a server defined collection of previous messages. Set this property to "true" to retrieve a history of the dicussions.
The message body in XHTML format. Internally, this uses the XHTML data extension.
I
The unique identifier of this stanza. ID generation is accomplished using the static <code>generateID</code> method.
An array of objects that represent the identities of a resource discovered. For more information on categories, see <a href="http://www.jabber.org/registrar/disco-categories.html"> http://www.jabber.org/registrar/disco-categories.html</a> The objects in the array have the following possible attributes: <ul> <li><code>category</code> - a category of the kind of identity</li> <li><code>type</code> - a path to a resource that can be discovered without a JID</li> <li><code>name</code> - the friendly name of the identity</li> </ul>
This interface provides access to contained extensions and methods to modify the contained extensions. All XMPP stanzas that can be extended should implement this interface.
The interface describing an extension. All extensions must implement this interface.
Determines whether whitespace will be ignored on incoming XML data. Behaves the same as XML.ignoreWhite
To use custom ID generators call the static function on the XMPPStanza class with an instance that implements IIDGenerator. For example, on the first frame of your movie: XMPPStanza.setIDGenerator( new org.jivesoftware.xiff.data.id.SharedObjectGenerator()); At any time during the execution of your app, you can change the ID generator by calling the above method.
Uses a simple incrementation of a static variable to generate new IDs. Guaranteed to generate unique IDs for the duration of application execution.
Implements <a href="http://www.jabber.org/jeps/jep-0030.html">JEP-0030<a> for service info discovery. Also, take a look at <a href="http://www.jabber.org/jeps/jep-0020.html">JEP-0020</a> and <a href="http://www.jabber.org/jeps/jep-0060.html">JEP-0060</a>.
An interface for objects that abstract XML data by providing accessors to the original XML data stored within.
Instructions describing what to do with this form
Invites a user that is not currently a member of this room to this room. You must be joined to the room and have appropriate permissions to invite other memebers, as the room will format and send the invite message to the destination user rather that you sending the invite directly to the user. To listen to events, add an event listener on your XMPPConnection on the <code>invite</code> event.
Use this extension to invite another user
Manages the broadcasting of events during invitations. Add event listeners to an instance of this class to monitor invite and decline events You only need a single instance of this class to listen for all invite or decline events.
A class for abstraction and encapsulation of IQ (info-query) data.
Determines whether the connection to the room is active - that is, the user is connected and has joined the room.
Determines whether the connection with the server is currently active. (Not necessarily logged in. For login status, use the <code>isLoggedIn()</code> method.)
Determines whether this is a digest (SHA1) authentication.
All XMPP stanzas that will interact with the library should implement this interface.
Check this if property if you wish to determine the remote procedure call produced an error. If the XMPP stanza never made it to the RPC service, then the error would be on the stanza object instead of this extension.
Determines whether the user is connected and logged into the server.
Determines whether this is a plain-text password authentication.
Tests if the parameter comes is the same as this room
Tests if the parameter comes is the same user as that connected to the room
Implements <a href="http://www.jabber.org/jeps/jep-0030.html">JEP-0030<a> for service item discovery.
An array of BrowseItems containing information about the browsed resource
An array of objects that represent the items discovered The objects in the array have the following possible attributes: <ul> <li><code>jid</code> - the resource name</li> <li><code>node</code> - a path to a resource that can be discovered without a JID</li> <li><code>name</code> - the friendly name of the jid</li> <li><code>action</code> - the kind of action that occurs during publication of services it can be either "remove" or "update"</li> </ul>
J
[required] The full JabberID of the entity described
The JID for this roster item.
The jid property for destroy the action type
Joins a conference room based on the parameters specified by the room properties. This call will create an instant room based on a default server configuration if the room doesn't exist. To create and begin the configuration process of a reserved room, pass <code>true</code> to this method to begin the configuration process. When The configuration is complete, the room will be unlocked for others to join. Listen to the <code>configureForm</code> event to handle and either return or cancel the configuration of the room.
K
Kicks an occupant out of the room, assuming that the user has necessary permissions to do so. If the user does not, the server will return an error.
L
The label of this field used by user interfaces to render a descriptive title of this field
Leaves the current conference room, assuming that the user has joined one. If the user is not currently in a room, this method does nothing.
(Read-only) The number of items in the roster.
M
Size based condition to evaluate by the server for the maximum characters to return during history retrieval
Protocol based condition for the number of stanzas to return during history retrieval
A class for abstraction and encapsulation of message data.
Implements the administration command data model in <a href="http://www.jabber.org/jeps/jep-0045.html">JEP-0045<a> for multi-user chat.
Implements the base functionality shared by all MUC extensions
Implements the base MUC protocol schema from <a href="http://www.jabber.org/jeps/jep-0045.html">JEP-0045<a> for multi-user chat. This extension is typically used to test for the presence of MUC enabled conferencing service, or a MUC related error condition.
This class is used by the MUCExtension for internal representation of information pertaining to occupants in a multi-user conference room.
Implements the administration command data model in <a href="http://www.jabber.org/jeps/jep-0045.html">JEP-0045<a> for multi-user chat.
Implements the base MUC user protocol schema from <a href="http://www.jabber.org/jeps/jep-0045.html">JEP-0045<a> for multi-user chat.
N
[optional] A friendly name that may be used in a user interface
The name of this field used by the application or server. Note: this serializes to the <code>var</code> attribute on the field node. Since <code>var</code> is a reserved word in ActionScript this field uses <code>name</code> to describe the name of this field.
The display name for this roster item.
On top of the browsing framework, a simple form of "feature advertisement" can be built. This enables any entity to advertise which features it supports, based on the namespaces associated with those features. The <ns/> element is allowed as a subelement of the item. This element contains a single namespace that the entity supports, and multiple <ns/> elements can be included in any item. For a connected client this might be <ns>jabber:iq:oob</ns>, or for a service <ns>jabber:iq:search</ns>. This list of namespaces should be used to present available options for a user or to automatically locate functionality for an application. The children of a browse result may proactively contain a few <ns/> elements (such as the result of the service request to the home server), which advertises the features that the particular service supports. This list may not be complete (it is only for first-pass filtering by simpler clients), and the JID should be browsed if a complete list is required.
The nickname of the conference occupant.
The nickname to use when joining.
Static variables for specific type strings
Static class variables to be overridden in subclasses;
Static class variables to be overridden in subclasses;
Static class variables to be overridden in subclasses;
Static class variables to be overridden in subclasses;
Static class variables to be overridden in subclasses;
Static class variables to be overridden in subclasses;
Static class variables to be overridden in subclasses;
Static class variables to be overridden in subclasses;
Static class variables to be overridden in subclasses;
Static class variables to be overridden in subclasses;
Static class variables to be overridden in subclasses;
Static class variables to be overridden in subclasses;
Static class variables to be overridden in subclasses;
Static class variables to be overridden in subclasses;
O
The opacity of the fill, in percent. 100 is solid, 0 is transparent. This property can be used as the alpha parameter of MovieClip.lineStyle
The opacity of the stroke, in percent. 100 is solid, 0 is transparent. This property can be used as the alpha parameter of MovieClip.lineStyle
P
The password to use when logging in.
The password to use for authentication.
If a room is password protected, add this extension and set the password
Property to use if the concerned room is password protected
A message extension for whitboard exchange. This class is the base class for other extension classes such as Path
The paths available in this whiteboard message
The port to use when connecting. The default XMPP port is 5222.
This class provides encapsulation for manipulation of presence data for sending and receiving.
The priority of the presence, usually on a scale of 1-5.
R
The reason for the invite/decline/destroy
Implements jabber:iq:register namespace. Use this to create new accounts on the jabber server. Send an empty IQ.GET_TYPE packet with this extension and the return will either be a conflict, or the fields you will need to fill out. Send a IQ.SET_TYPE 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.
Removes the extension from its parent.
Use this method to remove all fields.
Use this method to remove all items.
Removes all items from the roster data.
Use this method to remove all items.
Removes a contact from the roster and revokes all presence subscriptions for that contact. This method will only attempt action if the contact you are trying to remove is currently on the roster in the first place.
Used to remove instances as listeners for certain events. Event dispatching is handled using Macromedia's EventDispatcher class found in mx.events.EventDispatcher.
Replaces one node in the stanza with another simple text node.
Requests an affiliation list for a given affiliation with with room. This will either broadcast the event <code>affiliations</code> or <code>adminError</code> depending on the result of the request Use one of the following affiliations: <code>Room.NO_AFFILIATION</code> <code>Room.OUTCAST_AFFILIATION</code> <code>Room.MEMBER_AFFILIATION</code> <code>Room.ADMIN_AFFILIATION</code> <code>Room.OWNER_AFFILIATION</code>
Requests a configuration form from the room. Listen to <code>configureForm</code> event to fill out the form then call either <code>configure</code> or <code>cancelConfiguration</code> to complete the configuration process You must be joined to the room and have the owner affiliation to request a configuration form
Requests subscription authorization with a user or service. In the XMPP-world, you cannot receive notifications on changes to a contact's presence until that contact has authorized you to subscribe to his/her/its presence.
The resource to use when logging in. A resource is required (defaults to "XIFF") and allows a user to login using the same account simultaneously (most likely from multiple machines). Typical examples of the resource include "Home" or "Office" to indicate the user's current location.
The resource to use for authentication.
The result of this remote procedure call. It can contain elements of any type.
Revokes all affiliations from the JIDs. This is the same as: grant(Room.NO_AFFILIATION, jids) If the process could not be completed, the room will dispatch the event adminError Note: if the JID is banned from this room, then this will also revoke their banned status.
Manages incoming and outgoing data from a conference room as part of multi-user conferencing (JEP-0045). You will need an instance of this class for each room that the user joins. You can also use your own, external data provider if you choose, by using the <code>setExternalDataProvider()</code> method. This is most useful for applications where the data provider might need to be a class other than an array with the Data Provider API decorations, like in the case of a Macromedia Central LCDataProvider. Overall, however, its probably a rare occurence.
The room name that should be used when joining.
Manages a user's server-side instant messaging roster (or "buddy list"). By default, this class uses an internal data provider to keep track of roster data locally and provides a "read-only" form of the Data Provider API for external use. Non-read operations are performed using alternative, roster-specific methods. You can also use your own, external data provider if you choose, by using the <code>setExternalDataProvider()</code> method. This is most useful for applications where the data provider might need to be a class other than an array with the Data Provider API decorations, like in the case of a Macromedia Central LCDataProvider. Overall, however, its probably a rare occurence.
An IQ extension for roster data. Roster data is typically any data that is sent or received with the "jabber:iq:roster" namespace.
This class is used internally by the RosterExtension class for managing items received and sent as roster data. Usually, each item in the roster represents a single contact, and this class is used to represent, abstract, and serialize/deserialize this data.
Implements <a href="http://www.jabber.org/jeps/jep-0009.html">JEP-0009<a> for XML-RPC over XMPP.
S
Time based condition to retrive all messages for the last N seconds.
The read-only list of start and end points encoded as an array of objects with the format { from: { x: ###, y: ### }, to: { x: ###, y: ### } } You should not modify this list. Segments should be added with addSegment
Sends data to the server. If the data to send cannot be serialized properly, this method throws a SerializeException.
Sends a message to the conference room.
Sends a private message to a specific participant in the conference room.
Registers a new account with the server, sending the registration data as specified in the fieldMap paramter.
This exception is thrown whenever there is a problem serializing or deserializing data for sending to the server.
SerializationException - constructor in class org.jivesoftware.xiff.exception.SerializationException
Serializes the IQ into XML form for sending to a server.
Called when the library need to retrieve the state of the instance. If the instance manages its own state, then the state should be copied into the XMLNode passed. If the instance also implements INodeProxy, then the parent should be verified against the parent XMLNode passed to determine if the serialization is in the same namespace.
Serializes the Message into XML form for sending to a server.
Serializes the Presence into XML form for sending to a server.
Prepares the XML version of the stanza for transmission to the server.
Called when the library need to retrieve the state of the instance. If the instance manages its own state, then the state should be copied into the XMLNode passed. If the instance also implements INodeProxy, then the parent should be verified against the parent XMLNode passed to determine if the serialization is in the same namespace.
ISerializable implementation which loads this extension from XML
Called when the library need to retrieve the state of the instance. If the instance manages its own state, then the state should be copied into the XMLNode passed. If the instance also implements INodeProxy, then the parent should be verified against the parent XMLNode passed to determine if the serialization is in the same namespace.
Called when the library need to retrieve the state of the instance. If the instance manages its own state, then the state should be copied into the XMLNode passed. If the instance also implements INodeProxy, then the parent should be verified against the parent XMLNode passed to determine if the serialization is in the same namespace.
Called when this extension is being put back on the network. Perform any further serialization for Extensions and items
Serializes the FormField data to XML for sending.
Serializes the RosterExtension data to XML for sending.
Serializes the RosterItem data to XML for sending.
Called when this extension is being put back on the network. Perform any further serialization for Extensions and items
Called when the library need to retrieve the state of the instance. If the instance manages its own state, then the state should be copied into the XMLNode passed. If the instance also implements INodeProxy, then the parent should be verified against the parent XMLNode passed to determine if the serialization is in the same namespace.
Called when the library need to retrieve the state of the instance. If the instance manages its own state, then the state should be copied into the XMLNode passed. If the instance also implements INodeProxy, then the parent should be verified against the parent XMLNode passed to determine if the serialization is in the same namespace.
Called when this extension is being put back on the network. Perform any further serialization for Extensions and items
Called when the library need to retrieve the state of the instance. If the instance manages its own state, then the state should be copied into the XMLNode passed. If the instance also implements INodeProxy, then the parent should be verified against the parent XMLNode passed to determine if the serialization is in the same namespace.
Interface method, returning the namespace for this extension
Serializes the Fill into the parent node. Because the fill serializes into the attributes of the XML node, it will directly modify the parent node passed.
Serializes the Path data to XML for sending.
Serializes the Stroke into the parent node. Because the stroke serializes into the attributes of the XML node, it will directly modify the parent node passed.
Serializes the WhiteboardExtension data to XML for sending.
Creates the compact form of the segments in the fomrmat defined by SVG Example: M100 200L14 -15 L 125 100L150 200 300 400M10 20L30 40 50 60 z
The XMPP server to use for connection.
The service name of the discovery procedure
The name of the resource of the service queried if the resource doesn't have a JID. For more information, see <a href="http://www.jabber.org/registrar/disco-nodes.html"> http://www.jabber.org/registrar/disco-nodes.html</a>.
Static variables for specific type strings
Sets all the options available from an array of objects
Sets all the values of this field from an array of strings
Sets a reference to the XMPPConnection being used for incoming/outgoing XMPP data.
Sets a reference to the XMPPConnection being used for incoming/outgoing XMPP data.
Allows use of an external data provider instead of the one used internally by the class by default. This is useful in the case of a Macromedia Central application where the data provider might need to be an instance of an LCDataProvider. The data provider should either implement the Data Provider API interface, or the interface for Central's LCDataProvider.
Allows use of an external data provider instead of the one used internally by the class by default. This is useful in the case of a Macromedia Central application where the data provider might need to be an instance of an LCDataProvider. The data provider should either implement the Data Provider API interface, or the interface for Central's LCDataProvider.
Sets the fields given a fieldmap object containing keys of field names and values of value arrays
(Static method) Sets the ID generator for this stanza type. ID generators must implement the IIDGenerator interface. The XIFF library comes with a few default ID generators that have already been implemented (see org.jivesoftware.xiff.data.id.*). Setting the ID generator by stanza type is useful if you'd like to use different ID generation schemes for each type. For instance, messages could use the incremental ID generation scheme provided by the IncrementalGenerator class, while IQs could use the shared object ID generation scheme provided by the SharedObjectGenerator class.
Sets the XML node that will be abstracted.
Sets the XML node that should be used for this stanza's internal XML representation.
In a moderated room, sets voice status to a particular occupant, assuming the user has the necessary permissions to do so.
Sets your current presence status. Calling this method notifies others who are subscribed to your presence of a presence change. You should use this to change your status to away, extended-away, etc. There are static variables that you can use defined in the presence class for the <code>show</code> parameter: <ul> <li><code>Presence.SHOW_AWAY</code></li> <li><code>Presence.SHOW_CHAT</code></li> <li><code>Presence.SHOW_DND</code></li> <li><code>Presence.SHOW_NORMAL</code></li> <li><code>Presence.SHOW_XA</code></li> </ul>
Set the JID of the room in the form "room@conference.server"
A static class for SHA1 hash creation. Original ActionScript 1.0 version by Branden Hall. Original ActionScript 2.0 translation by Ron Haberle.
Generates an incrementing ID and saves the last value in a local shared object. Guaranteed to generate unique IDs for a single machine.
The show value; away, online, etc. There are predefined static variables in the Presence class for this: <ul> <li>Presence.SHOW_AWAY</li> <li>Presence.SHOW_CHAT</li> <li>Presence.SHOW_DND</li> <li>Presence.SHOW_NORMAL</li> <li>Presence.SHOW_XA</li> </ul>
Static variables for show values
Time base condition to retrieve all messages from a given time formatted in the format described in <a href="http://www.jabber.org/jeps/jep-0082.html">JEP-0082</a>.
Sorts items in the roster using a specific comparison function as passed to the method. Part of the "read-only" implementation of the DataProvider API. For more information, consult the DataProvider documentation.
Sorts items in the roster by a specific field name.
The status; usually used for "away messages."
Property used to add or retrieve a status code describing the condition that occurs.
Property that contains some text with a description of a condition.
The Stroke object that contains the properties describing the stroke of this path
A helper class that abstracts the serialization of strokes and provides an interface to access the properties
The message subject. Typically chat and groupchat-type messages do not use subjects. Rather, this is reserved for normal and headline-type messages.
The subscription type for this roster item. Subscription types have been enumerated by static variables in the RosterExtension: <ul> <li>RosterExtension.SUBSCRIBE_TYPE_NONE</li> <li>RosterExtension.SUBSCRIBE_TYPE_TO</li> <li>RosterExtension.SUBSCRIBE_TYPE_FROM</li> <li>RosterExtension.SUBSCRIBE_TYPE_BOTH</li> <li>RosterExtension.SUBSCRIBE_TYPE_REMOVE</li> </ul>
T
The message thread ID. Threading is used to group messages of the same discussion together. The library does not perform message grouping, rather it is up to any client authors to properly perform this task.
The title of this form
The JID of the recipient.
The to property for invite and decline action types
Converts the extension stanza XML to a string.
The marshalling process, accepting a block of XML, a string description of the remote method, and an array of flash typed parameters.
The stanza type. There are MANY types available, depending on what kind of stanza this is. The XIFF Library defines the types for IQ, Presence, and Message in each respective class as static string variables. Below is a listing of each: <b>IQ</b> <ul> <li>IQ.SET_TYPE</li> <li>IQ.GET_TYPE</li> <li>IQ.RESULT_TYPE</li> <li>IQ.ERROR_TYPE</li> </ul> <b>Presence</b> <ul> <li>Presence.AVAILABLE_TYPE</li> <li>Presence.UNAVAILABLE_TYPE</li> <li>Presence.PROBE_TYPE</li> <li>Presence.SUBSCRIBE_TYPE</li> <li>Presence.UNSUBSCRIBE_TYPE</li> <li>Presence.SUBSCRIBED_TYPE</li> <li>Presence.UNSUBSCRIBED_TYPE</li> <li>Presence.ERROR_TYPE</li> </ul> <b>Message</b> <ul> <li>Message.NORMAL_TYPE</li> <li>Message.CHAT_TYPE</li> <li>Message.GROUPCHAT_TYPE</li> <li>Message.HEADLINE_TYPE</li> <li>Message.ERROR_TYPE</li> </ul>
[optional] -- One of the official types from the specified category, or a non-standard type prefixed with the string "x-".
The type of form. May be one of the following: <code>FormExtension.REQUEST_TYPE</code> <code>FormExtension.RESULT_TYPE</code> <code>FormExtension.SUBMIT_TYPE</code> <code>FormExtension.CANCEL_TYPE</code>
The type of this field used by user interfaces to render an approprite control to represent this field. May be one of the following: <code>FormExtension.FIELD_TYPE_BOOLEAN</code> <code>FormExtension.FIELD_TYPE_FIXED</code> <code>FormExtension.FIELD_TYPE_HIDDEN</code> <code>FormExtension.FIELD_TYPE_JID_MULTI</code> <code>FormExtension.FIELD_TYPE_JID_SINGLE</code> <code>FormExtension.FIELD_TYPE_LIST_MULTI</code> <code>FormExtension.FIELD_TYPE_LIST_SINGLE</code> <code>FormExtension.FIELD_TYPE_TEXT_MULTI</code> <code>FormExtension.FIELD_TYPE_TEXT_PRIVATE</code> <code>FormExtension.FIELD_TYPE_TEXT_SINGLE</code>
The type of user extension this is
U
Updates the information for an existing contact. You can use this method to change the display name or associated group for a contact in your roster.
The username to use for connection. If this property is null when <code>connect()</code> is called, the class will fetch registration field data rather than attempt to login.
The username to use for authentication.
V
The chosen value for this field. In forms with a type <code>FormExtension.REQUEST_TYPE</code> this is typically the default value of the field. Applies to the following field types: <code>FormExtension.FIELD_TYPE_BOOLEAN</code> <code>FormExtension.FIELD_TYPE_FIXED</code> <code>FormExtension.FIELD_TYPE_HIDDEN</code> <code>FormExtension.FIELD_TYPE_JID_SINGLE</code> <code>FormExtension.FIELD_TYPE_LIST_SINGLE</code> <code>FormExtension.FIELD_TYPE_LIST_MULTI</code> <code>FormExtension.FIELD_TYPE_TEXT_PRIVATE</code> <code>FormExtension.FIELD_TYPE_TEXT_SINGLE</code> Suggested values can typically be retrieved in <code>getAllOptions</code>
[optional] A string containing the version of the node, equivalent to the response provided to a query in the 'jabber:iq:version' namespace. This is useful for servers, especially for lists of services (see the 'service/serverlist' category/type above).
W
A message extension for whitboard exchange. This class is the base class for other extension classes such as Path All child whiteboard objects are contained and serialized by this class
WhiteboardExtension - constructor in class org.jivesoftware.xiff.data.whiteboard.WhiteboardExtension
The width of the stroke in pixels. This is in a format used by MovieClip.lineStyle
X
This class provides an extension for XHTML body text in messages.
Global factory for all XMLNode generation
Implements client side XML marshalling of methods and parameters into XMLRPC. For more information on RPC over XMPP, see <a href="http://www.jabber.org/jeps/jep-0009.html"> http://www.jabber.org/jeps/jep-0009.html</a>.
This is a base class for all classes that encapsulate XML stanza data. It provides a set of methods that faciliate easy manipulation of XML data.
Connects to an XMPP server and manages incoming/outgoing data from that server. The XMPPConnection class is the core of the XIFF Library, as all else relies on this class to communicate with the server. For an in-depth look at the XMPP protocol core, take a look at the <a href="http://www.jabber.org/ietf/draft-ietf-xmpp-core-23.txt">IETF draft for the XMPP Core</a>. Usually, you will have one instance of the XMPPConnection class for each connection to a server.
The base class for all XMPP stanza data classes.