未验证 提交 149a4cbb 编写于 作者: 葛亚芳 提交者: Gitee

update zh-cn/application-dev/reference/apis/js-apis-inputmethod-extension-context.md.

Signed-off-by: N葛亚芳 <geyafang@huawei.com>
上级 478083a2
...@@ -5,13 +5,14 @@ InputMethodExtensionContext模块是InputMethodExtensionAbility的上下文环 ...@@ -5,13 +5,14 @@ InputMethodExtensionContext模块是InputMethodExtensionAbility的上下文环
InputMethodExtensionContext模块提供InputMethodExtensionAbility具有的能力和接口,包括启动、停止、绑定、解绑Ability。 InputMethodExtensionContext模块提供InputMethodExtensionAbility具有的能力和接口,包括启动、停止、绑定、解绑Ability。
> **说明:** > **说明:**
> >
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
> 本模块接口仅可在Stage模型下使用。 > 本模块接口仅可在Stage模型下使用。
## 导入模块 ## 导入模块
``` ```ts
import InputMethodExtensionContext from '@ohos.inputmethodextensioncontext'; import InputMethodExtensionContext from '@ohos.inputmethodextensioncontext';
``` ```
...@@ -19,151 +20,151 @@ import InputMethodExtensionContext from '@ohos.inputmethodextensioncontext'; ...@@ -19,151 +20,151 @@ import InputMethodExtensionContext from '@ohos.inputmethodextensioncontext';
在使用InputMethodExtensionContext的功能前,需要通过InputMethodExtensionAbility子类实例获取。 在使用InputMethodExtensionContext的功能前,需要通过InputMethodExtensionAbility子类实例获取。
```js ```ts
import InputMethodExtensionAbility from '@ohos.inputmethodextensionability'; import InputMethodExtensionAbility from '@ohos.inputmethodextensionability';
class MainAbility extends InputMethodExtensionAbility { class MainAbility extends InputMethodExtensionAbility {
onCreate() { onCreate() {
let context = this.context; let context = this.context;
} }
} }
``` ```
## InputMethodExtensionContext.startAbility ## InputMethodExtensionContext.startAbility
startAbility(want: Want, callback: AsyncCallback&lt;void&gt;): void; startAbility(want: Want, callback: AsyncCallback&lt;void&gt;): void
启动Ability,包含一个Want类型参数。callback形式返回启动结果 启动Ability。使用callback异步回调
**系统能力**SystemCapability.MiscServices.InputMethodFramework **系统能力:** SystemCapability.MiscServices.InputMethodFramework
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | Want类型参数,传入需要启动的ability的信息,如ability名称,包名等。 | | want | [Want](js-apis-application-Want.md) | 是 | Want类型参数,传入需要启动的ability的信息,如ability名称,包名等。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数,返回接口调用是否成功的结果。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
**示例:** **示例:**
```js ```ts
let want = { let want = {
'bundleName': 'com.example.myapp', 'bundleName': 'com.example.myapp',
'abilityName': 'MyAbility'}; 'abilityName': 'MyAbility'
this.context.startAbility(want, (err) => { };
console.log('startAbility result:' + JSON.stringify(err)); this.context.startAbility(want, (err) => {
}); console.log('startAbility result:' + JSON.stringify(err));
``` });
```
## InputMethodExtensionContext.startAbility ## InputMethodExtensionContext.startAbility
startAbility(want: Want, options?: StartOptions): Promise\<void>; startAbility(want: Want, options: StartOptions, callback: AsyncCallback&lt;void&gt;): void
启动Ability,包含Want类型参数,以及可选填的StartOption类型参数。通过Promise方法返回结果 启动Ability。使用callback异步回调
**系统能力**SystemCapability.MiscServices.InputMethodFramework **系统能力:** SystemCapability.MiscServices.InputMethodFramework
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | Want类型参数,传入需要启动的ability的信息,如ability名称,包名等。 | | want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 |
| options | [StartOptions](js-apis-application-StartOptions.md) | 否 | 启动Ability所携带的参数。 | | options | [StartOptions](js-apis-application-StartOptions.md) | 是 | 启动Ability所携带的参数。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | 返回一个Promise,包含接口的结果。 |
**示例:** **示例:**
```js ```ts
let want = { let want = {
'bundleName': 'com.example.myapp', 'deviceId': '',
'abilityName': 'MyAbility' 'bundleName': 'com.extreme.test',
}; 'abilityName': 'MainAbility'
this.context.startAbility(want).then((data) => { };
console.log('success:' + JSON.stringify(data)); let options = {
}).catch((error) => { windowMode: 0,
console.log('failed:' + JSON.stringify(error)); };
}); this.context.startAbility(want, options, (error) => {
console.log('error.code = ' + error.code)
``` })
```
## InputMethodExtensionContext.startAbility ## InputMethodExtensionContext.startAbility
startAbility(want: Want, options: StartOptions, callback: AsyncCallback&lt;void&gt;): void startAbility(want: Want, options?: StartOptions): Promise\<void>
启动Ability,包含有两个参数,Want类型和StartOption类型参数。callback形式返回启动结果 启动Ability。使用Promise异步回调
**系统能力**SystemCapability.MiscServices.InputMethodFramework **系统能力:** SystemCapability.MiscServices.InputMethodFramework
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | | want | [Want](js-apis-application-Want.md) | 是 | Want类型参数,传入需要启动的ability的信息,如ability名称,包名等。 |
| options | [StartOptions](js-apis-application-StartOptions.md) | 是 | 启动Ability所携带的参数。 | | options | [StartOptions](js-apis-application-StartOptions.md) | 否 | 启动Ability所携带的参数。 |
| callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回启动结果。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | 无结果的Promise对象。 |
**示例:** **示例:**
```js ```ts
var want = { let want = {
'deviceId': '', 'bundleName': 'com.example.myapp',
'bundleName': 'com.extreme.test', 'abilityName': 'MyAbility'
'abilityName': 'MainAbility' };
}; this.context.startAbility(want).then((data) => {
var options = { console.log('success:' + JSON.stringify(data));
windowMode: 0, }).catch((error) => {
}; console.log('failed:' + JSON.stringify(error));
this.context.startAbility(want, options, (error) => { });
console.log('error.code = ' + error.code) ```
})
```
## InputMethodExtensionContext.terminateSelf ## InputMethodExtensionContext.terminateSelf
terminateSelf(callback: AsyncCallback&lt;void&gt;): void; terminateSelf(callback: AsyncCallback&lt;void&gt;): void
停止输入法应用自身,通过Callback方法返回接口调用是否成功 停止输入法应用自身。使用callback异步回调
**系统能力**SystemCapability.MiscServices.InputMethodFramework **系统能力:** SystemCapability.MiscServices.InputMethodFramework
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | -------------------------------------- | | -------- | ------------------------- | ---- | ---------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数,返回接口调用是否成功的结果。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
**示例:** **示例:**
```js ```ts
this.context.terminateSelf((err) => { this.context.terminateSelf((err) => {
console.log('terminateSelf result:' + JSON.stringify(err)); console.log('terminateSelf result:' + JSON.stringify(err));
}); });
``` ```
## InputMethodExtensionContext.terminateSelf ## InputMethodExtensionContext.terminateSelf
terminateSelf(): Promise&lt;void&gt;; terminateSelf(): Promise&lt;void&gt;
停止输入法应用自身。通过Promise返回结果 停止输入法应用自身。使用Promise异步回调
**系统能力**SystemCapability.MiscServices.InputMethodFramework **系统能力:** SystemCapability.MiscServices.InputMethodFramework
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | -------- | -------- |
| Promise&lt;void&gt; | 返回一个Promise,包含接口的结果。 | | Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**示例:** **示例:**
```js ```ts
this.context.terminateSelf().then((data) => { this.context.terminateSelf().then((data) => {
console.log('success:' + JSON.stringify(data)); console.log('success:' + JSON.stringify(data));
}).catch((error) => { }).catch((error) => {
console.log('failed:' + JSON.stringify(error)); console.log('failed:' + JSON.stringify(error));
}); });
``` ```
\ No newline at end of file
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册