Contact class

Applies to Windows and Windows Phone

Represents a contact.

Syntax


Public NotInheritable Class Contact

Attributes

[MarshalingBehavior(Agile)]
[Version(0x06030000)]

Members

The Contact class has these types of members:

Constructors

The Contact class has these constructors.

ConstructorDescription
Contact Creates a new instance of the Contact class.

 

Properties

The Contact class has these properties.

PropertyAccess typeDescription

Addresses

Read-onlyGets the contact addresses for a contact.

ConnectedServiceAccounts

Read-onlyGets the connected service accounts for a contact.

DataSuppliers

Read-onlyGets the data suppliers for a contact. The maximum string length for each data supplier is 50 characters.

DisplayName

Read-onlyGets the display name for a contact. You can only access this property from a UI thread.

Emails

Read-onlyGets the email addresses for a contact.

Fields

Read-onlyFields may be altered or unavailable for releases after Windows 8.1. Instead, use Phones, Emails, Addresses, or ConnectedServiceAccounts. Sets the fields that contain information about a contact.

FirstName

Read/writeGets and sets the first name for a contact. The maximum string length for the first name is 64 characters.

HonorificNamePrefix

Read/writeGets and sets the honorific prefix for the name for a contact. The maximum string length for the honorific prefix is 32 characters.

HonorificNameSuffix

Read/writeGets and sets the honorific suffix for the name for a contact. The maximum string length for the honorific suffix is 32 characters.

Id

Read/writeGets and sets the identifier for a contact. The maximum string length for the identifier is 256 characters.

ImportantDates

Read-onlyGets the important dates for a contact.

JobInfo

Read-onlyGets the job info items for a contact.

LastName

Read/writeGets and sets the last name for a contact. The maximum string length for the last name is 64 characters.

MiddleName

Read/writeGets and sets the middle name for a contact. The maximum string length for the middle name is 64 characters.

Name

Read/writeName may be altered or unavailable for releases after Windows 8.1. Instead, use FirstName. Sets and gets the name of the contact.

Notes

Read/writeGets and sets notes for a contact. The maximum string length for notes is 4096 characters.

Phones

Read-onlyGets info about the phones for a contact.

ProviderProperties

Read-onlyGets the property set object for the contact.

SignificantOthers

Read-onlyGets the significant others for a contact.

Thumbnail

Read/writeGets or sets a thumbnail image that represents this contact.

Websites

Read-onlyGets the Web sites for a contact.

YomiDisplayName

Read-onlyGets the Yomi (phonetic Japanese equivalent) display name for a contact.

YomiFamilyName

Read/writeGets the Yomi (phonetic Japanese equivalent) family name for a contact. The maximum string length for the Yomi family name is 120 characters.

YomiGivenName

Read/writeGets the Yomi (phonetic Japanese equivalent) given name for a contact. The maximum string length for the Yomi given name is 120 characters.

 

Remarks

No matter how you store contact information in your app, you must be able to put that information into a Contact object. This way, other apps that allow users to select contacts can use your app and process the contact information it provides.

For info about how to manage contacts, see Managing contact cards (XAML) and Managing contact cards (HTML).

Examples

This code shows how your app can take an app-specific contact object and use it to create a Contact object. First, here's an example of an object that contains contact information.


var sampleContacts = [
    {
        firstName: "Kim",
        lastName: "Abercrombie",
        image: "KimAbercrombie.jpg",
        personalEmail: "kim@contoso.com",
        homePhone: "921 555-0187",
        address: {
            full: "123 Main St, Redmond WA, 23456",
            street: "123 Main St",
            city: "Redmond",
            state: "WA",
            zipCode: "23456"
        },
        id: "49b0652e-8f39-48c5-853b-e5e94e6b8a11"
    }
];


This function creates the contact, which supports a number of fields:


function createContactForBasket(sampleContact) {

    // Transfer contact data to a Contact object
    var contact = new Windows.ApplicationModel.Contacts.Contact();
    contact.firstName = sampleContact.firstName;
    contact.lastName = sampleContact.lastName;
    contact.id = sampleContact.id;

    // Add the personal email address to the Contact object’s emails vector
    var personalEmail = new Windows.ApplicationModel.Contacts.ContactEmail();
    personalEmail.address = sampleContact.personalEmail;
    personalEmail.kind = Windows.ApplicationModel.Contacts.ContactEmailKind.personal;
    contact.emails.append(personalEmail);

    // Adds the home phone number to the Contact object’s phones vector
    var homePhone = new Windows.ApplicationModel.Contacts.ContactPhone();
    homePhone.number = sampleContact.homePhone;
    homePhone.kind = Windows.ApplicationModel.Contacts.ContactPhoneKind.home;
    contact.phones.append(homePhone);

    // Adds the address to the Contact object’s addresses vector
    var homeAddress = new Windows.ApplicationModel.Contacts.ContactAddress();
    homeAddress.streetAddress = sampleContact.address.street;
    homeAddress.locality = sampleContact.address.city;
    homeAddress.region = sampleContact.address.state;
    homeAddress.postalCode = sampleContact.address.zipCode;
    homeAddress.kind = Windows.ApplicationModel.Contacts.ContactAddressKind.home;
    contact.addresses.append(homeAddress);

    // Sets the thumbnail for the contact from path
    Windows.ApplicationModel.Package.current.installedLocation.getFileAsync(sampleContact.image).then(
          function (imageFile) {
                 var streamReference = Windows.Storage.Streams.RandomAccessStreamReference.createFromFile(imageFile);
                 contact.thumbnail = randomAccessStreamReference;
          });

    return contact;
}


Requirements

Minimum supported client

Windows 8 [Windows Store apps only]

Minimum supported server

Windows Server 2012 [Windows Store apps only]

Minimum supported phone

Windows Phone 8.1 [Windows Phone Silverlight 8.1 and Windows Runtime apps]

Namespace

Windows.ApplicationModel.Contacts
Windows::ApplicationModel::Contacts [C++]

Metadata

Windows.winmd

See also

Contact manager API sample
Contact Picker app sample
Handling Contact Actions sample

 

 

Show:
© 2014 Microsoft