org.jivesoftware.smackx.workgroup.packet

Class AgentInfo

java.lang.Object

org.jivesoftware.smack.packet.Stanza

org.jivesoftware.smack.packet.IQ

org.jivesoftware.smackx.workgroup.packet.AgentInfo

All Implemented Interfaces:

Element, Packet, TopLevelStreamElement

public class AgentInfo
extends IQ

IQ stanza(/packet) for retrieving and changing the Agent personal information.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AgentInfo.Provider An IQProvider for AgentInfo packets.

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

IQ.IQChildElementXmlStringBuilder, IQ.Type

Field Summary

Fields

Modifier and Type	Field and Description
static String	ELEMENT_NAME Element name of the stanza(/packet) extension.
static String	NAMESPACE Namespace of the stanza(/packet) extension.

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 and Description
AgentInfo()

Method Summary

Modifier and Type	Method and Description
protected IQ.IQChildElementXmlStringBuilder	getIQChildElementBuilder(IQ.IQChildElementXmlStringBuilder buf) This method must be overwritten by IQ subclasses to create their child content.
String	getJid() Returns the Agent's jid.
String	getName() Returns the Agent's name.
void	setJid(String jid) Sets the Agent's jid.
void	setName(String name) Sets the Agent's name.

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

createErrorResponse, createResultIQ, getChildElementName, getChildElementNamespace, getChildElementXML, getType, isRequestIQ, setType, toXML

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

addCommonAttributes, addExtension, addExtensions, appendErrorIfExists, getDefaultLanguage, getError, getExtension, getExtension, getExtensions, getExtensions, getExtensionsXML, getFrom, getLanguage, getPacketID, getStanzaId, getTo, hasExtension, hasExtension, hasStanzaIdSet, overrideExtension, removeExtension, removeExtension, setError, setFrom, setLanguage, setPacketID, setStanzaId, setTo, toString

Methods inherited from class java.lang.Object

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

Field Detail

ELEMENT_NAME

public static final String ELEMENT_NAME

Element name of the stanza(/packet) extension.

See Also:

Constant Field Values

NAMESPACE

public static final String NAMESPACE

Namespace of the stanza(/packet) extension.

See Also:

Constant Field Values

Constructor Detail

AgentInfo

public AgentInfo()

Method Detail

getJid

public String getJid()

Returns the Agent's jid.

Returns:

the Agent's jid.

setJid

public void setJid(String jid)

Sets the Agent's jid.

Parameters:

jid - the jid of the agent.

getName

public String getName()

Returns the Agent's name. The name of the agent may be different than the user's name. This property may be shown in the webchat client.

Returns:

the Agent's name.

setName

public void setName(String name)

Sets the Agent's name. The name of the agent may be different than the user's name. This property may be shown in the webchat client.

Parameters:

name - the new name of the agent.

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 that the builder does not include the final end element. This will be done automatically by IQChildelementXmlStringBuilder after eventual existing stanza(/packet) extensions 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 stanza(/packet) extensions), 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.