@ohos.application.formHost (FormHost)

FormHost模块提供了卡片使用方相关接口的能力，包括对使用方同一用户下安装的卡片进行删除、释放、请求更新，获取信息、状态等操作。

说明：

本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 从API version 9 开始不再维护，建议使用FormHost替代。 本模块接口均为系统接口。

导入模块

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

deleteForm

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

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

需要权限：ohos.permission.REQUIRE_FORM

系统能力：SystemCapability.Ability.Form

参数：

示例：

let formId = '12400633174999288';
formHost.deleteForm(formId, (error, data) => {
  if (error.code) {
    console.log('formHost deleteForm, error:' + JSON.stringify(error));
  }
});

deleteForm

deleteForm(formId: string): Promise<void>

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

需要权限：ohos.permission.REQUIRE_FORM

系统能力：SystemCapability.Ability.Form

参数：

返回值：

参数：

let formId = '12400633174999288';
formHost.deleteForm(formId).then(() => {
  console.log('formHost deleteForm success');
}).catch((error) => {
  console.log('formHost deleteForm, error:' + JSON.stringify(error));
});

releaseForm

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

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

需要权限：ohos.permission.REQUIRE_FORM

系统能力：SystemCapability.Ability.Form

参数：

示例：

let formId = '12400633174999288';
formHost.releaseForm(formId, (error, data) => {
  if (error.code) {
    console.log('formHost releaseForm, error:' + JSON.stringify(error));
  }
});

releaseForm

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

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

需要权限：ohos.permission.REQUIRE_FORM

系统能力：SystemCapability.Ability.Form

参数：

示例：

let formId = '12400633174999288';
formHost.releaseForm(formId, true, (error, data) => {
  if (error.code) {
    console.log('formHost releaseForm, error:' + JSON.stringify(error));
  }
});

releaseForm

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

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

需要权限：ohos.permission.REQUIRE_FORM

系统能力：SystemCapability.Ability.Form

参数：

返回值：

示例：

let formId = '12400633174999288';
formHost.releaseForm(formId, true).then(() => {
  console.log('formHost releaseForm success');
}).catch((error) => {
  console.log('formHost releaseForm, error:' + JSON.stringify(error));
});

requestForm

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

请求卡片更新。使用callback异步回调。

需要权限：ohos.permission.REQUIRE_FORM

系统能力：SystemCapability.Ability.Form

参数：

示例：

let formId = '12400633174999288';
formHost.requestForm(formId, (error, data) => {
  if (error.code) {
    console.log('formHost requestForm, error:' + JSON.stringify(error));
  }
});

requestForm

requestForm(formId: string): Promise<void>

请求卡片更新。使用Promise异步回调。

需要权限：ohos.permission.REQUIRE_FORM

系统能力：SystemCapability.Ability.Form

参数：

返回值：

示例：

let formId = '12400633174999288';
formHost.requestForm(formId).then(() => {
  console.log('formHost requestForm success');
}).catch((error) => {
  console.log('formHost requestForm, error:' + JSON.stringify(error));
});

castTempForm

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

将指定的临时卡片转换为普通卡片。使用callback异步回调。

需要权限：ohos.permission.REQUIRE_FORM

系统能力：SystemCapability.Ability.Form

参数：

示例：

let formId = '12400633174999288';
formHost.castTempForm(formId, (error, data) => {
  if (error.code) {
    console.log('formHost castTempForm, error:' + JSON.stringify(error));
  }
});

castTempForm

castTempForm(formId: string): Promise<void>

将指定的临时卡片转换为普通卡片。使用Promise异步回调。

需要权限：ohos.permission.REQUIRE_FORM

系统能力：SystemCapability.Ability.Form

参数：

返回值：

示例：

let formId = '12400633174999288';
formHost.castTempForm(formId).then(() => {
  console.log('formHost castTempForm success');
}).catch((error) => {
  console.log('formHost castTempForm, error:' + JSON.stringify(error));
});

notifyVisibleForms

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

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

需要权限：ohos.permission.REQUIRE_FORM

系统能力：SystemCapability.Ability.Form

参数：

示例：

let formId = ['12400633174999288'];
formHost.notifyVisibleForms(formId, (error, data) => {
  if (error.code) {
    console.log('formHost notifyVisibleForms, error:' + JSON.stringify(error));
  }
});

notifyVisibleForms

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

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

需要权限：ohos.permission.REQUIRE_FORM

系统能力：SystemCapability.Ability.Form

参数：

返回值：

示例：

let formId = ['12400633174999288'];
formHost.notifyVisibleForms(formId).then(() => {
  console.log('formHost notifyVisibleForms success');
}).catch((error) => {
  console.log('formHost notifyVisibleForms, error:' + JSON.stringify(error));
});

notifyInvisibleForms

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

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

需要权限：ohos.permission.REQUIRE_FORM

系统能力：SystemCapability.Ability.Form

参数：

示例：

let formId = ['12400633174999288'];
formHost.notifyInvisibleForms(formId, (error, data) => {
  if (error.code) {
    console.log('formHost notifyInvisibleForms, error:' + JSON.stringify(error));
  }
});

notifyInvisibleForms

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

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

需要权限：ohos.permission.REQUIRE_FORM

系统能力：SystemCapability.Ability.Form

参数：

返回值：

示例：

let formId = ['12400633174999288'];
formHost.notifyInvisibleForms(formId).then(() => {
  console.log('formHost notifyInvisibleForms success');
}).catch((error) => {
  console.log('formHost notifyInvisibleForms, error:' + JSON.stringify(error));
});

enableFormsUpdate

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

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

需要权限：ohos.permission.REQUIRE_FORM

系统能力：SystemCapability.Ability.Form

参数：

示例：

let formId = ['12400633174999288'];
formHost.enableFormsUpdate(formId, (error, data) => {
  if (error.code) {
    console.log('formHost enableFormsUpdate, error:' + JSON.stringify(error));
  }
});

enableFormsUpdate

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

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

需要权限：ohos.permission.REQUIRE_FORM

系统能力：SystemCapability.Ability.Form

参数：

返回值：

示例：

let formId = ['12400633174999288'];
formHost.enableFormsUpdate(formId).then(() => {
  console.log('formHost enableFormsUpdate success');
}).catch((error) => {
  console.log('formHost enableFormsUpdate, error:' + JSON.stringify(error));
});

disableFormsUpdate

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

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

需要权限：ohos.permission.REQUIRE_FORM

系统能力：SystemCapability.Ability.Form

参数：

示例：

let formId = ['12400633174999288'];
formHost.disableFormsUpdate(formId, (error, data) => {
  if (error.code) {
    console.log('formHost disableFormsUpdate, error:' + JSON.stringify(error));
  }
});

disableFormsUpdate

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

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

需要权限：ohos.permission.REQUIRE_FORM

系统能力：SystemCapability.Ability.Form

参数：

返回值：

示例：

let formId = ['12400633174999288'];
formHost.disableFormsUpdate(formId).then(() => {
  console.log('formHost disableFormsUpdate success');
}).catch((error) => {
  console.log('formHost disableFormsUpdate, error:' + JSON.stringify(error));
});

isSystemReady

isSystemReady(callback: AsyncCallback<void>): void

检查系统是否准备好。使用callback异步回调。

系统能力：SystemCapability.Ability.Form

参数：

示例：

let formId = '12400633174999288';
formHost.isSystemReady((error, data) => {
  if (error.code) {
    console.log('formHost isSystemReady, error:' + JSON.stringify(error));
  }
});

isSystemReady

isSystemReady(): Promise<void>

检查系统是否准备好。使用Promise异步回调。

系统能力：SystemCapability.Ability.Form

返回值：

示例：

let formId = '12400633174999288';
formHost.isSystemReady().then(() => {
  console.log('formHost isSystemReady success');
}).catch((error) => {
  console.log('formHost isSystemReady, error:' + JSON.stringify(error));
});

getAllFormsInfo

getAllFormsInfo(callback: AsyncCallback<Array<formInfo.FormInfo>>): void

获取设备上所有应用提供的卡片信息。使用callback异步回调。

需要权限：ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

系统能力：SystemCapability.Ability.Form

参数：

示例：

formHost.getAllFormsInfo((error, data) => {
  if (error.code) {
    console.log('formHost getAllFormsInfo, error:' + JSON.stringify(error));
  } else {
    console.log('formHost getAllFormsInfo, data:' + JSON.stringify(data));
  }
});

getAllFormsInfo

getAllFormsInfo(): Promise<Array<formInfo.FormInfo>>

获取设备上所有应用提供的卡片信息。使用Promise异步回调。

需要权限：ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

系统能力：SystemCapability.Ability.Form

返回值：

示例：

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

getFormsInfo

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

获取设备上指定应用程序提供的卡片信息。使用callback异步回调。

需要权限：ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

系统能力：SystemCapability.Ability.Form

参数：

示例：

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));
  }
});

getFormsInfo

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

获取设备上指定应用程序提供的卡片信息。使用callback异步回调。

需要权限：ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

系统能力：SystemCapability.Ability.Form

参数：

示例：

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));
  }
});

getFormsInfo

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

获取设备上指定应用程序提供的卡片信息。使用Promise异步回调。

需要权限：ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

系统能力：SystemCapability.Ability.Form

参数：

返回值：

示例：

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));
});

deleteInvalidForms

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

根据列表删除应用程序的无效卡片。使用callback异步回调。

需要权限：ohos.permission.REQUIRE_FORM

系统能力：SystemCapability.Ability.Form

参数：

示例：

let 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));
  }
});

deleteInvalidForms

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

根据列表删除应用程序的无效卡片。使用Promise异步回调。

需要权限：ohos.permission.REQUIRE_FORM

系统能力：SystemCapability.Ability.Form

参数：

返回值：

示例：

let 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));
});

acquireFormState

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

获取卡片状态。使用callback异步回调。

需要权限：ohos.permission.REQUIRE_FORM 和 ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

系统能力：SystemCapability.Ability.Form

参数：

示例：

let want = {
  'deviceId': '',
  'bundleName': 'ohos.samples.FormApplication',
  'abilityName': 'FormAbility',
  'parameters': {
    'ohos.extra.param.key.module_name': 'entry',
    'ohos.extra.param.key.form_name': 'widget',
    'ohos.extra.param.key.form_dimension': 2
  }
};
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));
  }
});

acquireFormState

acquireFormState(want: Want): Promise<formInfo.FormStateInfo>

获取卡片状态。使用Promise异步回调。

需要权限：ohos.permission.REQUIRE_FORM 和 ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

系统能力：SystemCapability.Ability.Form

参数：

返回值：

示例：

let want = {
  'deviceId': '',
  'bundleName': 'ohos.samples.FormApplication',
  'abilityName': 'FormAbility',
  'parameters': {
    'ohos.extra.param.key.module_name': 'entry',
    'ohos.extra.param.key.form_name': 'widget',
    'ohos.extra.param.key.form_dimension': 2
  }
};
formHost.acquireFormState(want).then((data) => {
  console.log('formHost acquireFormState, data:' + JSON.stringify(data));
}).catch((error) => {
  console.log('formHost acquireFormState, error:' + JSON.stringify(error));
});

on('formUninstall')

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

订阅卡片卸载事件。使用callback异步回调。

系统能力：SystemCapability.Ability.Form

参数：

示例：

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

off('formUninstall')

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

取消订阅卡片卸载事件。使用callback异步回调。

系统能力：SystemCapability.Ability.Form

参数：

示例：

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

notifyFormsVisible

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

通知卡片是否可见。使用callback异步回调。

需要权限：ohos.permission.REQUIRE_FORM

系统能力：SystemCapability.Ability.Form

参数：

示例：

let formIds = new Array('12400633174999288', '12400633174999289');
formHost.notifyFormsVisible(formIds, true, (error, data) => {
  if (error.code) {
    console.log('formHost notifyFormsVisible, error:' + JSON.stringify(error));
  }
});

notifyFormsVisible

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

通知卡片是否可见。使用Promise异步回调。

需要权限：ohos.permission.REQUIRE_FORM

系统能力：SystemCapability.Ability.Form

参数：

返回值：

示例：

let 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));
});

notifyFormsEnableUpdate

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

通知卡片是否启用更新状态。使用callback异步回调。

需要权限：ohos.permission.REQUIRE_FORM

系统能力：SystemCapability.Ability.Form

参数：

示例：

let formIds = new Array('12400633174999288', '12400633174999289');
formHost.notifyFormsEnableUpdate(formIds, true, (error, data) => {
  if (error.code) {
    console.log('formHost notifyFormsEnableUpdate, error:' + JSON.stringify(error));
  }
});

notifyFormsEnableUpdate

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

通知卡片是否启用更新状态。使用Promise异步回调。

需要权限：ohos.permission.REQUIRE_FORM

系统能力：SystemCapability.Ability.Form

参数：

返回值：

示例：

let 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));
});