openharmony/interface_sdk-js
1
0
Fork 0
mirror of https://gitee.com/openharmony/interface_sdk-js synced 2024-11-23 15:20:17 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Signed-off-by: ma-shaoyin <mashaoyin1@huawei.com>

Browse Source 
Changes to be committed:
This commit is contained in:
ma-shaoyin 2024-02-28 10:15:36 +08:00
parent d168878d09
commit d5907be6fc
1 changed files with 19 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
api/@ohos.inputMethodEngine.d.ts vendored
View File

@ -367,6 +367,15 @@ declare namespace inputMethodEngine {
*/
function createKeyboardDelegate(): KeyboardDelegate;
/**
* Indicates possible command data types.
*
* @syscap SystemCapability.MiscServices.InputMethodFramework
* @systemapi
* @since 12
*/
type CommandDtaType = number | string | boolean;
/**
* @interface KeyboardController
* @syscap SystemCapability.MiscServices.InputMethodFramework
@ -487,28 +496,28 @@ declare namespace inputMethodEngine {
off(type: 'keyboardShow' | 'keyboardHide', callback?: () => void): void;
/**
* Subscribe 'sendPrivateCommand'
* Subscribe 'sendPrivateCommand'.This function can only be called by default input method configured by system.
*
* @param { 'sendPrivateCommand' } type - indicates the type of subscribe event.
* @param { function } callback - indicates the callback of on('sendPrivateCommand').
* @throws { BusinessError } 202 - not system application.
* @throws { BusinessError } 12800010 - not default input method configured by system.
* @syscap SystemCapability.MiscServices.InputMethodFramework
* @systemapi
* @since 12
*/
on(type: 'sendPrivateCommand', callback: (record: Record<string, Object>) => void): void;
on(type: 'privateCommand', callback: (commandData: Record<string, CommandDtaType>) => void): void;
/**
* Unsubscribe 'sendPrivateCommand'
* Unsubscribe 'sendPrivateCommand'.This function can only be called by default input method configured by system.
*
* @param { 'sendPrivateCommand' } type - indicates the type of subscribe event.
* @param { function } [callback] - optional, indicates the callback of off('sendPrivateCommand').
* @throws { BusinessError } 202 - not system application.
* @throws { BusinessError } 12800010 - not default input method configured by system.
* @syscap SystemCapability.MiscServices.InputMethodFramework
* @systemapi
* @since 12
*/
off(type: 'sendPrivateCommand', callback?: (record: Record<string, Object>) => void): void;
off(type: 'privateCommand', callback?: (commandData: Record<string, CommandDtaType>) => void): void;
}
/**
@ -1271,19 +1280,17 @@ declare namespace inputMethodEngine {
sendExtendAction(action: ExtendAction): Promise<void>;
/**
* Send private command.
* Send private command.This function can only be called by default input method configured by system.
*
* @param { Record<string, Object> } record - action code which will be send.
* @param { Record<string, CommandDtaType> } record - action code which will be send.
* @returns { Promise<void> } the promise returned by the function.
* @throws { BusinessError } 202 - not system application.
* @throws { BusinessError } 401 - parameter error.
* @throws { BusinessError } 12800003 - input method client error.
* @throws { BusinessError } 12800006 - Input method controller error.
* @throws { BusinessError } 12800010 - not default input method configured by system.
* @syscap SystemCapability.MiscServices.InputMethodFramework
* @systemapi
* @since 12
*/
sendPrivateCommand(record: Record<string, Object>): Promise<void>;
sendPrivateCommand(commandData: Record<string, CommandDtaType>): Promise<void>;
}
/**