From 128ed807f12973898d367e104730a30be42c212f Mon Sep 17 00:00:00 2001 From: zhaolinglan Date: Mon, 8 Aug 2022 21:52:35 +0800 Subject: [PATCH] add doc for inputmethod extension Signed-off-by: zhaolinglan --- .../reference/apis/Readme-CN.md | 2 + .../js-apis-inputmethod-extension-ability.md | 66 +++++++ .../js-apis-inputmethod-extension-context.md | 163 ++++++++++++++++++ 3 files changed, 231 insertions(+) create mode 100644 zh-cn/application-dev/reference/apis/js-apis-inputmethod-extension-ability.md create mode 100644 zh-cn/application-dev/reference/apis/js-apis-inputmethod-extension-context.md diff --git a/zh-cn/application-dev/reference/apis/Readme-CN.md b/zh-cn/application-dev/reference/apis/Readme-CN.md index c562459758..ec9646adb6 100755 --- a/zh-cn/application-dev/reference/apis/Readme-CN.md +++ b/zh-cn/application-dev/reference/apis/Readme-CN.md @@ -28,6 +28,8 @@ - application/[FormExtensionContext (FormExtensionContext)](js-apis-formextensioncontext.md) - application/[PermissionRequestResult (PermissionRequestResult)](js-apis-permissionrequestresult.md) - application/[ServiceExtensionContext (ServiceExtensionContext)](js-apis-service-extension-context.md) + - [InputMethodExtensionAbility (InputMethodExtensionAbility )](js-apis-inputmethod-extension-ability.md) + - [InputMethodExtensionContext (InputMethodExtensionContext)](js-apis-inputmethod-extension-context.md) - 通用 - [@ohos.ability.dataUriUtils (DataUriUtils模块)](js-apis-DataUriUtils.md) - [@ohos.ability.errorCode (ErrorCode)](js-apis-ability-errorCode.md) diff --git a/zh-cn/application-dev/reference/apis/js-apis-inputmethod-extension-ability.md b/zh-cn/application-dev/reference/apis/js-apis-inputmethod-extension-ability.md new file mode 100644 index 0000000000..32fe81eb49 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-inputmethod-extension-ability.md @@ -0,0 +1,66 @@ +# InputMethodExtensionAbility + +InputMethodExtensionAbility模块提供InputMethodExtension服务扩展相关接口的能力。 + +> **说明：** +> +> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> 本模块接口仅可在Stage模型下使用。 + +## 导入模块 + +``` +import InputMethodExtension from '@ohos.inputmethodextensionability'; +``` + +## 属性 + +**系统能力**：SystemCapability.MiscServices.InputMethodFramework + +| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| -------- | -------- | -------- | -------- | -------- | +| context | [InputMethodExtensionContext](js-apis-inputmethod-extension-context.md) | 是 | 否 | InputMethodExtension的上下文环境，继承自ExtensionContext。 | + + +## InputMethodExtensionAbility.onCreate() + +onCreate(want: Want): void; + +Extension生命周期回调，在创建时回调，执行初始化业务逻辑操作。 + +**系统能力**：SystemCapability.MiscServices.InputMethodFramework + +**参数：** + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | want | [Want](js-apis-application-Want.md) | 是 | 当前Extension相关的Want类型信息，包括ability名称、bundle名称等。 | + +**示例：** + + ```js + class InputMethodExt extends InputMethodExtensionAbility { + onCreate(want) { + console.log('onCreate, want:' + want.abilityName); + } + } + ``` + + +## InputMethodExtensionAbility.onDestroy() + +onDestroy(): void; + +Extension生命周期回调，在销毁时回调，执行资源清理等操作。 + +**系统能力**：SystemCapability.MiscServices.InputMethodFramework + +**示例：** + + ```js + class InputMethodExt extends InputMethodExtensionAbility { + onDestroy() { + console.log('onDestroy'); + } + } + ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-inputmethod-extension-context.md b/zh-cn/application-dev/reference/apis/js-apis-inputmethod-extension-context.md new file mode 100644 index 0000000000..dcefb62cde --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-inputmethod-extension-context.md @@ -0,0 +1,163 @@ +# InputMethodExtensionContext + +InputMethodExtensionContext模块是InputMethodExtensionAbility的上下文环境，继承自ExtensionContext。 + +InputMethodExtensionContext模块提供InputMethodExtensionAbility具有的能力和接口，包括启动、停止、绑定、解绑Ability。 + +> **说明：** +> +> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> 本模块接口仅可在Stage模型下使用。 + +## 使用说明 + +在使用InputMethodExtensionContext的功能前，需要通过InputMethodExtensionAbility子类实例获取。 + +```js + import InputMethodExtensionAbility from '@ohos.inputmethodextensionability'; + class MainAbility extends InputMethodExtensionAbility { + onCreate() { + let context = this.context; + } + } +``` + +## startAbility + +startAbility(want: Want, callback: AsyncCallback<void>): void; + +启动Ability。 + +**系统能力**：SystemCapability.MiscServices.InputMethodFramework + +**参数：** + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | want | [Want](js-apis-application-Want.md) | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 | + | callback | AsyncCallback<void> | 否 | 回调函数，返回接口调用是否成功的结果。 | + +**示例：** + + ```js + let want = { + "bundleName": "com.example.myapp", + "abilityName": "MyAbility"}; + this.context.startAbility(want, (err) => { + console.log('startAbility result:' + JSON.stringify(err)); + }); + ``` + +## startAbility + +startAbility(want: Want, options?: StartOptions): Promise\; + +启动Ability。通过Promise返回结果。 + +**系统能力**：SystemCapability.MiscServices.InputMethodFramework + +**参数：** + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | want | [Want](js-apis-application-Want.md) | 是 | Want类型参数，传入需要启动的ability的信息，如ability名称，包名等。 | + | options | [StartOptions](js-apis-application-StartOptions.md) | 是 | 启动Ability所携带的参数。 | + +**返回值：** + + | 类型 | 说明 | + | -------- | -------- | + | Promise<void> | 返回一个Promise，包含接口的结果。 | + +**示例：** + + ```js + let want = { + "bundleName": "com.example.myapp", + "abilityName": "MyAbility" + }; + this.context.startAbility(want).then((data) => { + console.log('success:' + JSON.stringify(data)); + }).catch((error) => { + console.log('failed:' + JSON.stringify(error)); + }); + + ``` + +## startAbility + +startAbility(want: Want, options: StartOptions, callback: AsyncCallback<void>): void + +启动Ability。 + +**系统能力**：SystemCapability.MiscServices.InputMethodFramework + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | +| options | [StartOptions](js-apis-application-StartOptions.md) | 是 | 启动Ability所携带的参数。 | +| callback | AsyncCallback<void> | 是 | callback形式返回启动结果。 | + +**示例：** + + ```js + var want = { + "deviceId": "", + "bundleName": "com.extreme.test", + "abilityName": "MainAbility" + }; + var options = { + windowMode: 0, + }; + this.context.startAbility(want, options, (error) => { + console.log("error.code = " + error.code) + }) + ``` + +## InputMethodExtensionContext.terminateSelf + +terminateSelf(callback: AsyncCallback<void>): void; + +停止Ability自身。 + +**系统能力**：SystemCapability.MiscServices.InputMethodFramework + +**参数：** + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | callback | AsyncCallback<void> | 否 | 回调函数，返回接口调用是否成功的结果。 | + +**示例：** + + ```js + this.context.terminateSelf((err) => { + console.log('terminateSelf result:' + JSON.stringify(err)); + }); + ``` + +## InputMethodExtensionContext.terminateSelf + +terminateSelf(): Promise<void>; + +停止自身。通过Promise返回结果。 + +**系统能力**：SystemCapability.MiscServices.InputMethodFramework + +**返回值：** + + | 类型 | 说明 | + | -------- | -------- | + | Promise<void> | 返回一个Promise，包含接口的结果。 | + +**示例：** + + ```js + this.context.terminateSelf().then((data) => { + console.log('success:' + JSON.stringify(data)); + }).catch((error) => { + console.log('failed:' + JSON.stringify(error)); + }); + ``` -- GitLab