applications_contactsdata/README_zh.md

联系人数据库子系统

applications_contactsdata

• 简介
• 架构图
• 目录
• 相关仓

简介

联系人数据库应用是每一个用户管理联系人数据库的不可缺少的一个信息管理应用， 它的内容对于用户管理者来说是至关重要的，所以联系人数据库应该能够为每一个 用户的管理提供充足的信息和快捷查询手段，大大方便用户合理的管理联系人数据库信息。

架构图

目录

/foundation/contactsdataability/
├── ability
│   ├── account                        #账户管理
│   ├── common                         #公共方法:log,utils等
│   ├── datadisasterrecovery           #数据损坏恢复
│   ├── merge                          #联系人合并
│   └── sinicization                   #汉字转拼音相关
├── contacts                            #NAPI
├── dataBusiness
│   ├── calllog                        #通话记录
│   ├── contacts                       #联系人
│   ├── quicksearch                    #快速检索
│   └── voicemail                      #语音信箱
├── test                               #测试目录
├── BUILD.gn
└── ohos.build

使用说明

概述

提供联系人数据和通话记录以及语音信箱增、删、改、查、等接口。 接口参数主要有string类型的uri和对象类型的value、DataSharePredicates

使用功能接口前，需要导入相关模块。

import dataShare from '@ohos.data.dataShare';

通话记录

dataShareHelper.insert(uri: string, value: ValuesBucket)

• 接口说明

  通话记录插入

• insert参数描述

  名称	读写属性	类型	必填	描述
  uri	只读	string	是	具体操作的uri
  value	只读	ValuesBucket	是	数据库字段key-value对象

返回值为 通话记录id

更新示例

import dataShare from '@ohos.data.dataShare';
var calllogData = "datashare:///com.ohos.calllogability";
var calllogUri = "datashare:///com.ohos.calllogability/calls/calllog";
var value = {"phone_number" : "xxxxx","display_name" : "xxx"};
// 获取dataShareHelper
let dataShareHelper = dataShare.createDataShareHelper(calllogData);
// 调用insert方法
dataShareHelper.insert(calllogUri, value).then((data) => {
	console.info("calllogId = " + data);
});

dataShareHelper.update(uri: string, condition: DataSharePredicates, value: ValuesBucket)

• 接口说明

  通话记录修改

• update参数描述

  名称	读写属性	类型	必填	描述
  uri	只读	string	是	具体操作的uri
  condition	只读	DataSharePredicates	是	更新条件
  value	只读	ValuesBucket	是	数据库字段key-value对象

返回值为 成功为0否则为-1

修改示例

import dataShare from '@ohos.data.dataShare';
var calllogData = "datashare:///com.ohos.calllogability";
var calllogUri = "datashare:///com.ohos.calllogability/calls/calllog";
var value = {"phone_number" : "xxxxx","display_name" : "xxx"};
// 获取dataShareHelper
let dataShareHelper = dataShare.createDataShareHelper(calllogData);
// 条件参数
let condition = new dataShare.DataSharePredicates();
condition.equalTo("id", "xxx");
// 调用update方法
dataShareHelper.update(calllogUri, value, condition).then((data) => {
	console.info("resultCode = " + data);
});

dataShareHelper.delete(uri: string, condition: DataSharePredicates)

• 接口说明

  通话记录删除

• delete参数描述

  名称	读写属性	类型	必填	描述
  uri	只读	string	是	具体操作的uri
  condition	只读	DataSharePredicates	是	删除条件

返回值为 成功为0否则为-1

删除示例

import dataShare from '@ohos.data.dataShare';
var calllogData = "datashare:///com.ohos.calllogability";
var calllogUri = "datashare:///com.ohos.calllogability/calls/calllog";
// 获取dataShareHelper
let dataShareHelper = dataShare.createDataShareHelper(calllogData);
// 条件参数
let condition = new dataShare.DataSharePredicates();
condition.equalTo("id", "xxx");
// 调用delete方法
dataShareHelper.delete(calllogUri, condition).then((data) => {
	console.info("deleteCode = " + data);
});

dataShareHelper.query(uri: string, condition: DataSharePredicates, resultColumns: array)

• 接口说明

  通话记录查询

• 查询参数描述

  名称	读写属性	类型	必填	描述
  uri	只读	string	是	具体操作的uri
  condition	只读	DataSharePredicates	是	查询条件
  resultColumns	只读	array	是	需要查询的列字段名称

返回值为 ResultSet 查询结果集

查询示例

import dataShare from '@ohos.data.dataShare';
var calllogData = "datashare:///com.ohos.calllogability";
var calllogUri = "datashare:///com.ohos.calllogability/calls/calllog";
// 获取dataShareHelper
let dataShareHelper = dataShare.createDataShareHelper(calllogData);
// 条件参数
let condition = new dataShare.DataSharePredicates();
condition.equalTo("id", "xxx");
var resultColumns = [ "id", "display_name", "phone_number"];
// 调用query方法
dataShareHelper.query(calllogUri, resultColumns, condition).then((resultSet) => {
    if (resultSet.goToFirstRow()) {
        do {
            var displayName = resultSet.getString(resultSet.getColumnIndex("display_name"));
            var id = resultSet.getLong(resultSet.getColumnIndex("id"));
            var phoneNumber = resultSet.getString(resultSet.getColumnIndex("phone_number"));
        } while (resultSet.goToNextRow());
    }
    resultSet.close();	
});

返回值为 ResultSet 查询结果集

语音信箱

dataShareHelper.insert(uri: string, value: ValuesBucket)

• 接口说明

  语音信箱插入

• insert参数描述

  名称	读写属性	类型	必填	描述
  uri	只读	string	是	具体操作的uri
  value	只读	ValuesBucket	是	数据库字段key-value对象

返回值为 语音信箱表id

更新示例

import dataShare from '@ohos.data.dataShare';
var voicemailData = "datashare:///com.ohos.voicemailability";
var voicemailUri = "datashare:///com.ohos.voicemailability/calls/voicemail";
var value = {"phone_number" : "xxxxx","display_name" : "xxx"};
// 获取dataShareHelper
let dataShareHelper = dataShare.createDataShareHelper(voicemailData);
// 调用insert方法
dataShareHelper.insert(voicemailUri, value).then((data) => {
	console.info("calllogId = " + data);
});

dataShareHelper.update(uri: string, condition:DataSharePredicates, value: ValuesBucket)

• 接口说明

  语音信箱修改

• update参数描述

  名称	读写属性	类型	必填	描述
  uri	只读	string	是	具体操作的uri
  condition	只读	DataSharePredicates	是	更新条件
  value	只读	ValuesBucket	是	数据库字段key-value对象

返回值为 成功为0否则为-1

修改示例

import dataShare from '@ohos.data.dataShare';
var voicemailData = "datashare:///com.ohos.voicemailability";
var voicemailUri = "datashare:///com.ohos.voicemailability/calls/voicemail";
var value = {"phone_number" : "xxxxx","display_name" : "xxx"};
// 获取dataShareHelper
let dataShareHelper = dataShare.createDataShareHelper(voicemailData);
// 条件参数
let condition = new dataShare.DataSharePredicates();
condition.equalTo("id", "xxx");
// 调用update方法
dataShareHelper.update(voicemailUri, value, condition).then((data) => {
	console.info("resultCode = " + data);
});

dataShareHelper.delete(uri: string, condition: DataSharePredicates)

• 接口说明

  语音信箱删除

• delete参数描述

  名称	读写属性	类型	必填	描述
  uri	只读	string	是	具体操作的uri
  condition	只读	DataSharePredicates	是	删除条件

返回值为 成功为0否则为-1

删除示例

import dataShare from '@ohos.data.dataShare';
var voicemailData = "datashare:///com.ohos.voicemailability";
var voicemailUri = "datashare:///com.ohos.voicemailability/calls/voicemail";
// 获取dataShareHelper
let dataShareHelper = dataShare.createDataShareHelper(voicemailData);
// 条件参数
let condition = new dataShare.DataSharePredicates();
condition.equalTo("id", "xxx");
// 调用delete方法
dataShareHelper.delete(voicemailUri, condition).then((data) => {
	console.info("deleteCode = " + data);
});

dataShareHelper.query(uri: string, condition: DataSharePredicates, resultColumns:array)

• 接口说明

  语音信箱查询

• 查询参数描述

  名称	读写属性	类型	必填	描述
  uri	只读	string	是	具体操作的uri
  condition	只读	DataSharePredicates	是	查询条件
  resultColumns	只读	array	是	需要查询的列字段名称

返回值为 ResultSet 查询结果集

查询示例

import dataShare from '@ohos.data.dataShare';
var voicemailData = "datashare:///com.ohos.voicemailability";
var voicemailUri = "datashare:///com.ohos.voicemailability/calls/voicemail";
// 获取dataShareHelper
let dataShareHelper = dataShare.createDataShareHelper(voicemailData);
// 条件参数
let condition = new dataShare.DataSharePredicates();
condition.equalTo("id", "xxx");
var resultColumns = [ "id", "display_name", "phone_number"];
// 调用query方法
dataShareHelper.query(voicemailUri, resultColumns, condition).then((resultSet) => {
    if (resultSet.goToFirstRow()) {
        do {
            var displayName = resultSet.getString(resultSet.getColumnIndex("display_name"));
            var id = resultSet.getLong(resultSet.getColumnIndex("id"));
            var phoneNumber = resultSet.getString(resultSet.getColumnIndex("phone_number"));
        } while (resultSet.goToNextRow());
    }
    resultSet.close();	
});

联系人

dataShareHelper.insert(uri: string, value: ValuesBucket)

• 接口说明

  联系人插入

• insert参数描述

  名称	读写属性	类型	必填	描述
  uri	只读	string	是	具体操作的uri
  value	只读	ValuesBucket	是	数据库字段key-value对象

返回值为 联系人数据表id

更新示例

import dataShare from '@ohos.data.dataShare';
var contactsData = "datashare:///com.ohos.contactsdataability";
var rawContactUri = "datashare:///com.ohos.contactsdataability/contacts/raw_contact";
var contactDataUri = "datashare:///com.ohos.contactsdataability/contacts/contact_data";
var value = {"display_name" : "xxx"};
// 获取dataShareHelper
let dataShareHelper = dataShare.createDataShareHelper(contactsData);
// 调用insert方法
dataShareHelper.insert(rawContactUri, value).then((rawContactId) => {
	console.info("rawContactId = " + rawContactId);
    // 联系人详细信息插入
    var contactDataValues = {
        "raw_contact_id" : rawContactId,
        "content_type" : "name",
        "detail_info" : "xxxxxxx"
    };
   dataShareHelper.insert(contactDataUri, contactDataValues).then((contactDataId) => {
      console.info("rawContactId = " + contactDataId);
   };
});

dataShareHelper.update(uri: string, condition: DataSharePredicates, value: ValuesBucket)

• 接口说明

  联系人修改

• update参数描述

  名称	读写属性	类型	必填	描述
  uri	只读	string	是	具体操作的uri
  condition	只读	DataSharePredicates	是	更新条件
  value	只读	ValuesBucket	是	数据库字段key-value对象

返回值为 成功为0否则为-1

修改示例

import dataShare from '@ohos.data.dataShare';
var contactsData = "datashare:///com.ohos.contactsdataability";
var rawContactUri = "datashare:///com.ohos.contactsdataability/contacts/raw_contact";
var contactDataUri = "datashare:///com.ohos.contactsdataability/contacts/contact_data";
var value = {"display_name" : "xxx"};
// 获取dataShareHelper
let dataShareHelper = dataShare.createDataShareHelper(contactsData);
// 条件参数
let condition = new dataShare.DataSharePredicates();
condition.equalTo("id", "xxx");
// 调用update方法
dataShareHelper.update(rawContactUri, value, condition).then((data) => {
	console.info("resultCode = " + data);
});

dataShareHelper.delete(uri: string, condition: DataSharePredicates)

• 接口说明

  联系人删除

• delete参数描述

  名称	读写属性	类型	必填	描述
  uri	只读	string	是	具体操作的uri
  condition	只读	DataSharePredicates	是	删除条件

返回值为 成功为0否则为-1

删除示例

import dataShare from '@ohos.data.dataShare';
var contactsData = "datashare:///com.ohos.contactsdataability";
var rawContactUri = "datashare:///com.ohos.contactsdataability/contacts/raw_contact";
var contactDataUri = "datashare:///com.ohos.contactsdataability/contacts/contact_data";
// 获取dataShareHelper
let dataShareHelper = dataShare.createDataShareHelper(contactsData);
// 条件参数
let condition = new dataShare.DataSharePredicates();
condition.equalTo("id", "xxx");
// 调用delete方法
dataShareHelper.delete(contactDataUri, condition).then((data) => {
	console.info("deleteCode = " + data);
});

dataShareHelper.query(uri: string, condition: DataSharePredicates, resultColumns: array)

• 接口说明

  联系人查询

• 查询参数描述

  名称	读写属性	类型	必填	描述
  uri	只读	string	是	具体操作的uri
  condition	只读	DataSharePredicates	是	查询条件
  resultColumns	只读	array	是	需要查询的列字段名称

返回值为 ResultSet 查询结果集

查询示例

import dataShare from '@ohos.data.dataShare';
var contactsData = "datashare:///com.ohos.contactsdataability";
var rawContactUri = "datashare:///com.ohos.contactsdataability/contacts/raw_contact";
// 获取dataShareHelper
let dataShareHelper = dataShare.createDataShareHelper(contactsData);
// 条件参数
let condition = new dataShare.DataSharePredicates();
condition.equalTo("id", "xxx");
var resultColumns = [ "id", "display_name"];
// 调用query方法
dataShareHelper.query(rawContactUri, resultColumns, condition).then((resultSet) => {
    if (resultSet.goToFirstRow()) {
        do {
            var displayName = resultSet.getString(resultSet.getColumnIndex("display_name"));
        } while (resultSet.goToNextRow());
    }
    resultSet.close();	
});

系统公共uri
datashare:///com.ohos.contactsdataability
datashare:///com.ohos.contactsdataability/contacts/contact
datashare:///com.ohos.contactsdataability/contacts/raw_contact
datashare:///com.ohos.contactsdataability/contacts/contact_data
datashare:///com.ohos.contactsdataability/contacts/raw_contact/query_merge_list
datashare:///com.ohos.contactsdataability/contacts/raw_contact/split_contact
datashare:///com.ohos.contactsdataability/contacts/raw_contact/manual_merge
datashare:///com.ohos.contactsdataability/contacts/raw_contact/auto_merge
datashare:///com.ohos.contactsdataability/contacts/contact_type
datashare:///com.ohos.contactsdataability/contacts/groups
datashare:///com.ohos.contactsdataability/contacts/photo_files
datashare:///com.ohos.contactsdataability/contacts/contact_blocklist
datashare:///com.ohos.contactsdataability/contacts/deleted_raw_contact
datashare:///com.ohos.contactsdataability/contacts/search_contact
datashare:///com.ohos.contactsdataability/contacts/deleted_raw_contact
datashare:///com.ohos.contactsdataability/contacts/deleted_raw_contact_record
datashare:///com.ohos.contactsdataability/contacts/backup
datashare:///com.ohos.contactsdataability/contacts/recover
datashare:///com.ohos.contactsdataability/profile/contact
datashare:///com.ohos.contactsdataability/profile/raw_contact
datashare:///com.ohos.contactsdataability/profile/contact_data
datashare:///com.ohos.contactsdataability/profile/raw_contact/query_merge_list
datashare:///com.ohos.contactsdataability/profile/raw_contact/split_contact
datashare:///com.ohos.contactsdataability/profile/raw_contact/manual_merge
datashare:///com.ohos.contactsdataability/profile/raw_contact/auto_merge
datashare:///com.ohos.contactsdataability/profile/contact_type
datashare:///com.ohos.contactsdataability/profile/groups
datashare:///com.ohos.contactsdataability/profile/photo_files
datashare:///com.ohos.contactsdataability/profile/contact_blocklist
datashare:///com.ohos.contactsdataability/profile/deleted_raw_contact
datashare:///com.ohos.contactsdataability/profile/search_contact
datashare:///com.ohos.contactsdataability/profile/deleted_raw_contact
datashare:///com.ohos.contactsdataability/profile/deleted_raw_contact_record
datashare:///com.ohos.contactsdataability/profile/backup
datashare:///com.ohos.contactsdataability/profile/recover
datashare:///com.ohos.calllogability
datashare:///com.ohos.calllogability/calls/calllog
datashare:///com.ohos.voicemailability
datashare:///com.ohos.voicemailability/calls/voicemail

相关仓

系统应用

applications_contactsdata