rocks.xmpp.extensions.avatar

Class AvatarManager

java.lang.Object

rocks.xmpp.core.session.Manager

rocks.xmpp.extensions.avatar.AvatarManager

public final class AvatarManager
extends Manager

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.

This class is thread-safe.

Method Summary

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

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

isEnabled, setEnabled

Methods inherited from class java.lang.Object

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

Method Detail

getAvatar

public final byte[] getAvatar(rocks.xmpp.addr.Jid contact)
                       throws 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:

StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

XmppException

getAvatarImage

public final BufferedImage getAvatarImage(rocks.xmpp.addr.Jid contact)
                                   throws XmppException

Gets the user avatar from the user's vCard.

Parameters:

contact - The contact. Must not be null.

Returns:

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

Throws:

StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

XmppException

publishAvatar

public final void publishAvatar(byte[] imageData)
                         throws XmppException

Publishes an avatar to your VCard.

Parameters:

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

Throws:

StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

XmppException

See Also:

3.1 User Publishes Avatar

publishAvatarImage

public final void publishAvatarImage(BufferedImage bufferedImage)
                              throws XmppException

Publishes an avatar to your VCard.

Parameters:

bufferedImage - The avatar image, which must be in PNG format. null resets the avatar.

Throws:

StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

XmppException

See Also:

3.1 User Publishes Avatar

addAvatarChangeListener

public final void addAvatarChangeListener(Consumer<AvatarChangeEvent> avatarChangeListener)

Adds an avatar listener, to listen for avatar updates.

Parameters:

avatarChangeListener - The avatar listener.

removeAvatarChangeListener

public final void removeAvatarChangeListener(Consumer<AvatarChangeEvent> avatarChangeListener)

Removes a previously added avatar listener.

Parameters:

avatarChangeListener - The avatar listener.