rocks.xmpp.extensions.avatar

Class AvatarManager

java.lang.Object

rocks.xmpp.core.session.Manager

rocks.xmpp.core.session.ExtensionManager

rocks.xmpp.extensions.avatar.AvatarManager

public final class AvatarManager
extends ExtensionManager

This class manages avatar updates as described in XEP-0153: vCard-Based Avatars and XEP-0084: User Avatar.

Whenever an avatar update is received by a contact, either via the presence based avatar extension (XEP-0153) or the PEP-based notification (XEP-0084), the registered listeners are triggered.

By default this manager is not enabled.

Author:

Christian Schudt

Field Summary

Fields inherited from class rocks.xmpp.core.session.ExtensionManager

features, xmppSession

Method Summary

Modifier and Type	Method and Description
void	addAvatarChangeListener(AvatarChangeListener avatarChangeListener) Adds an avatar listener, to listen for avatar updates.
byte[]	getAvatar(rocks.xmpp.core.Jid contact) Gets the user avatar from the user's vCard.
void	publishAvatar(byte[] imageData) Publishes an avatar to your VCard.
void	removeAvatarChangeListener(AvatarChangeListener avatarChangeListener) Removes a previously added avatar listener.

Methods inherited from class rocks.xmpp.core.session.ExtensionManager

setEnabled

Methods inherited from class rocks.xmpp.core.session.Manager

isEnabled

Methods inherited from class java.lang.Object

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

Method Detail

getAvatar

public byte[] getAvatar(rocks.xmpp.core.Jid contact)
                 throws rocks.xmpp.core.XmppException

Gets the user avatar from the user's vCard.

Parameters:

contact - The contact.

Returns:

The contact's avatar or null, if it has no avatar.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

publishAvatar

public void publishAvatar(byte[] imageData)
                   throws rocks.xmpp.core.XmppException

Publishes an avatar to your VCard.

Parameters:

imageData - The avatar image data, which must be in PNG format.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

See Also:

3.1 User Publishes Avatar

addAvatarChangeListener

public void addAvatarChangeListener(AvatarChangeListener avatarChangeListener)

Adds an avatar listener, to listen for avatar updates.

Parameters:

avatarChangeListener - The avatar listener.

removeAvatarChangeListener

public void removeAvatarChangeListener(AvatarChangeListener avatarChangeListener)

Removes a previously added avatar listener.

Parameters:

avatarChangeListener - The avatar listener.