Smack

org.jivesoftware.smackx.workgroup.ext.macros
Class Macros

java.lang.Object
  extended by org.jivesoftware.smack.packet.Packet
      extended by org.jivesoftware.smack.packet.IQ
          extended by org.jivesoftware.smackx.workgroup.ext.macros.Macros

public class Macros
extends IQ

Macros iq is responsible for handling global and personal macros in the a Live Assistant Workgroup.


Nested Class Summary
static class Macros.InternalProvider
          An IQProvider for Macro packets.
 
Nested classes/interfaces inherited from class org.jivesoftware.smack.packet.IQ
IQ.Type
 
Field Summary
static java.lang.String ELEMENT_NAME
          Element name of the packet extension.
static java.lang.String NAMESPACE
          Namespace of the packet extension.
 
Fields inherited from class org.jivesoftware.smack.packet.Packet
DEFAULT_LANGUAGE, ID_NOT_AVAILABLE
 
Constructor Summary
Macros()
           
 
Method Summary
 java.lang.String getChildElementXML()
          Returns the sub-element XML section of the IQ packet, or null if there isn't one.
 MacroGroup getPersonalMacroGroup()
           
 MacroGroup getRootGroup()
           
 boolean isPersonal()
           
 void setPersonal(boolean personal)
           
 void setPersonalMacroGroup(MacroGroup personalMacroGroup)
           
 void setRootGroup(MacroGroup rootGroup)
           
 
Methods inherited from class org.jivesoftware.smack.packet.IQ
createErrorResponse, createResultIQ, getType, setType, toXML
 
Methods inherited from class org.jivesoftware.smack.packet.Packet
addExtension, addExtensions, deleteProperty, equals, getDefaultLanguage, getError, getExtension, getExtension, getExtensions, getExtensionsXML, getFrom, getPacketID, getProperty, getPropertyNames, getTo, getXmlns, hashCode, nextID, removeExtension, setDefaultXmlns, setError, setFrom, setPacketID, setProperty, setTo
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ELEMENT_NAME

public static final java.lang.String ELEMENT_NAME
Element name of the packet extension.

See Also:
Constant Field Values

NAMESPACE

public static final java.lang.String NAMESPACE
Namespace of the packet extension.

See Also:
Constant Field Values
Constructor Detail

Macros

public Macros()
Method Detail

getRootGroup

public MacroGroup getRootGroup()

setRootGroup

public void setRootGroup(MacroGroup rootGroup)

isPersonal

public boolean isPersonal()

setPersonal

public void setPersonal(boolean personal)

getPersonalMacroGroup

public MacroGroup getPersonalMacroGroup()

setPersonalMacroGroup

public void setPersonalMacroGroup(MacroGroup personalMacroGroup)

getChildElementXML

public java.lang.String getChildElementXML()
Description copied from class: IQ
Returns the sub-element XML section of the IQ packet, or null if there isn't one. Packet extensions must be included, if any are defined.

Extensions of this class must override this method.

Specified by:
getChildElementXML in class IQ
Returns:
the child element section of the IQ XML.

Smack

Copyright © 2003-2007 Jive Software.