org.linphone.core

Interface Vcard

public interface Vcard

Object storing contact information using vCard 4.0 format.

Method Summary

Modifier and Type	Method and Description
void	addExtendedProperty(java.lang.String name, java.lang.String value) Adds an extended property to the vCard.
void	addPhoneNumber(java.lang.String phone) Adds a phone number in the vCard, using the TEL property.
void	addPhoneNumberWithLabel(FriendPhoneNumber phoneNumber) Adds a FriendPhoneNumber in the vCard, using the TEL property.
void	addSipAddress(java.lang.String sipAddress) Adds a SIP address in the vCard, using the IMPP property.
java.lang.String	asVcard4String() Returns the vCard4 representation of the LinphoneVcard.
Vcard	clone() Clone a Vcard.
void	editMainSipAddress(java.lang.String sipAddress) Edits the preferred SIP address in the vCard (or the first one), using the IMPP property.
boolean	generateUniqueId() Generates a random unique id for the vCard.
java.lang.String	getEtag() Gets the eTag of the vCard.
java.lang.String[]	getExtendedPropertiesValuesByName(java.lang.String name) Get the vCard extended properties values per property name.
java.lang.String	getFamilyName() Returns the family name in the N attribute of the vCard, or null if it isn't set yet.
java.lang.String	getFullName() Returns the FN attribute of the vCard, or null if it isn't set yet.
java.lang.String	getGivenName() Returns the given name in the N attribute of the vCard, or null if it isn't set yet.
long	getNativePointer() Gets the native pointer used by this class to make native method calls.
java.lang.String	getOrganization() Gets the Organization of the vCard.
java.lang.String[]	getPhoneNumbers() Returns the list of phone numbers in the vCard (all the TEL attributes) or null.
FriendPhoneNumber[]	getPhoneNumbersWithLabel() Returns the list of phone numbers in the vCard (all the TEL attributes) or null.
java.lang.String	getPhoto() Returns the first PHOTO property or null.
Address[]	getSipAddresses() Returns the list of SIP addresses in the vCard (all the IMPP attributes that has an URI value starting by "sip:") or null.
boolean	getSkipValidation() Returns the skipFieldValidation property of the vcard.
java.lang.String	getUid() Gets the UID of the vCard.
java.lang.String	getUrl() Gets the URL of the vCard.
java.lang.Object	getUserData() Gets the object stored in this object user's data
void	removeExtentedPropertiesByName(java.lang.String name) Remove all the extend properties per property name.
void	removeOrganization() Removes the Organization field of the vCard.
void	removePhoneNumber(java.lang.String phone) Removes a phone number in the vCard (if it exists), using the TEL property.
void	removePhoneNumberWithLabel(FriendPhoneNumber phoneNumber) Removes a FriendPhoneNumber in the vCard (if it exists), using the TEL property.
void	removePhoto() Removes any existing PHOTO property.
void	removeSipAddress(java.lang.String sipAddress) Removes a SIP address in the vCard (if it exists), using the IMPP property.
void	setEtag(java.lang.String etag) Sets the eTAG of the vCard.
void	setFamilyName(java.lang.String name) Sets the family name in the N attribute of the vCard.
void	setFullName(java.lang.String name) Sets the FN attribute of the vCard (which is mandatory).
void	setGivenName(java.lang.String name) Sets the given name in the N attribute of the vCard.
void	setOrganization(java.lang.String organization) Fills the Organization field of the vCard.
void	setPhoto(java.lang.String picture) Sets a picture URI in the vCard, using the PHOTO property.
void	setSkipValidation(boolean skip) Sets the skipFieldValidation property of the vcard.
void	setUid(java.lang.String uid) Sets the unique ID of the vCard.
void	setUrl(java.lang.String url) Sets the URL of the vCard.
void	setUserData(java.lang.Object data) Sets the object to store in this object user's data
java.lang.String	toString()

Method Detail

getEtag

@Nullable
java.lang.String getEtag()

Gets the eTag of the vCard.

Returns:

the eTag of the vCard in the CardDAV server, otherwise null.

setEtag

void setEtag(@Nullable
             java.lang.String etag)

Sets the eTAG of the vCard.

Parameters:

etag - the eTAG.

getFamilyName

@Nullable
java.lang.String getFamilyName()

Returns the family name in the N attribute of the vCard, or null if it isn't
set yet.

Returns:

the family name of the vCard, or null

setFamilyName

void setFamilyName(@Nullable
                   java.lang.String name)

Sets the family name in the N attribute of the vCard.

Parameters:

name - the family name to set for the vCard

getFullName

@Nullable
java.lang.String getFullName()

Returns the FN attribute of the vCard, or null if it isn't set yet.

Returns:

the display name of the vCard, or null.

setFullName

void setFullName(@Nullable
                 java.lang.String name)

Sets the FN attribute of the vCard (which is mandatory).

Parameters:

name - the display name to set for the vCard

getGivenName

@Nullable
java.lang.String getGivenName()

Returns the given name in the N attribute of the vCard, or null if it isn't set
yet.

Returns:

the given name of the vCard, or null

setGivenName

void setGivenName(@Nullable
                  java.lang.String name)

Sets the given name in the N attribute of the vCard.

Parameters:

name - the given name to set for the vCard

getOrganization

@Nullable
java.lang.String getOrganization()

Gets the Organization of the vCard.

Returns:

the Organization of the vCard or null.

setOrganization

void setOrganization(@Nullable
                     java.lang.String organization)

Fills the Organization field of the vCard.

Parameters:

organization - the Organization.

getPhoneNumbers

@NonNull
java.lang.String[] getPhoneNumbers()

Returns the list of phone numbers in the vCard (all the TEL attributes) or
null.

Returns:

The phone numbers as string.

getPhoneNumbersWithLabel

@NonNull
FriendPhoneNumber[] getPhoneNumbersWithLabel()

Returns the list of phone numbers in the vCard (all the TEL attributes) or
null.

Returns:

The phone numbers as FriendPhoneNumber.

getPhoto

@Nullable
java.lang.String getPhoto()

Returns the first PHOTO property or null.

Returns:

The picture URI as string or null if none has been set.

setPhoto

void setPhoto(@Nullable
              java.lang.String picture)

Sets a picture URI in the vCard, using the PHOTO property.

Parameters:

picture - the picture URI to add. If null it will have the same effet as
removePhoto().

getSipAddresses

@NonNull
Address[] getSipAddresses()

Returns the list of SIP addresses in the vCard (all the IMPP attributes that
has an URI value starting by "sip:") or null.

Returns:

The SIP addresses.

getSkipValidation

boolean getSkipValidation()

Returns the skipFieldValidation property of the vcard.

Returns:

the skipFieldValidation property of the vcard

setSkipValidation

void setSkipValidation(boolean skip)

Sets the skipFieldValidation property of the vcard.

Parameters:

skip - skipFieldValidation property of the vcard

getUid

@Nullable
java.lang.String getUid()

Gets the UID of the vCard.

Returns:

the UID of the vCard, otherwise null.

setUid

void setUid(@Nullable
            java.lang.String uid)

Sets the unique ID of the vCard.

Parameters:

uid - the unique id

getUrl

@Nullable
java.lang.String getUrl()

Gets the URL of the vCard.

Returns:

the URL of the vCard in the CardDAV server, otherwise null.

setUrl

void setUrl(@Nullable
            java.lang.String url)

Sets the URL of the vCard.

Parameters:

url - the URL.

addExtendedProperty

void addExtendedProperty(@NonNull
                         java.lang.String name,
                         @NonNull
                         java.lang.String value)

Adds an extended property to the vCard.

Parameters:

name - the name of the extended property to add

value - the value of the extended property to add

addPhoneNumber

void addPhoneNumber(@NonNull
                    java.lang.String phone)

Adds a phone number in the vCard, using the TEL property.

Parameters:

phone - the phone number to add

addPhoneNumberWithLabel

void addPhoneNumberWithLabel(@NonNull
                             FriendPhoneNumber phoneNumber)

Adds a FriendPhoneNumber in the vCard, using the TEL property.

Parameters:

phoneNumber - the FriendPhoneNumber to add

addSipAddress

void addSipAddress(@NonNull
                   java.lang.String sipAddress)

Adds a SIP address in the vCard, using the IMPP property.

Parameters:

sipAddress - the SIP address to add

asVcard4String

@Nullable
java.lang.String asVcard4String()

Returns the vCard4 representation of the LinphoneVcard.

Returns:

a const char * that represents the vCard.

clone

@NonNull
Vcard clone()

Clone a Vcard.

Returns:

a new Vcard object

editMainSipAddress

void editMainSipAddress(@NonNull
                        java.lang.String sipAddress)

Edits the preferred SIP address in the vCard (or the first one), using the IMPP
property.

Parameters:

sipAddress - the new SIP address

generateUniqueId

boolean generateUniqueId()

Generates a random unique id for the vCard.

If is required to be able to synchronize the vCard with a CardDAV server

Returns:

true if operation is successful, otherwise false (for example if it
already has an unique ID)

getExtendedPropertiesValuesByName

@NonNull
java.lang.String[] getExtendedPropertiesValuesByName(@NonNull
                                                              java.lang.String name)

Get the vCard extended properties values per property name.

Parameters:

name - the name to filter the extended properties on.

Returns:

The extended properties values as string.

removeExtentedPropertiesByName

void removeExtentedPropertiesByName(@NonNull
                                    java.lang.String name)

Remove all the extend properties per property name.

Parameters:

name - the name to remove the extended properties on.

removeOrganization

void removeOrganization()

Removes the Organization field of the vCard.

removePhoneNumber

void removePhoneNumber(@NonNull
                       java.lang.String phone)

Removes a phone number in the vCard (if it exists), using the TEL property.

Parameters:

phone - the phone number to remove

removePhoneNumberWithLabel

void removePhoneNumberWithLabel(@NonNull
                                FriendPhoneNumber phoneNumber)

Removes a FriendPhoneNumber in the vCard (if it exists), using the TEL
property.

Parameters:

phoneNumber - the FriendPhoneNumber to remove

removePhoto

void removePhoto()

Removes any existing PHOTO property.

removeSipAddress

void removeSipAddress(@NonNull
                      java.lang.String sipAddress)

Removes a SIP address in the vCard (if it exists), using the IMPP property.

Parameters:

sipAddress - the SIP address to remove

setUserData

void setUserData(java.lang.Object data)

Sets the object to store in this object user's data

Parameters:

data - the object to store

getUserData

java.lang.Object getUserData()

Gets the object stored in this object user's data

Returns:

the object store if any, null otherwise

getNativePointer

long getNativePointer()

Gets the native pointer used by this class to make native method calls.

Returns:

the nativer pointer, as long

toString

java.lang.String toString()

Overrides:

toString in class java.lang.Object