輸入法服務

導入模塊

import inputMethodEngine from '@ohos.inputMethodEngine';

常量

功能鍵常量值、編輯框常量值及光標常量值。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

inputMethodEngine.getInputMethodAbility9+

getInputMethodAbility(): InputMethodAbility

獲取服務端實例。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

示例：

let InputMethodAbility = inputMethodEngine.getInputMethodAbility();

inputMethodEngine.getKeyboardDelegate9+

getKeyboardDelegate(): KeyboardDelegate

獲取客戶端監(jiān)聽實例。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

示例：

let KeyboardDelegate = inputMethodEngine.getKeyboardDelegate();

inputMethodEngine.getInputMethodEngine(deprecated)

getInputMethodEngine(): InputMethodEngine

獲取服務端實例。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

示例：

let InputMethodEngine = inputMethodEngine.getInputMethodEngine();

inputMethodEngine.createKeyboardDelegate(deprecated)

createKeyboardDelegate(): KeyboardDelegate

獲取客戶端監(jiān)聽實例。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

示例：

let keyboardDelegate = inputMethodEngine.createKeyboardDelegate();

InputMethodEngine

下列API示例中都需使用getInputMethodEngine回調獲取到InputMethodEngine實例，再通過此實例調用對應方法。

on('inputStart')

on(type: 'inputStart', callback: (kbController: KeyboardController, textInputClient: TextInputClient) => void): void

訂閱輸入法綁定成功事件。使用callback異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

示例：

inputMethodEngine.getInputMethodEngine().on('inputStart', (kbController, textClient) => {
    let keyboardController = kbController;
    let textInputClient = textClient;
});

off('inputStart')

off(type: 'inputStart', callback?: (kbController: KeyboardController, textInputClient: TextInputClient) => void): void

取消訂閱輸入法綁定成功事件。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

示例：

inputMethodEngine.getInputMethodEngine().off('inputStart', (kbController, textInputClient) => {
    console.log('delete inputStart notification.');
});

on('keyboardShow'|'keyboardHide')

on(type: 'keyboardShow'|'keyboardHide', callback: () => void): void

訂閱輸入法事件。使用callback異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

示例：

inputMethodEngine.getInputMethodEngine().on('keyboardShow', () => {
    console.log('inputMethodEngine keyboardShow.');
});
inputMethodEngine.getInputMethodEngine().on('keyboardHide', () => {
    console.log('inputMethodEngine keyboardHide.');
});

off('keyboardShow'|'keyboardHide')

off(type: 'keyboardShow'|'keyboardHide', callback?: () => void): void

取消訂閱輸入法事件。使用callback異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

示例：

inputMethodEngine.getInputMethodEngine().off('keyboardShow');
inputMethodEngine.getInputMethodEngine().off('keyboardHide');

InputMethodAbility

下列API示例中都需使用getInputMethodAbility回調獲取到InputMethodAbility實例，再通過此實例調用對應方法。

on('inputStart')9+

on(type: 'inputStart', callback: (kbController: KeyboardController, inputClient: InputClient) => void): void

訂閱輸入法綁定成功事件。使用callback異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

示例：

inputMethodEngine.getInputMethodAbility().on('inputStart', (kbController, client) => {
    let keyboardController = kbController;
    let inputClient = client;
});

off('inputStart')9+

off(type: 'inputStart', callback?: (kbController: KeyboardController, inputClient: InputClient) => void): void

取消訂閱輸入法綁定成功事件。使用callback異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

示例：

inputMethodEngine.getInputMethodAbility().off('inputStart');

on('inputStop')9+

on(type: 'inputStop', callback: () => void): void

訂閱停止輸入法應用事件。使用callback異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

示例：

inputMethodEngine.getInputMethodAbility().on('inputStop', () => {
    console.log('inputMethodAbility inputStop');
});

off('inputStop')9+

off(type: 'inputStop', callback: () => void): void

取消訂閱停止輸入法應用事件。使用callback異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

示例：

inputMethodEngine.getInputMethodAbility().off('inputStop', () => {
    console.log('inputMethodAbility delete inputStop notification.');
});

on('setCallingWindow')9+

on(type: 'setCallingWindow', callback: (wid: number) => void): void

訂閱設置調用窗口事件。使用callback異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

示例：

inputMethodEngine.getInputMethodAbility().on('setCallingWindow', (wid) => {
    console.log('inputMethodAbility setCallingWindow');
});

off('setCallingWindow')9+

off(type: 'setCallingWindow', callback: (wid:number) => void): void

取消訂閱設置調用窗口事件。使用callback異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

示例：

inputMethodEngine.getInputMethodAbility().off('setCallingWindow', () => {
    console.log('inputMethodAbility delete setCallingWindow notification.');
});

on('keyboardShow'|'keyboardHide')9+

on(type: 'keyboardShow'|'keyboardHide', callback: () => void): void

訂閱輸入法事件。使用callback異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

示例：

inputMethodEngine.getInputMethodAbility().on('keyboardShow', () => {
    console.log('InputMethodAbility keyboardShow.');
});
inputMethodEngine.getInputMethodAbility().on('keyboardHide', () => {
    console.log('InputMethodAbility keyboardHide.');
});

off('keyboardShow'|'keyboardHide')9+

off(type: 'keyboardShow'|'keyboardHide', callback?: () => void): void

取消訂閱輸入法事件。使用callback異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

示例：

inputMethodEngine.getInputMethodAbility().off('keyboardShow', () => {
    console.log('InputMethodAbility delete keyboardShow notification.');
});
inputMethodEngine.getInputMethodAbility().off('keyboardHide', () => {
    console.log('InputMethodAbility delete keyboardHide notification.');
});

on('setSubtype')9+

on(type: 'setSubtype', callback: (inputMethodSubtype: InputMethodSubtype) => void): void

訂閱設置輸入法子類型事件。使用callback異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

示例：

inputMethodEngine.getInputMethodAbility().on('setSubtype', (inputMethodSubtype) => {
    console.log('InputMethodAbility setSubtype.');
});

off('setSubtype')9+

off(type: 'setSubtype', callback?: (inputMethodSubtype: InputMethodSubtype) => void): void

取消訂閱輸入法子類型事件。使用callback異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

示例：

inputMethodEngine.getInputMethodAbility().off('setSubtype', () => {
    console.log('InputMethodAbility delete setSubtype notification.');
});

KeyboardDelegate

下列API示例中都需使用getKeyboardDelegate回調獲取到KeyboardDelegate實例，再通過此實例調用對應方法。

on('keyDown'|'keyUp')

on(type: 'keyDown'|'keyUp', callback: (event: KeyEvent) => boolean): void

訂閱硬鍵盤（即物理鍵盤）事件。使用callback異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

示例：

inputMethodEngine.getKeyboardDelegate().on('keyUp', (keyEvent) => {
    console.info('inputMethodEngine keyCode.(keyUp):' + JSON.stringify(keyEvent.keyCode));
    console.info('inputMethodEngine keyAction.(keyUp):' + JSON.stringify(keyEvent.keyAction));
    return true;
});
inputMethodEngine.getKeyboardDelegate().on('keyDown', (keyEvent) => {
    console.info('inputMethodEngine keyCode.(keyDown):' + JSON.stringify(keyEvent.keyCode));
    console.info('inputMethodEngine keyAction.(keyDown):' + JSON.stringify(keyEvent.keyAction));
    return true;
});

off('keyDown'|'keyUp')

off(type: 'keyDown'|'keyUp', callback?: (event: KeyEvent) => boolean): void

取消訂閱硬鍵盤（即物理鍵盤）事件。使用callback異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

示例：

inputMethodEngine.getKeyboardDelegate().off('keyUp', (keyEvent) => {
    console.log('delete keyUp notification.');
    return true;
});
inputMethodEngine.getKeyboardDelegate().off('keyDown', (keyEvent) => {
    console.log('delete keyDown notification.');
    return true;
});

on('cursorContextChange')

on(type: 'cursorContextChange', callback: (x: number, y:number, height:number) => void): void

訂閱光標變化事件。使用callback異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

示例：

inputMethodEngine.getKeyboardDelegate().on('cursorContextChange', (x, y, height) => {
    console.log('inputMethodEngine cursorContextChange x:' + x);
    console.log('inputMethodEngine cursorContextChange y:' + y);
    console.log('inputMethodEngine cursorContextChange height:' + height);
});

off('cursorContextChange')

off(type: 'cursorContextChange', callback?: (x: number, y: number, height: number) => void): void

取消訂閱光標變化事件。使用callback異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

示例：

inputMethodEngine.getKeyboardDelegate().off('cursorContextChange', (x, y, height) => {
    console.log('delete cursorContextChange notification.');
});

on('selectionChange')

on(type: 'selectionChange', callback: (oldBegin: number, oldEnd: number, newBegin: number, newEnd: number) => void): void

訂閱文本選擇變化事件。使用callback異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

示例：

inputMethodEngine.getKeyboardDelegate().on('selectionChange', (oldBegin, oldEnd, newBegin, newEnd) => {
    console.log('inputMethodEngine beforeEach selectionChange oldBegin:' + oldBegin);
    console.log('inputMethodEngine beforeEach selectionChange oldEnd:' + oldEnd);
    console.log('inputMethodEngine beforeEach selectionChange newBegin:' + newBegin);
    console.log('inputMethodEngine beforeEach selectionChange newEnd:' + newEnd);
});

off('selectionChange')

off(type: 'selectionChange', callback?: (oldBegin: number, oldEnd: number, newBegin: number, newEnd: number) => void): void

取消訂閱文本選擇變化事件。使用callback異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

示例：

inputMethodEngine.getKeyboardDelegate().off('selectionChange', (oldBegin, oldEnd, newBegin, newEnd) => {
  console.log('delete selectionChange notification.');
});

on('textChange')

on(type: 'textChange', callback: (text: string) => void): void

訂閱文本變化事件。使用callback異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

示例：

inputMethodEngine.getKeyboardDelegate().on('textChange', (text) => {
    console.log('inputMethodEngine textChange. text:' + text);
});

off('textChange')

off(type: 'textChange', callback?: (text: string) => void): void

取消訂閱文本變化事件。使用callback異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

示例：

inputMethodEngine.getKeyboardDelegate().off('textChange', (text) => {
    console.log('delete textChange notification. text:' + text);
});

KeyboardController

下列API示例中都需使用on('inputStart')回調獲取到KeyboardController實例，再通過此實例調用對應方法。

hide9+

hide(callback: AsyncCallback<void>): void

隱藏輸入法。使用callback異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

錯誤碼：

以下錯誤碼的詳細介紹請參見輸入法框架錯誤碼。

示例：

keyboardController.hide((err) => {
    if (err !== undefined) {
        console.error('Failed to hide keyboard: ' + JSON.stringify(err));
        return;
    }
    console.log('Succeeded in hiding keyboard.');
});

hide9+

hide(): Promise<void>

隱藏輸入法。使用promise異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

錯誤碼：

以下錯誤碼的詳細介紹請參見輸入法框架錯誤碼。

示例：

keyboardController.hide().then(() => {
    console.info('Succeeded in hiding keyboard.');
}).catch((err) => {
    console.info('Failed to hide keyboard: ' + JSON.stringify(err));
});

hideKeyboard(deprecated)

hideKeyboard(callback: AsyncCallback<void>): void

隱藏輸入法。使用callback異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

示例：

keyboardController.hideKeyboard((err) => {
    if (err !== undefined) {
        console.error('Failed to hide Keyboard: ' + JSON.stringify(err));
        return;
    }
    console.log('Succeeded in hiding keyboard.');
});

hideKeyboard(deprecated)

hideKeyboard(): Promise<void>

隱藏輸入法。使用promise異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

示例：

keyboardController.hideKeyboard().then(() => {
    console.info('Succeeded in hiding keyboard.');
}).catch((err) => {
    console.info('Failed to hide Keyboard: ' + JSON.stringify(err));
});

InputClient9+

下列API示例中都需使用on('inputStart')回調獲取到InputClient實例，再通過此實例調用對應方法。

sendKeyFunction9+

sendKeyFunction(action:number, callback: AsyncCallback<boolean>): void

發(fā)送功能鍵。使用callback異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

錯誤碼：

以下錯誤碼的詳細介紹請參見輸入法框架錯誤碼。

示例：

let action = 1;
try {
    inputClient.sendKeyFunction(action, (err, result) => {
        if (err !== undefined) {
            console.error('Failed to sendKeyFunction: ' + JSON.stringify(err));
            return;
        }
        if (result) {
            console.info('Succeeded in sending key function. ');
        } else {
            console.error('Failed to sendKeyFunction. ');
        }
    });
} catch (err) {
    console.error('sendKeyFunction err: ' + JSON.stringify(err));
}

sendKeyFunction9+

sendKeyFunction(action: number): Promise<boolean>

發(fā)送功能鍵。使用promise異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

返回值：

錯誤碼：

以下錯誤碼的詳細介紹請參見輸入法框架錯誤碼。

示例：

let action = 1;
try {
    inputClient.sendKeyFunction(action).then((result) => {
        if (result) {
            console.info('Succeeded in sending key function. ');
        } else {
            console.error('Failed to sendKeyFunction. ');
        }
    }).catch((err) => {
        console.error('Failed to sendKeyFunction:' + JSON.stringify(err));
    });
} catch (err) {
    console.error('Failed to sendKeyFunction: ' + JSON.stringify(err));
}

getForward9+

getForward(length:number, callback: AsyncCallback<string>): void

獲取光標前固定長度的文本。使用callback異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

錯誤碼：

以下錯誤碼的詳細介紹請參見輸入法框架錯誤碼。

示例：

let length = 1;
try {
    inputClient.getForward(length, (err, text) => {
        if (err !== undefined) {
            console.error('Failed to getForward: ' + JSON.stringify(err));
            return;
        }
        console.log('Succeeded in getting forward, text: ' + text);
    });
} catch (err) {
    console.error('Failed to getForward: ' + JSON.stringify(err));
}

getForward9+

getForward(length:number): Promise<string>

獲取光標前固定長度的文本。使用promise異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

返回值：

錯誤碼：

以下錯誤碼的詳細介紹請參見輸入法框架錯誤碼。

示例：

let length = 1;
try {
    inputClient.getForward(length).then((text) => {
        console.info('Succeeded in getting forward, text: ' + text);
    }).catch((err) => {
        console.error('Failed to getForward: ' + JSON.stringify(err));
    });
} catch (err) {
    console.error('Failed to getForward: ' + JSON.stringify(err));
}

getBackward9+

getBackward(length:number, callback: AsyncCallback<string>): void

獲取光標后固定長度的文本。使用callback異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

錯誤碼：

以下錯誤碼的詳細介紹請參見輸入法框架錯誤碼。

示例：

let length = 1;
try {
    inputClient.getBackward(length, (err, text) => {
        if (err !== undefined) {
            console.error('Failed to getForward: ' + JSON.stringify(err));
            return;
        }
        console.log('Succeeded in getting backward, text: ' + text);
    });
} catch (err) {
    console.error('Failed to getForward: ' + JSON.stringify(err));
}

getBackward9+

getBackward(length:number): Promise<string>

獲取光標后固定長度的文本。使用promise異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

返回值：

錯誤碼：

以下錯誤碼的詳細介紹請參見輸入法框架錯誤碼。

示例：

let length = 1;
try {
    inputClient.getBackward(length).then((text) => {
        console.info('Succeeded in getting backward, text: ' + text);
    }).catch((err) => {
        console.error('Failed to getForward: ' + JSON.stringify(err));
    });
} catch (err) {
    console.error('Failed to getForward: ' + JSON.stringify(err));
}

deleteForward9+

deleteForward(length:number, callback: AsyncCallback<boolean>): void

刪除光標前固定長度的文本。使用callback異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

錯誤碼：

以下錯誤碼的詳細介紹請參見輸入法框架錯誤碼。

示例：

let length = 1;
try {
    inputClient.deleteForward(length, (err, result) => {
        if (err !== undefined) {
            console.error('Failed to delete forward: ' + JSON.stringify(err));
            return;
        }
        if (result) {
            console.info('Succeeded in deleting forward. ');
        } else {
            console.error('Failed to delete forward: ' + JSON.stringify(err));
        }
    });
} catch (err) {
    console.error('Failed to delete forward: ' + JSON.stringify(err));
}

deleteForward9+

deleteForward(length:number): Promise<boolean>

刪除光標前固定長度的文本。使用promise異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

返回值：

錯誤碼：

以下錯誤碼的詳細介紹請參見輸入法框架錯誤碼。

示例：

let length = 1;
try {
    inputClient.deleteForward(length).then((result) => {
        if (result) {
            console.info('Succeeded in deleting forward. ');
        } else {
            console.error('Failed to delete Forward. ');
        }
    }).catch((err) => {
        console.error('Failed to delete Forward: ' + JSON.stringify(err));
    });
} catch (err) {
    console.error('Failed to delete Forward: ' + JSON.stringify(err));
}

deleteBackward9+

deleteBackward(length:number, callback: AsyncCallback<boolean>): void

刪除光標后固定長度的文本。使用callback異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

錯誤碼：

以下錯誤碼的詳細介紹請參見輸入法框架錯誤碼。

示例：

let length = 1;
try {
    inputClient.deleteBackward(length, (err, result) => {
        if (err !== undefined) {
            console.error('Failed to delete Backward: ' + JSON.stringify(err));
            return;
        }
        if (result) {
            console.info('Succeeded in deleting backward. ');
        } else {
            console.error('Failed to delete Backward: ' + JSON.stringify(err));
        }
    });
} catch (err) {
    console.error('deleteBackward err: ' + JSON.stringify(err));
}

deleteBackward9+

deleteBackward(length:number): Promise<boolean>

刪除光標后固定長度的文本。使用promise異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

返回值：

錯誤碼：

以下錯誤碼的詳細介紹請參見輸入法框架錯誤碼。

示例：

let length = 1;
inputClient.deleteBackward(length).then((result) => {
    if (result) {
        console.info('Succeeded in deleting backward. ');
    } else {
        console.error('Failed to deleteBackward. ');
    }
}).catch((err) => {
    console.error('Failed to deleteBackward: ' + JSON.stringify(err));
});

insertText9+

insertText(text:string, callback: AsyncCallback<boolean>): void

插入文本。使用callback異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

錯誤碼：

以下錯誤碼的詳細介紹請參見輸入法框架錯誤碼。

示例：

inputClient.insertText('test', (err, result) => {
    if (err !== undefined) {
        console.error('Failed to insertText: ' + JSON.stringify(err));
        return;
    }
    if (result) {
        console.info('Succeeded in inserting text. ');
    } else {
        console.error('Failed to insertText. ');
    }
});

insertText9+

insertText(text:string): Promise<boolean>

插入文本。使用promise異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

返回值：

錯誤碼：

以下錯誤碼的詳細介紹請參見輸入法框架錯誤碼。

示例：

try {
    inputClient.insertText('test').then((result) => {
        if (result) {
            console.info('Succeeded in inserting text. ');
        } else {
            console.error('Failed to insertText. ');
        }
    }).catch((err) => {
        console.error('Failed to insertText: ' + JSON.stringify(err));
    });
} catch (err) {
    console.error('Failed to insertText: ' + JSON.stringify(err));
}

getEditorAttribute9+

getEditorAttribute(callback: AsyncCallback<EditorAttribute>): void

獲取編輯框屬性值。使用callback異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

錯誤碼：

以下錯誤碼的詳細介紹請參見輸入法框架錯誤碼。

示例：

inputClient.getEditorAttribute((err, editorAttribute) => {
    if (err !== undefined) {
        console.error('Failed to getEditorAttribute: ' + JSON.stringify(err));
        return;
    }
    console.log('editorAttribute.inputPattern: ' + JSON.stringify(editorAttribute.inputPattern));
    console.log('editorAttribute.enterKeyType: ' + JSON.stringify(editorAttribute.enterKeyType));
});

getEditorAttribute9+

getEditorAttribute(): Promise<EditorAttribute>

獲取編輯框屬性值。使用promise異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

錯誤碼：

以下錯誤碼的詳細介紹請參見輸入法框架錯誤碼。

示例：

inputClient.getEditorAttribute().then((editorAttribute) => {
    console.info('editorAttribute.inputPattern: ' + JSON.stringify(editorAttribute.inputPattern));
    console.info('editorAttribute.enterKeyType: ' + JSON.stringify(editorAttribute.enterKeyType));
}).catch((err) => {
    console.error('Failed to getEditorAttribute: ' + JSON.stringify(err));
});

moveCursor9+

moveCursor(direction: number, callback: AsyncCallback<void>): void

移動光標。使用callback異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

錯誤碼：

以下錯誤碼的詳細介紹請參見輸入法框架錯誤碼。

示例：

try {
    inputClient.moveCursor(inputMethodEngine.CURSOR_UP, (err) => {
        if (err !== undefined) {
            console.error('Failed to moveCursor: ' + JSON.stringify(err));
            return;
        }
        console.info('Succeeded in moving cursor.');
    });
} catch (err) {
    console.error('Failed to moveCursor: ' + JSON.stringify(err));
}

moveCursor9+

moveCursor(direction: number): Promise<void>

移動光標。使用promise異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

返回值：

錯誤碼：

以下錯誤碼的詳細介紹請參見輸入法框架錯誤碼。

示例：

try {
    inputClient.moveCursor(inputMethodEngine.CURSOR_UP).then(() => {
        console.log('Succeeded in moving cursor.');
    }).catch((err) => {
        console.error('Failed to moveCursor: ' + JSON.stringify(err));
    });
} catch (err) {
    console.log('Failed to moveCursor: ' + JSON.stringify(err));
}

EditorAttribute

編輯框屬性值。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

KeyEvent

按鍵屬性值。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

TextInputClient(deprecated)

下列API示例中都需使用on('inputStart')回調獲取到TextInputClient實例，再通過此實例調用對應方法。

getForward(deprecated)

getForward(length:number, callback: AsyncCallback<string>): void

獲取光標前固定長度的文本。使用callback異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

示例：

let length = 1;
textInputClient.getForward(length, (err, text) => {
    if (err !== undefined) {
        console.error('Failed to getForward: ' + JSON.stringify(err));
        return;
    }
    console.log('Succeeded in getting forward, text: ' + text);
});

getForward(deprecated)

getForward(length:number): Promise<string>

獲取光標前固定長度的文本。使用promise異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

返回值：

示例：

let length = 1;
textInputClient.getForward(length).then((text) => {
    console.info('Succeeded in getting forward, text: ' + text);
}).catch((err) => {
    console.error('Failed to getForward: ' + JSON.stringify(err));
});

getBackward(deprecated)

getBackward(length:number, callback: AsyncCallback<string>): void

獲取光標后固定長度的文本。使用callback異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

示例：

let length = 1;
textInputClient.getBackward(length, (err, text) => {
    if (err !== undefined) {
        console.error('Failed to getBackward: ' + JSON.stringify(err));
        return;
    }
    console.log('Succeeded in getting borward, text: ' + text);
});

getBackward(deprecated)

getBackward(length:number): Promise<string>

獲取光標后固定長度的文本。使用promise異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

返回值：

示例：

let length = 1;
textInputClient.getBackward(length).then((text) => {
    console.info('Succeeded in getting backward: ' + JSON.stringify(text));
}).catch((err) => {
    console.error('Failed to getBackward: ' + JSON.stringify(err));
});

deleteForward(deprecated)

deleteForward(length:number, callback: AsyncCallback<boolean>): void

刪除光標前固定長度的文本。使用callback異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

示例：

let length = 1;
textInputClient.deleteForward(length, (err, result) => {
    if (err !== undefined) {
        console.error('Failed to deleteForward: ' + JSON.stringify(err));
        return;
    }
    if (result) {
        console.info('Succeeded in deleting forward. ');
    } else {
        console.error('Failed to deleteForward. ');
    }
});

deleteForward(deprecated)

deleteForward(length:number): Promise<boolean>

刪除光標前固定長度的文本。使用promise異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

返回值：

示例：

let length = 1;
textInputClient.deleteForward(length).then((result) => {
    if (result) {
        console.info('Succeeded in deleting forward. ');
    } else {
        console.error('Failed to delete forward. ');
    }
}).catch((err) => {
    console.error('Failed to delete forward: ' + JSON.stringify(err));
});

deleteBackward(deprecated)

deleteBackward(length:number, callback: AsyncCallback<boolean>): void

刪除光標后固定長度的文本。使用callback異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

示例：

let length = 1;
textInputClient.deleteBackward(length, (err, result) => {
    if (err !== undefined) {
        console.error('Failed to delete backward: ' + JSON.stringify(err));
        return;
    }
    if (result) {
        console.info('Succeeded in deleting backward. ');
    } else {
        console.error('Failed to deleteBackward. ');
    }
});

deleteBackward(deprecated)

deleteBackward(length:number): Promise<boolean>

刪除光標后固定長度的文本。使用callback異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

返回值：

示例：

let length = 1;
textInputClient.deleteBackward(length).then((result) => {
    if (result) {
        console.info('Succeeded in deleting backward. ');
    } else {
        console.error('Failed to deleteBackward. ');
    }
}).catch((err) => {
    console.error('Failed to deleteBackward: ' + JSON.stringify(err));
});

sendKeyFunction(deprecated)

sendKeyFunction(action: number, callback: AsyncCallback<boolean>): void

發(fā)送功能鍵。使用callback異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

示例：

let action = 1;
textInputClient.sendKeyFunction(action, (err, result) => {
    if (err !== undefined) {
        console.error('Failed to sendKeyFunction: ' + JSON.stringify(err));
        return;
    }
    if (result) {
        console.info('Succeeded in sending key function. ');
    } else {
        console.error('Failed to sendKeyFunction. ');
    }
});

sendKeyFunction(deprecated)

sendKeyFunction(action: number): Promise<boolean>

發(fā)送功能鍵。使用promise異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

返回值：

示例：

let action = 1;
textInputClient.sendKeyFunction(action).then((result) => {
    if (result) {
        console.info('Succeeded in sending key function. ');
    } else {
        console.error('Failed to sendKeyFunction. ');
    }
}).catch((err) => {
    console.error('Failed to sendKeyFunction:' + JSON.stringify(err));
});

insertText(deprecated)

insertText(text:string, callback: AsyncCallback<boolean>): void

插入文本。使用callback異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

示例：

textInputClient.insertText('test', (err, result) => {
    if (err !== undefined) {
        console.error('Failed to insertText: ' + JSON.stringify(err));
        return;
    }
    if (result) {
        console.info('Succeeded in inserting text. ');
    } else {
        console.error('Failed to insertText. ');
    }
});

insertText(deprecated)

insertText(text:string): Promise<boolean>

插入文本。使用promise異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

返回值：

示例：

textInputClient.insertText('test').then((result) => {
    if (result) {
        console.info('Succeeded in inserting text. ');
    } else {
        console.error('Failed to insertText. ');
    }
}).catch((err) => {
    console.error('Failed to insertText: ' + JSON.stringify(err));
});

getEditorAttribute(deprecated)

getEditorAttribute(callback: AsyncCallback<EditorAttribute>): void

獲取編輯框屬性值。使用callback異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

參數：

示例：

textInputClient.getEditorAttribute((err, editorAttribute) => {
    if (err !== undefined) {
        console.error('Failed to getEditorAttribute: ' + JSON.stringify(err));
        return;
    }
    console.log('editorAttribute.inputPattern: ' + JSON.stringify(editorAttribute.inputPattern));
    console.log('editorAttribute.enterKeyType: ' + JSON.stringify(editorAttribute.enterKeyType));
});

getEditorAttribute(deprecated)

getEditorAttribute(): Promise<EditorAttribute>

獲取編輯框屬性值。使用promise異步回調。

系統(tǒng)能力： SystemCapability.MiscServices.InputMethodFramework

返回值：

示例：

textInputClient.getEditorAttribute().then((editorAttribute) => {
    console.info('editorAttribute.inputPattern: ' + JSON.stringify(editorAttribute.inputPattern));
    console.info('editorAttribute.enterKeyType: ' + JSON.stringify(editorAttribute.enterKeyType));
}).catch((err) => {
    console.error('Failed to getEditorAttribute: ' + JSON.stringify(err));
});