Main PagePackagesClass TreeIndexHelp
Previous | Next
Frames | No Frames
Summary: Field | Property | Contructor | Method
Detail: Field | Property | Contructor | Method
org.jivesoftware.xiff.data.muc

class MUCUserExtension

Object | +--org.jivesoftware.xiff.data.XMLStanza | +--org.jivesoftware.xiff.data.Extension | +--org.jivesoftware.xiff.data.muc.MUCBaseExtension | +--org.jivesoftware.xiff.data.muc.MUCUserExtension
Implemented Interfaces: IExtension
class MUCUserExtension extends MUCBaseExtension
Implements the base MUC user protocol schema from JEP-0045 for multi-user chat.

Field Summary

public static DECLINE_TYPE: String
public static DESTROY_TYPE: String
public static ELEMENT: String
public static INVITE_TYPE: String
public static NS: String
Static class variables to be overridden in subclasses;
public static OTHER_TYPE: String
Fields inherited from class org.jivesoftware.xiff.data.XMLStanza
XMLFactory

Property Summary

public from: String (read-only)
The from property for invite and decline action types
public jid: String (read-only)
The jid property for destroy the action type
public password: String (read, write)
Property to use if the concerned room is password protected
public reason: String (read-only)
The reason for the invite/decline/destroy
public statusCode: Number (read, write)
Property used to add or retrieve a status code describing the condition that occurs.
public statusMessage: String (read, write)
Property that contains some text with a description of a condition.
public to: String (read-only)
The to property for invite and decline action types
public type: String (read-only)
The type of user extension this is

Constructor

public MUCUserExtension ( parent: XMLNode)

Method Summary

public decline ( to: String, from: String, reason: String )
Use this extension to decline an invitation
public deserialize ( node: XMLNode ): Boolean
Called when data is retrieved from the XMLSocket, use this method to extract any state into internal state.
public destroy ( room: String, reason: String )
Use this extension to destroy a room
public getElementName ( ): String
public getNS ( ): String
public invite ( to: String, from: String, reason: String )
Use this extension to invite another user
Methods inherited from class org.jivesoftware.xiff.data.muc.MUCBaseExtension
addExtension, addItem, deserialize, getAllExtensions, getAllExtensionsByNS, getAllItems, MUCBaseExtensionStatic, removeAllExtensions, removeAllItems, removeExtension, serialize
Methods inherited from class org.jivesoftware.xiff.data.Extension
remove, toString
Methods inherited from class org.jivesoftware.xiff.data.XMLStanza
addTextNode, ensureNode, getNode, replaceTextNode, setNode

Field Documentation

DECLINE_TYPE

public static var DECLINE_TYPE: String

    DESTROY_TYPE

    public static var DESTROY_TYPE: String

      ELEMENT

      public static var ELEMENT: String

        INVITE_TYPE

        public static var INVITE_TYPE: String

          NS

          public static var NS: String
          Static class variables to be overridden in subclasses;

            OTHER_TYPE

            public static var OTHER_TYPE: String

              Property Documentation

              from

              public from: String (read-only)
              The from property for invite and decline action types

                jid

                public jid: String (read-only)
                The jid property for destroy the action type

                  password

                  public password: String (read, write)
                  Property to use if the concerned room is password protected

                    reason

                    public reason: String (read-only)
                    The reason for the invite/decline/destroy

                      statusCode

                      public statusCode: Number (read, write)
                      Property used to add or retrieve a status code describing the condition that occurs.

                        statusMessage

                        public statusMessage: String (read, write)
                        Property that contains some text with a description of a condition.

                          to

                          public to: String (read-only)
                          The to property for invite and decline action types

                            type

                            public type: String (read-only)
                            The type of user extension this is

                              Constructor Documentation

                              MUCUserExtension

                              public function MUCUserExtension (
                              parent: XMLNode)

                                Method Documentation

                                decline

                                public function decline (
                                to: String,
                                from: String,
                                reason: String)
                                Use this extension to decline an invitation

                                  deserialize

                                  public function deserialize (
                                  node: XMLNode): Boolean
                                  Called when data is retrieved from the XMLSocket, use this method to extract any state into internal state.

                                  destroy

                                  public function destroy (
                                  room: String,
                                  reason: String)
                                  Use this extension to destroy a room

                                    getElementName

                                    public function getElementName (
                                    ): String

                                    getNS

                                    public function getNS (
                                    ): String

                                    invite

                                    public function invite (
                                    to: String,
                                    from: String,
                                    reason: String)
                                    Use this extension to invite another user
                                      The documentation was generated from the following file:
                                      • MUCUserExtension.as, Last Modified: 3/10/2005 10:12:56 PM
                                      Copyright © 2004 Mirell Development | Created with AS2Doc | 6/14/2005 9:32:28 AM