Package org.jivesoftware.smackx.usertune

Class UserTuneManager

java.lang.Object

org.jivesoftware.smack.Manager

org.jivesoftware.smackx.usertune.UserTuneManager

public final class UserTuneManager
extends Manager

Entry point for Smacks API for XEP-0118: User Tune.
To publish a UserTune, please use publishUserTune(UserTuneElement) method. This will publish the node.
To stop publishing a UserTune, please use clearUserTune() method. This will send a disabling publish signal.
To add a UserTune listener in order to remain updated with other users UserTune, use addUserTuneListener(PepEventListener) method.
To link a UserTuneElement with Message, use 'message.addExtension(userTuneElement)'.
An example to illustrate is provided inside UserTuneElementTest inside the test package.

See Also:

XEP-0118: User Tune

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
boolean	addUserTuneListener(PepEventListener<UserTuneElement> listener)
void	clearUserTune()
static UserTuneManager	getInstanceFor(XMPPConnection connection)
void	publishUserTune(UserTuneElement userTuneElement)
boolean	removeUserTuneListener(PepEventListener<UserTuneElement> listener)

Methods inherited from class org.jivesoftware.smack.Manager

connection, getAuthenticatedConnectionOrThrow, schedule, schedule, scheduleBlocking

Methods inherited from class java.lang.Object

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

Field Detail

USERTUNE_NODE

public static final java.lang.String USERTUNE_NODE

See Also:

Constant Field Values

Method Detail

getInstanceFor

public static UserTuneManager getInstanceFor(XMPPConnection connection)
                                      throws SmackException.NotLoggedInException

Throws:

SmackException.NotLoggedInException

clearUserTune

public void clearUserTune()
                   throws SmackException.NotLoggedInException,
                          PubSubException.NotALeafNodeException,
                          SmackException.NoResponseException,
                          SmackException.NotConnectedException,
                          XMPPException.XMPPErrorException,
                          java.lang.InterruptedException

Throws:

SmackException.NotLoggedInException

PubSubException.NotALeafNodeException

SmackException.NoResponseException

SmackException.NotConnectedException

XMPPException.XMPPErrorException

java.lang.InterruptedException

publishUserTune

public void publishUserTune(UserTuneElement userTuneElement)
                     throws SmackException.NotLoggedInException,
                            PubSubException.NotALeafNodeException,
                            SmackException.NoResponseException,
                            SmackException.NotConnectedException,
                            XMPPException.XMPPErrorException,
                            java.lang.InterruptedException

Throws:

SmackException.NotLoggedInException

PubSubException.NotALeafNodeException

SmackException.NoResponseException

SmackException.NotConnectedException

XMPPException.XMPPErrorException

java.lang.InterruptedException

addUserTuneListener

public boolean addUserTuneListener(PepEventListener<UserTuneElement> listener)

removeUserTuneListener

public boolean removeUserTuneListener(PepEventListener<UserTuneElement> listener)