From ee4b429ed8ed206eea4f27495b91af3d0556c2cc Mon Sep 17 00:00:00 2001 From: yangzk Date: Wed, 8 Feb 2023 16:52:00 +0800 Subject: [PATCH] =?UTF-8?q?IssueNo:=20#I6DRA8=20Description:=20=E5=85=83?= =?UTF-8?q?=E8=83=BD=E5=8A=9BAPI9=E7=BB=88=E5=AE=A1=E4=BF=AE=E6=94=B9=20?= =?UTF-8?q?=E6=96=87=E6=A1=A3=E9=80=82=E9=85=8D=20Sig:=20SIG=5FApplication?= =?UTF-8?q?Framework=20Feature=20or=20Bugfix:=20Bugfix=20Binary=20Source:?= =?UTF-8?q?=20No?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: yangzk Change-Id: I0cc8a4fee81f29395724dfc3d6f40e99b388c34a --- .../apis/js-apis-app-ability-common.md | 16 +- .../apis/js-apis-app-ability-wantConstant.md | 60 +--- .../apis/js-apis-app-form-formBindingData.md | 2 +- .../apis/js-apis-app-form-formInfo.md | 1 - .../js-apis-application-formBindingData.md | 2 +- .../apis/js-apis-application-formExtension.md | 284 ---------------- .../apis/js-apis-application-formHost.md | 135 -------- .../apis/js-apis-application-formInfo.md | 40 +-- .../apis/js-apis-application-formProvider.md | 303 ------------------ ...is-inner-application-applicationContext.md | 24 +- .../apis/js-apis-inner-application-context.md | 12 +- ...apis-inner-application-uiAbilityContext.md | 2 - 12 files changed, 24 insertions(+), 857 deletions(-) delete mode 100644 zh-cn/application-dev/reference/apis/js-apis-application-formExtension.md diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-common.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-common.md index a4f459ec1c..44505896b3 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-common.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-common.md @@ -24,9 +24,8 @@ import common from '@ohos.app.ability.common' | Context | [Context](js-apis-inner-application-context.md) | Context二级模块。 | | ExtensionContext | [ExtensionContext](js-apis-inner-application-extensionContext.md) | ExtensionContext二级模块。 | | FormExtensionContext | [FormExtensionContext](js-apis-inner-application-formExtensionContext.md) | FormExtensionContext二级模块。 | -| AreaMode | [AreaMode](#areamode) | AreaMode枚举值。 | +| ServiceExtensionContext | [ServiceExtensionContext](js-apis-inner-application-serviceExtensionContext.md) | ServiceExtensionContext二级模块。 | | EventHub | [EventHub](js-apis-inner-application-eventHub.md) | EventHub二级模块。 | -| PermissionRequestResult | [PermissionRequestResult](js-apis-inner-application-permissionRequestResult.md) | PermissionRequestResult二级模块。 | | PacMap | [PacMap](js-apis-inner-ability-dataAbilityHelper.md#PacMap) | PacMap二级模块。 | | AbilityResult | [AbilityResult](js-apis-inner-ability-abilityResult.md) | AbilityResult二级模块。 | | ConnectOptions | [ConnectOptions](js-apis-inner-ability-connectOptions.md) | ConnectOptions二级模块。 | @@ -42,21 +41,8 @@ let baseContext: common.BaseContext; let context: common.Context; let extensionContext: common.ExtensionContext; let formExtensionContext: common.FormExtensionContext; -let areaMode: common.AreaMode; let eventHub: common.EventHub; -let permissionRequestResult: common.PermissionRequestResult; let pacMap: common.PacMap; let abilityResult: common.AbilityResult; let connectOptions: common.ConnectOptions; ``` - -## AreaMode - -数据加密等级的枚举。 - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core - -| 名称 | 值 | 说明 | -| --------------- | ---- | --------------- | -| EL1 | 0 | 设备级加密区，设备开机后可访问的数据区。 | -| EL2 | 1 | 用户级加密区，设备开机，首次输入密码后才能够访问的数据区。 | \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-ability-wantConstant.md b/zh-cn/application-dev/reference/apis/js-apis-app-ability-wantConstant.md index de78f53fb4..5568419351 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-ability-wantConstant.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-ability-wantConstant.md @@ -12,61 +12,21 @@ wantConstant模块提供want中操作want常数和解释Flags说明的能力。 import wantConstant from '@ohos.app.ability.wantConstant'; ``` -## wantConstant.Action -want操作的常数。用于表示要执行的通用操作。 -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase +## wantConstant.Params -| 名称 | 值 | 说明 | -| ------------ | ------------------ | ---------------------- | -| ACTION_HOME | ohos.want.action.home | 指示返回原点的操作。 | -| ACTION_DIAL | ohos.want.action.dial | 指示启动显示小键盘的页面功能的操作 | -| ACTION_SEARCH | ohos.want.action.search | 指示启动页面搜索功能的操作。 | -| ACTION_WIRELESS_SETTINGS | ohos.settings.wireless | 指示启动提供无线网络设置的页面功能的操作，例如，Wi-Fi选项。 | -| ACTION_MANAGE_APPLICATIONS_SETTINGS | ohos.settings.manage.applications | 指示启动管理已安装应用程序的页面功能的操作。 | -| ACTION_APPLICATION_DETAILS_SETTINGS | ohos.settings.application.details | 指示启动显示指定应用程序详细信息的页面功能的操作。 | -| ACTION_SET_ALARM | ohos.want.action.setAlarm | 指示启动页面功能以设置闹钟的操作。 | -| ACTION_SHOW_ALARMS | ohos.want.action.showAlarms | 指示启动显示所有警报的页面功能的操作时钟。 | -| ACTION_SNOOZE_ALARM | ohos.want.action.snoozeAlarm | 指示启动用于使闹钟睡眠的页面功能的操作。 | -| ACTION_DISMISS_ALARM | ohos.want.action.dismissAlarm | 指示启动删除闹钟的页面功能的操作。 | -| ACTION_DISMISS_TIMER | ohos.want.action.dismissTimer | 指示启动页面功能以关闭计时器的操作。 | -| ACTION_SEND_SMS | ohos.want.action.sendSms | 指示启动发送sms的页面功能的操作。 | -| ACTION_CHOOSE | ohos.want.action.choose | 指示启动页面功能以打开联系人或图片的操作。 | -| ACTION_IMAGE_CAPTURE | ohos.want.action.imageCapture | 指示启动页面拍照功能的操作。 | -| ACTION_VIDEO_CAPTURE | ohos.want.action.videoCapture | 指示启动页面功能以拍摄视频的操作。 | -| ACTION_SELECT | ohos.want.action.select | 指示显示应用程序选择对话框的操作。 | -| ACTION_SEND_DATA | ohos.want.action.sendData | 指示发送单个数据记录的操作。 | -| ACTION_SEND_MULTIPLE_DATA | ohos.want.action.sendMultipleData | 指示发送多个数据记录的操作。 | -| ACTION_SCAN_MEDIA_FILE | ohos.want.action.scanMediaFile | 指示请求媒体扫描仪扫描文件并将文件添加到媒体库的操作。 | -| ACTION_VIEW_DATA | ohos.want.action.viewData | 指示查看数据的操作。 | -| ACTION_EDIT_DATA | ohos.want.action.editData | 指示编辑数据的操作。 | -| INTENT_PARAMS_INTENT | ability.want.params.INTENT | 指示用行为选择器来展示选择的操作。 | -| INTENT_PARAMS_TITLE | ability.want.params.TITLE | 指示与行为选择器一起使用时的字符序列对话框标题。 | -| ACTION_FILE_SELECT | ohos.action.fileSelect | 指示选择文件的操作。 | -| PARAMS_STREAM | ability.params.stream | 指示发送数据时与目标关联的数据流的URI | -| ACTION_APP_ACCOUNT_AUTH | account.appAccount.action.auth | 指示提供auth服务的操作。 | -| ACTION_MARKET_DOWNLOAD | ohos.want.action.marketDownload | 表示从应用程序市场下载应用程序的的操作。
**系统API**：该接口为系统接口，三方应用不支持调用。 | -| ACTION_MARKET_CROWDTEST | ohos.want.action.marketCrowdTest | 指示从应用程序市场众测应用程序的操作。
**系统API**：该接口为系统接口，三方应用不支持调用。 | -| DLP_PARAMS_SANDBOX |ohos.dlp.params.sandbox | 指示沙盒标志的参数的操作。
**系统API**：该接口为系统接口，三方应用不支持调用。 | -| DLP_PARAMS_BUNDLE_NAME |ohos.dlp.params.bundleName |指示DLP Bundle名称的参数的操作。
**系统API**：该接口为系统接口，三方应用不支持调用。 | -| DLP_PARAMS_MODULE_NAME |ohos.dlp.params.moduleName |指示DLP模块名称的参数的操作。
**系统API**：该接口为系统接口，三方应用不支持调用。 | -| DLP_PARAMS_ABILITY_NAME |ohos.dlp.params.abilityName |指示DLP能力名称的参数的操作。
**系统API**：该接口为系统接口，三方应用不支持调用。 | -| DLP_PARAMS_INDEX |ohos.dlp.params.index |指示DLP索引参数的操作。
**系统API**：该接口为系统接口，三方应用不支持调用。 | - -## wantConstant.Entity - -want实体的常数。用于表示目标Ability额外的类别信息。 +want的Params操作的常量。 + +| 名称 | 值 | 说明 | +| ----------------------- | --------------------------- | ------------------------------------------------------------ | +| DLP_PARAMS_SANDBOX | ohos.dlp.params.sandbox | 指示沙盒标志的参数的操作。
**系统API**：该接口为系统接口，三方应用不支持调用。 | +| DLP_PARAMS_BUNDLE_NAME | ohos.dlp.params.bundleName | 指示DLP Bundle名称的参数的操作。
**系统API**：该接口为系统接口，三方应用不支持调用。 | +| DLP_PARAMS_MODULE_NAME | ohos.dlp.params.moduleName | 指示DLP模块名称的参数的操作。
**系统API**：该接口为系统接口，三方应用不支持调用。 | +| DLP_PARAMS_ABILITY_NAME | ohos.dlp.params.abilityName | 指示DLP能力名称的参数的操作。
**系统API**：该接口为系统接口，三方应用不支持调用。 | +| DLP_PARAMS_INDEX | ohos.dlp.params.index | 指示DLP索引参数的操作。
**系统API**：该接口为系统接口，三方应用不支持调用。 | -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase -| 名称 | 值 | 说明 | -| ------------ | ------------------ | ---------------------- | -| ENTITY_DEFAULT | entity.system.default | 指示默认实体，如果未指定该实体，则使用该实体。 | -| ENTITY_HOME | entity.system.home | 指示主屏幕实体。 | -| ENTITY_VOICE | entity.system.voice | 表示语音交互实体。 | -| ENTITY_BROWSABLE | entity.system.browsable | 指示浏览器类别。 | -| ENTITY_VIDEO | entity.system.video | 指示视频类别。 | ## wantConstant.Flags diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-form-formBindingData.md b/zh-cn/application-dev/reference/apis/js-apis-app-form-formBindingData.md index 61c0e1007a..766965c889 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-form-formBindingData.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-form-formBindingData.md @@ -48,8 +48,8 @@ createFormBindingData(obj?: Object | string): FormBindingData **示例：** ```ts -import fs from '@ohos.file.fs'; import formBindingData from '@ohos.app.form.formBindingData'; +import fs from '@ohos.file.fs'; try { let fd = fs.openSync('/path/to/form.png') diff --git a/zh-cn/application-dev/reference/apis/js-apis-app-form-formInfo.md b/zh-cn/application-dev/reference/apis/js-apis-app-form-formInfo.md index 5d6a41a9d8..1740b16940 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-app-form-formInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-app-form-formInfo.md @@ -31,7 +31,6 @@ import formInfo from '@ohos.app.form.formInfo'; | isDefault | boolean | 是 | 否 | 卡片是否是默认卡片。 | | updateEnabled | boolean | 是 | 否 | 卡片是否使能更新。 | | formVisibleNotify | boolean | 是 | 否 | 卡片是否使能可见通知。 | -| relatedBundleName | string | 是 | 否 | 卡片所属的相关联Bundle名称。 | | scheduledUpdateTime | string | 是 | 否 | 卡片更新时间。 | | formConfigAbility | string | 是 | 否 | 卡片配置ability。指定长按卡片弹出的选择框内，编辑选项所对应的ability。 | | updateDuration | number | 是 | 否 | 卡片更新周期。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-formBindingData.md b/zh-cn/application-dev/reference/apis/js-apis-application-formBindingData.md index 78f507d1bc..efe8b66391 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-formBindingData.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-formBindingData.md @@ -58,7 +58,7 @@ try { "formImages": { "image": fd } }; formBindingData.createFormBindingData(obj); -} catch (error.code) { +} catch (error) { console.log('catch error, error:' + JSON.stringify(error)); } ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-formExtension.md b/zh-cn/application-dev/reference/apis/js-apis-application-formExtension.md deleted file mode 100644 index 741a99c544..0000000000 --- a/zh-cn/application-dev/reference/apis/js-apis-application-formExtension.md +++ /dev/null @@ -1,284 +0,0 @@ -# @ohos.application.FormExtension (FormExtension) - -FormExtension模块提供了FormExtension卡片扩展相关接口。 - -> **说明：** -> -> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -> 从API version 9 开始不再维护，建议使用[FormExtensionAbility](js-apis-app-form-formExtensionAbility.md)替代。 -> 本模块接口仅可在Stage模型下使用。 - -## 导入模块 - -```ts -import FormExtension from '@ohos.application.FormExtension'; -``` - -## 属性 - -**系统能力**：SystemCapability.Ability.Form - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| ------- | ------------------------------------------------------- | ---- | ---- | --------------------------------------------------- | -| context | [FormExtensionContext](js-apis-inner-application-formExtensionContext.md) | 是 | 否 | FormExtension的上下文环境，继承自ExtensionContext。 | - -## onCreate - -onCreate(want: Want): formBindingData.FormBindingData - -卡片提供方接收创建卡片的通知接口。 - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | -------------------------------------- | ---- | ------------------------------------------------------------ | -| want | [Want](js-apis-application-want.md) | 是 | 当前Extension相关的Want类型信息，包括卡片ID、卡片名称、卡片样式等。这些卡片信息必须作为持久数据进行管理，以便后续更新和删除卡片。 | - -**返回值：** - -| 类型 | 说明 | -| ------------------------------------------------------------ | ----------------------------------------------------------- | -| [formBindingData.FormBindingData](js-apis-application-formBindingData.md#formbindingdata) | formBindingData.FormBindingData对象，卡片要显示的数据。 | - -**示例：** - -```ts -import formBindingData from '@ohos.application.formBindingData' -export default class MyFormExtension extends FormExtension { - onCreate(want) { - console.log('FormExtension onCreate, want:' + want.abilityName); - let dataObj1 = { - temperature:"11c", - "time":"11:00" - }; - let obj1 = formBindingData.createFormBindingData(dataObj1); - return obj1; - } -} -``` - -## FormExtension.onCastToNormal - -onCastToNormal(formId: string): void - -卡片提供方接收临时卡片转常态卡片的通知接口。 - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------------------------ | -| formId | string | 是 | 请求转换为常态的卡片标识。 | - -**示例：** - -```ts -export default class MyFormExtension extends FormExtension { - onCastToNormal(formId) { - console.log('FormExtension onCastToNormal, formId:' + formId); - } -} -``` - -## FormExtension.onUpdate - -onUpdate(formId: string): void - -卡片提供方接收更新卡片的通知接口。获取最新数据后调用[FormExtensionContext](js-apis-inner-application-formExtensionContext.md)的updateForm接口刷新卡片数据。 - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------------------ | -| formId | string | 是 | 请求更新的卡片ID。 | - -**示例：** - -```ts -import formBindingData from '@ohos.application.formBindingData' -export default class MyFormExtension extends FormExtension { - onUpdate(formId) { - console.log('FormExtension onUpdate, formId:' + formId); - let obj2 = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"}); - this.context.updateForm(formId, obj2).then((data)=>{ - console.log('FormExtension context updateForm, data:' + data); - }).catch((error) => { - console.error('Operation updateForm failed. Cause: ' + error);}); - } -} -``` - -## FormExtension.onVisibilityChange - -onVisibilityChange(newStatus: { [key: string]: number }): void - -卡片提供方接收修改可见性的通知接口。 - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| --------- | ------------------------- | ---- | ---------------------------- | -| newStatus | { [key: string]: number } | 是 | 请求修改的卡片ID和可见状态。 | - -**示例：** - -```ts -import formBindingData from '@ohos.application.formBindingData' -export default class MyFormExtension extends FormExtension { - onVisibilityChange(newStatus) { - console.log('FormExtension onVisibilityChange, newStatus:' + newStatus); - let obj2 = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"}); - - for (let key in newStatus) { - console.log('FormExtension onVisibilityChange, key:' + key + ", value=" + newStatus[key]); - this.context.updateForm(key, obj2).then((data)=>{ - console.log('FormExtension context updateForm, data:' + data); - }).catch((error) => { - console.error('Operation updateForm failed. Cause: ' + error);}); - } - } -} -``` - -## FormExtension.onEvent - -onEvent(formId: string, message: string): void - -卡片提供方接收处理卡片事件的通知接口。 - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------- | ------ | ---- | ---------------------- | -| formId | string | 是 | 请求触发事件的卡片标识。 | -| message | string | 是 | 事件消息。 | - -**示例：** - -```ts -export default class MyFormExtension extends FormExtension { - onEvent(formId, message) { - console.log('FormExtension onEvent, formId:' + formId + ", message:" + message); - } -} -``` - -## FormExtension.onDestroy - -onDestroy(formId: string): void - -卡片提供方接收销毁卡片的通知接口。 - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------------------ | -| formId | string | 是 | 请求销毁的卡片标识。 | - -**示例：** - -```ts -export default class MyFormExtension extends FormExtension { - onDestroy(formId) { - console.log('FormExtension onDestroy, formId:' + formId); - } -} -``` - -## FormExtension.onConfigurationUpdated - -onConfigurationUpdated(config: Configuration): void; - -当系统配置更新时调用。 - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| config | [Configuration](js-apis-application-configuration.md) | 是 | 表示需要更新的配置信息。 | - -**示例：** - -```ts -class MyFormExtension extends FormExtension { - onConfigurationUpdated(config) { - console.log('onConfigurationUpdated, config:' + JSON.stringify(config)); - } -} -``` - -## FormExtension.onAcquireFormState - -onAcquireFormState?(want: Want): formInfo.FormState; - -卡片提供方接收查询卡片状态通知接口。默认返回卡片初始状态。 - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| want | [Want](js-apis-application-want.md) | 是 | want表示获取卡片状态的描述。描述包括Bundle名称、能力名称、模块名称、卡片名和卡片维度。 | - -**示例：** - -```ts -import formInfo from '@ohos.application.formInfo' -class MyFormExtension extends FormExtension { - onAcquireFormState(want) { - console.log('FormExtension onAcquireFormState, want:' + want); - return formInfo.FormState.UNKNOWN; - } -} -``` - -## FormExtension.onShare - -onShare?(formId: string): {[key: string]: any}; - -卡片提供方接收卡片分享的通知接口。 - -**系统接口**: 此接口为系统接口。 - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| formId | string | 是 | 卡片标识。 | - -**返回值：** - -| 类型 | 说明 | -| ------------------------------------------------------------ | ----------------------------------------------------------- | -| {[key: string]: any} | 卡片要分享的数据，由开发者自行决定传入的键值对。 | - -**示例：** - -```ts -class MyFormExtension extends FormExtension { - onShare(formId) { - console.log('FormExtension onShare, formId:' + formId); - let wantParams = { - "temperature":"20", - "time":"2022-8-8 09:59", - }; - return wantParams; - } -} -``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-formHost.md b/zh-cn/application-dev/reference/apis/js-apis-application-formHost.md index 46506dd17a..83cbfb25fb 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-formHost.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-formHost.md @@ -1117,138 +1117,3 @@ formHost.notifyFormsEnableUpdate(formIds, true).then(() => { console.error('formHost notifyFormsEnableUpdate, error:' + JSON.stringify(error)); }); ``` -## shareForm9+ - -shareForm(formId: string, deviceId: string, callback: AsyncCallback<void>): void - -指定formId和远程设备Id进行卡片分享。使用callback异步回调。 - -**需要权限**：ohos.permission.REQUIRE_FORM 和 ohos.permission.DISTRIBUTED_DATASYNC - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------- | -| formId | string | 是 | 卡片标识。 | -| deviceId | string | 是 | 远程设备标识。 | -| callback | AsyncCallback<void> | 是 | 回调函数。当指定formId和远程设备Id进行卡片分享成功，error为undefined，否则为错误对象。 | - -**示例：** - -```ts -import formHost from '@ohos.application.formHost'; - -let formId = "12400633174999288"; -let deviceId = "EFC11C0C53628D8CC2F8CB5052477E130D075917034613B9884C55CD22B3DEF2"; -formHost.shareForm(formId, deviceId, (error, data) => { - if (error.code) { - console.error('formHost shareForm, error:' + JSON.stringify(error)); - } -}); -``` - -## shareForm9+ - -shareForm(formId: string, deviceId: string): Promise<void> - -指定formId和远程设备Id进行卡片分享。使用Promise异步回调。 - -**需要权限**：ohos.permission.REQUIRE_FORM - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------- | -| formId | string | 是 | 卡片标识。 | -| deviceId | string | 是 | 远程设备标识。 | - -**返回值：** - -| 类型 | 说明 | -| -------- | -------- | -| Promise<void> | 无返回结果的Promise对象。 | - -**参数：** - -```ts -import formHost from '@ohos.application.formHost'; - -let formId = "12400633174999288"; -let deviceId = "EFC11C0C53628D8CC2F8CB5052477E130D075917034613B9884C55CD22B3DEF2"; -formHost.shareForm(formId, deviceId).then(() => { - console.log('formHost shareForm success'); -}).catch((error) => { - console.error('formHost shareForm, error:' + JSON.stringify(error)); -}); -``` - -## notifyFormsPrivacyProtected9+ - -notifyFormsPrivacyProtected(formIds: Array<string>, isProtected: boolean, callback: AsyncCallback<void>): void - -通知指定卡片隐私保护状态改变。使用callback异步回调。 - -**需要权限**：ohos.permission.REQUIRE_FORM - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------- | -| formId | string | 是 | 卡片标识。 | -| deviceId | string | 是 | 远程设备标识。 | - -```ts -import formHost from '@ohos.application.formHost'; - -let formIds = new Array("12400633174999288", "12400633174999289"); -formHost.notifyFormsPrivacyProtected(formIds, true).then(() => { - console.log('formHost shareForm success'); -}).catch((error) => { - console.error('formHost shareForm, error:' + JSON.stringify(error)); -}); -``` - -## notifyFormsPrivacyProtected - -function notifyFormsPrivacyProtected(formIds: Array<string>, isProtected: boolean): Promise<void>; - -通知指定卡片隐私保护状态改变。使用Promise异步回调。 - -**需要权限**：ohos.permission.REQUIRE_FORM - -**系统能力**：SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ----------- | --------------- | ---- | -------------------------------- | -| formIds | Array<string> | 是 | 需要修改隐私保护的卡片标识列表。 | -| isProtected | boolean | 是 | 是否进行隐私保护。 | - -**返回值：** - -| 类型 | 说明 | -| ------------------- | ------------------------- | -| Promise<void> | 无返回结果的Promise对象。 | - - -```ts -import formHost from '@ohos.application.formHost'; - -let formIds = new Array("12400633174999288", "12400633174999289"); -try { - formHost.notifyFormsPrivacyProtected(formIds, true).then(() => { - console.log('formHost notifyFormsPrivacyProtected success'); - }).catch((error) => { - console.log('formHost notifyFormsPrivacyProtected, error:' + JSON.stringify(error)); - }); -} catch(error) { - console.log('formHost notifyFormsPrivacyProtected, error:' + JSON.stringify(error)); -} -``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-formInfo.md b/zh-cn/application-dev/reference/apis/js-apis-application-formInfo.md index 37b32fbecf..5ef129c5b6 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-formInfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-formInfo.md @@ -49,7 +49,6 @@ import formInfo from '@ohos.application.formInfo'; | 名称 | 值 | 说明 | | ----------- | ---- | ------------ | | JS | 1 | 卡片类型为JS。 | -| eTS9+ | 2 | 卡片类型为eTS。 | ## ColorMode @@ -94,48 +93,11 @@ import formInfo from '@ohos.application.formInfo'; | 名称 | 值 | 说明 | | ----------- | ---- | ------------ | -| IDENTITY_KEY9+ | "ohos.extra.param.key.form_identity" | 卡片标识。
**系统接口**: 此接口为系统接口。 | +| IDENTITY_KEY | "ohos.extra.param.key.form_identity" | 卡片标识。
**系统接口**: 此接口为系统接口。 | | DIMENSION_KEY | "ohos.extra.param.key.form_dimension" | 卡片规格样式。 | | NAME_KEY | "ohos.extra.param.key.form_name" | 卡片名称。 | | MODULE_NAME_KEY | "ohos.extra.param.key.module_name" | 卡片所属模块名称。 | | WIDTH_KEY | "ohos.extra.param.key.form_width" | 卡片宽度。 | | HEIGHT_KEY | "ohos.extra.param.key.form_height" | 卡片高度。 | | TEMPORARY_KEY | "ohos.extra.param.key.form_temporary" | 临时卡片。 | -| ABILITY_NAME_KEY9+ | "ohos.extra.param.key.ability_name" | ability名称。 | -| DEVICE_ID_KEY9+ | "ohos.extra.param.key.device_id" | 设备标识。 | -| BUNDLE_NAME_KEY9+ | "ohos.extra.param.key.bundle_name" | 指示指定要获取的捆绑包名称的键。| -## FormDimension9+ - -定义卡片尺寸枚举。 - -**系统能力**：SystemCapability.Ability.Form - -| 名称 | 值 | 说明 | -| ----------- | ---- | ------------ | -| Dimension_1_2 9+ | 1 | 1 x 2 form。 | -| Dimension_2_2 9+ | 2 | 2 x 2 form。 | -| Dimension_2_4 9+ | 3 | 2 x 4 form。 | -| Dimension_4_4 9+ | 4 | 4 x 4 form。 | -| Dimension_2_1 9+ | 5 | 2 x 1 form。 | - -## FormInfoFilter9+ - -卡片信息过滤器，仅将符合过滤器内要求的卡片信息返回。 - -**系统能力**：SystemCapability.Ability.Form - -| 名称 | 说明 | -| ----------- | ------------ | -| moduleName9+ | 选填。仅保留moduleName与提供值相符的卡片信息。
未填写时则不通过moduleName进行过滤。 | - -## VisibilityType9+ - -卡片当前可见类型枚举。 - -**系统能力**：SystemCapability.Ability.Form - -| 名称 | 值 | 说明 | -| ----------- | ---- | ------------ | -| FORM_VISIBLE9+ | 1 | 表示卡片为可见。 | -| FORM_INVISIBLE9+ | 2 | 表示卡片为不可见。 | \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-formProvider.md b/zh-cn/application-dev/reference/apis/js-apis-application-formProvider.md index 6f78d8cb6f..7bb591aef8 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-formProvider.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-formProvider.md @@ -142,307 +142,4 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData): Pr }); ``` -## getFormsInfo9+ -getFormsInfo(callback: AsyncCallback<Array<formInfo.FormInfo>>): void - -获取设备上当前应用程序的卡片信息，使用callback异步回调。 - -**系统能力：** SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------- | -| callback | AsyncCallback<Array<[formInfo.FormInfo](./js-apis-application-formInfo.md#forminfo-1)>> | 是 | 回调函数。返回查询到的卡片信息。 | - -**示例：** - -```ts -import formProvider from '@ohos.app.form.formProvider'; - -formProvider.getFormsInfo((error, data) => { - if (error.code) { - console.log('formProvider getFormsInfo, error:' + JSON.stringify(error)); - } else { - console.log('formProvider getFormsInfo, data:' + JSON.stringify(data)); - } -}); -``` -## getFormsInfo9+ - -getFormsInfo(filter: formInfo.FormInfoFilter, callback: AsyncCallback<Array<formInfo.FormInfo>>): void - -获取设备上当前应用程序的卡片信息，并筛选符合条件的信息，使用callback异步回调。 - -**系统能力：** SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------- | -| filter | [formInfo.FormInfoFilter](./js-apis-application-formInfo.md#forminfofilter) | 是 | 卡片信息过滤器。 | -| callback | AsyncCallback<Array<[formInfo.FormInfo](./js-apis-application-formInfo.md#forminfo-1)>> | 是 | 回调函数。返回查询到符合条件的卡片信息。 | - -**示例：** - -```ts -import formInfo from '@ohos.application.formInfo'; -import formProvider from '@ohos.app.form.formProvider'; - -const filter : formInfo.FormInfoFilter = { - // get info of forms belong to module entry. - moduleName : "entry" -}; -formProvider.getFormsInfo(filter, (error, data) => { - if (error.code) { - console.log('formProvider getFormsInfo, error:' + JSON.stringify(error)); - } else { - console.log('formProvider getFormsInfo, data:' + JSON.stringify(data)); - } -}); -``` - -## getFormsInfo9+ - -getFormsInfo(filter?: formInfo.FormInfoFilter): Promise<Array<formInfo.FormInfo>> - -获取设备上当前应用程序的卡片信息，使用Promise异步回调。 - -**系统能力：** SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------- | -| filter | [formInfo.FormInfoFilter](./js-apis-application-formInfo.md) | 否 | 卡片信息过滤器。 | - -**返回值：** - -| 类型 | 说明 | -| :------------ | :---------------------------------- | -| Promise<Array<[formInfo.FormInfo](./js-apis-application-formInfo.md#forminfo-1)>> | Promise对象。返回查询到符合条件的卡片信息。 | - -**示例：** - -```ts -import formInfo from '@ohos.application.formInfo'; -import formProvider from '@ohos.app.form.formProvider'; - -const filter : formInfo.FormInfoFilter = { - // get info of forms belong to module entry. - moduleName : "entry" -}; -formProvider.getFormsInfo(filter).then((data) => { - console.log('formProvider getFormsInfo, data:' + JSON.stringify(data)); -}).catch((error) => { - console.log('formProvider getFormsInfo, error:' + JSON.stringify(error)); -}); -``` - -## requestPublishForm9+ - -requestPublishForm(want: Want, formBindingData: formBindingData.FormBindingData, callback: AsyncCallback\): void - -请求发布一张卡片到使用方。使用方通常为桌面。 - -**系统能力：** SystemCapability.Ability.Form - -**系统接口**: 此接口为系统接口。 - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ---------------------------------------------------------------------- | ---- | ---------------- | -| want | [Want](js-apis-application-want.md) | 是 | 发布请求。需包含以下字段。
abilityName: 目标卡片ability
parameters:
"ohos.extra.param.key.form_dimension"
"ohos.extra.param.key.form_name"
"ohos.extra.param.key.module_name" | -| formBindingData | [formBindingData.FormBindingData](js-apis-application-formBindingData.md#formbindingdata) | 是 | 创建卡片的数据。 | -| callback | AsyncCallback<string> | 是 | 回调函数。返回卡片标识。 | - -**示例：** - - ```ts - import formBindingData from '@ohos.application.formBindingData'; - import formProvider from '@ohos.app.form.formProvider'; - let want = { - abilityName: "FormAbility", - parameters: { - "ohos.extra.param.key.form_dimension": 2, - "ohos.extra.param.key.form_name": "widget", - "ohos.extra.param.key.module_name": "entry" - } - }; - let obj = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"}); - formProvider.requestPublishForm(want, obj, (error, data) => { - if (error.code) { - console.log('formProvider requestPublishForm, error: ' + JSON.stringify(error)); - } else { - console.log('formProvider requestPublishForm, form ID is: ' + JSON.stringify(data)); - } - }); - ``` - -## requestPublishForm9+ - -requestPublishForm(want: Want, callback: AsyncCallback<string>): void - -请求发布一张卡片到使用方。使用方通常为桌面。 - -**系统能力：** SystemCapability.Ability.Form - -**系统接口**: 此接口为系统接口。 - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ----------------------------------- | ---- | ------------------------------------------------------------ | -| want | [Want](js-apis-application-want.md) | 是 | 发布请求。需包含以下字段。
abilityName: 目标卡片ability
parameters:
"ohos.extra.param.key.form_dimension"
"ohos.extra.param.key.form_name"
"ohos.extra.param.key.module_name" | -| callback | AsyncCallback<string> | 是 | 回调函数。返回卡片标识。 | - -**示例：** - - ```ts - import formProvider from '@ohos.app.form.formProvider'; - - let want = { - abilityName: "FormAbility", - parameters: { - "ohos.extra.param.key.form_dimension": 2, - "ohos.extra.param.key.form_name": "widget", - "ohos.extra.param.key.module_name": "entry" - } - }; - formProvider.requestPublishForm(want, (error, data) => { - if (error.code) { - console.log('formProvider requestPublishForm, error: ' + JSON.stringify(error)); - } else { - console.log('formProvider requestPublishForm, form ID is: ' + JSON.stringify(data)); - } - }); - ``` - -## requestPublishForm9+ - -requestPublishForm(want: Want, formBindingData?: formBindingData.FormBindingData): Promise<string> - -请求发布一张卡片到使用方。使用方通常为桌面。 - -**系统能力：** SystemCapability.Ability.Form - -**系统接口**: 此接口为系统接口。 - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| --------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | -| want | [Want](js-apis-application-want.md) | 是 | 发布请求。需包含以下字段。
abilityName: 目标卡片ability
parameters:
"ohos.extra.param.key.form_dimension"
"ohos.extra.param.key.form_name"
"ohos.extra.param.key.module_name" | -| formBindingData | [formBindingData.FormBindingData](js-apis-application-formBindingData.md#formbindingdata) | 是 | 创建卡片的数据。 | - -**返回值：** - -| 类型 | 说明 | -| :------------ | :---------------------------------- | -| Promise<string> | Promise对象。返回卡片标识。 | - -**示例：** - - ```ts - import formProvider from '@ohos.app.form.formProvider'; - - let want = { - abilityName: "FormAbility", - parameters: { - "ohos.extra.param.key.form_dimension": 2, - "ohos.extra.param.key.form_name": "widget", - "ohos.extra.param.key.module_name": "entry" - } - }; - formProvider.requestPublishForm(want).then((data) => { - console.log('formProvider requestPublishForm success, form ID is :' + JSON.stringify(data)); - }).catch((error) => { - console.log('formProvider requestPublishForm, error: ' + JSON.stringify(error)); - }); - ``` - -## isRequestPublishFormSupported9+ - -isRequestPublishFormSupported(callback: AsyncCallback<boolean>): void - -查询是否支持发布一张卡片到使用方。 - -**系统接口**: 此接口为系统接口。 - -**系统能力：** SystemCapability.Ability.Form - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------- | -| callback | AsyncCallback<boolean> | 是 | 回调函数。返回是否支持发布一张卡片到使用方。| - -**示例：** - -```ts -formProvider.isRequestPublishFormSupported((error, isSupported) => { - if (error.code) { - console.log('formProvider isRequestPublishFormSupported, error:' + JSON.stringify(error)); - } else { - if (isSupported) { - let want = { - abilityName: "FormAbility", - parameters: { - "ohos.extra.param.key.form_dimension": 2, - "ohos.extra.param.key.form_name": "widget", - "ohos.extra.param.key.module_name": "entry" - } - }; - formProvider.requestPublishForm(want, (error, data) => { - if (error.code) { - console.log('formProvider requestPublishForm, error: ' + JSON.stringify(error)); - } else { - console.log('formProvider requestPublishForm, form ID is: ' + JSON.stringify(data)); - } - }); - } - } -}); -``` - -## isRequestPublishFormSupported9+ - -isRequestPublishFormSupported(): Promise<boolean> - -查询是否支持发布一张卡片到使用方。 - -**系统接口**: 此接口为系统接口。 - -**系统能力：** SystemCapability.Ability.Form - -**返回值：** - -| 类型 | 说明 | -| :------------ | :---------------------------------- | -| Promise<boolean> | Promise对象。返回是否支持发布一张卡片到使用方。 | - -**示例：** - -```ts -formProvider.isRequestPublishFormSupported().then((isSupported) => { - if (isSupported) { - let want = { - abilityName: "FormAbility", - parameters: { - "ohos.extra.param.key.form_dimension": 2, - "ohos.extra.param.key.form_name": "widget", - "ohos.extra.param.key.module_name": "entry" - } - }; - formProvider.requestPublishForm(want).then((data) => { - console.log('formProvider requestPublishForm success, form ID is :' + JSON.stringify(data)); - }).catch((error) => { - console.log('formProvider requestPublishForm, error: ' + JSON.stringify(error)); - }); - } -}).catch((error) => { - console.log('formProvider isRequestPublishFormSupported, error:' + JSON.stringify(error)); -}); -``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-applicationContext.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-applicationContext.md index 89accd1caa..e03b28ec9d 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-applicationContext.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-applicationContext.md @@ -325,9 +325,9 @@ applicationContext.getProcessRunningInformation((err, data) => { }) ``` -## ApplicationContext.killProcessesBySelf9+ +## ApplicationContext.killAllProcesses9+ -killProcessesBySelf(): Promise; +killAllProcesses(): Promise\; 杀死应用所在的进程。 @@ -337,22 +337,18 @@ killProcessesBySelf(): Promise; | 类型 | 说明 | | -------- | -------- | -| Promise\> | 以Promise方式返回杀死应用所在的进程结果。 | +| Promise\ | 以Promise方式返回杀死应用所在的进程结果。 | **示例：** ```ts let applicationContext = this.context.getApplicationContext(); -applicationContext.killProcessesBySelf().then((data) => { - console.log("The process running information is:" + JSON.stringify(data)); -}).catch((error) => { - console.error("error:" + JSON.stringify(error)); -}); +applicationContext.killAllProcesses() ``` -## ApplicationContext.killProcessesBySelf9+ +## ApplicationContext.killAllProcesses9+ -killProcessesBySelf(callback: AsyncCallback); +killAllProcesses(callback: AsyncCallback\); 杀死应用所在的进程。 @@ -362,15 +358,13 @@ killProcessesBySelf(callback: AsyncCallback); | 类型 | 说明 | | -------- | -------- | -|AsyncCallback\ | 以callback方式返回杀死应用所在的进程结果。 | +|AsyncCallback\ | 以callback方式返回杀死应用所在的进程结果。 | **示例：** ```ts let applicationContext = this.context.getApplicationContext(); -applicationContext.killProcessesBySelf(err => { - if (err.code !== 0) { - console.error("killProcessesBySelf faile, err: " + JSON.stringify(err)); - } +applicationContext.killAllProcesses(err => { + console.error("killAllProcesses result: " + JSON.stringify(err)); }) ``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-context.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-context.md index c2f6b786ee..d5dca1bf8a 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-context.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-context.md @@ -23,7 +23,7 @@ Context模块提供了ability或application的上下文的能力，包括访问 | bundleCodeDir | string | 是 | 否 | 安装包目录。 | | distributedFilesDir | string | 是 | 否 | 分布式文件目录。 | | eventHub | [EventHub](js-apis-inner-application-eventHub.md) | 是 | 否 | 事件中心，提供订阅、取消订阅、触发事件对象。 | -| area | [AreaMode](#areamode) | 是 | 否 | 文件分区信息。 | +| area | contextConstant.[AreaMode](js-apis-app-ability-contextConstant.md) | 是 | 否 | 文件分区信息。 | ## Context.createBundleContext @@ -172,13 +172,3 @@ try { } ``` -## AreaMode - -文件分区 - -**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core - -| 名称 | 值 | 说明 | -| -------- | -------- | -------- | -| EL1 | 0 | 设备级加密区，设备开机后可访问的数据区。 | -| EL2 | 1 | 用户级加密区，设备开机，首次输入密码后才能够访问的数据区。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-application-uiAbilityContext.md b/zh-cn/application-dev/reference/apis/js-apis-inner-application-uiAbilityContext.md index d8d636c72e..3f0c8ff804 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inner-application-uiAbilityContext.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-application-uiAbilityContext.md @@ -1593,8 +1593,6 @@ startAbilityByCall(want: Want): Promise<Caller>; **系统能力**：SystemCapability.Ability.AbilityRuntime.Core -**系统API**: 此接口为系统接口，三方应用不支持调用。 - **参数：** | 参数名 | 类型 | 必填 | 说明 | -- GitLab