@ohos.telephony.vcard (VCard模块)（系统接口）

VCard是电子名片的文件格式标准,它可包含的信息有：姓名、地址资讯、电话号码、URL，logo，相片等。VCard模块提供了VCard能力，包括将VCard文件导入联系人数据库和将联系人数据导出为VCard文件等。

说明：

本模块首批接口从API version 11开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
本模块为系统接口。

导入模块

import vcard from '@ohos.telephony.vcard';

vcard.importVCard¹¹⁺

importVCard(context: Context, filePath: string, callback: AsyncCallback<void>): void

将VCard文件导入联系人数据库。使用callback异步回调。

需要权限：ohos.permission.WRITE_CONTACTS 和 ohos.permission.READ_CONTACTS

系统接口： 此接口为系统接口。

系统能力：SystemCapability.Telephony.CoreService

参数：

错误码：

以下错误码的详细介绍请参见ohos.telephony(电话子系统)错误码。

示例：

import window from '@ohos.window';
import UIAbility from '@ohos.app.ability.UIAbility';
import { BusinessError } from '@ohos.base';
import vcard from '@ohos.telephony.vcard';

class EntryAbility extends UIAbility {
    onWindowStageCreate(windowStage: window.WindowStage) {
        let filePath: string = "/data/storage/vcf/contacts.vcf";
        vcard.importVCard(this.context, filePath, (err: BusinessError) => {
            console.log(`callback: err->${JSON.stringify(err)}`);
        });
    }
}

vcard.importVCard¹¹⁺

importVCard(context: Context,filePath: string, accountId: number, callback: AsyncCallback<void>): void

将VCard文件导入联系人数据库。使用callback异步回调。

需要权限：ohos.permission.WRITE_CONTACTS 和 ohos.permission.READ_CONTACTS

系统接口： 此接口为系统接口。

系统能力：SystemCapability.Telephony.CoreService

参数：

错误码：

以下错误码的详细介绍请参见ohos.telephony(电话子系统)错误码。

示例：

import window from '@ohos.window';
import UIAbility from '@ohos.app.ability.UIAbility';
import { BusinessError } from '@ohos.base';
import vcard from '@ohos.telephony.vcard';

class EntryAbility extends UIAbility {
    onWindowStageCreate(windowStage: window.WindowStage) {
        let filePath: string = "/data/storage/vcf/contacts.vcf";
        let accountId: number = 0;
        vcard.importVCard(this.context, filePath, accountId, (err: BusinessError) => {
            console.log(`callback: err->${JSON.stringify(err)}`);
        });
    }
}

vcard.importVCard¹¹⁺

importVCard(context: Context, filePath: string, accountId?: number): Promise<void>

将VCard文件导入联系人数据库。使用Promise异步回调。

需要权限：ohos.permission.WRITE_CONTACTS 和 ohos.permission.READ_CONTACTS

系统接口： 此接口为系统接口。

系统能力：SystemCapability.Telephony.CoreService

参数：

返回值：

错误码：

以下错误码的详细介绍请参见ohos.telephony(电话子系统)错误码。

示例：

import window from '@ohos.window';
import UIAbility from '@ohos.app.ability.UIAbility';
import { BusinessError } from '@ohos.base';
import vcard from '@ohos.telephony.vcard';

class EntryAbility extends UIAbility {
    onWindowStageCreate(windowStage: window.WindowStage) {
        let filePath: string = "/data/storage/vcf/contacts.vcf";
        let accountId: number = 0;
        vcard.importVCard(this.context, filePath, accountId).then(() => {
            console.log(`importVCard success.`);
        }).catch((err: BusinessError) => {
            console.log(`importVCard failed, promise: err->${JSON.stringify(err)}`);
        });
    }
}

vcard.exportVCard¹¹⁺

exportVCard(context: Context, predicates: dataSharePredicates.DataSharePredicates, callback: AsyncCallback<string>): void

将联系人导出为vcf文件。使用callback异步回调。

需要权限：ohos.permission.WRITE_CONTACTS 和 ohos.permission.READ_CONTACTS

系统接口： 此接口为系统接口。

系统能力：SystemCapability.Telephony.CoreService

参数：

错误码：

以下错误码的详细介绍请参见ohos.telephony(电话子系统)错误码。

示例：

import window from '@ohos.window';
import UIAbility from '@ohos.app.ability.UIAbility';
import { BusinessError } from '@ohos.base';
import vcard from '@ohos.telephony.vcard';
import dataSharePredicates from '@ohos.data.dataSharePredicates';

class EntryAbility extends UIAbility {
    onWindowStageCreate(windowStage: window.WindowStage) {
        let predicates = new dataSharePredicates.DataSharePredicates();
        predicates.equalTo("NAME", "Rose");

        vcard.exportVCard(this.context, predicates, (err: BusinessError, data: string) => {
            console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
        });
    }
}

vcard.exportVCard¹¹⁺

exportVCard(context: Context, predicates: dataSharePredicates.DataSharePredicates, options: VCardBuilderOptions, callback: AsyncCallback<string>): void

将联系人导出为vcf文件。使用callback异步回调。

需要权限：ohos.permission.WRITE_CONTACTS 和 ohos.permission.READ_CONTACTS

系统接口： 此接口为系统接口。

系统能力：SystemCapability.Telephony.CoreService

参数：

错误码：

以下错误码的详细介绍请参见ohos.telephony(电话子系统)错误码。

示例：

import window from '@ohos.window';
import UIAbility from '@ohos.app.ability.UIAbility';
import { BusinessError } from '@ohos.base';
import vcard from '@ohos.telephony.vcard';
import dataSharePredicates from '@ohos.data.dataSharePredicates';

class EntryAbility extends UIAbility {
    onWindowStageCreate(windowStage: window.WindowStage) {
        let predicates = new dataSharePredicates.DataSharePredicates();
        predicates.equalTo("NAME", "Rose");
        let options: vcard.VCardBuilderOptions = {
            cardType: vcard.VCardType.VERSION_21,
            charset: "UTF-8"
        };
        vcard.exportVCard(this.context, predicates, options, (err: BusinessError, data: string) => {
            console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
        });
    }
}

vcard.exportVCard¹¹⁺

exportVCard(context: Context, predicates: dataSharePredicates.DataSharePredicates, options?: VCardBuilderOptions): Promise<string>

将联系人导出为vcf文件。使用Promise异步回调。

需要权限：ohos.permission.WRITE_CONTACTS 和 ohos.permission.READ_CONTACTS

系统接口： 此接口为系统接口。

系统能力：SystemCapability.Telephony.CoreService

参数：

返回值：

错误码：

以下错误码的详细介绍请参见ohos.telephony(电话子系统)错误码。

示例：

import window from '@ohos.window';
import UIAbility from '@ohos.app.ability.UIAbility';
import { BusinessError } from '@ohos.base';
import vcard from '@ohos.telephony.vcard';
import dataSharePredicates from '@ohos.data.dataSharePredicates';

class EntryAbility extends UIAbility {
    onWindowStageCreate(windowStage: window.WindowStage) {
        let predicates = new dataSharePredicates.DataSharePredicates();
        predicates.equalTo("NAME", "Rose");
        let options: vcard.VCardBuilderOptions = {
            cardType: vcard.VCardType.VERSION_21,
            charset: "UTF-8"
        };
        vcard.exportVCard(this.context, predicates, options).then(() => {
            console.log(`exportVCard success.`);
        }).catch((err: BusinessError) => {
            console.log(`exportVCard failed, promise: err->${JSON.stringify(err)}`);
        });
    }
}

VCardBuilderOptions¹¹⁺

VCard版本和编码信息。

系统接口： 此接口为系统接口。

系统能力：SystemCapability.Telephony.CoreService

VCardType¹¹⁺

VCard版本类型。

系统接口： 此接口为系统接口。

系统能力：SystemCapability.Telephony.CoreService