Linphone.Vcard Class Reference

Inheritance diagram for Linphone.Vcard:

Public Member Functions
void	AddExtendedProperty (string name, string val)
void	AddPhoneNumber (string phone)
void	AddPhoneNumberWithLabel (Linphone.FriendPhoneNumber phoneNumber)
void	AddSipAddress (string sipAddress)
string	AsVcard4String ()
string	AsVcard4StringWithBase64Picture ()
Linphone.Vcard	Clone ()
void	EditMainSipAddress (string sipAddress)
bool	GenerateUniqueId ()
IEnumerable< string >	GetExtendedPropertiesValuesByName (string name)
void	RemoveExtentedPropertiesByName (string name)
void	RemoveJobTitle ()
void	RemoveOrganization ()
void	RemovePhoneNumber (string phone)
void	RemovePhoneNumberWithLabel (Linphone.FriendPhoneNumber phoneNumber)
void	RemovePhoto ()
void	RemoveSipAddress (string sipAddress)

Properties
string	Etag [get, set]
string	FamilyName [get, set]
string	FullName [get, set]
string	GivenName [get, set]
string	JobTitle [get, set]
string	Organization [get, set]
IEnumerable< string >	PhoneNumbers [get]
IEnumerable< Linphone.FriendPhoneNumber >	PhoneNumbersWithLabel [get]
string	Photo [get, set]
IEnumerable< Linphone.Address >	SipAddresses [get]
string	Uid [get, set]
string	Url [get, set]

Additional Inherited Members
Protected Member Functions inherited from Linphone.LinphoneObject
static String	linphone_pointer_to_string (IntPtr ptr)
static IntPtr	linphone_string_to_pointer ([MarshalAs(LinphoneWrapper.ByteStringMarshalling)] String str)
IntPtr	StringArrayToBctbxList (IEnumerable< string > stringlist)
void	CleanStringArrayPtrs (IntPtr l)

Detailed Description

Object storing contact information using vCard 4.0 format.

Member Function Documentation

void Linphone.Vcard.AddExtendedProperty ( string  name, string  val  )

inline

Adds an extended property to the vCard.

Parameters

name	the name of the extended property to add
val	the value of the extended property to add

void Linphone.Vcard.AddPhoneNumber ( string  phone )

inline

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

Parameters

phone

the phone number to add

void Linphone.Vcard.AddPhoneNumberWithLabel ( Linphone.FriendPhoneNumber  phoneNumber )

inline

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

Parameters

phoneNumber

the Linphone.FriendPhoneNumber to add

void Linphone.Vcard.AddSipAddress ( string  sipAddress )

inline

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

Parameters

sipAddress

the SIP address to add

string Linphone.Vcard.AsVcard4String ( )

inline

Returns the vCard4 representation of the LinphoneVcard.

Returns

a const char * that represents the vCard.

string Linphone.Vcard.AsVcard4StringWithBase64Picture ( )

inline

Returns the vCard4 representation of the LinphoneVcard, but if a local file is detected in a PHOTO field, it will be converted to base64.

Returns

a const char * that represents the vCard.

Linphone.Vcard Linphone.Vcard.Clone ( )

inline

Clone a Linphone.Vcard.

Returns

a new Linphone.Vcard object

void Linphone.Vcard.EditMainSipAddress ( string  sipAddress )

inline

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

Parameters

sipAddress

the new SIP address

bool Linphone.Vcard.GenerateUniqueId ( )

inline

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)

IEnumerable<string> Linphone.Vcard.GetExtendedPropertiesValuesByName ( string  name )

inline

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. A list of char * objects.

void Linphone.Vcard.RemoveExtentedPropertiesByName ( string  name )

inline

Remove all the extend properties per property name.

Parameters

name	the name to remove the extended properties on.

void Linphone.Vcard.RemoveJobTitle ( )

inline

Removes the Title field of the vCard.

void Linphone.Vcard.RemoveOrganization ( )

inline

Removes the Organization field of the vCard.

void Linphone.Vcard.RemovePhoneNumber ( string  phone )

inline

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

Parameters

phone

the phone number to remove

void Linphone.Vcard.RemovePhoneNumberWithLabel ( Linphone.FriendPhoneNumber  phoneNumber )

inline

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

Parameters

phoneNumber

the Linphone.FriendPhoneNumber to remove

void Linphone.Vcard.RemovePhoto ( )

inline

Removes any existing PHOTO property.

void Linphone.Vcard.RemoveSipAddress ( string  sipAddress )

inline

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

Parameters

sipAddress

the SIP address to remove

Property Documentation

string Linphone.Vcard.Etag

getset

Gets the eTag of the vCard.

Returns

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

string Linphone.Vcard.FamilyName

getset

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

string Linphone.Vcard.FullName

getset

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

Returns

the display name of the vCard, or null.

string Linphone.Vcard.GivenName

getset

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

string Linphone.Vcard.JobTitle

getset

Gets the Title of the vCard.

Returns

the Title of the vCard or null.

string Linphone.Vcard.Organization

getset

Gets the Organization of the vCard.

Returns

the Organization of the vCard or null.

IEnumerable<string> Linphone.Vcard.PhoneNumbers

get

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

Returns

The phone numbers as string. A list of char * objects.

IEnumerable<Linphone.FriendPhoneNumber> Linphone.Vcard.PhoneNumbersWithLabel

get

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

Returns

The phone numbers as Linphone.FriendPhoneNumber. A list of Linphone.FriendPhoneNumber objects.

string Linphone.Vcard.Photo

getset

Returns the first PHOTO property or null.

Returns

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

IEnumerable<Linphone.Address> Linphone.Vcard.SipAddresses

get

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. A list of Linphone.Address objects.

string Linphone.Vcard.Uid

getset

Gets the UID of the vCard.

Returns

the UID of the vCard, otherwise null.

string Linphone.Vcard.Url

getset

Gets the URL of the vCard.

Returns

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

---

The documentation for this class was generated from the following file:

• LinphoneWrapper.cs