# 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; } } ``` ## InputMethodExtensionContext.startAbility startAbility(want: Want, callback: AsyncCallback<void>): void; 启动Ability,包含一个Want类型参数。callback形式返回启动结果。 **系统能力**: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)); }); ``` ## InputMethodExtensionContext.startAbility startAbility(want: Want, options?: StartOptions): Promise\; 启动Ability,包含Want类型参数,以及可选填的StartOption类型参数。通过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)); }); ``` ## InputMethodExtensionContext.startAbility startAbility(want: Want, options: StartOptions, callback: AsyncCallback<void>): void 启动Ability,包含有两个参数,Want类型和StartOption类型参数。callback形式返回启动结果。 **系统能力**: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; 停止输入法应用自身,通过Callback方法返回接口调用是否成功。 **系统能力**: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)); }); ```