Class Vcard
Object storing contact information using vCard 4.0 format.
Inherited Members
Namespace: Linphone
Assembly: cs.temp.dll.dll
Syntax
public class Vcard : LinphoneObject
Properties
Etag
Gets the eTag of the vCard.
Declaration
public string Etag { get; set; }
Property Value
Type | Description |
---|---|
System.String | the eTag of the vCard in the CardDAV server, otherwise null. |
FamilyName
Returns the family name in the N attribute of the vCard, or null if it isn't set yet.
Declaration
public string FamilyName { get; set; }
Property Value
Type | Description |
---|---|
System.String | the family name of the vCard, or null |
FullName
Returns the FN attribute of the vCard, or null if it isn't set yet.
Declaration
public string FullName { get; set; }
Property Value
Type | Description |
---|---|
System.String | the display name of the vCard, or null. |
GivenName
Returns the given name in the N attribute of the vCard, or null if it isn't set yet.
Declaration
public string GivenName { get; set; }
Property Value
Type | Description |
---|---|
System.String | the given name of the vCard, or null |
JobTitle
Gets the Title of the vCard.
Declaration
public string JobTitle { get; set; }
Property Value
Type | Description |
---|---|
System.String | the Title of the vCard or null. |
Organization
Gets the Organization of the vCard.
Declaration
public string Organization { get; set; }
Property Value
Type | Description |
---|---|
System.String | the Organization of the vCard or null. |
PhoneNumbers
Returns the list of phone numbers in the vCard (all the TEL attributes) or null.
Declaration
public IEnumerable<string> PhoneNumbers { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<System.String> | The phone numbers as string. |
PhoneNumbersWithLabel
Returns the list of phone numbers in the vCard (all the TEL attributes) or null.
Declaration
public IEnumerable<FriendPhoneNumber> PhoneNumbersWithLabel { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<FriendPhoneNumber> | The phone numbers as FriendPhoneNumber. |
Photo
Returns the first PHOTO property or null.
Declaration
public string Photo { get; set; }
Property Value
Type | Description |
---|---|
System.String | The picture URI as string or null if none has been set. |
SipAddresses
Returns the list of SIP addresses in the vCard (all the IMPP attributes that has an URI value starting by "sip:") or null.
Declaration
public IEnumerable<Address> SipAddresses { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<Address> | The SIP addresses. |
Uid
Gets the UID of the vCard.
Declaration
public string Uid { get; set; }
Property Value
Type | Description |
---|---|
System.String | the UID of the vCard, otherwise null. |
Url
Gets the URL of the vCard.
Declaration
public string Url { get; set; }
Property Value
Type | Description |
---|---|
System.String | the URL of the vCard in the CardDAV server, otherwise null. |
Methods
AddExtendedProperty(String, String)
Adds an extended property to the vCard.
Declaration
public void AddExtendedProperty(string name, string val)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | the name of the extended property to add |
System.String | val | the value of the extended property to add |
AddPhoneNumber(String)
Adds a phone number in the vCard, using the TEL property.
Declaration
public void AddPhoneNumber(string phone)
Parameters
Type | Name | Description |
---|---|---|
System.String | phone | the phone number to add |
AddPhoneNumberWithLabel(FriendPhoneNumber)
Adds a FriendPhoneNumber in the vCard, using the TEL property.
Declaration
public void AddPhoneNumberWithLabel(FriendPhoneNumber phoneNumber)
Parameters
Type | Name | Description |
---|---|---|
FriendPhoneNumber | phoneNumber | the FriendPhoneNumber to add |
AddSipAddress(String)
Adds a SIP address in the vCard, using the IMPP property.
Declaration
public void AddSipAddress(string sipAddress)
Parameters
Type | Name | Description |
---|---|---|
System.String | sipAddress | the SIP address to add |
AsVcard4String()
Returns the vCard4 representation of the LinphoneVcard.
Declaration
public string AsVcard4String()
Returns
Type | Description |
---|---|
System.String | a const char * that represents the vCard. |
Clone()
Clone a Vcard.
Declaration
public Vcard Clone()
Returns
Type | Description |
---|---|
Vcard | a new Vcard object |
EditMainSipAddress(String)
Edits the preferred SIP address in the vCard (or the first one), using the IMPP property.
Declaration
public void EditMainSipAddress(string sipAddress)
Parameters
Type | Name | Description |
---|---|---|
System.String | sipAddress | the new SIP address |
GenerateUniqueId()
Generates a random unique id for the vCard.
If is required to be able to synchronize the vCard with a CardDAV server
Declaration
public bool GenerateUniqueId()
Returns
Type | Description |
---|---|
System.Boolean | true if operation is successful, otherwise false (for example if it already has an unique ID) |
GetExtendedPropertiesValuesByName(String)
Get the vCard extended properties values per property name.
Declaration
public IEnumerable<string> GetExtendedPropertiesValuesByName(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | the name to filter the extended properties on. |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<System.String> | The extended properties values as string. |
RemoveExtentedPropertiesByName(String)
Remove all the extend properties per property name.
Declaration
public void RemoveExtentedPropertiesByName(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | the name to remove the extended properties on. |
RemoveJobTitle()
Removes the Title field of the vCard.
Declaration
public void RemoveJobTitle()
RemoveOrganization()
Removes the Organization field of the vCard.
Declaration
public void RemoveOrganization()
RemovePhoneNumber(String)
Removes a phone number in the vCard (if it exists), using the TEL property.
Declaration
public void RemovePhoneNumber(string phone)
Parameters
Type | Name | Description |
---|---|---|
System.String | phone | the phone number to remove |
RemovePhoneNumberWithLabel(FriendPhoneNumber)
Removes a FriendPhoneNumber in the vCard (if it exists), using the TEL property.
Declaration
public void RemovePhoneNumberWithLabel(FriendPhoneNumber phoneNumber)
Parameters
Type | Name | Description |
---|---|---|
FriendPhoneNumber | phoneNumber | the FriendPhoneNumber to remove |
RemovePhoto()
Removes any existing PHOTO property.
Declaration
public void RemovePhoto()
RemoveSipAddress(String)
Removes a SIP address in the vCard (if it exists), using the IMPP property.
Declaration
public void RemoveSipAddress(string sipAddress)
Parameters
Type | Name | Description |
---|---|---|
System.String | sipAddress | the SIP address to remove |