org.jivesoftware.smackx.usertune

Class UserTuneManager

java.lang.Object

org.jivesoftware.smack.Manager

org.jivesoftware.smackx.usertune.UserTuneManager

public final class UserTuneManager
extends org.jivesoftware.smack.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(UserTuneListener) 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 and Description
static java.lang.String	USERTUNE_NODE
static java.lang.String	USERTUNE_NOTIFY

Method Summary

Modifier and Type	Method and Description
boolean	addUserTuneListener(UserTuneListener listener)
void	clearUserTune()
void	disableUserTuneNotifications()
void	enableUserTuneNotifications()
static UserTuneManager	getInstanceFor(org.jivesoftware.smack.XMPPConnection connection)
void	publishUserTune(UserTuneElement userTuneElement)
boolean	removeUserTuneListener(UserTuneListener listener)
static void	setUserTuneNotificationsEnabledByDefault(boolean bool)

Methods inherited from class org.jivesoftware.smack.Manager

connection, getAuthenticatedConnectionOrThrow, schedule

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

USERTUNE_NOTIFY

public static final java.lang.String USERTUNE_NOTIFY

See Also:

Constant Field Values

Method Detail

getInstanceFor

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

Throws:

org.jivesoftware.smack.SmackException.NotLoggedInException

setUserTuneNotificationsEnabledByDefault

public static void setUserTuneNotificationsEnabledByDefault(boolean bool)

enableUserTuneNotifications

public void enableUserTuneNotifications()

disableUserTuneNotifications

public void disableUserTuneNotifications()

clearUserTune

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

Throws:

org.jivesoftware.smack.SmackException.NotLoggedInException

PubSubException.NotALeafNodeException

org.jivesoftware.smack.SmackException.NoResponseException

org.jivesoftware.smack.SmackException.NotConnectedException

org.jivesoftware.smack.XMPPException.XMPPErrorException

java.lang.InterruptedException

publishUserTune

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

Throws:

org.jivesoftware.smack.SmackException.NotLoggedInException

PubSubException.NotALeafNodeException

org.jivesoftware.smack.SmackException.NoResponseException

org.jivesoftware.smack.SmackException.NotConnectedException

org.jivesoftware.smack.XMPPException.XMPPErrorException

java.lang.InterruptedException

addUserTuneListener

public boolean addUserTuneListener(UserTuneListener listener)

removeUserTuneListener

public boolean removeUserTuneListener(UserTuneListener listener)