FormHost


FormHost

icon-note.gif 说明: 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

卡片使用方相关接口。

导入模块

import formHost from '@ohos.application.formHost';
1

权限

ohos.permission.REQUIRE_FORM

ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

deleteForm

deleteForm(formId: string, callback: AsyncCallback<void>): void;

删除指定的卡片。调用此方法后,应用程序将无法使用该卡片,卡片管理器服务不再保留有关该卡片的信息。

系统能力:

SystemCapability.Ability.Form

参数:

参数名 类型 必填 说明
formId string 卡片标识
callback AsyncCallback<void> callback形式返回结果

示例:

var formId = "12400633174999288";
formHost.deleteForm(formId, (error, data) => {
    if (error.code) {
        console.log('formHost deleteForm, error:' + JSON.stringify(error));
    }
});
1
2
3
4
5
6

deleteForm

deleteForm(formId: string): Promise<void>;

删除指定的卡片。调用此方法后,应用程序将无法使用该卡片,卡片管理器服务不再保留有关该卡片的信息。

系统能力:

SystemCapability.Ability.Form

参数:

参数名 类型 必填 说明
formId string 卡片标识

返回值:

类型 说明
Promise<void> 返回一个Promise,包含接口的结果

参数:

var formId = "12400633174999288";
formHost.deleteForm(formId).then(() => {
    console.log('formHost deleteForm success');
}).catch((error) => {
    console.log('formHost deleteForm, error:' + JSON.stringify(error));
});
1
2
3
4
5
6

releaseForm

releaseForm(formId: string, callback: AsyncCallback<void>): void;

释放指定的卡片。调用此方法后,应用程序将无法使用该卡片,但卡片管理器服务仍然保留有关该卡片的缓存信息和存储信息。

系统能力:

SystemCapability.Ability.Form

参数:

参数名 类型 必填 说明
formId string 卡片标识
callback AsyncCallback<void> callback形式返回结果

示例:

var formId = "12400633174999288";
formHost.releaseForm(formId, (error, data) => {
    if (error.code) {
        console.log('formHost releaseForm, error:' + JSON.stringify(error));
    }
});
1
2
3
4
5
6

releaseForm

releaseForm(formId: string, isReleaseCache: boolean, callback: AsyncCallback<void>): void;

释放指定的卡片。调用此方法后,应用程序将无法使用该卡片,卡片管理器服务保留有关该卡片的存储信息,可以选择是否保留缓存信息。

系统能力:

SystemCapability.Ability.Form

参数:

参数名 类型 必填 说明
formId string 卡片标识
isReleaseCache boolean 是否释放缓存
callback AsyncCallback<void> callback形式返回结果

示例:

var formId = "12400633174999288";
formHost.releaseForm(formId, true, (error, data) => {
    if (error.code) {
        console.log('formHost releaseForm, error:' + JSON.stringify(error));
    }
});
1
2
3
4
5
6

releaseForm

releaseForm(formId: string, isReleaseCache?: boolean): Promise<void>;

释放指定的卡片。调用此方法后,应用程序将无法使用该卡片,卡片管理器服务保留有关该卡片的存储信息,可以选择是否保留缓存信息。

系统能力:

SystemCapability.Ability.Form

参数:

参数名 类型 必填 说明
formId string 卡片标识
isReleaseCache boolean 是否释放缓存

返回值:

类型 说明
Promise<void> 返回一个Promise,包含接口的结果

示例:

var formId = "12400633174999288";
formHost.releaseForm(formId, true).then(() => {
    console.log('formHost releaseForm success');
}).catch((error) => {
    console.log('formHost releaseForm, error:' + JSON.stringify(error));
});
1
2
3
4
5
6

requestForm

requestForm(formId: string, callback: AsyncCallback<void>): void;

请求卡片更新。

系统能力:

SystemCapability.Ability.Form

参数:

参数名 类型 必填 说明
formId string 卡片标识
callback AsyncCallback<void> callback形式返回结果

示例:

var formId = "12400633174999288";
formHost.requestForm(formId, (error, data) => {
    if (error.code) {
        console.log('formHost requestForm, error:' + JSON.stringify(error));
    }
});
1
2
3
4
5
6

requestForm

requestForm(formId: string): Promise<void>;

请求卡片更新。

系统能力:

SystemCapability.Ability.Form

参数:

参数名 类型 必填 说明
formId string 卡片标识

返回值:

类型 说明
Promise<void> 返回一个Promise,包含接口的结果

示例:

var formId = "12400633174999288";
formHost.requestForm(formId).then(() => {
    console.log('formHost requestForm success');
}).catch((error) => {
    console.log('formHost requestForm, error:' + JSON.stringify(error));
});
1
2
3
4
5
6

castTempForm

castTempForm(formId: string, callback: AsyncCallback<void>): void;

将指定的临时卡片转换为普通卡片。

系统能力:

SystemCapability.Ability.Form

参数:

参数名 类型 必填 说明
formId string 卡片标识
callback AsyncCallback<void> callback形式返回结果

示例:

var formId = "12400633174999288";
formHost.castTempForm(formId, (error, data) => {
    if (error.code) {
        console.log('formHost castTempForm, error:' + JSON.stringify(error));
    }
});
1
2
3
4
5
6

castTempForm

castTempForm(formId: string): Promise<void>;

将指定的临时卡片转换为普通卡片。

系统能力:

SystemCapability.Ability.Form

参数:

参数名 类型 必填 说明
formId string 卡片标识

返回值:

类型 说明
Promise<void> 返回一个Promise,包含接口的结果

示例:

var formId = "12400633174999288";
formHost.castTempForm(formId).then(() => {
    console.log('formHost castTempForm success');
}).catch((error) => {
    console.log('formHost castTempForm, error:' + JSON.stringify(error));
});
1
2
3
4
5
6

notifyVisibleForms

notifyVisibleForms(formIds: Array<string>, callback: AsyncCallback<void>): void;

向卡片框架发送通知以使指定的卡片可见。该方法调用成功后,会调用onVisibilityChange通知卡片提供方。

系统能力:

SystemCapability.Ability.Form

参数:

参数名 类型 必填 说明
formIds Array<string> 卡片标识列表
callback AsyncCallback<void> callback形式返回结果

示例:

var formId = "12400633174999288";
formHost.notifyVisibleForms(formId, (error, data) => {
    if (error.code) {
        console.log('formHost notifyVisibleForms, error:' + JSON.stringify(error));
    }
});
1
2
3
4
5
6

notifyVisibleForms

notifyVisibleForms(formIds: Array<string>): Promise<void>;

向卡片框架发送通知以使指定的卡片可见。该方法调用成功后,会调用onVisibilityChange通知卡片提供方。

系统能力:

SystemCapability.Ability.Form

参数:

参数名 类型 必填 说明
formIds Array<string> 卡片标识列表

返回值:

类型 说明
Promise<void> 返回一个Promise,包含接口的结果

示例:

var formId = "12400633174999288";
formHost.notifyVisibleForms(formId).then(() => {
    console.log('formHost notifyVisibleForms success');
}).catch((error) => {
    console.log('formHost notifyVisibleForms, error:' + JSON.stringify(error));
});
1
2
3
4
5
6

notifyInvisibleForms

notifyInvisibleForms(formIds: Array<string>, callback: AsyncCallback<void>): void;

向卡片框架发送通知以使指定的卡片不可见。该方法调用成功后,会调用onVisibilityChange通知卡片提供方。

系统能力:

SystemCapability.Ability.Form

参数:

参数名 类型 必填 说明
formIds Array<string> 卡片标识列表
callback AsyncCallback<void> callback形式返回结果

示例:

var formId = "12400633174999288";
formHost.notifyInvisibleForms(formId, (error, data) => {
    if (error.code) {
        console.log('formHost notifyInvisibleForms, error:' + JSON.stringify(error));
    }
});
1
2
3
4
5
6

notifyInvisibleForms

notifyInvisibleForms(formIds: Array<string>): Promise<void>;

向卡片框架发送通知以使指定的卡片不可见。该方法调用成功后,会调用onVisibilityChange通知卡片提供方。

系统能力:

SystemCapability.Ability.Form

参数:

参数名 类型 必填 说明
formIds Array<string> 卡片标识列表

返回值:

类型 说明
Promise<void> 返回一个Promise,包含接口的结果

示例:

var formId = "12400633174999288";
formHost.notifyInvisibleForms(formId).then(() => {
    console.log('formHost notifyInvisibleForms success');
}).catch((error) => {
    console.log('formHost notifyInvisibleForms, error:' + JSON.stringify(error));
});
1
2
3
4
5
6

enableFormsUpdate

enableFormsUpdate(formIds: Array<string>, callback: AsyncCallback<void>): void;

向卡片框架发送通知以使指定的卡片可以更新。该方法调用成功后,卡片刷新状态设置为使能,卡片可以接收来自卡片提供方的更新。

系统能力:

SystemCapability.Ability.Form

参数:

参数名 类型 必填 说明
formIds Array<string> 卡片标识列表
callback AsyncCallback<void> callback形式返回结果

示例:

var formId = "12400633174999288";
formHost.enableFormsUpdate(formId, (error, data) => {
    if (error.code) {
        console.log('formHost enableFormsUpdate, error:' + JSON.stringify(error));
    }
});
1
2
3
4
5
6

enableFormsUpdate

enableFormsUpdate(formIds: Array<string>): Promise<void>;

向卡片框架发送通知以使指定的卡片可以更新。该方法调用成功后,卡片刷新状态设置为使能,卡片可以接收来自卡片提供方的更新。

系统能力:

SystemCapability.Ability.Form

参数:

参数名 类型 必填 说明
formIds Array<string> 卡片标识列表

返回值:

类型 说明
Promise<void> 返回一个Promise,包含接口的结果

示例:

var formId = "12400633174999288";
formHost.enableFormsUpdate(formId).then(() => {
    console.log('formHost enableFormsUpdate success');
}).catch((error) => {
    console.log('formHost enableFormsUpdate, error:' + JSON.stringify(error));
});
1
2
3
4
5
6

disableFormsUpdate

disableFormsUpdate(formIds: Array<string>, callback: AsyncCallback<void>): void;

向卡片框架发送通知以使指定的卡片不可以更新。该方法调用成功后,卡片刷新状态设置为去使能,卡片不可以接收来自卡片提供方的更新。

系统能力:

SystemCapability.Ability.Form

参数:

参数名 类型 必填 说明
formIds Array<string> 卡片标识列表
callback AsyncCallback<void> callback形式返回结果

示例:

var formId = "12400633174999288";
formHost.disableFormsUpdate(formId, (error, data) => {
    if (error.code) {
        console.log('formHost disableFormsUpdate, error:' + JSON.stringify(error));
    }
});
1
2
3
4
5
6

disableFormsUpdate

disableFormsUpdate(formIds: Array<string>): Promise<void>;

向卡片框架发送通知以使指定的卡片不可以更新。该方法调用成功后,卡片刷新状态设置为去使能,卡片不可以接收来自卡片提供方的更新。

系统能力:

SystemCapability.Ability.Form

参数:

参数名 类型 必填 说明
formIds Array<string> 卡片标识列表

返回值:

类型 说明
Promise<void> 返回一个Promise,包含接口的结果

示例:

var formId = "12400633174999288";
formHost.disableFormsUpdate(formId).then(() => {
    console.log('formHost disableFormsUpdate success');
}).catch((error) => {
    console.log('formHost disableFormsUpdate, error:' + JSON.stringify(error));
});
1
2
3
4
5
6

isSystemReady

isSystemReady(callback: AsyncCallback<void>): void;

检查系统是否准备好。

系统能力:

SystemCapability.Ability.Form

参数:

参数名 类型 必填 说明
callback AsyncCallback<void> callback形式返回结果

示例:

var formId = "12400633174999288";
formHost.isSystemReady((error, data) => {
    if (error.code) {
        console.log('formHost isSystemReady, error:' + JSON.stringify(error));
    }
});
1
2
3
4
5
6

isSystemReady

isSystemReady(): Promise<void>;

检查系统是否准备好。

系统能力:

SystemCapability.Ability.Form

返回值:

类型 说明
Promise<void> 返回一个Promise,包含接口的结果

示例:

var formId = "12400633174999288";
formHost.isSystemReady().then(() => {
    console.log('formHost isSystemReady success');
}).catch((error) => {
    console.log('formHost isSystemReady, error:' + JSON.stringify(error));
});
1
2
3
4
5
6

getAllFormsInfo

getAllFormsInfo(callback: AsyncCallback<Array<FormInfo>>): void;

获取设备上所有应用提供的卡片信息。

系统能力:

SystemCapability.Ability.Form

参数:

参数名 类型 必填 说明
callback AsyncCallback<Array<FormInfo>> callback形式返回查询到的卡片信息

示例:

formHost.getAllFormsInfo((error, data) => {
    if (error.code) {
        console.log('formHost getAllFormsInfo, error:' + JSON.stringify(error));
    } else {
        console.log('formHost getAllFormsInfo, data:' + JSON.stringify(data));
    }
});
1
2
3
4
5
6
7

getAllFormsInfo

getAllFormsInfo(): Promise<Array<FormInfo>>;

获取设备上所有应用提供的卡片信息。

系统能力:

SystemCapability.Ability.Form

返回值:

类型 说明
Promise<Array<FormInfo>> Promise实例,用于获取异步返回查询到的卡片信息

示例:

formHost.getAllFormsInfo().then((data) => {
    console.log('formHost getAllFormsInfo data:' + JSON.stringify(data));
}).catch((error) => {
    console.log('formHost getAllFormsInfo, error:' + JSON.stringify(error));
});
1
2
3
4
5

getFormsInfo

getFormsInfo(bundleName: string, callback: AsyncCallback<Array<FormInfo>>): void;

获取设备上指定应用程序提供的卡片信息。

系统能力:

SystemCapability.Ability.Form

参数:

参数名 类型 必填 说明
bundleName string 要查询的应用程序包名称
callback AsyncCallback<Array<FormInfo>> callback形式返回查询到的卡片信息

示例:

formHost.getFormsInfo("com.example.ohos.formjsdemo", (error, data) => {
    if (error.code) {
        console.log('formHost getFormsInfo, error:' + JSON.stringify(error));
    } else {
        console.log('formHost getFormsInfo, data:' + JSON.stringify(data));
    }
});
1
2
3
4
5
6
7

getFormsInfo

getFormsInfo(bundleName: string, moduleName: string, callback: AsyncCallback<Array<FormInfo>>): void;

获取设备上指定应用程序提供的卡片信息。

系统能力:

SystemCapability.Ability.Form

参数:

参数名 类型 必填 说明
bundleName string 要查询的应用程序包名称
moduleName string 要查询的模块名称
callback AsyncCallback<Array<FormInfo>> callback形式返回查询到的卡片信息

示例:

formHost.getFormsInfo("com.example.ohos.formjsdemo", "entry", (error, data) => {
    if (error.code) {
        console.log('formHost getFormsInfo, error:' + JSON.stringify(error));
    } else {
        console.log('formHost getFormsInfo, data:' + JSON.stringify(data));
    }
});
1
2
3
4
5
6
7

getFormsInfo

getFormsInfo(bundleName: string, moduleName?: string): Promise<Array<FormInfo>>;

获取设备上指定应用程序提供的卡片信息。

系统能力:

SystemCapability.Ability.Form

参数:

参数名 类型 必填 说明
bundleName string 要查询的应用程序包名称
moduleName string 要查询的模块名称

返回值:

类型 说明
Promise<Array<FormInfo>> Promise实例,用于获取异步返回查询到的卡片信息

示例:

formHost.getFormsInfo("com.example.ohos.formjsdemo", "entry").then((data) => {
    console.log('formHost getFormsInfo, data:' + JSON.stringify(data));
}).catch((error) => {
    console.log('formHost getFormsInfo, error:' + JSON.stringify(error));
});
1
2
3
4
5

deleteInvalidForms

deleteInvalidForms(formIds: Array<string>, callback: AsyncCallback<number>): void;

根据列表删除应用程序的无效卡片。

系统能力:

SystemCapability.Ability.Form

参数:

参数名 类型 必填 说明
formIds Array<string> 有效卡片标识列表
callback AsyncCallback<number> callback形式返回删除的卡片个数

示例:

var formIds = new Array("12400633174999288", "12400633174999289");
formHost.deleteInvalidForms(formIds, (error, data) => {
    if (error.code) {
        console.log('formHost deleteInvalidForms, error:' + JSON.stringify(error));
    } else {
        console.log('formHost deleteInvalidForms, data:' + JSON.stringify(data));
    }
});
1
2
3
4
5
6
7
8

deleteInvalidForms

function deleteInvalidForms(formIds: Array<string>): Promise<number>;

根据列表删除应用程序的无效卡片。

系统能力:

SystemCapability.Ability.Form

参数:

参数名 类型 必填 说明
formIds Array<string> 有效卡片标识列表

返回值:

类型 说明
Promise<number> Promise实例,用于获取异步返回删除的卡片个数

示例:

var formIds = new Array("12400633174999288", "12400633174999289");
formHost.deleteInvalidForms(formIds).then((data) => {
    console.log('formHost deleteInvalidForms, data:' + JSON.stringify(data));
}).catch((error) => {
    console.log('formHost deleteInvalidForms, error:' + JSON.stringify(error));
});
1
2
3
4
5
6

acquireFormState

acquireFormState(want: Want, callback: AsyncCallback<FormStateInfo>): void;

获取卡片状态

系统能力:

SystemCapability.Ability.Form

参数:

参数名 类型 必填 说明
want Want 查询卡片状态时携带的want信息
callback AsyncCallback<FormStateInfo> callback形式返回卡片状态

示例:

var want = {
	"deviceId": "",
	"bundleName": "com.extreme.test",
	"abilityName": "com.extreme.test.MainAbility"
};
formHost.acquireFormState(want, (error, data) => {
    if (error.code) {
        console.log('formHost acquireFormState, error:' + JSON.stringify(error));
    } else {
        console.log('formHost acquireFormState, data:' + JSON.stringify(data));
    }
});
1
2
3
4
5
6
7
8
9
10
11
12

acquireFormState

function acquireFormState(want: Want): Promise<FormStateInfo>;

获取卡片状态。

参数:

参数名 类型 必填 说明
want Want 查询卡片状态时携带的want信息

返回值:

类型 说明
Promise<FormStateInfo> Promise实例,用于返回卡片状态

系统能力:

SystemCapability.Ability.Form

示例:

var want = {
	"deviceId": "",
	"bundleName": "com.extreme.test",
	"abilityName": "com.extreme.test.MainAbility"
};
formHost.acquireFormState(want).then((data) => {
    console.log('formHost acquireFormState, data:' + JSON.stringify(data));
}).catch((error) => {
    console.log('formHost acquireFormState, error:' + JSON.stringify(error));
});
1
2
3
4
5
6
7
8
9
10

on("formUninstall")

on(type: "formUninstall", callback: Callback<string>): void;

订阅卡片卸载事件。

系统能力:

SystemCapability.Ability.Form

参数:

参数名 类型 必填 说明
type string 填写"formUninstall",表示卡片卸载事件
callback Callback<string> 需要注册的事件回调方法

示例:

let callback = function(formId) {
    console.log('formHost on formUninstall, formId:' + formId);
}
formHost.on("formUninstall", callback);
1
2
3
4

off("formUninstall")

off(type: "formUninstall", callback?: Callback<string>): void;

取消订阅卡片卸载事件。

系统能力:

SystemCapability.Ability.Form

参数:

参数名 类型 必填 说明
type string 填写"formUninstall",表示卡片卸载事件
callback Callback<string> 需要注销的事件回调方法。缺省时,表示注销所有已注册事件回调

示例:

let callback = function(formId) {
    console.log('formHost on formUninstall, formId:' + formId);
}
formHost.off("formUninstall", callback);
1
2
3
4

notifyFormsVisible

notifyFormsVisible(formIds: Array<string>, isVisible: boolean, callback: AsyncCallback<void>): void;

通知卡片是否可见。

系统能力:

SystemCapability.Ability.Form

参数:

参数名 类型 必填 说明
formIds Array<string> 卡片标识列表
isVisible boolean 是否可见
callback AsyncCallback<void> callback形式返回结果

示例:

var formIds = new Array("12400633174999288", "12400633174999289");
formHost.notifyFormsVisible(formIds, true, (error, data) => {
    if (error.code) {
        console.log('formHost notifyFormsVisible, error:' + JSON.stringify(error));
    }
});
1
2
3
4
5
6

notifyFormsVisible

notifyFormsVisible(formIds: Array<string>, isVisible: boolean): Promise<void>;

通知卡片是否可见。

系统能力:

SystemCapability.Ability.Form

参数:

参数名 类型 必填 说明
formIds Array<string> 卡片标识列表
isVisible boolean 是否可见

返回值:

类型 说明
Promise<void> 返回一个Promise,包含接口的结果

示例:

var formIds = new Array("12400633174999288", "12400633174999289");
formHost.notifyFormsVisible(formIds, true).then(() => {
    console.log('formHost notifyFormsVisible success');
}).catch((error) => {
    console.log('formHost notifyFormsVisible, error:' + JSON.stringify(error));
});
1
2
3
4
5
6

notifyFormsEnableUpdate

notifyFormsEnableUpdate(formIds: Array<string>, isEnableUpdate: boolean, callback: AsyncCallback<void>): void;

通知卡片是否启用更新状态。

系统能力:

SystemCapability.Ability.Form

参数:

参数名 类型 必填 说明
formIds Array<string> 卡片标识列表
isEnableUpdate boolean 是否使能更新
callback AsyncCallback<void> callback形式返回结果

示例:

var formIds = new Array("12400633174999288", "12400633174999289");
formHost.notifyFormsEnableUpdate(formIds, true, (error, data) => {
    if (error.code) {
        console.log('formHost notifyFormsEnableUpdate, error:' + JSON.stringify(error));
    }
});
1
2
3
4
5
6

notifyFormsEnableUpdate

notifyFormsEnableUpdate(formIds: Array<string>, isEnableUpdate: boolean): Promise<void>;

通知卡片是否启用更新状态。

系统能力:

SystemCapability.Ability.Form

参数:

参数名 类型 必填 说明
formIds Array<string> 卡片标识列表
isEnableUpdate boolean 是否使能更新

返回值:

类型 说明
Promise<void> 返回一个Promise,包含接口的结果

示例:

var formIds = new Array("12400633174999288", "12400633174999289");
formHost.notifyFormsEnableUpdate(formIds, true).then(() => {
    console.log('formHost notifyFormsEnableUpdate success');
}).catch((error) => {
    console.log('formHost notifyFormsEnableUpdate, error:' + JSON.stringify(error));
});
1
2
3
4
5
6