Class ContactsVcard

    Definition

    Namespace:
    Tizen.Pims.Contacts
    Assembly:
    Tizen.Pims.Contacts.dll

    A class for parsing and making the vCards.

    public static class ContactsVcard
    Inheritance
    object
    ContactsVcard
    Remarks

    It's based on the vCard v3.0 specification.

    Methods

    View Source

    Compose(ContactsRecord)

    Retrieves the vCard stream from a contacts record.

    Declaration
    public static string Compose(ContactsRecord record)
    Parameters
    Type Name Description
    ContactsRecord record

    The contacts record.

    Returns
    Type Description
    string

    The vCard stream.

    Remarks

    It's based on the vCard v3.0 specification.

    Exceptions
    Type Condition
    System.ArgumentException

    Thrown when one of the arguments provided to a method is not valid.

    System.OutOfMemoryException

    Thrown when failed due to out of memory.

    System.NotSupportedException

    Thrown when the feature is not supported.

    View Source

    Parse(string)

    Retrieves all the contacts with a contacts list from a vCard stream.

    Declaration
    public static ContactsList Parse(string stream)
    Parameters
    Type Name Description
    string stream

    The vCard stream.

    Returns
    Type Description
    ContactsList

    The contacts list.

    Remarks

    It's based on the vCard v3.0 specification.

    Exceptions
    Type Condition
    System.ArgumentException

    Thrown when one of the arguments provided to a method is not valid.

    System.OutOfMemoryException

    Thrown when failed due to out of memory.

    System.NotSupportedException

    Thrown when the feature is not supported.

    View Source

    ParseForEach(string, ParseCallback)

    Retrieves all the contacts with a record from a vCard file.

    Declaration
    public static void ParseForEach(string path, ParseCallback callback)
    Parameters
    Type Name Description
    string path

    The file path of a vCard stream file.

    ParseCallback callback

    The callback function to invoke.

    Remarks

    It's based on the vCard v3.0 specification.

    Exceptions
    Type Condition
    System.InvalidOperationException

    Thrown when the method failed due to an invalid operation.

    System.ArgumentException

    Thrown when one of the arguments provided to a method is not valid.

    System.OutOfMemoryException

    Thrown when failed due to out of memory.

    System.NotSupportedException

    Thrown when the feature is not supported.

    • View Source
    Back to top Copyright © 2016-2024 Samsung
    Generated by DocFX