@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 '@ohos.telephony.vcard';

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

Error codes

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

Example

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

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

Error codes

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

Example

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>

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

Return value

Error codes

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

Example

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

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

Error codes

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

Example

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

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

Error codes

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

Example

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>

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

Return value

Error codes

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

Example

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

Defines the VCard information.

System API: This is a system API.

System capability: SystemCapability.Telephony.CoreService

VCardType¹¹⁺

Enumerates VCard versions.

System API: This is a system API.

System capability: SystemCapability.Telephony.CoreService