输入法模块（ime）

ime 模块约定

参数说明：

参数名	类型	是否必填	默认值	描述
前提	-	-	-	系统设置 → 键盘 → 添加「Auto Click E」键盘，授予完全访问并在输入场景下切换到该键盘；若添加后在切换列表中看不到，可重启设备后再试
调用时机	-	-	-	在已弹出该 Auto Click E 键盘且焦点在输入框时，完成读字、模拟键入、粘贴与剪贴板读写
键盘切换	-	-	-	需手动切换到「Auto Click E」键盘；可用 isOk 轮询确认；其余输入类方法应在键盘已弹出、目标框已聚焦后再调用，否则结果未定义

返回值：

类型	描述
—	本段为模块说明，无运行时返回值

示例：

let ok = ime.isOk();
if (ok) {
 logger.debug('ime 模块约定：当前为 Auto Click E 键盘', ok);
}else{
 logger.debug('ime 模块约定：当前非 Auto Click E 键盘', ok);
}

---

ime.isOk - 是否为 Auto Click E 键盘

function ime.isOk(): Promise<boolean>;

参数说明：

参数名	类型	是否必填	默认值	描述
（无）	-	-	-	无参数（判断当前是否已弹出「Auto Click E」键盘，可轮询后再调用 input 等）

返回值：

类型	描述
Promise<boolean>	true 表示当前为已弹出的 Auto Click E 键盘；否则 false

示例：

let ok = ime.isOk();
if (ok) {
 logger.debug('是否为 Auto Click E 键盘 ime.isOk：是', ok);
}else{
 logger.debug('是否为 Auto Click E 键盘 ime.isOk：否', ok);
}

---

ime.getText - 读取输入框文本

function ime.getText(): Promise<string>;

参数说明：

参数名	类型	是否必填	默认值	描述
（无）	-	-	-	无参数

返回值：

类型	描述
Promise<string>	当前框内文本

示例：

let t = ime.getText();
logger.debug('读取输入框 ime.getText：', t);

---

ime.clearText - 清空输入框

function ime.clearText(): Promise<boolean>;

参数说明：

参数名	类型	是否必填	默认值	描述
（无）	-	-	-	无参数

返回值：

类型	描述
Promise<boolean>	成功 true；失败 false

示例：

let clearOk = ime.clearText();
if (clearOk) {
 logger.debug('清空输入框 ime.clearText 成功：', clearOk);
}else{
 logger.debug('清空输入框 ime.clearText 失败：', clearOk);
}

---

ime.input - 模拟逐字输入

function ime.input(
 text: string,
 sleep?: number,
): Promise<string>;

参数说明：

参数名	类型	是否必填	默认值	描述
text	string	是	-	要输入的字符串
sleep	number	否	-	大于 0 时生效：单位为毫秒，每输入一个字符后等待再输入下一个（首字前不等待）

返回值：

类型	描述
Promise<string>	输入完成后框内文本；失败时常为空串 ""

示例：

let after = ime.input('hello');
logger.debug('逐字输入 ime.input：', after);

const slow = ime.input('hello', 200);
logger.debug('逐字输入 ime.input（延时）：', slow);

---

ime.paste - 粘贴

function ime.paste(
 content?: string,
): Promise<string>;

参数说明：

参数名	类型	是否必填	默认值	描述
content	string	否	-	要粘贴的文本；不传则用剪贴板已有内容

返回值：

类型	描述
Promise<string>	粘贴后框内文本

示例：

let t1 = ime.paste();
logger.debug('粘贴剪贴板 ime.paste：', t1);

const t2 = ime.paste('预设内容');
logger.debug('粘贴指定内容 ime.paste：', t2);

---

ime.pressDel - 退格一次

function ime.pressDel(): Promise<string>;

参数说明：

参数名	类型	是否必填	默认值	描述
（无）	-	-	-	无参数

返回值：

类型	描述
Promise<string>	删除后剩余文本

示例：

let rest = ime.pressDel();
logger.debug('退格 ime.pressDel：', rest);

---

ime.pressEnter - 回车

function ime.pressEnter(): Promise<boolean>;

参数说明：

参数名	类型	是否必填	默认值	描述
（无）	-	-	-	无参数

返回值：

类型	描述
Promise<boolean>	成功 true；失败 false

示例：

let enterOk = ime.pressEnter();
if (enterOk) {
 logger.debug('回车 ime.pressEnter 成功：', enterOk);
}else{
 logger.debug('回车 ime.pressEnter 失败：', enterOk);
}

---

ime.dismiss - 收起键盘

function ime.dismiss(): Promise<boolean>;

参数说明：

参数名	类型	是否必填	默认值	描述
（无）	-	-	-	无参数

返回值：

类型	描述
Promise<boolean>	成功 true；失败 false

示例：

let dismissOk = ime.dismiss();
if (dismissOk) {
 logger.debug('收起键盘 ime.dismiss 成功：', dismissOk);
}else{
 logger.debug('收起键盘 ime.dismiss 失败：', dismissOk);
}

---

ime.getClipboard - 读剪贴板

function ime.getClipboard(): Promise<string>;

参数说明：

参数名	类型	是否必填	默认值	描述
（无）	-	-	-	无参数

返回值：

类型	描述
Promise<string>	剪贴板文本

示例：

let c = ime.getClipboard();
logger.debug('读剪贴板 ime.getClipboard：', c);

---

ime.setClipboard - 写剪贴板

function ime.setClipboard(
 text: string,
): Promise<boolean>;

参数说明：

参数名	类型	是否必填	默认值	描述
text	string	是	-	要写入的文本

返回值：

类型	描述
Promise<boolean>	成功 true；失败 false

示例：

let clipOk = ime.setClipboard('copy me');
if (clipOk) {
 logger.debug('写剪贴板 ime.setClipboard 成功：', clipOk);
}else{
 logger.debug('写剪贴板 ime.setClipboard 失败：', clipOk);
}