Package org.jivesoftware.smackx.workgroup.settings

Class ChatSettings

java.lang.Object

org.jivesoftware.smack.packet.Stanza

org.jivesoftware.smack.packet.IQ

org.jivesoftware.smackx.workgroup.settings.ChatSettings

All Implemented Interfaces:

Element, IqView, NamedElement, StanzaView, TopLevelStreamElement, XmlElement, XmlLangElement

public class ChatSettings
extends IQ

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ChatSettings.InternalProvider	Stanza extension provider for AgentStatusRequest packets.

Nested classes/interfaces inherited from class org.jivesoftware.smack.packet.IQ

IQ.IQChildElementXmlStringBuilder, IQ.ResponseType, IQ.Type

Field Summary

Fields

Modifier and Type	Field	Description
static int	BOT_SETTINGS	Defined as Bot settings type.
static String	ELEMENT_NAME	Element name of the stanza extension.
static int	IMAGE_SETTINGS	Defined as image type.
static String	NAMESPACE	Namespace of the stanza extension.
static int	TEXT_SETTINGS	Defined as Text settings type.

Fields inherited from class org.jivesoftware.smack.packet.IQ

IQ_ELEMENT, QUERY_ELEMENT

Fields inherited from class org.jivesoftware.smack.packet.Stanza

DEFAULT_LANGUAGE, ITEM, language, TEXT

Constructor Summary

Constructors

Constructor	Description
ChatSettings()
ChatSettings(String key)

Method Summary

Modifier and Type	Method	Description
void	addSetting(ChatSetting setting)
ChatSetting	getChatSetting(String key)
ChatSetting	getFirstEntry()
protected IQ.IQChildElementXmlStringBuilder	getIQChildElementBuilder(IQ.IQChildElementXmlStringBuilder buf)	This method must be overwritten by IQ subclasses to create their child content.
Collection<ChatSetting>	getSettings()
void	setKey(String key)
void	setType(int type)

Methods inherited from class org.jivesoftware.smack.packet.IQ

createErrorResponse, createErrorResponse, createErrorResponse, createResultIQ, getChildElementName, getChildElementNamespace, getChildElementQName, getChildElementXML, getElementName, getType, setType, toString, toXML

Methods inherited from class org.jivesoftware.smack.packet.Stanza

addCommonAttributes, addExtension, addExtensions, appendErrorIfExists, getDefaultLanguage, getError, getExtension, getExtension, getExtension, getExtensionElement, getExtensions, getExtensions, getExtensions, getExtensions, getExtensionsMap, getFrom, getLanguage, getNamespace, getStanzaId, getTo, hasExtension, hasExtension, hasStanzaIdSet, logCommonAttributes, overrideExtension, removeExtension, removeExtension, setError, setError, setFrom, setLanguage, setNewStanzaId, setStanzaId, setStanzaId, setTo, throwIfNoStanzaId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jivesoftware.smack.packet.Element

toXML, toXML

Methods inherited from interface org.jivesoftware.smack.packet.IqView

isRequestIQ, isResponseIQ

Methods inherited from interface org.jivesoftware.smack.packet.StanzaView

getError, getExtension, getExtension, getExtensions, getExtensions, getExtensions, getFrom, getStanzaId, getTo, hasExtension, hasExtension, hasExtension

Methods inherited from interface org.jivesoftware.smack.packet.XmlElement

getQName

Field Detail

IMAGE_SETTINGS

public static final int IMAGE_SETTINGS

Defined as image type.

See Also:

Constant Field Values

TEXT_SETTINGS

public static final int TEXT_SETTINGS

Defined as Text settings type.

See Also:

Constant Field Values

BOT_SETTINGS

public static final int BOT_SETTINGS

Defined as Bot settings type.

See Also:

Constant Field Values

ELEMENT_NAME

public static final String ELEMENT_NAME

Element name of the stanza extension.

See Also:

Constant Field Values

NAMESPACE

public static final String NAMESPACE

Namespace of the stanza extension.

See Also:

Constant Field Values

Constructor Detail

ChatSettings

public ChatSettings()

ChatSettings

public ChatSettings(String key)

Method Detail

setKey

public void setKey(String key)

setType

public void setType(int type)

addSetting

public void addSetting(ChatSetting setting)

getSettings

public Collection<ChatSetting> getSettings()

getChatSetting

public ChatSetting getChatSetting(String key)

getFirstEntry

public ChatSetting getFirstEntry()

getIQChildElementBuilder

protected IQ.IQChildElementXmlStringBuilder getIQChildElementBuilder(IQ.IQChildElementXmlStringBuilder buf)

Description copied from class: IQ

This method must be overwritten by IQ subclasses to create their child content. It is important you don't use the builder to add the final end tag. This will be done automatically by IQ.IQChildElementXmlStringBuilder after eventual existing ExtensionElements have been added.

For example to create an IQ with a extra attribute and an additional child element

 
 <iq to='foo@example.org' id='123'>
   <bar xmlns='example:bar' extraAttribute='blaz'>
      <extraElement>elementText</extraElement>
   </bar>
 </iq>
 
 

the body of the getIQChildElementBuilder looks like

 
 // The builder 'xml' will already have the child element and the 'xmlns' attribute added
 // So the current builder state is "<bar xmlns='example:bar'"
 xml.attribute("extraAttribute", "blaz");
 xml.rightAngleBracket();
 xml.element("extraElement", "elementText");
 // Do not close the 'bar' attribute by calling xml.closeElement('bar')
 
 

If your IQ only contains attributes and no child elements, i.e. it can be represented as empty element, then you can mark it as such.

 xml.attribute("myAttribute", "myAttributeValue");
 xml.setEmptyElement();
 

If your IQ does not contain any attributes or child elements (besides ExtensionElements), consider sub-classing SimpleIQ instead.

Specified by:

getIQChildElementBuilder in class IQ

Parameters:

buf - a pre-created builder which already has the child element and the 'xmlns' attribute set.

Returns:

the build to create the IQ child content.