导入模块

import inputMethod from '@ohos.inputMethod';

常量8+

常量值。

系统能力： SystemCapability.MiscServices.InputMethodFramework

InputMethodProperty8+

输入法应用属性。

系统能力： SystemCapability.MiscServices.InputMethodFramework

inputMethod.getController9+

getController(): InputMethodController

获取客户端实例InputMethodController。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

示例：

let inputMethodController = inputMethod.getController();

inputMethod.getSetting9+

getSetting(): InputMethodSetting

获取客户端设置实例InputMethodSetting。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

示例：

let inputMethodSetting = inputMethod.getSetting();

inputMethod.switchInputMethod9+

switchInputMethod(target: InputMethodProperty, callback: AsyncCallback<boolean>): void

切换输入法。使用callback异步回调。

需要权限： ohos.permission.CONNECT_IME_ABILITY，仅系统应用可用。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

示例：

let im = inputMethod.getCurrentInputMethod();
let prop = {
    packageName: im.packageName,
    methodId: im.methodId,
    name: im.packageName,
    id: im.methodId,
    extra: {}
}
try{
    inputMethod.switchInputMethod(prop, (err, result) => {
        if (err !== undefined) {
            console.error('Failed to switchInputMethod: ' + JSON.stringify(err));
            return;
        }
        if (result) {
            console.info('Succeeded in switching inputmethod.');
        } else {
            console.error('Failed to switchInputMethod.');
        }
    });
} catch(err) {
    console.error('Failed to switchInputMethod: ' + JSON.stringify(err));
}

inputMethod.switchInputMethod9+

switchInputMethod(target: InputMethodProperty): Promise<boolean>

切换输入法。使用promise异步回调。

需要权限： ohos.permission.CONNECT_IME_ABILITY，仅系统应用可用。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

返回值：

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

示例：

let im = inputMethod.getCurrentInputMethod();
let prop = {
    packageName: im.packageName,
    methodId: im.methodId,
    name: im.packageName,
    id: im.methodId,
    extra: {}
}
try {
    inputMethod.switchInputMethod(prop).then((result) => {
        if (result) {
            console.info('Succeeded in switching inputmethod.');
        } else {
            console.error('Failed to switchInputMethod.');
        }
    }).catch((err) => {
        console.error('Failed to switchInputMethod: ' + JSON.stringify(err));
    })
} catch(err) {
    console.error('Failed to switchInputMethod: ' + JSON.stringify(err));
}

inputMethod.getCurrentInputMethod9+

getCurrentInputMethod(): InputMethodProperty

获取当前输入法扩展应用，提供同步接口，返回当前输入法属性。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

示例：

let currentIme = inputMethod.getCurrentInputMethod();

inputMethod.switchCurrentInputMethodSubtype9+

switchCurrentInputMethodSubtype(target: InputMethodSubtype, callback: AsyncCallback<boolean>): void

在当前输入法应用内切换子类型。使用callback异步回调。

需要权限： ohos.permission.CONNECT_IME_ABILITY，仅系统应用可用。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

示例：

try {
    inputMethod.switchCurrentInputMethodSubtype({
      id: "ServiceExtAbility",
      label: "",
      name: "com.example.kikakeyboard",
      mode: "upper",
      locale: "",
      language: "",
      icon: "",
      iconId: 0,
      extra: {}
    }, (err, result) => {
        if (err !== undefined) {
            console.error('Failed to switchCurrentInputMethodSubtype: ' + JSON.stringify(err));
            return;
        }
        if (result) {
            console.info('Succeeded in switching currentInputMethodSubtype.');
        } else {
            console.error('Failed to switchCurrentInputMethodSubtype');
        }
    });
} catch(err) {
    console.error('Failed to switchCurrentInputMethodSubtype: ' + JSON.stringify(err));
}

inputMethod.switchCurrentInputMethodSubtype9+

switchCurrentInputMethodSubtype(target: InputMethodSubtype): Promise<boolean>

在当前输入法应用内切换子类型。使用promise异步回调。

需要权限： ohos.permission.CONNECT_IME_ABILITY，仅系统应用可用。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

返回值：

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

示例：

try {
    inputMethod.switchCurrentInputMethodSubtype({
      id: "ServiceExtAbility",
      label: "",
      name: "com.example.kikakeyboard",
      mode: "upper",
      locale: "",
      language: "",
      icon: "",
      iconId: 0,
      extra: {}
    }).then((result) => {
        if (result) {
            console.info('Succeeded in switching currentInputMethodSubtype.');
        } else {
            console.error('Failed to switchCurrentInputMethodSubtype.');
        }
    }).catch((err) => {
        console.error('Failed to switchCurrentInputMethodSubtype: ' + JSON.stringify(err));
    })
} catch(err) {
    console.error('Failed to switchCurrentInputMethodSubtype: ' + JSON.stringify(err));
}

inputMethod.getCurrentInputMethodSubtype9+

getCurrentInputMethodSubtype(): InputMethodSubtype

获取当前输入法子类型。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

示例：

let currentImeSubType = inputMethod.getCurrentInputMethodSubtype();

inputMethod.switchCurrentInputMethodAndSubtype9+

switchCurrentInputMethodAndSubtype(inputMethodProperty: InputMethodProperty, inputMethodSubtype: InputMethodSubtype, callback: AsyncCallback<boolean>): void

切换至指定输入法应用的指定子类型，用于跨输入法应用切换子类型。使用callback异步回调。

需要权限： ohos.permission.CONNECT_IME_ABILITY，仅系统应用可用。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

示例：

let im = inputMethod.getCurrentInputMethod();
let imSubType = inputMethod.getCurrentInputMethodSubtype();
try {
    inputMethod.switchCurrentInputMethodAndSubtype(im, imSubType, (err,result) => {
        if (err !== undefined) {
            console.error('Failed to switchCurrentInputMethodAndSubtype: ' + JSON.stringify(err));
            return;
        }
        if (result) {
            console.info('Succeeded in switching currentInputMethodAndSubtype.');
        } else {
            console.error('Failed to switchCurrentInputMethodAndSubtype.');
        }
    });
} catch (err) {
    console.error('Failed to switchCurrentInputMethodAndSubtype: ' + JSON.stringify(err));
}

inputMethod.switchCurrentInputMethodAndSubtype9+

switchCurrentInputMethodAndSubtype(inputMethodProperty: InputMethodProperty, inputMethodSubtype: InputMethodSubtype): Promise<boolean>

切换至指定输入法应用的指定子类型，用于跨输入法应用切换子类型。使用promise异步回调。

需要权限： ohos.permission.CONNECT_IME_ABILITY，仅系统应用可用。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

返回值：

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

示例：

let im = inputMethod.getCurrentInputMethod();
let imSubType = inputMethod.getCurrentInputMethodSubtype();
try {
    inputMethod.switchCurrentInputMethodAndSubtype(im, imSubType).then((result) => {
        if (result) {
            console.info('Succeeded in switching currentInputMethodAndSubtype.');
        } else {
            console.error('Failed to switchCurrentInputMethodAndSubtype.');
        }
    }).catch((err) => {
        console.error('Failed to switchCurrentInputMethodAndSubtype: ' + JSON.stringify(err));
    })
} catch(err) {
    console.error('Failed to switchCurrentInputMethodAndSubtype: ' + JSON.stringify(err));
}

inputMethod.getInputMethodController(deprecated)

getInputMethodController(): InputMethodController

获取客户端实例InputMethodController。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

示例：

let inputMethodController = inputMethod.getInputMethodController();

inputMethod.getInputMethodSetting(deprecated)

getInputMethodSetting(): InputMethodSetting

获取客户端设置实例InputMethodSetting。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

示例：

let inputMethodSetting = inputMethod.getInputMethodSetting();

InputMethodController

下列API示例中都需使用getController获取到InputMethodController实例，再通过此实例调用对应方法。

stopInputSession9+

stopInputSession(callback: AsyncCallback<boolean>): void

结束输入会话。通过点击输入框实现输入会话的开启之后该接口的调用才可生效。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

示例：

try {
    inputMethodController.stopInputSession((error, result) => {
        if (error !== undefined) {
            console.error('Failed to stopInputSession: ' + JSON.stringify(error));
            return;
        }
        if (result) {
            console.info('Succeeded in stopping inputSession.');
        } else {
            console.error('Failed to stopInputSession.');
        }
    });
} catch(error) {
    console.error('Failed to stopInputSession: ' + JSON.stringify(error));
}

stopInputSession9+

stopInputSession(): Promise<boolean>

结束输入会话。通过点击输入框实现输入会话的开启之后此接口才可生效。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

示例：

try {
    inputMethodController.stopInputSession().then((result) => {
        if (result) {
            console.info('Succeeded in stopping inputSession.');
        } else {
            console.error('Failed to stopInputSession.');
        }
    }).catch((err) => {
        console.error('Failed to stopInputSession: ' + JSON.stringify(err));
    })
} catch(err) {
    console.error('Failed to stopInputSession: ' + JSON.stringify(err));
}

showSoftKeyboard9+

showSoftKeyboard(callback: AsyncCallback<void>): void

显示软键盘。需要与输入框绑定使用。当点击输入框后，才可通过该接口的调用显示出当前输入法的软键盘。使用callback异步回调。

需要权限： ohos.permission.CONNECT_IME_ABILITY，仅系统应用可用。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

示例：

inputMethodController.showSoftKeyboard((err) => {
    if (err === undefined) {
        console.info('Succeeded in showing softKeyboard.');
    } else {
        console.error('Failed to showSoftKeyboard: ' + JSON.stringify(err));
    }
})

showSoftKeyboard9+

showSoftKeyboard(): Promise<void>

显示软键盘。需要与输入框绑定使用。当点击输入框后，才可通过该接口的调用显示出当前输入法的软键盘。使用Promise异步回调。

需要权限： ohos.permission.CONNECT_IME_ABILITY，仅系统应用可用。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

示例：

inputMethodController.showSoftKeyboard().then(() => {
    console.log('Succeeded in showing softKeyboard.');
}).catch((err) => {
    console.error('Failed to showSoftKeyboard: ' + JSON.stringify(err));
});

hideSoftKeyboard9+

hideSoftKeyboard(callback: AsyncCallback<void>): void

隐藏软键盘。需要与输入框绑定使用。点击输入框后，才可以使用该接口的调用隐藏软键盘。使用callback异步回调。

需要权限： ohos.permission.CONNECT_IME_ABILITY，仅系统应用可用。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

示例：

inputMethodController.hideSoftKeyboard((err) => {
    if (err === undefined) {
        console.info('Succeeded in hiding softKeyboard.');
    } else {
        console.error('Failed to hideSoftKeyboard: ' + JSON.stringify(err));
    }
})

hideSoftKeyboard9+

hideSoftKeyboard(): Promise<void>

隐藏软键盘。需要与输入框绑定使用。点击输入框后，才可以使用该接口的调用隐藏软键盘。使用Promise异步回调。

需要权限： ohos.permission.CONNECT_IME_ABILITY，仅系统应用可用。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

示例：

inputMethodController.hideSoftKeyboard().then(() => {
    console.log('Succeeded in hiding softKeyboard.');
}).catch((err) => {
    console.error('Failed to hideSoftKeyboard: ' + JSON.stringify(err));
});

stopInput(deprecated)

stopInput(callback: AsyncCallback<boolean>): void

结束输入会话。通过点击输入框实现输入会话的开启之后该接口的调用才可生效。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

inputMethodController.stopInput((error, result) => {
    if (error !== undefined) {
        console.error('Failed to stopInput: ' + JSON.stringify(error));
        return;
    }
    if (result) {
        console.info('Succeeded in stopping input.');
    } else {
        console.error('Failed to stopInput.');
    }
});

stopInput(deprecated)

stopInput(): Promise<boolean>

结束输入会话。通过点击输入框实现输入会话的开启之后该接口的调用才可生效。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

示例：

inputMethodController.stopInput().then((result) => {
    if (result) {
        console.info('Succeeded in stopping input.');
    } else {
        console.error('Failed to stopInput.');
    }
}).catch((err) => {
    console.error('Failed to stopInput: ' + err);
})

InputMethodSetting8+

下列API示例中都需使用getSetting获取到InputMethodSetting实例，再通过此实例调用对应方法。

on('imeChange')9+

on(type: 'imeChange', callback: (inputMethodProperty: InputMethodProperty, inputMethodSubtype: InputMethodSubtype) => void): void

订阅输入法及子类型变化监听事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

inputMethodSetting.on('imeChange', (inputMethodProperty, inputMethodSubtype) => {
    console.info('Succeeded in subscribing imeChange: inputMethodProperty: ' + JSON.stringify(inputMethodProperty) + " , inputMethodSubtype: " + JSON.stringify(inputMethodSubtype));
});

off('imeChange')9+

off(type: 'imeChange', callback?: (inputMethodProperty: InputMethodProperty, inputMethodSubtype: InputMethodSubtype) => void): void

取消订阅输入法及子类型变化监听事件。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

inputMethodSetting.off('imeChange');

listInputMethodSubtype9+

listInputMethodSubtype(inputMethodProperty: InputMethodProperty, callback: AsyncCallback<Array<InputMethodSubtype>>): void

获取指定输入法应用的所有子类型。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

示例：

let inputMethodProperty = {
    packageName: 'com.example.kikakeyboard',
    methodId: 'com.example.kikakeyboard',
    name: 'com.example.kikakeyboard',
    id: 'com.example.kikakeyboard',
    extra:{}
}
try {
    inputMethodSetting.listInputMethodSubtype(inputMethodProperty, (err,data) => {
        if (err !== undefined) {
            console.error('Failed to listInputMethodSubtype: ' + JSON.stringify(err));
            return;
        }
        console.log('Succeeded in listing inputMethodSubtype.');
    });
} catch (err) {
    console.error('Failed to listInputMethodSubtype: ' + JSON.stringify(err));
}

listInputMethodSubtype9+

listInputMethodSubtype(inputMethodProperty: InputMethodProperty): Promise<Array<InputMethodSubtype>>

获取指定输入法应用的所有子类型。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

返回值：

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

示例：

let inputMethodProperty = {
    packageName: 'com.example.kikakeyboard',
    methodId: 'com.example.kikakeyboard',
    name: 'com.example.kikakeyboard',
    id: 'com.example.kikakeyboard',
    extra:{}
}
try {
    inputMethodSetting.listInputMethodSubtype(inputMethodProperty).then((data) => {
        console.info('Succeeded in listing inputMethodSubtype.');
    }).catch((err) => {
        console.error('Failed to listInputMethodSubtype: ' + JSON.stringify(err));
    })
} catch(err) {
    console.error('Failed to listInputMethodSubtype: ' + JSON.stringify(err));
}

listCurrentInputMethodSubtype9+

listCurrentInputMethodSubtype(callback: AsyncCallback<Array<InputMethodSubtype>>): void

查询当前输入法应用的所有子类型。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

示例：

try {
    inputMethodSetting.listCurrentInputMethodSubtype((err, data) => {
        if (err !== undefined) {
            console.error('Failed to listCurrentInputMethodSubtype: ' + JSON.stringify(err));
            return;
        }
        console.log('Succeeded in listing currentInputMethodSubtype.');
    });
} catch(err) {
    console.error('Failed to listCurrentInputMethodSubtype: ' + JSON.stringify(err));
}

listCurrentInputMethodSubtype9+

listCurrentInputMethodSubtype(): Promise<Array<InputMethodSubtype>>

查询当前输入法的子类型列表。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

示例：

try {
    inputMethodSetting.listCurrentInputMethodSubtype().then((data) => {
        console.info('Succeeded in listing currentInputMethodSubtype.');
    }).catch((err) => {
        console.error('Failed to listCurrentInputMethodSubtype: ' + JSON.stringify(err));
    })
} catch(err) {
    console.error('Failed to listCurrentInputMethodSubtype: ' + JSON.stringify(err));
}

getInputMethods9+

getInputMethods(enable: boolean, callback: AsyncCallback<Array<InputMethodProperty>>): void

获取已激活/未激活输入法列表。参数enable取true，返回已激活输入法列表，取false返回未激活输入法列表。已激活/未激活输入法的确切功能当前版本未支持。当前版本中，已激活输入法包括当前使用的输入法，未激活输入法包括当前输入法以外的其他已安装的输入法。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

示例：

try {
    inputMethodSetting.getInputMethods(true, (err,data) => {
        if (err !== undefined) {
            console.error('Failed to getInputMethods: ' + JSON.stringify(err));
            return;
        }
        console.log('Succeeded in getting inputMethods.');
    });
} catch (err) {
    console.error('Failed to getInputMethods: ' + JSON.stringify(err));
}

getInputMethods9+

getInputMethods(enable: boolean): Promise<Array<InputMethodProperty>>

获取已激活/未激活输入法列表。参数enable取true，返回已激活输入法列表，取false返回未激活输入法列表。已激活/未激活输入法的确切功能当前版本未支持。当前版本中，已激活输入法包括当前使用的输入法，未激活输入法包括当前输入法以外的其他已安装的输入法。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

返回值：

示例：

try {
    inputMethodSetting.getInputMethods(true).then((data) => {
        console.info('Succeeded in getting inputMethods.');
    }).catch((err) => {
        console.error('Failed to getInputMethods: ' + JSON.stringify(err));
    })
} catch(err) {
    console.error('Failed to getInputMethods: ' + JSON.stringify(err));
}

showOptionalInputMethods9+

showOptionalInputMethods(callback: AsyncCallback<boolean>): void

显示输入法选择对话框。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

示例：

try {
    inputMethodSetting.showOptionalInputMethods((err, data) => {
        if (err !== undefined) {
            console.error('Failed to showOptionalInputMethods: ' + JSON.stringify(err));
            return;
        }
        console.info('Succeeded in showing optionalInputMethods.');
    });
} catch (err) {
    console.error('Failed to showOptionalInputMethods: ' + JSON.stringify(err));
}

showOptionalInputMethods9+

showOptionalInputMethods(): Promise<boolean>

显示输入法选择对话框。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

错误码：

以下错误码的详细介绍请参见输入法框架错误码。

示例：

inputMethodSetting.showOptionalInputMethods().then((data) => {
    console.info('Succeeded in showing optionalInputMethods.');
}).catch((err) => {
    console.error('Failed to showOptionalInputMethods: ' + JSON.stringify(err));
})

listInputMethod(deprecated)

listInputMethod(callback: AsyncCallback<Array<InputMethodProperty>>): void

查询已安装的输入法列表。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

inputMethodSetting.listInputMethod((err,data) => {
    if (err !== undefined) {
        console.error('Failed to listInputMethod: ' + JSON.stringify(err));
        return;
    }
    console.log('Succeeded in listing inputMethod.');
 });

listInputMethod(deprecated)

listInputMethod(): Promise<Array<InputMethodProperty>>

查询已安装的输入法列表。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

示例：

inputMethodSetting.listInputMethod().then((data) => {
    console.info('Succeeded in listing inputMethod.');
}).catch((err) => {
    console.error('Failed to listInputMethod: ' + JSON.stringify(err));
})

displayOptionalInputMethod(deprecated)

displayOptionalInputMethod(callback: AsyncCallback<void>): void

显示输入法选择对话框。使用callback异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

参数：

示例：

inputMethodSetting.displayOptionalInputMethod((err) => {
    if (err !== undefined) {
        console.error('Failed to displayOptionalInputMethod: ' + JSON.stringify(err));
        return;
    }
    console.info('Succeeded in displaying optionalInputMethod.');
});

displayOptionalInputMethod(deprecated)

displayOptionalInputMethod(): Promise<void>

显示输入法选择对话框。使用promise异步回调。

系统能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

示例：

inputMethodSetting.displayOptionalInputMethod().then(() => {
    console.info('Succeeded in displaying optionalInputMethod.');
}).catch((err) => {
    console.error('Failed to displayOptionalInputMethod: ' + JSON.stringify(err));
})