!20632 【docs】【需求】新增文本信息获取回调接口

Merge pull request !20632 from cy7717/master

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

@@ -2107,6 +2107,180 @@ off(type: 'selectByMovement'): void
 inputMethodController.off('selectByMovement');
 ```
 
+### on('getLeftTextOfCursor')<sup>10+</sup>
+
+on(type: 'getLeftTextOfCursor', callback: (length: number) => string): void;
+
+订阅输入法应用获取光标左侧指定长度文本事件。使用callback异步回调。
+
+**系统能力：** SystemCapability.MiscServices.InputMethodFramework
+
+**参数：**
+
+| 参数名   | 类型   | 必填 | 说明     |
+| -------- | ----- | ---- | ------ |
+| type     | string  | 是   | 设置监听类型。<br/>- type为‘getLeftTextOfCursor’时表示订阅输入法应用获取光标左侧指定长度文本事件监听。 |
+| callback | (length: number) => string | 是   | 回调函数，获取光标左侧指定长度文本内容。<br/>开发者需要在该函数中，获取编辑框最新状态下光标左侧指定length长度的文本内容并返回。 |
+
+**示例：**
+
+```js
+try {
+  inputMethodController.on('getLeftTextOfCursor', (length) => {
+    console.info(`Succeeded in subscribing getLeftTextOfCursor, length: ${length}`);
+    let text:string = "";
+    return text;
+  });
+} catch(err) {
+  console.error(`Failed to subscribe getLeftTextOfCursor. Code: ${err.code}, message: ${err.message}`);
+}
+```
+
+### off('getLeftTextOfCursor')<sup>10+</sup>
+
+off(type: 'getLeftTextOfCursor', callback?: (length: number) => string): void;
+
+取消订阅输入法应用获取光标左侧指定长度文本事件。使用callback异步回调。
+
+**系统能力：** SystemCapability.MiscServices.InputMethodFramework
+
+**参数：**
+
+| 参数名 | 类型   | 必填 | 说明                                                         |
+| ------ | ------ | ---- | ------------------------------------------------------------ |
+| type   | string | 是   | 设置监听类型。<br/>- type为‘getLeftTextOfCursor’时表示取消订阅输入法应用获取光标左侧指定长度文本事件监听。 |
+| callback | (length: number) => string | 否  | 回调函数，获取光标左侧指定长度文本内容。需要与on接口传入的保持一致。|
+
+**示例：**
+
+```js
+try {
+  inputMethodController.off('getLeftTextOfCursor', (length) => {
+    console.info(`Succeeded in unsubscribing getLeftTextOfCursor, length: ${length}`);
+    let text:string = "";
+    return text;
+  });
+} catch(err) {
+  console.error(`Failed to unsubscribing getLeftTextOfCursor. Code: ${err.code}, message: ${err.message}`);
+}
+```
+
+### on('getRightTextOfCursor')<sup>10+</sup>
+
+on(type: 'getRightTextOfCursor', callback: (length: number) => string): void;
+
+订阅输入法应用获取光标右侧指定长度文本事件。使用callback异步回调。
+
+**系统能力：** SystemCapability.MiscServices.InputMethodFramework
+
+**参数：**
+
+| 参数名   | 类型   | 必填 | 说明     |
+| -------- | ----- | ---- | ------ |
+| type     | string  | 是   | 设置监听类型。<br/>- type为‘getRightTextOfCursor’时表示订阅输入法应用获取光标右侧指定长度文本事件监听。 |
+| callback | (length: number) => string | 是   | 回调函数，获取光标右侧指定长度文本内容。<br/>开发者需要在该函数中，获取编辑框最新状态下光标右侧指定length长度的文本内容并返回。 |
+
+**示例：**
+
+```js
+try {
+  inputMethodController.on('getRightTextOfCursor', (length) => {
+    console.info(`Succeeded in subscribing getRightTextOfCursor, length: ${length}`);
+    let text:string = "";
+    return text;
+  });
+} catch(err) {
+  console.error(`Failed to subscribe getRightTextOfCursor. Code: ${err.code}, message: ${err.message}`);
+}
+```
+
+### off('getRightTextOfCursor')<sup>10+</sup>
+
+off(type: 'getRightTextOfCursor', callback?: (length: number) => string): void;
+
+取消订阅输入法应用获取光标右侧指定长度文本事件。使用callback异步回调。
+
+**系统能力：** SystemCapability.MiscServices.InputMethodFramework
+
+**参数：**
+
+| 参数名 | 类型   | 必填 | 说明                                                         |
+| ------ | ------ | ---- | ------------------------------------------------------------ |
+| type   | string | 是   | 设置监听类型。<br/>- type为‘getRightTextOfCursor’时表示取消订阅输入法应用获取光标右侧指定长度文本事件监听。 |
+| callback | (length: number) => string | 否  | 回调函数，获取光标右侧指定长度文本内容。需要与on接口传入的保持一致。|
+
+**示例：**
+
+```js
+try {
+  inputMethodController.off('getRightTextOfCursor', (length) => {
+    console.info(`Succeeded in unsubscribing getRightTextOfCursor, length: ${length}`);
+    let text:string = "";
+    return text;
+  });
+} catch(err) {
+  console.error(`Failed to unsubscribing getRightTextOfCursor. Code: ${err.code}, message: ${err.message}`);
+}
+```
+
+### on('getTextIndexAtCursor')<sup>10+</sup>
+
+on(type: 'getTextIndexAtCursor', callback: () => number): void;
+
+订阅输入法应用获取光标处文本索引事件。使用callback异步回调。
+
+**系统能力：** SystemCapability.MiscServices.InputMethodFramework
+
+**参数：**
+
+| 参数名   | 类型   | 必填 | 说明     |
+| -------- | ----- | ---- | ------ |
+| type     | string  | 是   | 设置监听类型。<br/>- type为‘getTextIndexAtCursor’时表示订阅输入法应用获取光标处文本索引事件监听。 |
+| callback | () => number | 是   | 回调函数，获取光标处文本索引。<br/>开发者需要在该函数中，获取编辑框最新状态下光标处文本索引并返回。 |
+
+**示例：**
+
+```js
+try {
+  inputMethodController.on('getTextIndexAtCursor', () => {
+    console.info(`Succeeded in subscribing getTextIndexAtCursor.`);
+    let index:number = 0;
+    return index;
+  });
+} catch(err) {
+  console.error(`Failed to subscribe getTextIndexAtCursor. Code: ${err.code}, message: ${err.message}`);
+}
+```
+
+### off('getTextIndexAtCursor')<sup>10+</sup>
+
+off(type: 'getTextIndexAtCursor', callback?: () => number): void;
+
+取消订阅输入法应用获取光标处文本索引事件。使用callback异步回调。
+
+**系统能力：** SystemCapability.MiscServices.InputMethodFramework
+
+**参数：**
+
+| 参数名 | 类型   | 必填 | 说明                                                         |
+| ------ | ------ | ---- | ------------------------------------------------------------ |
+| type   | string | 是   | 设置监听类型。<br/>- type为‘getTextIndexAtCursor’时表示取消订阅输入法应用获取光标处文本索引事件监听。 |
+| callback | () => number | 否  | 回调函数，获取光标处文本索引。需要与on接口传入的保持一致。|
+
+**示例：**
+
+```js
+try {
+  inputMethodController.off('getTextIndexAtCursor', () => {
+    console.info(`Succeeded in unsubscribing getTextIndexAtCursor.`);
+    let index:number = 0;
+    return index;
+  });
+} catch(err) {
+  console.error(`Failed to unsubscribing getTextIndexAtCursor. Code: ${err.code}, message: ${err.message}`);
+}
+```
+
 ## InputMethodSetting<sup>8+</sup>
 
 下列API示例中都需使用[getSetting](#inputmethodgetsetting9)获取到InputMethodSetting实例，再通过此实例调用对应方法。