@ohos.telephony.vcard (VCard) (System API)

VCard is a file format standard for electronic business cards. It contains information such as names, addresses, phone numbers, URLs, logos, and photos. The VCard module provides the VCard management functions, including importing VCard files to the contact database and exporting contact data to VCard files.

NOTE

The initial APIs of this module are supported since API version 11. Newly added APIs will be marked with a superscript to indicate their earliest API version.
The APIs provided by this module are system APIs.

Modules to Import

import { vcard } from '@kit.TelephonyKit';

vcard.importVCard¹¹⁺

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

Imports a VCard file (that is, .vcf file) to the contact database. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.WRITE_CONTACTS and ohos.permission.READ_CONTACTS

System API: This is a system API.

System capability: SystemCapability.Telephony.CoreService

Parameters

Name	Type	Mandatory	Description
context	Context	Yes	Application context.
filePath	string	Yes	Address of the .vcf file.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see ohos.telephony (Telephony) Error Codes.

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
8300001	Invalid parameter value.
8300003	System internal error.
8300999	Unknown error.

Example

import { window } from '@kit.ArkUI';
import { UIAbility } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { vcard } from '@kit.TelephonyKit';

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

Imports a VCard file (that is, .vcf file) to the contact database. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.WRITE_CONTACTS and ohos.permission.READ_CONTACTS

System API: This is a system API.

System capability: SystemCapability.Telephony.CoreService

Parameters

Name	Type	Mandatory	Description
context	Context	Yes	Application context.
filePath	string	Yes	Address of the .vcf file.
accountId	number	Yes	Contact account ID.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see ohos.telephony (Telephony) Error Codes.

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
8300001	Invalid parameter value.
8300003	System internal error.
8300999	Unknown error.

Example

import { window } from '@kit.ArkUI';
import { UIAbility } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { vcard } from '@kit.TelephonyKit';

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>

Imports a VCard file (that is, .vcf file) to the contact database. This API uses a promise to return the result.

Required permissions: ohos.permission.WRITE_CONTACTS and ohos.permission.READ_CONTACTS

System API: This is a system API.

System capability: SystemCapability.Telephony.CoreService

Parameters

Name	Type	Mandatory	Description
context	Context	Yes	Application context.
filePath	string	Yes	Address of the .vcf file.
accountId	number	No	Contact account ID.

Return value

Type	Description
Promise<void>	Promise used to return the result.

Error codes

For details about the error codes, see ohos.telephony (Telephony) Error Codes.

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
8300001	Invalid parameter value.
8300003	System internal error.
8300999	Unknown error.

Example

import { window } from '@kit.ArkUI';
import { UIAbility } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { vcard } from '@kit.TelephonyKit';

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

Exports contacts to a .vcf file. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.WRITE_CONTACTS and ohos.permission.READ_CONTACTS

System API: This is a system API.

System capability: SystemCapability.Telephony.CoreService

Parameters

Name	Type	Mandatory	Description
context	Context	Yes	Application context.
predicates	dataSharePredicates.DataSharePredicates	Yes	Query statement.
callback	AsyncCallback<string>	Yes	Callback used to return the result, which is the address of the .vcf file.

Error codes

For details about the error codes, see ohos.telephony (Telephony) Error Codes.

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
8300001	Invalid parameter value.
8300003	System internal error.
8300999	Unknown error.

Example

import { window } from '@kit.ArkUI';
import { UIAbility } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { vcard } from '@kit.TelephonyKit';
import { dataSharePredicates } from '@kit.ArkData';

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

Exports contacts to a .vcf file. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.WRITE_CONTACTS and ohos.permission.READ_CONTACTS

System API: This is a system API.

System capability: SystemCapability.Telephony.CoreService

Parameters

Name	Type	Mandatory	Description
context	Context	Yes	Application context.
predicates	dataSharePredicates.DataSharePredicates	Yes	Query statement.
options	VCardBuilderOptions	Yes	VCard version and encoding type.
callback	AsyncCallback<string>	Yes	Callback used to return the result, which is the address of the .vcf file.

Error codes

For details about the error codes, see ohos.telephony (Telephony) Error Codes.

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
8300001	Invalid parameter value.
8300003	System internal error.
8300999	Unknown error.

Example

import { window } from '@kit.ArkUI';
import { UIAbility } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { vcard } from '@kit.TelephonyKit';
import { dataSharePredicates } from '@kit.ArkData';

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>

Exports contacts to a .vcf file. This API uses a promise to return the result.

Required permissions: ohos.permission.WRITE_CONTACTS and ohos.permission.READ_CONTACTS

System API: This is a system API.

System capability: SystemCapability.Telephony.CoreService

Parameters

Name	Type	Mandatory	Description
context	Context	Yes	Application context.
predicates	dataSharePredicates.DataSharePredicates	Yes	Query statement.
options	VCardBuilderOptions	No	VCard version and encoding type.

Return value

Type	Description
Promise<string>	Promise used to return the result, which is the address of the .vcf file.

Error codes

For details about the error codes, see ohos.telephony (Telephony) Error Codes.

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
8300001	Invalid parameter value.
8300003	System internal error.
8300999	Unknown error.

Example

import { window } from '@kit.ArkUI';
import { UIAbility } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { vcard } from '@kit.TelephonyKit';
import { dataSharePredicates } from '@kit.ArkData';

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¹¹⁺

Defines the VCard information.

System API: This is a system API.

System capability: SystemCapability.Telephony.CoreService

Name	Type	Mandatory	Description
cardType	VCardType	No	VCard version. The default value is VERSION_21.
charset	string	No	VCard encoding type. The default value is UTF-8.

VCardType¹¹⁺

Enumerates VCard versions.

System API: This is a system API.

System capability: SystemCapability.Telephony.CoreService

Name	Value	Description
VERSION_21	0	VCard 2.1.
VERSION_30	1	VCard 3.0.
VERSION_40	2	VCard 4.0.

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Telephony Kit

harmony 鸿蒙Telephony_NetworkState

harmony 鸿蒙Telephony Error Codes

harmony 鸿蒙js-apis-call-sys

harmony 鸿蒙@ohos.telephony.call (Call)

harmony 鸿蒙@ohos.telephony.esim (eSIM Management) (System API)

harmony 鸿蒙@ohos.telephony.esim (eSIM Management)

harmony 鸿蒙@ohos.telephony.observer (Observer) (System API)

harmony 鸿蒙@ohos.telephony.observer (Observer)

harmony 鸿蒙@ohos.telephony.radio (Radio) (System API)

openharmony 鸿蒙 js-apis-vcard-sys

@ohos.telephony.vcard (VCard) (System API)

Modules to Import

vcard.importVCard¹¹⁺

vcard.importVCard¹¹⁺

vcard.importVCard¹¹⁺

vcard.exportVCard¹¹⁺

vcard.exportVCard¹¹⁺

vcard.exportVCard¹¹⁺

VCardBuilderOptions¹¹⁺

VCardType¹¹⁺

你可能感兴趣的鸿蒙文章

标签云

最热博客

最新博客

@ohos.telephony.vcard (VCard) (System API)

Modules to Import

vcard.importVCard11+

vcard.importVCard11+

vcard.importVCard11+

vcard.exportVCard11+

vcard.exportVCard11+

vcard.exportVCard11+

VCardBuilderOptions11+

VCardType11+

你可能感兴趣的鸿蒙文章

标签云

最热博客

最新博客

vcard.importVCard¹¹⁺

vcard.importVCard¹¹⁺

vcard.importVCard¹¹⁺

vcard.exportVCard¹¹⁺

vcard.exportVCard¹¹⁺

vcard.exportVCard¹¹⁺

VCardBuilderOptions¹¹⁺

VCardType¹¹⁺