提交 ae36ff33 编写于 作者: H Hollokin

输入法框架API资料补充

Signed-off-by: NHollokin <taoyuxin2@huawei.com>
上级 1a1ff423
...@@ -40,7 +40,7 @@ Extension生命周期回调,在拉起Extension输入法应用时调用,执 ...@@ -40,7 +40,7 @@ Extension生命周期回调,在拉起Extension输入法应用时调用,执
**示例:** **示例:**
```js ```ts
class InputMethodExt extends InputMethodExtensionAbility { class InputMethodExt extends InputMethodExtensionAbility {
onCreate(want) { onCreate(want) {
console.log('onCreate, want:' + want.abilityName); console.log('onCreate, want:' + want.abilityName);
...@@ -61,7 +61,7 @@ Extension生命周期回调,在销毁输入法应用时回调,执行资源 ...@@ -61,7 +61,7 @@ Extension生命周期回调,在销毁输入法应用时回调,执行资源
**示例:** **示例:**
```js ```ts
class InputMethodExt extends InputMethodExtensionAbility { class InputMethodExt extends InputMethodExtensionAbility {
onDestroy() { onDestroy() {
console.log('onDestroy'); console.log('onDestroy');
...@@ -88,7 +88,7 @@ Extension生命周期回调,在一个输入法extention开始时回调,执 ...@@ -88,7 +88,7 @@ Extension生命周期回调,在一个输入法extention开始时回调,执
**示例:** **示例:**
```js ```ts
class InputMethodExt extends InputMethodExtensionAbility { class InputMethodExt extends InputMethodExtensionAbility {
onRequest(want, startId) { onRequest(want, startId) {
console.log('onRequest, want:' + want.abilityName + 'startId:' + startId); console.log('onRequest, want:' + want.abilityName + 'startId:' + startId);
...@@ -120,7 +120,7 @@ Extension生命周期回调,在输入法extention首次连接输入法ability ...@@ -120,7 +120,7 @@ Extension生命周期回调,在输入法extention首次连接输入法ability
**示例:** **示例:**
```js ```ts
import rpc from '@ohos.rpc' import rpc from '@ohos.rpc'
class StubTest extends rpc.RemoteObject{ class StubTest extends rpc.RemoteObject{
constructor(des) { constructor(des) {
...@@ -155,7 +155,7 @@ Extension生命周期回调,在所有连接在输入法extention上的ability ...@@ -155,7 +155,7 @@ Extension生命周期回调,在所有连接在输入法extention上的ability
**示例:** **示例:**
```js ```ts
class InputMethodExt extends InputMethodExtensionAbility { class InputMethodExt extends InputMethodExtensionAbility {
onDisconnect(want) { onDisconnect(want) {
console.log('onDisconnect, want:' + want.abilityName); console.log('onDisconnect, want:' + want.abilityName);
...@@ -181,7 +181,7 @@ Extension生命周期回调,在一个新的客户端去尝试连接输入法ex ...@@ -181,7 +181,7 @@ Extension生命周期回调,在一个新的客户端去尝试连接输入法ex
**示例:** **示例:**
```js ```ts
class InputMethodExt extends InputMethodExtensionAbility { class InputMethodExt extends InputMethodExtensionAbility {
onReconnect(want) { onReconnect(want) {
console.log('onReconnect, want:' + want.abilityName); console.log('onReconnect, want:' + want.abilityName);
......
...@@ -19,7 +19,7 @@ import InputMethodExtensionContext from '@ohos.inputmethodextensioncontext'; ...@@ -19,7 +19,7 @@ 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() {
...@@ -32,7 +32,9 @@ class MainAbility extends InputMethodExtensionAbility { ...@@ -32,7 +32,9 @@ class MainAbility extends InputMethodExtensionAbility {
startAbility(want: Want, callback: AsyncCallback&lt;void&gt;): void; startAbility(want: Want, callback: AsyncCallback&lt;void&gt;): void;
启动Ability,包含一个Want类型参数。callback形式返回启动结果。 启动Ability。使用callback异步回调。
**模型约束**: 此接口仅可在Stage模型下使用。
**系统能力**:SystemCapability.MiscServices.InputMethodFramework **系统能力**:SystemCapability.MiscServices.InputMethodFramework
...@@ -41,11 +43,11 @@ startAbility(want: Want, callback: AsyncCallback&lt;void&gt;): void; ...@@ -41,11 +43,11 @@ startAbility(want: Want, callback: AsyncCallback&lt;void&gt;): void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| 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; | 是 | 回调函数。当启动Ability成功,err为undefined;否则为错误对象。 |
**示例:** **示例:**
```js ```ts
let want = { let want = {
'bundleName': 'com.example.myapp', 'bundleName': 'com.example.myapp',
'abilityName': 'MyAbility' 'abilityName': 'MyAbility'
...@@ -61,6 +63,8 @@ startAbility(want: Want, options?: StartOptions): Promise\<void>; ...@@ -61,6 +63,8 @@ startAbility(want: Want, options?: StartOptions): Promise\<void>;
启动Ability,包含Want类型参数,以及可选填的StartOption类型参数。通过Promise方法返回结果。 启动Ability,包含Want类型参数,以及可选填的StartOption类型参数。通过Promise方法返回结果。
**模型约束**: 此接口仅可在Stage模型下使用。
**系统能力**:SystemCapability.MiscServices.InputMethodFramework **系统能力**:SystemCapability.MiscServices.InputMethodFramework
**参数:** **参数:**
...@@ -78,7 +82,7 @@ startAbility(want: Want, options?: StartOptions): Promise\<void>; ...@@ -78,7 +82,7 @@ startAbility(want: Want, options?: StartOptions): Promise\<void>;
**示例:** **示例:**
```js ```ts
let want = { let want = {
'bundleName': 'com.example.myapp', 'bundleName': 'com.example.myapp',
'abilityName': 'MyAbility' 'abilityName': 'MyAbility'
...@@ -94,7 +98,9 @@ this.context.startAbility(want).then((data) => { ...@@ -94,7 +98,9 @@ this.context.startAbility(want).then((data) => {
startAbility(want: Want, options: StartOptions, callback: AsyncCallback&lt;void&gt;): void startAbility(want: Want, options: StartOptions, callback: AsyncCallback&lt;void&gt;): void
启动Ability,包含有两个参数,Want类型和StartOption类型参数。callback形式返回启动结果。 启动Ability。使用callback异步回调。
**模型约束**: 此接口仅可在Stage模型下使用。
**系统能力**:SystemCapability.MiscServices.InputMethodFramework **系统能力**:SystemCapability.MiscServices.InputMethodFramework
...@@ -104,11 +110,11 @@ startAbility(want: Want, options: StartOptions, callback: AsyncCallback&lt;void& ...@@ -104,11 +110,11 @@ startAbility(want: Want, options: StartOptions, callback: AsyncCallback&lt;void&
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-Want.md) | 是 | 启动Ability的want信息。 | | 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; | 是 | callback形式返回启动结果。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当启动Ability成功,err为undefined;否则为错误对象。|
**示例:** **示例:**
```js ```ts
let want = { let want = {
'deviceId': '', 'deviceId': '',
'bundleName': 'com.extreme.test', 'bundleName': 'com.extreme.test',
...@@ -126,7 +132,9 @@ this.context.startAbility(want, options, (error) => { ...@@ -126,7 +132,9 @@ this.context.startAbility(want, options, (error) => {
terminateSelf(callback: AsyncCallback&lt;void&gt;): void; terminateSelf(callback: AsyncCallback&lt;void&gt;): void;
停止输入法应用自身,通过Callback方法返回接口调用是否成功。 停止输入法应用自身。使用callback异步回调。
**模型约束**: 此接口仅可在Stage模型下使用。
**系统能力**:SystemCapability.MiscServices.InputMethodFramework **系统能力**:SystemCapability.MiscServices.InputMethodFramework
...@@ -134,11 +142,11 @@ terminateSelf(callback: AsyncCallback&lt;void&gt;): void; ...@@ -134,11 +142,11 @@ terminateSelf(callback: AsyncCallback&lt;void&gt;): void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | -------------------------------------- | | -------- | ------------------------- | ---- | -------------------------------------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数,返回接口调用是否成功的结果。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当启动Ability成功,err为undefined;否则为错误对象。 |
**示例:** **示例:**
```js ```ts
this.context.terminateSelf((err) => { this.context.terminateSelf((err) => {
console.log('terminateSelf result:' + JSON.stringify(err)); console.log('terminateSelf result:' + JSON.stringify(err));
}); });
...@@ -150,6 +158,8 @@ terminateSelf(): Promise&lt;void&gt;; ...@@ -150,6 +158,8 @@ terminateSelf(): Promise&lt;void&gt;;
停止输入法应用自身。通过Promise返回结果。 停止输入法应用自身。通过Promise返回结果。
**模型约束**: 此接口仅可在Stage模型下使用。
**系统能力**:SystemCapability.MiscServices.InputMethodFramework **系统能力**:SystemCapability.MiscServices.InputMethodFramework
**返回值:** **返回值:**
...@@ -160,7 +170,7 @@ terminateSelf(): Promise&lt;void&gt;; ...@@ -160,7 +170,7 @@ terminateSelf(): Promise&lt;void&gt;;
**示例:** **示例:**
```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) => {
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册