platform_contacts_api_common_model/com.tomtom.ivi.platform.contacts.api.common.model/Contact

Contact

data class Contact(val displayName: String, val initials: String = "", val givenName: String = "", val familyName: String = "", val companyName: String, val phoneNumbers: List<PhoneNumber>, val defaultPhoneNumberIndex: Int, val addresses: List<Address>, val defaultAddressIndex: Int, val source: ContactSource? = null, val favorite: Boolean, val image: DrawableResolver? = null, val primarySortKey: String, val alternativeSortKey: String) : Parcelable

Encapsulates an address book contact.

Constructors

Contact

fun Contact(displayName: String, initials: String = "", givenName: String = "", familyName: String = "", companyName: String, phoneNumbers: List<PhoneNumber>, defaultPhoneNumberIndex: Int, addresses: List<Address>, defaultAddressIndex: Int, source: ContactSource? = null, favorite: Boolean, image: DrawableResolver? = null, primarySortKey: String, alternativeSortKey: String)

Properties

addresses

val addresses: List<Address>

List of addresses for the contact.

alternativeSortKey

val alternativeSortKey: String

The alternative sort key used when a list of contacts is sorted.

companyName

val companyName: String

The name of the company associated with this contact.

defaultAddressIndex

val defaultAddressIndex: Int

The index of the default address. This is an index in the addresses list.

defaultPhoneNumberIndex

val defaultPhoneNumberIndex: Int

The index of the default phone number. This is an index of the phoneNumbers list.

displayName

val displayName: String

Name of the contact.

familyName

val familyName: String

Family name of the contact. This is the last name of a contact if the name is in Western style. See also FullNameStyle. This is an empty string if the contact does not have a family name set in the address book.

favorite

val favorite: Boolean

True when the contact is set as a favorite, false otherwise.

givenName

val givenName: String

Given name of the contact. This is typically the contact's first name in Western names. See also FullNameStyle. This is an empty string if the contact does not have a given name set in the address book.

image

val image: DrawableResolver? = null

An image associated with this contact, if available, or null if there is no image available.

initials

val initials: String

Initials of the contact.

phoneNumbers

val phoneNumbers: List<PhoneNumber>

List of phone numbers of the contact.

primarySortKey

val primarySortKey: String

The primary sort key used when a list of contacts is sorted.