@ohos.app.form.formObserver (formObserver)

formObserver模块提供了卡片监听方相关接口的能力，包括对同一用户下安装的卡片新增、删除、可见性变化事件的订阅和取消订阅，获取正在运行的卡片信息等。

说明：

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

导入模块

import formObserver from '@ohos.app.form.formObserver';

on('formAdd')

on(type: 'formAdd', observerCallback: Callback<formInfo.RunningFormInfo>): void

订阅卡片新增事件。使用callback异步回调，返回当前新增卡片的信息。

需要权限：ohos.permission.OBSERVE_FORM_RUNNING

系统能力：SystemCapability.Ability.Form

参数：

示例：

import formObserver from '@ohos.app.form.formObserver';
import formInfo from '@ohos.app.form.formInfo';

let callback = (data: formInfo.RunningFormInfo) => {
  console.log(`a new form added, data: ${JSON.stringify(data)}`);
}

formObserver.on('formAdd', callback);

on('formAdd')

on(type: 'formAdd', hostBundleName: string, observerCallback: Callback<formInfo.RunningFormInfo>): void

订阅卡片新增事件。使用callback异步回调，返回指定卡片使用方应用新增卡片的信息。

需要权限：ohos.permission.OBSERVE_FORM_RUNNING

系统能力：SystemCapability.Ability.Form

参数：

示例：

import formObserver from '@ohos.app.form.formObserver';
import formInfo from '@ohos.app.form.formInfo';

let bundleName: string = 'ohos.samples.FormApplication';

let callback = (data: formInfo.RunningFormInfo) => {
  console.log(`a new form added, data: ${JSON.stringify(data)}`);
}

formObserver.on('formAdd', bundleName, callback);

off('formAdd')

off(type: "formAdd", hostBundleName?: string, observerCallback?: Callback<formInfo.RunningFormInfo>): void

取消订阅卡片新增事件。使用callback异步回调，返返回当前新增卡片的信息。

需要权限：ohos.permission.OBSERVE_FORM_RUNNING

系统能力：SystemCapability.Ability.Form

参数：

示例：

import formObserver from '@ohos.app.form.formObserver';
import formInfo from '@ohos.app.form.formInfo';

let bundleName: string = 'ohos.samples.FormApplication';

let callback = (data: formInfo.RunningFormInfo) => {
  console.log(`a new form added, data: ${JSON.stringify(data)}`);
}

formObserver.off('formAdd', bundleName, callback);

说明： on('formAdd', callback)与off('formAdd', callback)相对应； on('formAdd', bundleName, callback)与off('formAdd', bundleName, callback)相对应； 订阅（on）只能由自己对应的取消订阅接口（off）取消。

on('formRemove')

on(type: 'formRemove', observerCallback: Callback<formInfo.RunningFormInfo>): void

订阅卡片删除事件。使用callback异步回调，返回当前删除卡片的信息。

需要权限：ohos.permission.OBSERVE_FORM_RUNNING

系统能力：SystemCapability.Ability.Form

参数：

示例：

import formObserver from '@ohos.app.form.formObserver';
import formInfo from '@ohos.app.form.formInfo';

let callback = (data: formInfo.RunningFormInfo) => {
  console.log(`form deleted, data: ${JSON.stringify(data)}`);
}

formObserver.on('formRemove', callback);

on('formRemove')

on(type: 'formRemove', hostBundleName: string, observerCallback: Callback<formInfo.RunningFormInfo>): void

订阅卡片删除事件。使用callback异步回调，返回指定卡片使用方应用被删除卡片的信息。

需要权限：ohos.permission.OBSERVE_FORM_RUNNING

系统能力：SystemCapability.Ability.Form

参数：

示例：

import formObserver from '@ohos.app.form.formObserver';
import formInfo from '@ohos.app.form.formInfo';

let bundleName: string = 'ohos.samples.FormApplication';

let callback = (data: formInfo.RunningFormInfo) => {
  console.log(`form deleted, data: ${JSON.stringify(data)}`);
}

formObserver.on('formRemove', bundleName, callback);

off('formRemove')

off(type: "formRemove", hostBundleName?: string, observerCallback?: Callback<formInfo.RunningFormInfo>): void

取消订阅卡片删除事件。使用callback异步回调，返回当前删除卡片的信息。

需要权限：ohos.permission.OBSERVE_FORM_RUNNING

系统能力：SystemCapability.Ability.Form

参数：

示例：

import formObserver from '@ohos.app.form.formObserver';
import formInfo from '@ohos.app.form.formInfo';

let bundleName: string = 'ohos.samples.FormApplication';

let callback = (data: formInfo.RunningFormInfo) => {
  console.log(`a new form added, data: ${JSON.stringify(data)}`);
}

formObserver.off('formRemove', bundleName, callback);

说明： on('formRemove', callback)与off('formRemove', callback)相对应； on('formRemove', bundleName, callback)与off('formRemove', bundleName, callback)相对应； 订阅（on）只能由自己对应的取消订阅接口（off）取消。

on('notifyVisible')

on(type: 'notifyVisible', observerCallback: Callback<Array<formInfo.RunningFormInfo>>): void

订阅通知卡片可见的事件。使用callback异步回调。

​触发通知卡片可见场景为：调用notifyVisibleForms接口通知对应卡片可见性变更为可见状态。

需要权限：ohos.permission.OBSERVE_FORM_RUNNING

系统能力：SystemCapability.Ability.Form

参数：

示例：

import formObserver from '@ohos.app.form.formObserver';
import formInfo from '@ohos.app.form.formInfo';

let callback = (data: formInfo.RunningFormInfo[]) => {
  console.log(`form change visibility, data: ${JSON.stringify(data)}`);
}

formObserver.on('notifyVisible', callback);

on('notifyVisible')

on(type: 'notifyVisible', hostBundleName: string, observerCallback: Callback<Array<formInfo.RunningFormInfo>>): void

订阅通知卡片可见的事件。使用callback异步回调。

​触发通知卡片可见场景为：调用notifyVisibleForms接口通知对应卡片可见性变更为可见状态。

需要权限：ohos.permission.OBSERVE_FORM_RUNNING

系统能力：SystemCapability.Ability.Form

参数：

示例：

import formObserver from '@ohos.app.form.formObserver';
import formInfo from '@ohos.app.form.formInfo';

let bundleName: string = 'ohos.samples.FormApplication';

let callback = (data: formInfo.RunningFormInfo[]) => {
  console.log(`form change visibility, data: ${JSON.stringify(data)}`);
}

formObserver.on('notifyVisible', bundleName, callback);

off('notifyVisible')

off(type: "notifyVisible", hostBundleName?: string, observerCallback?: Callback<Array<formInfo.RunningFormInfo>>): void

取消订阅通知卡片可见的事件。使用callback异步回调。

需要权限：ohos.permission.OBSERVE_FORM_RUNNING

系统能力：SystemCapability.Ability.Form

参数：

示例：

import formObserver from '@ohos.app.form.formObserver';
import formInfo from '@ohos.app.form.formInfo';

let bundleName: string = 'ohos.samples.FormApplication';

let callback = (data: formInfo.RunningFormInfo[]) => {
  console.log(`form change visibility, data: ${JSON.stringify(data)}`);
}

formObserver.off('notifyVisible', bundleName, callback);

说明： on('notifyVisible', callback)与off('notifyVisible', callback)相对应； on('notifyVisible', bundleName, callback)与off('notifyVisible', bundleName, callback)相对应； 订阅（on）只能由自己对应的取消订阅接口（off）取消。

on('notifyInvisible')

on(type: 'notifyInvisible', observerCallback: Callback<Array<formInfo.RunningFormInfo>>): void

订阅通知卡片不可见的事件。使用callback异步回调。

​触发通知卡片不可见场景为：调用notifyInvisibleForms接口通知对应卡片可见性变更为不可见状态。

需要权限：ohos.permission.OBSERVE_FORM_RUNNING

系统能力：SystemCapability.Ability.Form

参数：

示例：

import formObserver from '@ohos.app.form.formObserver';
import formInfo from '@ohos.app.form.formInfo';

let callback = (data: formInfo.RunningFormInfo[]) => {
  console.log(`form change invisibility, data: ${JSON.stringify(data)}`);
}

formObserver.on('notifyInvisible', callback);

on('notifyInvisible')

on(type: 'notifyInvisible', hostBundleName: string, observerCallback: Callback<Array<formInfo.RunningFormInfo>>): void

订阅通知卡片不可见的事件。使用callback异步回调。

​触发通知卡片不可见场景为：调用notifyInvisibleForms接口通知对应卡片可见性变更为不可见状态。

需要权限：ohos.permission.OBSERVE_FORM_RUNNING

系统能力：SystemCapability.Ability.Form

参数：

示例：

import formObserver from '@ohos.app.form.formObserver';
import formInfo from '@ohos.app.form.formInfo';

let bundleName: string = 'ohos.samples.FormApplication';

let callback = (data: formInfo.RunningFormInfo[]) => {
  console.log(`form change invisibility, data: ${JSON.stringify(data)}`);
}

formObserver.on('notifyInvisible', bundleName, callback);

off('notifyInvisible')

off(type: "notifyInvisible", hostBundleName?: string, observerCallback?: Callback<Array<formInfo.RunningFormInfo>>): void

取消订阅通知卡片不可见事件。使用callback异步回调。

需要权限：ohos.permission.OBSERVE_FORM_RUNNING

系统能力：SystemCapability.Ability.Form

参数：

示例：

import formObserver from '@ohos.app.form.formObserver';
import formInfo from '@ohos.app.form.formInfo';

let bundleName: string = 'ohos.samples.FormApplication';

let callback = (data: formInfo.RunningFormInfo[]) => {
  console.log(`form change invisibility, data: ${JSON.stringify(data)}`);
}

formObserver.off('notifyInvisible', bundleName, callback);

说明： on('notifyInvisible', callback)与off('notifyInvisible', callback)相对应； on('notifyInvisible', bundleName, callback)与off('notifyInvisible', bundleName, callback)相对应； 订阅（on）只能由自己对应的取消订阅接口（off）取消。

getRunningFormInfos

getRunningFormInfos(callback: AsyncCallback<Array<formInfo.RunningFormInfo>>, hostBundleName?: string): void

获取设备上正在运行的所有非临时卡片信息。使用callback异步回调。

需要权限：ohos.permission.OBSERVE_FORM_RUNNING

系统能力：SystemCapability.Ability.Form

参数：

错误码： 以下错误码的详细介绍请参见卡片错误码。

示例：

import formObserver from '@ohos.app.form.formObserver';
import formInfo from '@ohos.app.form.formInfo';
import Base from '@ohos.base';

try {
  formObserver.getRunningFormInfos((error: Base.BusinessError, data: formInfo.RunningFormInfo[]) => {
    if (error) {
      console.error(`error, code: ${error.code}, message: ${error.message}`);
    } else {
      console.log(`formObserver getRunningFormInfos, data: ${JSON.stringify(data)}`);
    }
  }, 'com.example.ohos.formjsdemo');
} catch(error) {
  console.error(`catch error, code: ${(error as Base.BusinessError).code}, message: ${(error as Base.BusinessError).message}`);
}

getRunningFormInfos

getRunningFormInfos(hostBundleName?: string): Promise<Array<formInfo.RunningFormInfo>>

获取设备上正在运行的所有非临时卡片信息。使用Promise异步回调。

需要权限：ohos.permission.OBSERVE_FORM_RUNNING

系统能力：SystemCapability.Ability.Form

参数：

返回值：

错误码： 以下错误码的详细介绍请参见卡片错误码。

示例：

import formObserver from '@ohos.app.form.formObserver';
import formInfo from '@ohos.app.form.formInfo';
import Base from '@ohos.base';

try {
  formObserver.getRunningFormInfos('com.example.ohos.formjsdemo').then((data: formInfo.RunningFormInfo[]) => {
    console.log(`formObserver getRunningFormInfos, data: ${JSON.stringify(data)}`);
  }).catch((error: Base.BusinessError) => {
    console.error(`error, code: ${error.code}, message: ${error.message}`);
  });
} catch(error) {
  console.error(`catch error, code: ${(error as Base.BusinessError).code}, message: ${(error as Base.BusinessError).message}`);
}

getRunningFormInfosByFilter

getRunningFormInfosByFilter(formProviderFilter: formInfo.FormProviderFilter): Promise<Array<formInfo.RunningFormInfo>>

根据提供方信息查询已添加的卡片信息列表。使用Promise异步回调。

模型约束： 此接口仅可在Stage模型下使用。

需要权限：ohos.permission.OBSERVE_FORM_RUNNING

系统能力：SystemCapability.Ability.Form

参数：

返回值：

错误码：

以下错误码的详细介绍请参见卡片错误码。

import formObserver from '@ohos.app.form.formObserver';
import formInfo from '@ohos.app.form.formInfo';
import Base from '@ohos.base';

let formInstanceFilter: formInfo.FormProviderFilter = {
  bundleName: "com.example.formprovide",
  abilityName: "EntryFormAbility",
  formName: "widget",
  moduleName: "entry"
}
try {
  formObserver.getRunningFormInfosByFilter(formInstanceFilter).then((data: formInfo.RunningFormInfo[]) => {
    console.info('formObserver getRunningFormInfosByFilter success, data:' + JSON.stringify(data));
  }).catch((error: Base.BusinessError) => {
    console.error(`error, code: ${error.code}, message: ${error.message}`);
  });
} catch(error) {
  console.error(`catch error, code: ${(error as Base.BusinessError).code}, message: ${(error as Base.BusinessError).message}`);
}

getRunningFormInfosByFilter

getRunningFormInfosByFilter(formProviderFilter: formInfo.FormProviderFilter, callback: AsyncCallback<Array<formInfo.RunningFormInfo>>): void

根据提供方信息查询已添加的卡片信息列表。使用callback异步回调。

模型约束： 此接口仅可在Stage模型下使用。

需要权限：ohos.permission.OBSERVE_FORM_RUNNING

系统能力：SystemCapability.Ability.Form

参数：

错误码：

以下错误码的详细介绍请参见卡片错误码。

示例：

import formObserver from '@ohos.app.form.formObserver';
import formInfo from '@ohos.app.form.formInfo';
import Base from '@ohos.base';

let formInstanceFilter: formInfo.FormProviderFilter = {
  bundleName: "com.example.formprovide",
  abilityName: "EntryFormAbility",
  formName: "widget",
  moduleName: "entry"
}
try {
  formObserver.getRunningFormInfosByFilter(formInstanceFilter,(error: Base.BusinessError, data: formInfo.RunningFormInfo[]) => {
    if (error) {
      console.error(`error, code: ${error.code}, message: ${error.message}`);
    } else {
      console.log(`formObserver getRunningFormInfosByFilter, data: ${JSON.stringify(data)}`);
    }
  });
} catch(error) {
  console.error(`catch error, code: ${(error as Base.BusinessError).code}, message: ${(error as Base.BusinessError).message}`);
}

getRunningFormInfoById

getRunningFormInfoById(formId: string): Promise<formInfo.RunningFormInfo>

根据formId查询已添加的卡片信息。使用Promise异步回调。

模型约束： 此接口仅可在Stage模型下使用。

需要权限：ohos.permission.OBSERVE_FORM_RUNNING

系统能力：SystemCapability.Ability.Form

参数：

返回值：

错误码：

以下错误码的详细介绍请参见卡片错误码。

示例：

import formObserver from '@ohos.app.form.formObserver';
import formInfo from '@ohos.app.form.formInfo';
import Base from '@ohos.base';

let formId: string = '12400633174999288';
try {
  formObserver.getRunningFormInfoById(formId).then((data: formInfo.RunningFormInfo) => {
    console.info('formObserver getRunningFormInfoById success, data:' + JSON.stringify(data));
  }).catch((error: Base.BusinessError) => {
    console.error(`error, code: ${error.code}, message: ${error.message}`);
  });
} catch(error) {
  console.error(`catch error, code: ${(error as Base.BusinessError).code}, message: ${(error as Base.BusinessError).message}`);
}

getRunningFormInfoById

getRunningFormInfoById(formId: string, callback: AsyncCallback<formInfo.RunningFormInfo>): void

根据提供方信息查询已添加的卡片信息。使用callback异步回调。

模型约束： 此接口仅可在Stage模型下使用。

需要权限：ohos.permission.OBSERVE_FORM_RUNNING

系统能力：SystemCapability.Ability.Form

参数：

错误码：

以下错误码的详细介绍请参见卡片错误码。

示例：

import formObserver from '@ohos.app.form.formObserver';
import formInfo from '@ohos.app.form.formInfo';
import Base from '@ohos.base';

let formId: string = '12400633174999288';
try {
  formObserver.getRunningFormInfoById(formId,(error: Base.BusinessError, data: formInfo.RunningFormInfo) => {
    if (error) {
      console.error(`error, code: ${error.code}, message: ${error.message}`);
    } else {
      console.log(`formObserver getRunningFormInfoById, data: ${JSON.stringify(data)}`);
    }
  });
} catch(error) {
  console.error(`catch error, code: ${(error as Base.BusinessError).code}, message: ${(error as Base.BusinessError).message}`);
}