VCard (smack 4.0.2 API)

java.lang.Object
- org.jivesoftware.smack.packet.Packet
- - org.jivesoftware.smack.packet.IQ
  - - org.jivesoftware.smackx.vcardtemp.packet.VCard

public class VCard
extends IQ

A VCard class for use with the SMACK jabber library.

You should refer to the XEP-54 documentation.

Please note that this class is incomplete but it does provide the most commonly found information in vCards. Also remember that VCard transfer is not a standard, and the protocol may change or be replaced.

Usage:

 
 // To save VCard:
 

 VCard vCard = new VCard();
 vCard.setFirstName("kir");
 vCard.setLastName("max");
 vCard.setEmailHome("foo@fee.bar");
 vCard.setJabberId("jabber@id.org");
 vCard.setOrganization("Jetbrains, s.r.o");
 vCard.setNickName("KIR");
 

 vCard.setField("TITLE", "Mr");
 vCard.setAddressFieldHome("STREET", "Some street");
 vCard.setAddressFieldWork("CTRY", "US");
 vCard.setPhoneWork("FAX", "3443233");
 

 vCard.save(connection);
 

 // To load VCard:
 

 VCard vCard = new VCard();
 vCard.load(conn); // load own VCard
 vCard.load(conn, "joe@foo.bar"); // load someone's VCard

Nested Class Summary
- Nested classes/interfaces inherited from class org.jivesoftware.smack.packet.IQ
  IQ.Type

Field Summary
- Fields inherited from class org.jivesoftware.smack.packet.Packet
  DEFAULT_LANGUAGE, ID_NOT_AVAILABLE

Constructor Summary

Constructors
Constructor and Description

VCard()

Constructors
Constructor and Description
`VCard()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`String`	`getAddressFieldHome(String addrField)` Get home address field
`String`	`getAddressFieldWork(String addrField)` Get work address field
`byte[]`	`getAvatar()` Return the byte representation of the avatar(if one exists), otherwise returns null if no avatar could be found.
`String`	`getAvatarHash()` Returns the SHA-1 Hash of the Avatar image.
`String`	`getAvatarMimeType()` Returns the MIME Type of the avatar or null if none is set
`static byte[]`	`getBytes(URL url)` Common code for getting the bytes of a url.
`String`	`getChildElementXML()` Returns the sub-element XML section of the IQ packet, or `null` if there isn't one.
`String`	`getEmailHome()`
`String`	`getEmailWork()`
`String`	`getField(String field)` Set generic VCard field.
`String`	`getFirstName()`
`String`	`getJabberId()`
`String`	`getLastName()`
`String`	`getMiddleName()`
`String`	`getNickName()`
`String`	`getOrganization()`
`String`	`getOrganizationUnit()`
`String`	`getPhoneHome(String phoneType)` Get home phone number
`String`	`getPhoneWork(String phoneType)` Get work phone number
`int`	`hashCode()`
`void`	`load(XMPPConnection connection)` Load VCard information for a connected user.
`void`	`load(XMPPConnection connection, String user)` Load VCard information for a given user.
`void`	`removeAvatar()` Removes the avatar from the vCard This is done by setting the PHOTO value to the empty string as defined in XEP-0153
`void`	`save(XMPPConnection connection)` Save this vCard for the user connected by 'connection'.
`void`	`setAddressFieldHome(String addrField, String value)` Set home address field
`void`	`setAddressFieldWork(String addrField, String value)` Set work address field
`void`	`setAvatar(byte[] bytes)` Specify the bytes of the JPEG for the avatar to use.
`void`	`setAvatar(byte[] bytes, String mimeType)` Specify the bytes for the avatar to use as well as the mime type.
`void`	`setAvatar(String encodedImage, String mimeType)` Specify the Avatar used for this vCard.
`void`	`setAvatar(URL avatarURL)` Set the avatar for the VCard by specifying the url to the image.
`void`	`setEmailHome(String email)`
`void`	`setEmailWork(String emailWork)`
`void`	`setEncodedImage(String encodedAvatar)` Deprecated. Use `setAvatar(String, String)` instead.
`void`	`setField(String field, String value)` Set generic VCard field.
`void`	`setField(String field, String value, boolean isUnescapable)` Set generic, unescapable VCard field.
`void`	`setFirstName(String firstName)`
`void`	`setJabberId(String jabberId)`
`void`	`setLastName(String lastName)`
`void`	`setMiddleName(String middleName)`
`void`	`setNickName(String nickName)`
`void`	`setOrganization(String organization)`
`void`	`setOrganizationUnit(String organizationUnit)`
`void`	`setPhoneHome(String phoneType, String phoneNum)` Set home phone number
`void`	`setPhoneWork(String phoneType, String phoneNum)` Set work phone number
`String`	`toString()`

Methods inherited from class org.jivesoftware.smack.packet.IQ
createErrorResponse, createResultIQ, getType, setType, toXML

Methods inherited from class org.jivesoftware.smack.packet.Packet
addCommonAttributes, addExtension, addExtensions, getDefaultLanguage, getError, getExtension, getExtension, getExtensions, getExtensionsXML, getFrom, getPacketID, getTo, getXmlns, nextID, removeExtension, setDefaultXmlns, setError, setFrom, setPacketID, setTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - VCard
```
public VCard()
```
- Method Detail
  - getField
```
public String getField(String field)
```
    Set generic VCard field.
    
    Parameters:
    field - value of field. Possible values: NICKNAME, PHOTO, BDAY, JABBERID, MAILER, TZ, GEO, TITLE, ROLE, LOGO, NOTE, PRODID, REV, SORT-STRING, SOUND, UID, URL, DESC.
  - setField
```
public void setField(String field,
            String value)
```
    Set generic VCard field.
    
    Parameters:
    value - value of field
    field - field to set. See getField(String)
    See Also:
    getField(String)
  - setField
```
public void setField(String field,
            String value,
            boolean isUnescapable)
```
    Set generic, unescapable VCard field. If unescabale is set to true, XML maybe a part of the value.
    
    Parameters:
    value - value of field
    field - field to set. See getField(String)
    isUnescapable - True if the value should not be escaped, and false if it should.
  - getFirstName
```
public String getFirstName()
```
  - setFirstName
```
public void setFirstName(String firstName)
```
  - getLastName
```
public String getLastName()
```
  - setLastName
```
public void setLastName(String lastName)
```
  - getMiddleName
```
public String getMiddleName()
```
  - setMiddleName
```
public void setMiddleName(String middleName)
```
  - getNickName
```
public String getNickName()
```
  - setNickName
```
public void setNickName(String nickName)
```
  - getEmailHome
```
public String getEmailHome()
```
  - setEmailHome
```
public void setEmailHome(String email)
```
  - getEmailWork
```
public String getEmailWork()
```
  - setEmailWork
```
public void setEmailWork(String emailWork)
```
  - getJabberId
```
public String getJabberId()
```
  - setJabberId
```
public void setJabberId(String jabberId)
```
  - getOrganization
```
public String getOrganization()
```
  - setOrganization
```
public void setOrganization(String organization)
```
  - getOrganizationUnit
```
public String getOrganizationUnit()
```
  - setOrganizationUnit
```
public void setOrganizationUnit(String organizationUnit)
```
  - getAddressFieldHome
```
public String getAddressFieldHome(String addrField)
```
    Get home address field
    
    Parameters:
    addrField - one of POSTAL, PARCEL, (DOM | INTL), PREF, POBOX, EXTADR, STREET, LOCALITY, REGION, PCODE, CTRY
  - setAddressFieldHome
```
public void setAddressFieldHome(String addrField,
                       String value)
```
    Set home address field
    
    Parameters:
    addrField - one of POSTAL, PARCEL, (DOM | INTL), PREF, POBOX, EXTADR, STREET, LOCALITY, REGION, PCODE, CTRY
  - getAddressFieldWork
```
public String getAddressFieldWork(String addrField)
```
    Get work address field
    
    Parameters:
    addrField - one of POSTAL, PARCEL, (DOM | INTL), PREF, POBOX, EXTADR, STREET, LOCALITY, REGION, PCODE, CTRY
  - setAddressFieldWork
```
public void setAddressFieldWork(String addrField,
                       String value)
```
    Set work address field
    
    Parameters:
    addrField - one of POSTAL, PARCEL, (DOM | INTL), PREF, POBOX, EXTADR, STREET, LOCALITY, REGION, PCODE, CTRY
  - setPhoneHome
```
public void setPhoneHome(String phoneType,
                String phoneNum)
```
    Set home phone number
    
    Parameters:
    phoneType - one of VOICE, FAX, PAGER, MSG, CELL, VIDEO, BBS, MODEM, ISDN, PCS, PREF
    phoneNum - phone number
  - getPhoneHome
```
public String getPhoneHome(String phoneType)
```
    Get home phone number
    
    Parameters:
    phoneType - one of VOICE, FAX, PAGER, MSG, CELL, VIDEO, BBS, MODEM, ISDN, PCS, PREF
  - setPhoneWork
```
public void setPhoneWork(String phoneType,
                String phoneNum)
```
    Set work phone number
    
    Parameters:
    phoneType - one of VOICE, FAX, PAGER, MSG, CELL, VIDEO, BBS, MODEM, ISDN, PCS, PREF
    phoneNum - phone number
  - getPhoneWork
```
public String getPhoneWork(String phoneType)
```
    Get work phone number
    
    Parameters:
    phoneType - one of VOICE, FAX, PAGER, MSG, CELL, VIDEO, BBS, MODEM, ISDN, PCS, PREF
  - setAvatar
```
public void setAvatar(URL avatarURL)
```
    Set the avatar for the VCard by specifying the url to the image.
    
    Parameters:
    avatarURL - the url to the image(png,jpeg,gif,bmp)
  - removeAvatar
```
public void removeAvatar()
```
    Removes the avatar from the vCard This is done by setting the PHOTO value to the empty string as defined in XEP-0153
  - setAvatar
```
public void setAvatar(byte[] bytes)
```
    Specify the bytes of the JPEG for the avatar to use. If bytes is null, then the avatar will be removed. 'image/jpeg' will be used as MIME type.
    
    Parameters:
    bytes - the bytes of the avatar, or null to remove the avatar data
  - setAvatar
```
public void setAvatar(byte[] bytes,
             String mimeType)
```
    Specify the bytes for the avatar to use as well as the mime type.
    
    Parameters:
    bytes - the bytes of the avatar.
    mimeType - the mime type of the avatar.
  - setAvatar
```
public void setAvatar(String encodedImage,
             String mimeType)
```
    Specify the Avatar used for this vCard.
    
    Parameters:
    encodedImage - the Base64 encoded image as String
    mimeType - the MIME type of the image
  - setEncodedImage
```
public void setEncodedImage(String encodedAvatar)
```
    Deprecated. Use setAvatar(String, String) instead.
    
    Set the encoded avatar string. This is used by the provider.
    
    Parameters:
    encodedAvatar - the encoded avatar string.
  - getAvatar
```
public byte[] getAvatar()
```
    Return the byte representation of the avatar(if one exists), otherwise returns null if no avatar could be found. Example 1
```
 // Load Avatar from VCard
 byte[] avatarBytes = vCard.getAvatar();
 
 // To create an ImageIcon for Swing applications
 ImageIcon icon = new ImageIcon(avatar);
 

 // To create just an image object from the bytes
 ByteArrayInputStream bais = new ByteArrayInputStream(avatar);
 try {
   Image image = ImageIO.read(bais);
  }
  catch (IOException e) {
    e.printStackTrace();
 }
 
```
    Returns:
    byte representation of avatar.
  - getAvatarMimeType
```
public String getAvatarMimeType()
```
    Returns the MIME Type of the avatar or null if none is set
    
    Returns:
    the MIME Type of the avatar or null
  - getBytes
```
public static byte[] getBytes(URL url)
                       throws IOException
```
    Common code for getting the bytes of a url.
    
    Parameters:
    url - the url to read.
    
    Throws:
    
    IOException
  - getAvatarHash
```
public String getAvatarHash()
```
    Returns the SHA-1 Hash of the Avatar image.
    
    Returns:
    the SHA-1 Hash of the Avatar image.
  - save
```
public void save(XMPPConnection connection)
          throws SmackException.NoResponseException,
                 XMPPException.XMPPErrorException,
                 SmackException.NotConnectedException
```
    Save this vCard for the user connected by 'connection'. XMPPConnection should be authenticated and not anonymous.
    
    NOTE: the method is asynchronous and does not wait for the returned value.
    
    Parameters:
    connection - the XMPPConnection to use.
    
    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
  - load
```
public void load(XMPPConnection connection)
          throws SmackException.NoResponseException,
                 XMPPException.XMPPErrorException,
                 SmackException.NotConnectedException
```
    Load VCard information for a connected user. XMPPConnection should be authenticated and not anonymous.
    
    Throws:
    
    XMPPException.XMPPErrorException
    
    SmackException.NoResponseException
    
    SmackException.NotConnectedException
  - load
```
public void load(XMPPConnection connection,
        String user)
          throws SmackException.NoResponseException,
                 XMPPException.XMPPErrorException,
                 SmackException.NotConnectedException
```
    Load VCard information for a given user. XMPPConnection should be authenticated and not anonymous.
    
    Throws:
    
    XMPPException.XMPPErrorException
    
    SmackException.NoResponseException - if there was no response from the server.
    
    SmackException.NotConnectedException
  - getChildElementXML
```
public String getChildElementXML()
```
    Description copied from class: IQ
    
    Returns the sub-element XML section of the IQ packet, or null if there isn't one. Packet extensions must be included, if any are defined.
    Extensions of this class must override this method.
    
    Specified by:
    
    getChildElementXML in class IQ
    
    Returns:
    the child element section of the IQ XML.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Packet
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Packet
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Packet

Class VCard

Nested Class Summary

Nested classes/interfaces inherited from class org.jivesoftware.smack.packet.IQ

Field Summary

Fields inherited from class org.jivesoftware.smack.packet.Packet

Constructor Summary

Method Summary

Methods inherited from class org.jivesoftware.smack.packet.IQ

Methods inherited from class org.jivesoftware.smack.packet.Packet

Methods inherited from class java.lang.Object

Constructor Detail

VCard

Method Detail

getField

setField

setField

getFirstName

setFirstName

getLastName

setLastName

getMiddleName

setMiddleName

getNickName

setNickName

getEmailHome

setEmailHome

getEmailWork

setEmailWork

getJabberId

setJabberId

getOrganization

setOrganization

getOrganizationUnit

setOrganizationUnit

getAddressFieldHome

setAddressFieldHome

getAddressFieldWork

setAddressFieldWork

setPhoneHome

getPhoneHome

setPhoneWork

getPhoneWork

setAvatar

removeAvatar

setAvatar

setAvatar

setAvatar

setEncodedImage

getAvatar

getAvatarMimeType

getBytes

getAvatarHash

save

load

load

getChildElementXML

equals

hashCode

toString