org.jivesoftware.smackx.pubsub

Class Affiliation

java.lang.Object

org.jivesoftware.smackx.pubsub.Affiliation

All Implemented Interfaces:

org.jivesoftware.smack.packet.Element, org.jivesoftware.smack.packet.ExtensionElement, org.jivesoftware.smack.packet.NamedElement

public class Affiliation
extends java.lang.Object
implements org.jivesoftware.smack.packet.ExtensionElement

Represents a affiliation between a user and a node, where the Affiliation.Type defines the type of affiliation. Affiliations are retrieved from the PubSubManager.getAffiliations() method, which gets affiliations for the calling user, based on the identity that is associated with the XMPPConnection.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Affiliation.Type

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ELEMENT

Constructor Summary

Constructors

Constructor and Description
Affiliation(org.jxmpp.jid.BareJid jid, Affiliation.Type affiliation) Construct a affiliation modification request.
Affiliation(org.jxmpp.jid.BareJid jid, Affiliation.Type affiliation, PubSubNamespace namespace)
Affiliation(java.lang.String node, Affiliation.Type affiliation) Constructs an affiliation.

Method Summary

Modifier and Type	Method and Description
Affiliation.Type	getAffiliation()
java.lang.String	getElementName()
org.jxmpp.jid.BareJid	getJid()
java.lang.String	getNamespace()
java.lang.String	getNode()
java.lang.String	getNodeId() Deprecated. use getNode() instead.
PubSubNamespace	getPubSubNamespace()
Affiliation.Type	getType() Deprecated. use getAffiliation() instead.
boolean	isAffiliationModification() Check if this is an affiliation element to modify affiliations on a node.
org.jivesoftware.smack.util.XmlStringBuilder	toXML()

Methods inherited from class java.lang.Object

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

Field Detail

ELEMENT

public static final java.lang.String ELEMENT

See Also:

Constant Field Values

Constructor Detail

Affiliation

public Affiliation(java.lang.String node,
                   Affiliation.Type affiliation)

Constructs an affiliation.

Parameters:

node - The node the user is affiliated with.

affiliation - the optional affiliation.

Affiliation

public Affiliation(org.jxmpp.jid.BareJid jid,
                   Affiliation.Type affiliation)

Construct a affiliation modification request.

Parameters:

jid -

affiliation -

Affiliation

public Affiliation(org.jxmpp.jid.BareJid jid,
                   Affiliation.Type affiliation,
                   PubSubNamespace namespace)

Method Detail

getNodeId

@Deprecated
public java.lang.String getNodeId()

Deprecated. use getNode() instead.

Get the node.

Returns:

the node.

getNode

public java.lang.String getNode()

getType

@Deprecated
public Affiliation.Type getType()

Deprecated. use getAffiliation() instead.

Get the type.

Returns:

the type.

getAffiliation

public Affiliation.Type getAffiliation()

getJid

public org.jxmpp.jid.BareJid getJid()

getElementName

public java.lang.String getElementName()

Specified by:

getElementName in interface org.jivesoftware.smack.packet.NamedElement

getNamespace

public java.lang.String getNamespace()

Specified by:

getNamespace in interface org.jivesoftware.smack.packet.ExtensionElement

getPubSubNamespace

public PubSubNamespace getPubSubNamespace()

isAffiliationModification

public boolean isAffiliationModification()

Check if this is an affiliation element to modify affiliations on a node.

Returns:

true if this is an affiliation element to modify affiliations on a node, false otherwise.

Since:

4.2

toXML

public org.jivesoftware.smack.util.XmlStringBuilder toXML()

Specified by:

toXML in interface org.jivesoftware.smack.packet.Element