Vcard

public class Vcard : LinphoneObject

Object storing contact information using vCard 4.0 format.

  • Undocumented

    Declaration

    Swift

    public static func getSwiftObject(cObject: OpaquePointer) -> Vcard

  • Undocumented

    Declaration

    Swift

    public var getCobject: OpaquePointer? { get }

  • Sets the eTAG of the vCard.

    Declaration

    Swift

    public var etag: String { get set }

    Parameters

    etag

    the eTAG.
    Gets the eTag of the vCard.

    Return Value

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

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

    Declaration

    Swift

    public var familyName: String { get set }

    Parameters

    name

    the family name to set for the vCard
    Returns the family name in the N attribute of the vCard, or nil if it isn’t set yet.

    Return Value

    the family name of the vCard, or nil

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

    Declaration

    Swift

    public var fullName: String { get set }

    Parameters

    name

    the display name to set for the vCard
    Returns the FN attribute of the vCard, or nil if it isn’t set yet.

    Return Value

    the display name of the vCard, or nil.

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

    Declaration

    Swift

    public var givenName: String { get set }

    Parameters

    name

    the given name to set for the vCard
    Returns the given name in the N attribute of the vCard, or nil if it isn’t set yet.

    Return Value

    the given name of the vCard, or nil

  • Fills the Organization field of the vCard.

    Declaration

    Swift

    public var organization: String { get set }

    Parameters

    organization

    the Organization.
    Gets the Organization of the vCard.

    Return Value

    the Organization of the vCard or nil.

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

    Declaration

    Swift

    public var phoneNumbers: [String] { get }

    Return Value

    The phone numbers as string.

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

    Declaration

    Swift

    public var phoneNumbersWithLabel: [FriendPhoneNumber] { get }

    Return Value

    The phone numbers as FriendPhoneNumber.

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

    Declaration

    Swift

    public var photo: String { get set }

    Parameters

    picture

    the picture URI to add. If nil it will have the same effet as removePhoto().
    Returns the first PHOTO property or nil.

    Return Value

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

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

    Declaration

    Swift

    public var sipAddresses: [Address] { get }

    Return Value

    The SIP addresses.

  • Sets the skipFieldValidation property of the vcard.

    Declaration

    Swift

    public var skipValidation: Bool { get set }

    Parameters

    skip

    skipFieldValidation property of the vcard Returns the skipFieldValidation property of the vcard.

    Return Value

    the skipFieldValidation property of the vcard

  • uid

    Sets the unique ID of the vCard.

    Declaration

    Swift

    public var uid: String { get set }

    Parameters

    uid

    the unique id
    Gets the UID of the vCard.

    Return Value

    the UID of the vCard, otherwise nil.

  • url

    Sets the URL of the vCard.

    Declaration

    Swift

    public var url: String { get set }

    Parameters

    url

    the URL.
    Gets the URL of the vCard.

    Return Value

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

  • Adds an extended property to the vCard.

    Declaration

    Swift

    public func addExtendedProperty(name: String, value: String)

    Parameters

    name

    the name of the extended property to add
    value

    the value of the extended property to add

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

    Declaration

    Swift

    public func addPhoneNumber(phone: String)

    Parameters

    phone

    the phone number to add

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

    Declaration

    Swift

    public func addPhoneNumberWithLabel(phoneNumber: FriendPhoneNumber)

    Parameters

    phoneNumber

    the FriendPhoneNumber to add

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

    Declaration

    Swift

    public func addSipAddress(sipAddress: String)

    Parameters

    sipAddress

    the SIP address to add

  • Returns the vCard4 representation of the LinphoneVcard.

    Declaration

    Swift

    public func asVcard4String() -> String

    Return Value

    a const char * that represents the vCard.

  • Clone a Vcard.

    Declaration

    Swift

    public func clone() -> Vcard?

    Return Value

    a new Vcard object

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

    Declaration

    Swift

    public func editMainSipAddress(sipAddress: String)

    Parameters

    sipAddress

    the new SIP address

  • Generates a random unique id for the vCard. If is required to be able to synchronize the vCard with a CardDAV server

    Declaration

    Swift

    public func generateUniqueId() -> Bool

    Return Value

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

  • Get the vCard extended properties values per property name.

    Declaration

    Swift

    public func getExtendedPropertiesValuesByName(name: String) -> [String]

    Parameters

    name

    the name to filter the extended properties on.

    Return Value

    The extended properties values as string.

  • Remove all the extend properties per property name.

    Declaration

    Swift

    public func removeExtentedPropertiesByName(name: String)

    Parameters

    name

    the name to remove the extended properties on.

  • Removes the Organization field of the vCard.

    Declaration

    Swift

    public func removeOrganization()

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

    Declaration

    Swift

    public func removePhoneNumber(phone: String)

    Parameters

    phone

    the phone number to remove

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

    Declaration

    Swift

    public func removePhoneNumberWithLabel(phoneNumber: FriendPhoneNumber)

    Parameters

    phoneNumber

    the FriendPhoneNumber to remove

  • Removes any existing PHOTO property.

    Declaration

    Swift

    public func removePhoto()

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

    Declaration

    Swift

    public func removeSipAddress(sipAddress: String)

    Parameters

    sipAddress

    the SIP address to remove