harmony 鸿蒙@ohos.app.form.formObserver (formObserver)

2023-10-30 浏览 (611)

@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异步回调，返回当前新增卡片的RunningFormInfo。

需要权限：ohos.permission.OBSERVE_FORM_RUNNING

系统能力：SystemCapability.Ability.Form

参数：

参数名类型必填说明
typestring是填写'formAdd'，表示卡片新增事件。
observerCallbackCallback<formInfo.RunningFormInfo>是回调函数。返回新增卡片的RunningFormInfo。

示例：

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

formObserver.on('formAdd', (data: formInfo.RunningFormInfo) => {
  console.log(`a new form added, data: ${JSON.stringify(data)}`);
});

on('formAdd')

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

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

需要权限：ohos.permission.OBSERVE_FORM_RUNNING

系统能力：SystemCapability.Ability.Form

参数：

参数名类型必填说明
typestring是填写'formAdd'，表示卡片新增事件。
hostBundleNamestring是指定订阅卡片使用方包的bundleName。缺省则订阅所有卡片使用方的卡片新增事件。
observerCallbackCallback<formInfo.RunningFormInfo>是回调函数。返回新增卡片的RunningFormInfo。

示例：

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

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

formObserver.on('formAdd', bundleName, (data: formInfo.RunningFormInfo) => {
  console.log(`a new form added, data: ${JSON.stringify(data)}`);
});

off('formAdd')

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

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

需要权限：ohos.permission.OBSERVE_FORM_RUNNING

系统能力：SystemCapability.Ability.Form

参数：

参数名类型必填说明
typestring是填写'formAdd'，表示卡片新增事件。
hostBundleNamestring否指定订阅卡片使用方包的bundleName。
填写该参数时，与注册时填写bundleName的on接口对应。
缺省则订阅所有卡片使用方的卡片删除事件，与注册时未填写bundleName的on接口相对应。
observerCallbackCallback<formInfo.RunningFormInfo>否回调函数。返回卡片RunningFormInfo。缺省时，表示注销对应已注册事件回调。
需与对应on('formAdd')的callback一致。

示例：

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

let bundleName: string = 'ohos.samples.FormApplication';
formObserver.off('formAdd', bundleName, (data: formInfo.RunningFormInfo) => {
  console.log(`a new form added, data: ${JSON.stringify(data)}`);
});

说明： 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异步回调，返回当前删除卡片的RunningFormInfo。

需要权限：ohos.permission.OBSERVE_FORM_RUNNING

系统能力：SystemCapability.Ability.Form

参数：

参数名类型必填说明
typestring是填写'formRemove'，表示卡片删除事件。
observerCallbackCallback<formInfo.RunningFormInfo>是回调函数。返回删除卡片的RunningFormInfo。

示例：

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

formObserver.on('formRemove', (data: formInfo.RunningFormInfo) => {
  console.log(`form deleted, data: ${JSON.stringify(data)}`);
});

on('formRemove')

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

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

需要权限：ohos.permission.OBSERVE_FORM_RUNNING

系统能力：SystemCapability.Ability.Form

参数：

参数名类型必填说明
typestring是填写'formRemove'，表示卡片删除事件。
hostBundleNamestring是指定订阅卡片使用方包的bundleName。缺省则订阅所有卡片使用方的卡片删除事件。
observerCallbackCallback<formInfo.RunningFormInfo>是回调函数。返回删除卡片的RunningFormInfo。

示例：

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

let bundleName: string = 'ohos.samples.FormApplication';
formObserver.on('formRemove', bundleName, (data: formInfo.RunningFormInfo) => {
  console.log(`form deleted, data: ${JSON.stringify(data)}`);
});

off('formRemove')

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

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

需要权限：ohos.permission.OBSERVE_FORM_RUNNING

系统能力：SystemCapability.Ability.Form

参数：

参数名类型必填说明
typestring是填写'formRemove'，表示卡片删除事件。
hostBundleNamestring否指定订阅卡片使用方包的bundleName。
填写该参数时，与注册时填写bundleName的on接口对应。
缺省则订阅所有卡片使用方的卡片删除事件，与注册时未填写bundleName的on接口相对应。
observerCallbackCallback<formInfo.RunningFormInfo>否回调函数。返回卡片RunningFormInfo。缺省时，表示注销对应已注册事件回调。
需与对应on('formRemove')的callback一致。

示例：

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

let bundleName: string = 'ohos.samples.FormApplication';
formObserver.off('formRemove', bundleName, (data: formInfo.RunningFormInfo) => {
  console.log(`a new form added, data: ${JSON.stringify(data)}`);
});

说明： 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

订阅通知卡片可见的事件。

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

需要权限：ohos.permission.OBSERVE_FORM_RUNNING

系统能力：SystemCapability.Ability.Form

参数：

参数名类型必填说明
typestring是仅允许填写'notifyVisible'，表示订阅通知卡片可见的事件。
observerCallbackCallback <Array<formInfo.RunningFormInfo>>是回调函数。返回订阅通知卡片可见的RunningFormInfo。

示例：

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

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

on('notifyVisible')

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

订阅通知卡片可见的事件。

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

需要权限：ohos.permission.OBSERVE_FORM_RUNNING

系统能力：SystemCapability.Ability.Form

参数：

参数名类型必填说明
typestring是仅允许填写'notifyVisible'，表示订阅通知卡片可见的事件。
hostBundleNamestring是指定卡片使用方的bundleName，用于订阅卡片在该使用方的可见状态变更事件。
observerCallbackCallback <Array<formInfo.RunningFormInfo>>是回调函数。返回订阅通知卡片可见的RunningFormInfo。

示例：

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

let bundleName: string = 'ohos.samples.FormApplication';
formObserver.on('notifyVisible', bundleName, (data: formInfo.RunningFormInfo[]) => {
  console.log(`form change visibility, data: ${JSON.stringify(data)}`);
});

off('notifyVisible')

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

取消订阅通知卡片可见的事件。

需要权限：ohos.permission.OBSERVE_FORM_RUNNING

系统能力：SystemCapability.Ability.Form

参数：

参数名类型必填说明
typestring是仅允许填写'notifyVisible'，表示取消订阅通知卡片为可见的事件。
hostBundleNamestring否指定卡片使用方的bundleName，用于订阅卡片在该使用方的可见状态变更事件。
填写该参数时，与注册时填写bundleName的on接口对应。
observerCallbackCallback <Array<formInfo.RunningFormInfo>>否入参，注册时注册进去的callback。缺省时，表示注销对应已注册订阅的回调。
需与对应on('notifyVisible')的callback一致。

示例：

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

let bundleName: string = 'ohos.samples.FormApplication';
formObserver.off('notifyVisible', bundleName, (data: formInfo.RunningFormInfo[]) => {
  console.log(`form change visibility, data: ${JSON.stringify(data)}`);
});

说明： 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

订阅通知卡片不可见的事件。

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

需要权限：ohos.permission.OBSERVE_FORM_RUNNING

系统能力：SystemCapability.Ability.Form

参数：

参数名类型必填说明
typestring是仅允许填写'notifyInvisible'，表示订阅卡片不可见的事件。
observerCallbackCallback <Array<formInfo.RunningFormInfo>>是回调函数。返回订阅通知卡片不可见的RunningFormInfo。

示例：

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

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

on('notifyInvisible')

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

订阅通知卡片不可见的事件。

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

需要权限：ohos.permission.OBSERVE_FORM_RUNNING

系统能力：SystemCapability.Ability.Form

参数：

参数名类型必填说明
typestring是仅允许填写'notifyInvisible'，表示订阅卡片不可见的事件。
hostBundleNamestring是指定卡片使用方的bundleName，用于订阅卡片在该使用方的可见状态变更事件。
observerCallbackCallback <Array<formInfo.RunningFormInfo>>是回调函数。返回订阅通知卡片不可见的RunningFormInfo。

示例：

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

let bundleName: string = 'ohos.samples.FormApplication';
formObserver.on('notifyInvisible', bundleName, (data: formInfo.RunningFormInfo[]) => {
  console.log(`form change invisibility, data: ${JSON.stringify(data)}`);
});

off('notifyInvisible')

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

取消订阅通知卡片不可见事件。

需要权限：ohos.permission.OBSERVE_FORM_RUNNING

系统能力：SystemCapability.Ability.Form

参数：

参数名类型必填说明
typestring是仅允许填写'notifyInvisible'，表示卡片可见性变更为不可见。
hostBundleNamestring否指定卡片使用方的bundleName，用于订阅卡片在该使用方的可见状态变更事件。
填写该参数时，与注册时填写bundleName的on接口对应。
observerCallbackCallback <Array<formInfo.RunningFormInfo>>否入参，注册时注册进去的callback。缺省时，表示注销对应已注册事件回调。
需与对应on('notifyInvisible')的callback一致。

示例：

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

let bundleName: string = 'ohos.samples.FormApplication';
formObserver.off('notifyInvisible', bundleName, (data: formInfo.RunningFormInfo[]) => {
  console.log(`form change invisibility, data: ${JSON.stringify(data)}`);
});

说明： 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

参数：

参数名类型必填说明
callbackAsyncCallback<Array<formInfo.RunningFormInfo>>是回调函数。获取设备上指定应用为卡片使用方的当前卡片信息成功，error为undefined，data为查询到的卡片信息。
hostBundleNamestring否指定要查询的卡片使用方名称，指定后会仅返回该卡片使用方下正在运行的非临时卡片信息。
缺省时，返回设备上所有正在运行的非临时卡片信息。

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

错误码ID错误信息
16500050An IPC connection error happened.
16500060A service connection error happened, please try again later.

示例：

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(callback: AsyncCallback<Array<formInfo.RunningFormInfo>>, isUnusedIncluded: boolean, hostBundleName?: string): void

获取所有卡片信息。使用callback异步回调。

需要权限：ohos.permission.OBSERVE_FORM_RUNNING

系统能力：SystemCapability.Ability.Form

参数：

参数名类型必填说明
callbackAsyncCallback<Array<formInfo.RunningFormInfo>>是以callback形式返回获取到的所有卡片信息，当获取成功时，回调中的error为undefined，data为查询到的卡片信息。
isUnusedIncludedboolean是是否包含未使用的卡片。
hostBundleNamestring否指定要查询的卡片使用方名称，指定后会仅返回该卡片使用方下正在运行的非临时卡片信息。
缺省时，返回设备上所有正在运行的非临时卡片信息。

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

错误码ID错误信息
16500050An IPC connection error happened.
16500060A service connection error happened, please try again later.

示例：

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)}`);
    }
  }, true, '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

参数：

参数名类型必填说明
hostBundleNamestring否指定要查询的卡片使用方名称，指定后会仅返回该卡片使用方下正在运行的非临时卡片信息。
缺省时，返回设备上所有正在运行的非临时卡片信息。

返回值：

类型说明
Promise<Array<formInfo.RunningFormInfo>>Promise对象，返回查询到的卡片信息。

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

错误码ID错误信息
16500050An IPC connection error happened.
16500060A service connection error happened, please try again later.

示例：

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

getRunningFormInfos

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

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

需要权限：ohos.permission.OBSERVE_FORM_RUNNING

系统能力：SystemCapability.Ability.Form

参数：

参数名类型必填说明
isUnusedIncludedboolean是是否包含未使用的卡片。
hostBundleNamestring否指定要查询的卡片使用方名称，指定后会仅返回该卡片使用方下正在运行的非临时卡片信息。
缺省时，返回设备上所有正在运行的非临时卡片信息。

返回值：

类型说明
Promise<Array<formInfo.RunningFormInfo>>Promise对象，返回查询到的卡片信息。

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

错误码ID错误信息
16500050An IPC connection error happened.
16500060A service connection error happened, please try again later.

示例：

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

try {
  formObserver.getRunningFormInfos(true, '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

参数：

参数名类型必填说明
formProviderFilterformInfo.FormProviderFilter是卡片提供方应用信息。

返回值：

类型说明
Promise<Array<formInfo.RunningFormInfo>>Promise对象，返回查询到的使用方列表信息。

错误码：

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

错误码ID错误信息
201Permissions denied.
202The application is not a system application.
401If the input parameter is not valid parameter.
16500050An IPC connection error happened.
16500100Failed to obtain the configuration information.
16501000An internal functional error occurred.
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

参数：

参数名类型必填说明
formProviderFilterformInfo.FormProviderFilter是卡片提供方应用信息。
callbackAsyncCallback<Array<formInfo.RunningFormInfo>>是回调函数。返回查询到的使用方列表信息，error为undefined，data为查询到的使用方列表信息；否则为错误对象。

错误码：

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

错误码ID错误信息
201Permissions denied.
202The application is not a system application.
401If the input parameter is not valid parameter.
16500050An IPC connection error happened.
16500100Failed to obtain the configuration information.
16501000An internal functional error occurred.
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

参数：

参数名类型必填说明
formIdstring是卡片标识。

返回值：

类型说明
Promise<formInfo.RunningFormInfo>Promise对象，返回查询到的使用方列表信息。

错误码：

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

错误码ID错误信息
201Permissions denied.
202The application is not a system application.
401If the input parameter is not valid parameter.
16500050An IPC connection error happened.
16500100Failed to obtain the configuration information.
16501000An internal functional error occurred.
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, isUnusedIncluded: boolean): Promise<formInfo.RunningFormInfo>

根据formId查询卡片已有的使用方列表信息。使用Promise异步回调。

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

需要权限：ohos.permission.OBSERVE_FORM_RUNNING

系统能力：SystemCapability.Ability.Form

参数：

参数名类型必填说明
formIdstring是卡片标识。
isUnusedIncludedboolean是是否包含未使用的卡片。

返回值：

类型说明
Promise<formInfo.RunningFormInfo>Promise对象，返回查询到的使用方列表信息。

错误码：

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

错误码ID错误信息
16500050An IPC connection error happened.
16500100Failed to obtain the configuration information.
16501000An internal functional error occurred.
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, true).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

参数：

参数名类型必填说明
formIdstring是卡片标识。
callbackAsyncCallback<formInfo.RunningFormInfo>是回调函数。返回查询到的使用方列表信息，error为undefined，data为查询到的使用方列表信息；否则为错误对象。

错误码：

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

错误码ID错误信息
201Permissions denied.
202The application is not a system application.
401If the input parameter is not valid parameter.
16500050An IPC connection error happened.
16500100Failed to obtain the configuration information.
16501000An internal functional error occurred.
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}`);
}

getRunningFormInfoById

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

根据卡片标识formId，查询卡片已有的使用方列表信息。使用callback异步回调。

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

需要权限：ohos.permission.OBSERVE_FORM_RUNNING

系统能力：SystemCapability.Ability.Form

参数：

参数名类型必填说明
formIdstring是卡片标识。
isUnusedIncludedboolean是是否包含未使用的卡片。
callbackAsyncCallback<formInfo.RunningFormInfo>是回调函数。返回查询到的使用方列表信息，error为undefined，data为查询到的使用方列表信息；否则为错误对象。

错误码：

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

错误码ID错误信息
16500050An IPC connection error happened.
16500100Failed to obtain the configuration information.
16501000An internal functional error occurred.
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, true, (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}`);
}

你可能感兴趣的鸿蒙文章

harmony 鸿蒙接口

harmony 鸿蒙系统公共事件定义(待停用)

harmony 鸿蒙系统公共事件定义

harmony 鸿蒙开发说明

harmony 鸿蒙企业设备管理概述（仅对系统应用开放）

harmony 鸿蒙BundleStatusCallback

harmony 鸿蒙@ohos.bundle.innerBundleManager (innerBundleManager模块)

harmony 鸿蒙@ohos.distributedBundle (分布式包管理)

harmony 鸿蒙@ohos.bundle (Bundle模块)

harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (企业设备管理扩展能力)

  • 所属分类： 后端技术
  • 本文标签： 鸿蒙 软件
  • 版权声明： 本文链接 https://seaxiang.com/blog/8b8658ad3fa94098ad5b4a89affbc69c