Package org.jivesoftware.smackx.vcardtemp

Class VCardManager

java.lang.Object

org.jivesoftware.smack.Manager

org.jivesoftware.smackx.vcardtemp.VCardManager

public final class VCardManager
extends Manager

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static VCardManager	getInstanceFor(XMPPConnection connection)	Retrieves a VCardManager for the specified XMPPConnection, creating one if it doesn't already exist.
boolean	isSupported(Jid jid)	Returns true if the given entity understands the vCard-XML format and allows the exchange of such.
static boolean	isSupported(Jid jid, XMPPConnection connection)	Deprecated. use isSupported(Jid) instead.
VCard	loadVCard()	Load the VCard of the current user.
VCard	loadVCard(EntityBareJid bareJid)	Load VCard information for a given user.
void	saveVCard(VCard vcard)	Save this vCard for the user connected by 'connection'.

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

NAMESPACE

public static final java.lang.String NAMESPACE

See Also:

Constant Field Values

ELEMENT

public static final java.lang.String ELEMENT

See Also:

Constant Field Values

Method Detail

getInstanceFor

public static VCardManager getInstanceFor(XMPPConnection connection)

Retrieves a VCardManager for the specified XMPPConnection, creating one if it doesn't already exist.

Parameters:

connection - the connection the manager is attached to.

Returns:

The new or existing manager.

isSupported

@Deprecated
public static boolean isSupported(Jid jid,
                                  XMPPConnection connection)
                           throws SmackException.NoResponseException,
                                  XMPPException.XMPPErrorException,
                                  SmackException.NotConnectedException,
                                  java.lang.InterruptedException

Deprecated.

use isSupported(Jid) instead.

Returns true if the given entity understands the vCard-XML format and allows the exchange of such.

Parameters:

jid - TODO javadoc me please

connection - TODO javadoc me please

Returns:

true if the given entity understands the vCard-XML format and exchange.

Throws:

XMPPException.XMPPErrorException - if there was an XMPP error returned.

SmackException.NoResponseException - if there was no response from the remote entity.

SmackException.NotConnectedException - if the XMPP connection is not connected.

java.lang.InterruptedException - if the calling thread was interrupted.

saveVCard

public void saveVCard(VCard vcard)
               throws SmackException.NoResponseException,
                      XMPPException.XMPPErrorException,
                      SmackException.NotConnectedException,
                      java.lang.InterruptedException

Save this vCard for the user connected by 'connection'. XMPPConnection should be authenticated and not anonymous.

Parameters:

vcard - VCard.

Throws:

XMPPException.XMPPErrorException - thrown if there was an issue setting the VCard in the server.

SmackException.NoResponseException - if there was no response from the server.

SmackException.NotConnectedException - if the XMPP connection is not connected.

java.lang.InterruptedException - if the calling thread was interrupted.

loadVCard

public VCard loadVCard()
                throws SmackException.NoResponseException,
                       XMPPException.XMPPErrorException,
                       SmackException.NotConnectedException,
                       java.lang.InterruptedException

Load the VCard of the current user.

Returns:

VCard.

Throws:

XMPPException.XMPPErrorException - if there was an XMPP error returned.

SmackException.NoResponseException - if there was no response from the remote entity.

SmackException.NotConnectedException - if the XMPP connection is not connected.

java.lang.InterruptedException - if the calling thread was interrupted.

loadVCard

public VCard loadVCard(EntityBareJid bareJid)
                throws SmackException.NoResponseException,
                       XMPPException.XMPPErrorException,
                       SmackException.NotConnectedException,
                       java.lang.InterruptedException

Load VCard information for a given user.

Parameters:

bareJid - bareJid of the user.

Returns:

VCard.

Throws:

XMPPException.XMPPErrorException - if there was an XMPP error returned.

SmackException.NoResponseException - if there was no response from the server.

SmackException.NotConnectedException - if the XMPP connection is not connected.

java.lang.InterruptedException - if the calling thread was interrupted.

isSupported

public boolean isSupported(Jid jid)
                    throws SmackException.NoResponseException,
                           XMPPException.XMPPErrorException,
                           SmackException.NotConnectedException,
                           java.lang.InterruptedException

Returns true if the given entity understands the vCard-XML format and allows the exchange of such.

Parameters:

jid - TODO javadoc me please

Returns:

true if the given entity understands the vCard-XML format and exchange.

Throws:

XMPPException.XMPPErrorException - if there was an XMPP error returned.

SmackException.NoResponseException - if there was no response from the remote entity.

SmackException.NotConnectedException - if the XMPP connection is not connected.

java.lang.InterruptedException - if the calling thread was interrupted.