This page provides information about views with properties.
Required Header
#include <contacts.h>
Overview
In this category, application developers can find tables with view properties. A view is a structure which describes properties of a record. A record can have basic properties of five types: integer, string, boolean, long integer, double. Each property of basic type has functions to operate on it:
For long integer functions, "lli" stands for long long int, usually used to hold UTC time. Record types which have *_id as their properties, hold identifiers of other records - for example, name, number and email views hold ID of their corresponding contacts in contact_id property (as children of the corresponding contacts record). Properties of type 'record' are other records. For example, the _contacts_contact view has a 'name' property of type 'record'. This means that records of type name (_contacts_name view) can be children of the contact record. If a name record holds the identifier of a contact record in its 'contact_id' property, it is the child record of the corresponding contact record. Records can have many children of a given type. For a more detailed explanation and examples, see the main section of Contacts API.
_contacts_address_book view
Type | Property ID | Read, Write | Description |
string | _uri | read only | Identifier of this contacts addressbook view |
integer | id | read only | DB record ID of the addressbook |
integer | account_id | read, write once | Account ID that the addressbook belongs to |
string | name | read, write | It cannot be NULL . Duplicate names are not allowed. |
integer | mode | read, write | Addressbook mode, refer to the contacts_address_book_mode_e |
_contacts_group view
Type | Property ID | Read, Write | Description |
string | _uri | read only | Identifier of this contacts group view |
integer | id | read only | DB record ID of the group |
integer | address_book_id | read, write once | Addressbook ID that the group belongs to |
string | name | read, write | Group name |
string | ringtone_path | read, write | Ringtone path of the group |
string | image_path | read, write | Image path of the group |
string | vibration | read, write | Vibration path of the group |
string | extra_data | read, write | Extra data for default group name |
boolean | is_read_only | read, write once | The group is read only or not |
string | message_alert | read, write | Message alert path of the group |
_contacts_person view
Type | Property ID | Read, Write | Description |
string | _uri | read only | Identifier of this contacts person view |
integer | id | read only | DB record ID of the person |
string | display_name | read only | Display name of the person |
string | display_name_index | read only | The first character of first string for grouping. This is normalized using icu (projection) |
integer | display_contact_id | read only | Display contact ID that the person belongs to |
string | ringtone_path | read, write | Ringtone path of the person |
string | image_thumbnail_path | read only | Image thumbnail path of the person |
string | vibration | read, write | Vibration path of the person |
string | message_alert | read, write | Message alert path of the person |
string | status | read only | Status of social account |
boolean | is_favorite | read, write | The person is favorite or not |
double | favorite_priority | read only | The priority of favorite contacts. it can be used as sorting key, see the contacts_query_set_sort |
integer | link_count | read only | Link count of contact records (projection) |
string | addressbook_ids | read only | Addressbook IDs that the person belongs to (projection) |
boolean | has_phonenumber | read only | The person has phone number or not |
boolean | has_email | read only | The person has email or not |
integer | snippet_type | read only | keyword matched data type, refer to they contacts_data_type_e (Since 3.0) |
string | snippet_string | read only | keyword matched data string (Since 3.0) |
_contacts_simple_contact view
You can only get simple contact using this view.
Type | Property ID | Description |
string | _uri | Identifier of this simple contact view |
integer | id | DB record ID of the contact |
string | display_name | Display name of the contact |
integer | display_source_id | The source type of display name, refer to the contacts_display_name_source_type_e |
integer | address_book_id | Addressbook that the contact belongs to |
string | ringtone_path | Ringtone path of the contact |
string | image_thumbnail_path | Image thumbnail path of the contact |
boolean | is_favorite | The contact is favorite or not |
boolean | has_phonenumber | The contact has phone number or not |
boolean | has_email | The contact has email or not |
integer | person_id | Person ID that the contact belongs to |
string | uid | Unique identifier |
string | vibration | Vibration path of the contact |
string | message_alert | Message alert path of the contact |
integer | changed_time | Last changed contact time |
_contacts_contact view
Type | Property ID | Read, Write | Description |
string | _uri | read only | Identifier of this contact view |
integer | id | read only | DB record ID of the contact |
string | display_name | read only | Display name of the contact |
integer | display_source_id | read only | The source type of display name, refer to the contacts_display_name_source_type_e |
integer | address_book_id | read, write once | Addressbook ID that the contact belongs to |
string | ringtone_path | read, write | Ringtone path of the contact |
string | image_thumbnail_path | read only | Image thumbnail path of the contact |
boolean | is_favorite | read, write | The contact is favorite or not |
boolean | has_phonenumber | read only | The contact has phone number or not |
boolean | has_email | read only | The contact has email or not |
integer | person_id | read, write once | Person ID that the contact belongs to. If set when inserting, a contact will be linked to person |
string | uid | read, write | Unique identifier |
string | vibration | read, write | Vibration path of the contact |
string | message_alert | read, write | Message alert path of the contact |
integer | changed_time | read only | Last changed contact time |
integer | link_mode | read, write once | The link mode, refer to the contacts_contact_link_mode_e. If the person_id was set, this value will be ignored |
record | name | read, write | _contacts_name child record (single) |
record | company | read, write | _contacts_company child record (multiple) |
record | note | read, write | _contacts_note child record (multiple) |
record | number | read, write | _contacts_number child record (multiple) |
record | email | read, write | _contacts_email child record (multiple) |
record | event | read, write | _contacts_event child record (multiple) |
record | messenger | read, write | _contacts_messenger child record (multiple) |
record | address | read, write | _contacts_address child record (multiple) |
record | url | read, write | _contacts_url child record (multiple) |
record | nickname | read, write | _contacts_nickname child record (multiple) |
record | profile | read, write | _contacts_profile child record (multiple) |
record | relationship | read, write | _contacts_relationship child record (multiple) |
record | image | read, write | _contacts_image child record (multiple) |
record | group_relation | read, write | _contacts_group_relation child record (multiple) |
record | sip | read, write | _contacts_sip child record (multiple) (Since 3.0) |
_contacts_my_profile view
Type | Property ID | Read, Write | Description |
string | _uri | read only | Identifier of this my profile view |
integer | id | read only | DB record ID of the my profile |
string | display_name | read only | Display name of the profile |
integer | address_book_id | read, write once | Addressbook ID that the profile belongs to |
string | image_thumbnail_path | read only | Image thumbnail path of the profile |
string | uid | read, write | Unique identifier |
integer | changed_time | read only | Last changed profile time |
record | name | read, write | _contacts_name child record (single) |
record | company | read, write | _contacts_company child record (multiple) |
record | note | read, write | _contacts_note child record (multiple) |
record | number | read, write | _contacts_number child record (multiple) |
record | email | read, write | _contacts_email child record (multiple) |
record | event | read, write | _contacts_event child record (multiple) |
record | messenger | read, write | _contacts_messenger child record (multiple) |
record | address | read, write | _contacts_address child record (multiple) |
record | url | read, write | _contacts_url child record (multiple) |
record | nickname | read, write | _contacts_nickname child record (multiple) |
record | profile | read, write | _contacts_profile child record (multiple) |
record | relationship | read, write | _contacts_relationship child record (multiple) |
record | image | read, write | _contacts_image child record (multiple) |
record | sip | read, write | _contacts_sip child record (multiple) (Since 3.0) |
_contacts_name view
Type | Property ID | Read, Write | Description |
string | _uri | read only | Identifier of this contacts name view |
integer | id | read only | DB record ID of the name |
integer | contact_id | read, write once | Contacts ID that the name record belongs to |
string | first | read, write | First name |
string | last | read, write | Last name |
string | addition | read, write | Middle name |
string | suffix | read, write | Suffix |
string | prefix | read, write | Prefix |
string | phonetic_first | read, write | Pronounce the first name |
string | phonetic_middle | read, write | Pronounce the middle name |
string | phonetic_last | read, write | Pronounce the last name |
_contacts_number view
Type | Property ID | Read, Write | Description |
string | _uri | read only | Identifier of this contacts number view |
integer | id | read only | DB record ID of the number |
integer | contact_id | read, write once | Contact ID that the number belongs to |
integer | type | read, write | Number type, refer to the contacts_number_type_e |
string | label | read, write | Custom number type label, when the number type is CONTACTS_NUMBER_TYPE_CUSTOM |
boolean | is_default | read, write | The number is default number or not |
string | number | read, write | Number |
string | normalized_number | filter only | You can only use this property for search filter. |
string | cleaned_number | filter only | You can only use this property for search filter. |
string | number_filter | filter only | You can only use this property for search filter. |
_contacts_email view
Type | Property ID | Read, Write | Description |
string | _uri | read only | Identifier of this contacts email view |
integer | id | read only | DB record ID of the email |
integer | contact_id | read, write once | Contact ID that the email belongs to |
integer | type | read, write | Email type, refer to the contacts_email_type_e |
string | label | read, write | Custom mail type label, when the email type is CONTACTS_EMAIL_TYPE_CUSTOM |
boolean | is_default | read, write | The email is default email or not |
string | email | read, write | Email address |
_contacts_address view
Type | Property ID | Read, Write | Description |
string | _uri | read only | Identifier of this contacts address view |
integer | id | read only | DB record ID of the address |
integer | contact_id | read, write once | Contact ID that the address belongs to |
integer | type | read, write | Address type, refer to the contacts_address_type_e |
string | label | read, write | Address type label, when the address type is CONTACTS_ADDRESS_TYPE_CUSTOM |
string | postbox | read, write | Post office box |
string | postal_code | read, write | Postal code |
string | region | read, write | Region |
string | locality | read, write | Locality |
string | street | read, write | Street |
string | country | read, write | Country |
string | extended | read, write | Extended address |
boolean | is_default | read, write | The address is default or not |
_contacts_note view
Type | Property ID | Read, Write | Description |
string | _uri | read only | Identifier of this contacts note view |
integer | id | read only | DB record ID of the note |
integer | contact_id | read, write once | Contact ID that the note belongs to |
string | note | read, write | Note contents |
_contacts_url view
Type | Property ID | Read, Write | Description |
string | _uri | read only | Identifier of this contacts URL view |
integer | id | read only | DB record ID of the URL |
integer | contact_id | read, write once | Contact ID that the URL belongs to |
integer | type | read, write | URL type, refer to the contacts_url_type_e |
string | label | read, write | Custom URL type label, when the URL type is CONTACTS_URL_TYPE_CUSTOM |
string | url | read, write | URL |
_contacts_event view
Type | Property ID | Read, Write | Description |
string | _uri | read only | Identifier of this contacts event view |
integer | id | read only | DB record ID of the event |
integer | contact_id | read, write once | Contact ID that the event belongs to |
integer | type | read, write | Event type, refer to the contacts_event_type_e |
string | label | read, write | Custom event type label, when the event type is CONTACTS_EVENT_TYPE_CUSTOM |
integer | date | read, write | Event date(YYYYMMDD). e.g. 2014/1/1 : 20140101. Even if the calendar_type is set as CONTACTS_EVENT_CALENDAR_TYPE_CHINESE, you SHOULD set Gregorian date |
integer | calendar_type | read, write | Calendar type, refer to the contacts_event_calendar_type_e |
bool | is_leap_month (Deprecated) | read, write | The month is leap or not (valid on lunisolar calendar only) |
_contacts_group_relation view
Refer contacts_group_add_contact, contacts_group_remove_contact
Type | Property ID | Read, Write | Description |
string | _uri | read only | Identifier of this relationship view |
integer | id | read only | DB record ID of the group (can not be used as filter) |
integer | group_id | read, write once | DB record ID of the group |
integer | contact_id | read, write once | DB record ID of the contact |
string | name | read only | Group name |
_contacts_relationship view
Type | Property ID | Read, Write | Description |
string | _uri | read only | Identifier of this relationship view |
integer | id | read only | DB record ID of the relationship |
integer | contact_id | read, write once | Contact ID that the relationship belongs to |
integer | type | read, write | Relationship type, refer to the contacts_relationship_type_e |
string | label | read, write | Custom relationship type label, when the relationship type is CONTACTS_RELATIONSHIP_TYPE_CUSTOM |
string | name | read, write | Selected contact name that the relationship belongs to |
_contacts_image view
Type | Property ID | Read, Write | Description |
string | _uri | read only | Identifier of this contacts image view |
integer | id | read only | DB record ID of the image |
integer | contact_id | read, write once | Contact ID that the image belongs to |
integer | type | read, write | Image type, refer to the contacts_image_type_e |
string | label | read, write | Custom image type label, when the image type is CONTACTS_IMAGE_TYPE_CUSTOM |
string | path | read, write | Image thumbnail path |
_contacts_company view
Type | Property ID | Read, Write | Description |
string | _uri | read only | Identifier of this contacts company view |
integer | id | read only | DB record ID of the company |
integer | contact_id | read, write once | Contact ID that the company belongs to |
integer | type | read, write | Company type, refer to the contacts_company_type_e |
string | label | read, write | Custom company type label, when the company type is CONTACTS_COMPANY_TYPE_CUSTOM |
string | name | read, write | Company name |
string | department | read, write | Department |
string | job_title | read, write | Job title |
string | assistant_name | read, write | Assistant name |
string | role | read, write | Role |
string | logo | read, write | Company logo image file path |
string | location | read, write | Company location |
string | description | read, write | Description |
string | phonetic_name | read, write | Pronounce the company name |
_contacts_nickname view
Type | Property ID | Read, Write | Description |
string | _uri | read only | Identifier of this contacts nickname view |
integer | id | read only | DB record ID of the nickname |
integer | contact_id | read, write once | Contact ID that the nickname belongs to |
string | name | read, write | Nickname |
_contacts_messenger view
Type | Property ID | Read, Write | Description |
string | _uri | read only | Identifier of this contacts messenger view |
integer | id | read only | DB record ID of the messenger |
integer | contact_id | read, write once | Contact ID that the messenger belongs to |
integer | type | read, write | Messenger type, refer to the contacts_messenger_type_e |
string | label | read, write | Custom messenger type label, when the messenger type is CONTACTS_MESSENGER_TYPE_CUSTOM |
string | im_id | read, write | Messenger ID (email address or email ID...) |
_contacts_extension view
Type | Property ID | Read, Write | Description |
string | _uri | read only | Identifier of this contacts extension view |
integer | id | read only | DB record ID of the contact extension |
integer | contact_id | read, write once | Contact ID that the contact extension belongs to |
integer | data1 | read, write | The extra child record format for non-provided from contacts-service |
string | data2 | read, write | The extra child record format for non-provided from contacts-service |
string | data3 | read, write | The extra child record format for non-provided from contacts-service |
string | data4 | read, write | The extra child record format for non-provided from contacts-service |
string | data5 | read, write | The extra child record format for non-provided from contacts-service |
string | data6 | read, write | The extra child record format for non-provided from contacts-service |
string | data7 | read, write | The extra child record format for non-provided from contacts-service |
string | data8 | read, write | The extra child record format for non-provided from contacts-service |
string | data9 | read, write | The extra child record format for non-provided from contacts-service |
string | data10 | read, write | The extra child record format for non-provided from contacts-service |
string | data11 | read, write | The extra child record format for non-provided from contacts-service |
string | data12 | read, write | The extra child record format for non-provided from contacts-service |
_contacts_sdn view
Type | Property ID | Read, Write | Description |
string | _uri | read only | Identifier of this contacts sdn view |
integer | id | read only | DB record ID of the sdn |
string | name | read only | Provided name of sdn |
string | number | read only | Provided number of sdn |
integer | sim_slot_no | read only | It is related to the SIM slot number. sim_slot_no 0 means first SIM card, sim_slot_no 1 means second SIM. It is same with handle index of telephony handle list. Refer to the telephony_init() |
_contacts_profile view
Type | Property ID | Read, Write | Description |
string | _uri | read only | Identifier of this contacts profile view |
integer | id | read only | DB record ID of profile |
integer | contact_id | read, write once | Contacts ID that the profile belongs to |
string | uid | read, write | Unique identifier |
string | text | read, write | Profile contents |
integer | order | read, write | Priority to display the profile |
string | service_operation | read, write | Data for app_control_set_operation |
string | mime | read, write | Data for app_control_set_mime |
string | app_id | read, write | Data for app_control_set_app_id |
string | uri | read, write | Data for app_control_set_uri |
string | category | read, write | Data for app_control_set_category |
string | extra_data | read, write | It includes "key:value,key:value," pairs. You should parse it. And you must base64 encode each key and value |
_contacts_activity_photo view
Type | Property ID | Read, Write | Description |
string | _uri | read only | Identifier of this contact activity photo view |
integer | id | read only | DB record ID of activity photo |
integer | activity_id | read, write once | Activity ID that the activity photo belongs to |
string | photo_url | read, write | Photo URL |
integer | sort_index | read, write | Sorted photo index |
_contacts_activity view
Type | Property ID | Read, Write | Description |
string | _uri | read only | Identifier of this activity view |
integer | id | read only | DB record ID of activity |
integer | contact_id | read, write once | Contact ID that the activity belongs to |
string | source_name | read, write | Account name that the activity belongs to |
int | timestamp | read, write | Published time of activity |
string | status | read, write | Activity status |
string | service_operation | read, write | Data for app_control_set_operation |
string | uri | read, write | Data for app_control_set_uri |
record | photo | read, write | _contacts_activity_photo child record (multiple) |
_contacts_speeddial view
Type | Property ID | Read, Write | Description |
string | _uri | read only | Identifier of this contact speed dial view |
integer | speeddial_number | read, write once | Stored speed dial number |
integer | number_id | read, write | Number ID that the speed dial belongs to |
string | number | read only | Contact number of specified speed dial |
string | number_label | read only | Contact number label of specified speed dial, when the number type is CONTACTS_NUMBER_TYPE_CUSTOM |
integer | number_type | read only | Contact number type, refer to the contacts_number_type_e |
integer | person_id | read only | Person ID that the speed dial belongs to |
string | display_name | read only | Display name that the speed dial belongs to |
string | image_thumbnail_path | read only | Image thumbnail path that the speed dial belongs to |
string | normalized_number | filter only | You can only use this property for search filter |
string | cleaned_number | filter only | You can only use this property for search filter |
string | number_filter | filter only | If you add filter with this property, the string will be normalized as minmatch length internally and the match rule will be applied CONTACTS_MATCH_EXACTLY |
_contacts_phone_log view
Type | Property ID | Read, Write | Description |
string | _uri | read only | Identifier of this phone log view |
integer | id | read only | DB record ID of phone log |
integer | person_id | read, write once | Person ID that the phone log belongs to |
string | address | read, write once | Number or Email that the phone log displays |
integer | log_time | read, write once | Call end time. The value means number of seconds since 1970-01-01 00:00:00 (UTC) |
integer | log_type | read, write | Log type, refer to the contacts_phone_log_type_e |
integer | extra_data1 | read, write once | You can set the related integer data (e.g. message_id, email_id or duration(seconds) of call) |
string | extra_data2 | read, write once | You can set the related string data (e.g. short message, subject) |
string | normalized_address | filter only | You can only use this property for search filter |
string | cleaned_address | filter only | You can only use this property for search filter |
string | address_filter | filter only | You can only use this property for search filter |
integer | sim_slot_no | read, write once | You can set the related SIM slot number. sim_slot_no 0 means first SIM card, sim_slot_no 1 means second SIM. It is same with handle index of telephony handle list. Refer to the telephony_init() |
_contacts_contact_updated_info view (read only)
Type | Property ID | Description |
string | _uri | Identifier of this contact updated info view |
integer | contact_id | Updated contact ID |
integer | address_book_id | Addressbook ID that the updated contact belongs to |
integer | type | Contact updated type, refer to the contacts_changed_e |
integer | version | Updated version |
boolean | image_changed | Contact image is changed or not |
_contacts_my_profile_updated_info view (read only)
Type | Property ID | Description |
string | _uri | Identifier of this my profile updated info view |
integer | address_book_id | Address book ID that the updated my profile belongs to |
integer | last_changed_type | Changed update type, refer to the contacts_changed_e |
integer | version | Updated version |
_contacts_group_updated_info view (read only)
Type | Property ID | Description |
string | _uri | Identifier of this group updated info view |
integer | group_id | Updated group ID |
integer | address_book_id | Address book ID that the updated group belongs to |
integer | type | Changed update type, refer to the contacts_changed_e |
integer | version | Updated version |
_contacts_group_member_updated_info view (read only)
Type | Property ID | Description |
string | _uri | Identifier of this group member updated info view |
integer | group_id | Updated group ID |
integer | address_book_id | Address book ID that the updated group belongs to |
integer | version | Updated version |
_contacts_grouprel_updated_info view (read only)
Type | Property ID | Description |
string | _uri | Identifier of this group relation updated info view |
integer | group_id | Group ID of group relation |
integer | contact_id | Contact ID of the updated group relation |
integer | address_book_id | Address book ID of contact that the updated group relation |
integer | type | Changed update type, refer to the contacts_changed_e |
integer | version | Updated version |
_contacts_person_contact view (read only)
Type | Property ID | Description |
string | _uri | Identifier of this person contact view |
integer | person_id | DB record ID of the person |
string | display_name | Display name of the person |
string | display_name_index | The first character of first string for grouping. This is normalized using icu (projection) |
integer | display_contact_id | Display contact ID that the person belongs to (projection) |
string | ringtone_path | Ringtone path of the person (projection) |
string | image_thumbnail_path | Image thumbnail path of the person (projection) |
string | vibration | Vibration path of the person (projection) |
string | message_alert | Message alert path of the person (projection) |
string | status | Status of social account (projection) |
boolean | is_favorite | The person is favorite or not |
integer | link_count | Link count of contact records (projection) |
integer | contact_id | Contact ID that the person belongs to |
string | addressbook_ids | Addressbook IDs that the person belongs to (projection) |
boolean | has_phonenumber | The person has phone number or not |
boolean | has_email | The person has email or not |
integer | address_book_id | Addressbook ID that the person belongs to |
integer | address_book_mode | Addressbook mode, refer to the contacts_address_book_mode_e |
string | address_book_name | Addressbook name that the person belongs to |
integer | snippet_type | keyword matched data type, refer to they contacts_data_type_e (Since 3.0) |
string | snippet_string | keyword matched data string (Since 3.0) |
_contacts_person_number view (read only)
Type | Property ID | Description |
string | _uri | Identifier of this person number view |
integer | person_id | DB record ID of the person |
string | display_name | Display name of the person |
string | display_name_index | The first character of first string for grouping. This is normalized using icu (projection) |
integer | display_contact_id | Display contact ID that the person belongs to (projection) |
string | ringtone_path | Ringtone path of the person (projection) |
string | image_thumbnail_path | Image thumbnail path of the person (projection) |
string | vibration | Vibration path of the person (projection) |
string | message_alert | Message alert path of the person (projection) |
boolean | is_favorite | The person is favorite or not |
boolean | has_phonenumber | The person has phone number or not |
boolean | has_email | The person has email or not |
integer | number_id | Number ID that the person belongs to |
integer | type | Number type, refer to the contacts_number_type_e (projection) |
string | label | Custom number type label, when the number type is CONTACTS_NUMBER_TYPE_CUSTOM (projection) |
boolean | is_primary_default | The number is default number or not |
string | number | Number |
string | number_filter | If you add filter with this property, the string will be normalized as minmatch length internally and the match rule will be applied CONTACTS_MATCH_EXACTLY |
string | normalized_number | You can only use this property for search filter |
string | cleaned_number | You can only use this property for search filter |
integer | snippet_type | keyword matched data type, refer to they contacts_data_type_e (Since 3.0) |
string | snippet_string | keyword matched data string (Since 3.0) |
_contacts_person_email view (read only)
Type | Property ID | Description |
string | _uri | Identifier of this person email view |
integer | person_id | DB record ID of the person |
string | display_name | Display name of the person |
string | display_name_index | The first character of first string for grouping. This is normalized using icu (projection) |
integer | display_contact_id | Display contact ID that the person belongs to (projection) |
string | ringtone_path | Ringtone path of the person (projection) |
string | image_thumbnail_path | Image thumbnail path of the person (projection) |
string | vibration | Vibration path of the person (projection) |
string | message_alert | Message alert path of the person (projection) |
boolean | is_favorite | The person is favorite or not |
boolean | has_phonenumber | The person has phone number or not |
boolean | has_email | The person has email or not |
integer | email_id | Email ID that the person belongs to |
integer | type | Email type, refer to the contacts_email_type_e (projection) |
string | label | Custom mail type label, when the email type is CONTACTS_EMAIL_TYPE_CUSTOM (projection) |
boolean | is_primary_default | The email is default email or not |
string | email | Email address |
integer | snippet_type | keyword matched data type, refer to they contacts_data_type_e (Since 3.0) |
string | snippet_string | keyword matched data string (Since 3.0) |
_contacts_person_grouprel view (read only)
Type | Property ID | Description |
string | _uri | Identifier of this person group relation view |
integer | person_id | DB record ID of the person |
string | display_name | Display name of the person |
string | display_name_index | The first character of first string for grouping. This is normalized using icu (projection) |
integer | display_contact_id | Display contact ID that the person belongs to (projection) |
string | ringtone_path | Ringtone path of the person (projection) |
string | image_thumbnail_path | Image thumbnail path of the person (projection) |
string | vibration | Vibration path of the person (projection) |
string | message_alert | Message alert path of the person (projection) |
string | status | Status of social account (projection) |
boolean | is_favorite | The person is favorite or not |
integer | link_count | Link count of contact records (projection) |
string | addressbook_ids | Addressbook IDs that the person belongs to (projection) |
boolean | has_phonenumber | The person has phone number or not |
boolean | has_email | The person has email or not |
integer | address_book_id | Addressbook ID that the person belongs to |
integer | address_book_mode | Addressbook mode, refer to the contacts_address_book_mode_e |
string | address_book_name | Addressbook name that the person belongs to |
integer | group_id | Group ID that the person belongs to |
integer | contact_id | Contact ID that the person belongs to (projection) |
integer | snippet_type | keyword matched data type, refer to they contacts_data_type_e (Since 3.0) |
string | snippet_string | keyword matched data string (Since 3.0) |
_contacts_person_group_assigned view (read only)
Type | Property ID | Description |
string | _uri | Identifier of this person group assigned view |
integer | person_id | DB record ID of the person |
string | display_name | Display name of the person |
string | display_name_index | The first character of first string for grouping. This is normalized using icu (projection) |
integer | display_contact_id | Display contact ID that the person belongs to (projection) |
string | ringtone_path | Ringtone path of the person (projection) |
string | image_thumbnail_path | Image thumbnail path of the person (projection) |
string | vibration | Vibration path of the person (projection) |
string | message_alert | Message alert path of the person (projection) |
string | status | Status of social account (projection) |
boolean | is_favorite | The person is favorite or not |
integer | link_count | Link count of contact records (projection) |
string | linked_address_book_ids | Addressbook IDs that the linked person belongs to (projection) |
boolean | has_phonenumber | The person has phone number or not |
boolean | has_email | The person has email or not |
integer | address_book_id | Addressbook ID that the person belongs to |
integer | address_book_mode | Addressbook mode, refer to the contacts_address_book_mode_e |
integer | group_id | Group ID that the person belongs to |
integer<dtd> | contact_id | Contact ID that the person belongs to (projection) |
integer | snippet_type | keyword matched data type, refer to they contacts_data_type_e (Since 3.0) |
string | snippet_string | keyword matched data string (Since 3.0) |
_contacts_person_group_not_assigned view (read only)
Type | Property ID | Description |
string | _uri | Identifier of this person group not assigned view |
integer | person_id | DB record ID of the person |
string | display_name | Display name of the person |
string | display_name_index | The first character of first string for grouping. This is normalized using icu (projection) |
integer | display_contact_id | Display contact ID that the person belongs to (projection) |
string | ringtone_path | Ringtone path of the person (projection) |
string | image_thumbnail_path | Image thumbnail path of the person (projection) |
string | vibration | Vibration path of the person (projection) |
string | message_alert | Message alert path of the person (projection) |
string | status | Status of social account (projection) |
boolean | is_favorite | The person is favorite or not |
integer | link_count | Link count of contact records (projection) |
string | linked_address_book_ids | Addressbook IDs that the linked person belongs to (projection) |
boolean | has_phonenumber | The person has phone number or not |
boolean | has_email | The person has email or not |
integer | address_book_id | Addressbook ID that the person belongs to |
integer | address_book_mode | Addressbook mode, refer to the contacts_address_book_mode_e |
integer | contact_id | Contact ID that the person belongs to (projection) |
integer | snippet_type | keyword matched data type, refer to they contacts_data_type_e (Since 3.0) |
string | snippet_string | keyword matched data string (Since 3.0) |
_contacts_person_phone_log view (read only)
Type | Property ID | Description |
string | _uri | Identifier of this phone log view |
integer | person_id | DB record ID of person |
string | display_name | Display name of the person |
string | image_thumbnail_path | Image thumbnail path of the person (projection) |
integer | log_id | DB record ID of phone log |
string | address | Number or Email that the phone log displays |
integer | address_type | Number or Email type (projection) |
integer | log_time | Call end time. The value means number of seconds since 1970-01-01 00:00:00 (UTC) |
integer | log_type | Log type, refer to the contacts_phone_log_type_e |
integer | extra_data1 | You can set the related integer data (e.g. message_id, email_id or duration(seconds) of call) (projection) |
string | extra_data2 | You can set the related string data (e.g. short message, subject) (projection) |
string | normalized_address | You can only use this property for search filter |
string | cleaned_address | You can only use this property for search filter |
string | address_filter | You can only use this property for search filter |
integer | sim_slot_no | It is related to the SIM slot number. sim_slot_no 0 means first SIM card, sim_slot_no 1 means second SIM. It is same with handle index of telephony handle list. Refer to the telephony_init() |
_contacts_person_usage view (read only)
Type | Property ID | Description |
string | _uri | Identifier of this person usage view |
integer | person_id | DB record ID of the person |
string | display_name | Display name of the person |
string | display_name_index | The first character of first string for grouping. This is normalized using icu (projection) |
integer | display_contact_id | Display contact ID that the person belongs to (projection) |
string | ringtone_path | Ringtone path of the person (projection) |
string | image_thumbnail_path | Image thumbnail path of the person (projection) |
string | vibration | Vibration path of the person (projection) |
string | message_alert | Message alert path of the person (projection) |
boolean | is_favorite | The person is favorite or not |
boolean | has_phonenumber | The person has phone number or not |
boolean | has_email | The person has email or not |
integer | usage_type | Usage type, refer to the contacts_usage_type_e |
integer | times_used | Usage number of person |
_contacts_contact_number view (read only)
Type | Property ID | Description |
string | _uri | Identifier of this contacts number view |
integer | contact_id | Contact ID that the number belongs to |
string | display_name | Display name of contact that the number belongs to |
integer | display_source_type | The source type of display name, refer to the contacts_display_name_source_type_e (projection) |
integer | address_book_id | Addressbook ID that the number belongs to |
integer | person_id | Person ID that the number belongs to |
string | ringtone_path | Ringtone path that the number belongs to (projection) |
string | image_thumbnail_path | Image thumbnail path that the number belongs to (projection) |
integer | number_id | DB record ID of the number |
integer | type | Number type, refer to the contacts_number_type_e (projection) |
string | label | Custom number type label, when the number type is CONTACTS_NUMBER_TYPE_CUSTOM (projection) |
boolean | is_default | The number is default number or not |
string | number | Number |
string | number_filter | If you add filter with this property, the string will be normalized as minmatch length internally and the match rule will be applied CONTACTS_MATCH_EXACTLY |
string | normalized_number | You can only use this property for search filter |
string | cleaned_number | You can only use this property for search filter |
_contacts_contact_email view (read only)
Type | Property ID | Description |
string | _uri | Identifier of this contacts email view |
integer | contact_id | Contact ID that the email belongs to |
string | display_name | Display name that the email belongs to |
integer | display_source_type | The source type of display name that the email belongs to (projection) |
integer | address_book_id | Addressbook ID that the email belongs to |
integer | person_id | Person ID that the email belongs to |
string | ringtone_path | Ringtone path that the email belongs to (projection) |
string | image_thumbnail_path | Image thumbnail path that the email belongs to (projection) |
integer | email_id | DB record ID of the email |
integer | type | Email type, refer to the contacts_email_type_e (projection) |
string | label | Custom mail type label, when the email type is CONTACTS_EMAIL_TYPE_CUSTOM (projection) |
boolean | is_default | Email is default email or not |
string | email | Email address |
_contacts_contact_grouprel view (read only)
Type | Property ID | Description |
string | _uri | Identifier of this contact grouprel view |
integer | contact_id | Contact ID that the contact group relation belongs to |
string | display_name | Display name of the group relation |
integer | display_source_type | The source type of display name (projection) |
integer | address_book_id | Addressbook ID that the group relation belongs to |
integer | person_id | Person ID that the group relation belongs to |
string | ringtone_path | Ringtone path of the group relation (projection) |
string | image_thumbnail_path | Image thumbnail path of the group relation (projection) |
integer | group_id | DB record ID of the group relation |
string | group_name | Group name (projection) |
_contacts_contact_activity view (read only)
Type | Property ID | Description |
string | _uri | Identifier of this contact activity view |
integer | contact_id | Contact ID that the activity belongs to |
string | display_name | Display name of the contact that the activity belongs to |
integer | display_source_type | The source type of display name that the activity belongs to |
integer | address_book_id | Addressbook that the activity belongs to |
integer | person_id | Person ID that the activity belongs to |
string | ringtone_path | Ringtone path of the contact that the activity belongs to (projection) |
string | image_thumbnail_path | Image thumbnail path of the contact that the activity belongs to (projection) |
integer | activity_id | DB record ID of the activity |
string | source_name | Account name that the activity belongs to |
string | status | Activity status (projection) |
integer | timestamp | Published time of activity |
string | service_operation | Data for service_set_operation |
string | uri | Data for service_set_uri |
_contacts_phone_log_stat view (read only)
Type | Property ID | Description |
string | _uri | Identifier of this log stat view |
integer | log_count | Log count (projection) |
integer | log_type | Log type, see the contacts_phone_log_type_e |
integer | sim_slot_no | It is related to the SIM slot number. sim_slot_no 0 means first SIM card, sim_slot_no 1 means second SIM. It is same with handle index of telephony handle list. Refer to the telephony_init() (Since 3.0) |
_contacts_sip view (Since 3.0)
Type | Property ID | Read, Write | Description |
string | _uri | read only | Identifier of this contacts sip view |
integer | id | read only | DB record ID of the sip |
integer | contact_id | read, write once | Contact ID that the sip belongs to |
string | address | read, write | SIP address |
integer | type | read, write | sip type, refer to the contacts_sip_type_e |
string | label | read, write | Custom sip type label, when the sip type is CONTACTS_SIP_TYPE_CUSTOM |