mirror of
https://gitee.com/openharmony/interface_sdk-js
synced 2024-10-07 14:13:45 +00:00
commit
0433f98390
5
api/@ohos.InputMethodExtensionAbility.d.ts
vendored
5
api/@ohos.InputMethodExtensionAbility.d.ts
vendored
@ -42,7 +42,8 @@ export default class InputMethodExtensionAbility {
|
|||||||
* Called back when a input method extension is started for initialization.
|
* Called back when a input method extension is started for initialization.
|
||||||
*
|
*
|
||||||
* @param { Want } want - Indicates the want of created service extension.
|
* @param { Want } want - Indicates the want of created service extension.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
* @StageModelOnly
|
* @StageModelOnly
|
||||||
* @since 9
|
* @since 9
|
||||||
@ -52,7 +53,7 @@ export default class InputMethodExtensionAbility {
|
|||||||
/**
|
/**
|
||||||
* Called back before a input method extension is destroyed.
|
* Called back before a input method extension is destroyed.
|
||||||
*
|
*
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes: Parameter verification failed.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
* @StageModelOnly
|
* @StageModelOnly
|
||||||
* @since 9
|
* @since 9
|
||||||
|
3
api/@ohos.InputMethodExtensionContext.d.ts
vendored
3
api/@ohos.InputMethodExtensionContext.d.ts
vendored
@ -56,7 +56,8 @@ export default class InputMethodExtensionContext extends ExtensionContext {
|
|||||||
*
|
*
|
||||||
* @param { Want } want - Indicates the ability to start.
|
* @param { Want } want - Indicates the ability to start.
|
||||||
* @returns { Promise<void> } The promise returned by the function.
|
* @returns { Promise<void> } The promise returned by the function.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 16000001 - The specified ability does not exist.
|
* @throws { BusinessError } 16000001 - The specified ability does not exist.
|
||||||
* @throws { BusinessError } 16000004 - Can not start invisible component.
|
* @throws { BusinessError } 16000004 - Can not start invisible component.
|
||||||
* @throws { BusinessError } 16000005 - The specified process does not have the permission.
|
* @throws { BusinessError } 16000005 - The specified process does not have the permission.
|
||||||
|
126
api/@ohos.inputMethod.d.ts
vendored
126
api/@ohos.inputMethod.d.ts
vendored
@ -108,7 +108,8 @@ declare namespace inputMethod {
|
|||||||
* @param { InputMethodProperty } target - indicates the input method which will replace the current one.
|
* @param { InputMethodProperty } target - indicates the input method which will replace the current one.
|
||||||
* @param { AsyncCallback<boolean> } callback - the callback of switchInputMethod.
|
* @param { AsyncCallback<boolean> } callback - the callback of switchInputMethod.
|
||||||
* @throws { BusinessError } 201 - permissions check fails.
|
* @throws { BusinessError } 201 - permissions check fails.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800005 - configuration persisting error.
|
* @throws { BusinessError } 12800005 - configuration persisting error.
|
||||||
* @throws { BusinessError } 12800008 - input method manager service error.
|
* @throws { BusinessError } 12800008 - input method manager service error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
@ -119,7 +120,8 @@ declare namespace inputMethod {
|
|||||||
*
|
*
|
||||||
* @param { InputMethodProperty } target - indicates the target input method.
|
* @param { InputMethodProperty } target - indicates the target input method.
|
||||||
* @param { AsyncCallback<boolean> } callback - the callback of switchInputMethod.
|
* @param { AsyncCallback<boolean> } callback - the callback of switchInputMethod.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800005 - configuration persisting error.
|
* @throws { BusinessError } 12800005 - configuration persisting error.
|
||||||
* @throws { BusinessError } 12800008 - input method manager service error.
|
* @throws { BusinessError } 12800008 - input method manager service error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
@ -134,7 +136,8 @@ declare namespace inputMethod {
|
|||||||
* @param { InputMethodProperty } target - Indicates the input method which will replace the current one.
|
* @param { InputMethodProperty } target - Indicates the input method which will replace the current one.
|
||||||
* @returns { Promise<boolean> } the promise returned by the function.
|
* @returns { Promise<boolean> } the promise returned by the function.
|
||||||
* @throws { BusinessError } 201 - permissions check fails.
|
* @throws { BusinessError } 201 - permissions check fails.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800005 - configuration persisting error.
|
* @throws { BusinessError } 12800005 - configuration persisting error.
|
||||||
* @throws { BusinessError } 12800008 - input method manager service error.
|
* @throws { BusinessError } 12800008 - input method manager service error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
@ -145,7 +148,8 @@ declare namespace inputMethod {
|
|||||||
*
|
*
|
||||||
* @param { InputMethodProperty } target - indicates the target input method.
|
* @param { InputMethodProperty } target - indicates the target input method.
|
||||||
* @returns { Promise<boolean> } the promise returned by the function.
|
* @returns { Promise<boolean> } the promise returned by the function.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800005 - configuration persisting error.
|
* @throws { BusinessError } 12800005 - configuration persisting error.
|
||||||
* @throws { BusinessError } 12800008 - input method manager service error.
|
* @throws { BusinessError } 12800008 - input method manager service error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
@ -169,7 +173,8 @@ declare namespace inputMethod {
|
|||||||
* @param { InputMethodSubtype } target - Indicates the input method subtype which will replace the current one.
|
* @param { InputMethodSubtype } target - Indicates the input method subtype which will replace the current one.
|
||||||
* @param { AsyncCallback<boolean> } callback - the callback of switchCurrentInputMethodSubtype.
|
* @param { AsyncCallback<boolean> } callback - the callback of switchCurrentInputMethodSubtype.
|
||||||
* @throws { BusinessError } 201 - permissions check fails.
|
* @throws { BusinessError } 201 - permissions check fails.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800005 - configuration persisting error.
|
* @throws { BusinessError } 12800005 - configuration persisting error.
|
||||||
* @throws { BusinessError } 12800008 - input method manager service error.
|
* @throws { BusinessError } 12800008 - input method manager service error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
@ -182,7 +187,8 @@ declare namespace inputMethod {
|
|||||||
* @param { InputMethodSubtype } target - Indicates the input method subtype which will replace the current one.
|
* @param { InputMethodSubtype } target - Indicates the input method subtype which will replace the current one.
|
||||||
* @param { AsyncCallback<boolean> } callback - the callback of switchCurrentInputMethodSubtype.
|
* @param { AsyncCallback<boolean> } callback - the callback of switchCurrentInputMethodSubtype.
|
||||||
* @throws { BusinessError } 201 - permissions check fails.
|
* @throws { BusinessError } 201 - permissions check fails.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800005 - configuration persisting error.
|
* @throws { BusinessError } 12800005 - configuration persisting error.
|
||||||
* @throws { BusinessError } 12800008 - input method manager service error.
|
* @throws { BusinessError } 12800008 - input method manager service error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
@ -193,7 +199,8 @@ declare namespace inputMethod {
|
|||||||
*
|
*
|
||||||
* @param { InputMethodSubtype } target - indicates the target input method subtype.
|
* @param { InputMethodSubtype } target - indicates the target input method subtype.
|
||||||
* @param { AsyncCallback<boolean> } callback - the callback of switchCurrentInputMethodSubtype.
|
* @param { AsyncCallback<boolean> } callback - the callback of switchCurrentInputMethodSubtype.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800005 - configuration persisting error.
|
* @throws { BusinessError } 12800005 - configuration persisting error.
|
||||||
* @throws { BusinessError } 12800008 - input method manager service error.
|
* @throws { BusinessError } 12800008 - input method manager service error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
@ -208,7 +215,8 @@ declare namespace inputMethod {
|
|||||||
* @param { InputMethodSubtype } target - Indicates the input method subtype which will replace the current one.
|
* @param { InputMethodSubtype } target - Indicates the input method subtype which will replace the current one.
|
||||||
* @returns { Promise<boolean> } the promise returned by the function.
|
* @returns { Promise<boolean> } the promise returned by the function.
|
||||||
* @throws { BusinessError } 201 - permissions check fails.
|
* @throws { BusinessError } 201 - permissions check fails.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800005 - configuration persisting error.
|
* @throws { BusinessError } 12800005 - configuration persisting error.
|
||||||
* @throws { BusinessError } 12800008 - input method manager service error.
|
* @throws { BusinessError } 12800008 - input method manager service error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
@ -221,7 +229,8 @@ declare namespace inputMethod {
|
|||||||
* @param { InputMethodSubtype } target - Indicates the input method subtype which will replace the current one.
|
* @param { InputMethodSubtype } target - Indicates the input method subtype which will replace the current one.
|
||||||
* @returns { Promise<boolean> } the promise returned by the function.
|
* @returns { Promise<boolean> } the promise returned by the function.
|
||||||
* @throws { BusinessError } 201 - permissions check fails.
|
* @throws { BusinessError } 201 - permissions check fails.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800005 - configuration persisting error.
|
* @throws { BusinessError } 12800005 - configuration persisting error.
|
||||||
* @throws { BusinessError } 12800008 - input method manager service error.
|
* @throws { BusinessError } 12800008 - input method manager service error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
@ -232,7 +241,8 @@ declare namespace inputMethod {
|
|||||||
*
|
*
|
||||||
* @param { InputMethodSubtype } target - indicates the target input method subtype.
|
* @param { InputMethodSubtype } target - indicates the target input method subtype.
|
||||||
* @returns { Promise<boolean> } the promise returned by the function.
|
* @returns { Promise<boolean> } the promise returned by the function.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800005 - configuration persisting error.
|
* @throws { BusinessError } 12800005 - configuration persisting error.
|
||||||
* @throws { BusinessError } 12800008 - input method manager service error.
|
* @throws { BusinessError } 12800008 - input method manager service error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
@ -257,7 +267,8 @@ declare namespace inputMethod {
|
|||||||
* @param { InputMethodSubtype } inputMethodSubtype - Indicates the target input method subtype.
|
* @param { InputMethodSubtype } inputMethodSubtype - Indicates the target input method subtype.
|
||||||
* @param { AsyncCallback<boolean> } callback - the callback of switchCurrentInputMethodAndSubtype.
|
* @param { AsyncCallback<boolean> } callback - the callback of switchCurrentInputMethodAndSubtype.
|
||||||
* @throws { BusinessError } 201 - permissions check fails.
|
* @throws { BusinessError } 201 - permissions check fails.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800005 - configuration persisting error.
|
* @throws { BusinessError } 12800005 - configuration persisting error.
|
||||||
* @throws { BusinessError } 12800008 - input method manager service error.
|
* @throws { BusinessError } 12800008 - input method manager service error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
@ -269,7 +280,8 @@ declare namespace inputMethod {
|
|||||||
* @param { InputMethodProperty } inputMethodProperty - indicates the target input method.
|
* @param { InputMethodProperty } inputMethodProperty - indicates the target input method.
|
||||||
* @param { InputMethodSubtype } inputMethodSubtype - indicates the target input method subtype.
|
* @param { InputMethodSubtype } inputMethodSubtype - indicates the target input method subtype.
|
||||||
* @param { AsyncCallback<boolean> } callback - the callback of switchCurrentInputMethodAndSubtype.
|
* @param { AsyncCallback<boolean> } callback - the callback of switchCurrentInputMethodAndSubtype.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800005 - configuration persisting error.
|
* @throws { BusinessError } 12800005 - configuration persisting error.
|
||||||
* @throws { BusinessError } 12800008 - input method manager service error.
|
* @throws { BusinessError } 12800008 - input method manager service error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
@ -289,7 +301,8 @@ declare namespace inputMethod {
|
|||||||
* @param { InputMethodSubtype } inputMethodSubtype - Indicates the target input method subtype.
|
* @param { InputMethodSubtype } inputMethodSubtype - Indicates the target input method subtype.
|
||||||
* @returns { Promise<boolean> } the promise returned by the function.
|
* @returns { Promise<boolean> } the promise returned by the function.
|
||||||
* @throws { BusinessError } 201 - permissions check fails.
|
* @throws { BusinessError } 201 - permissions check fails.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800005 - configuration persisting error.
|
* @throws { BusinessError } 12800005 - configuration persisting error.
|
||||||
* @throws { BusinessError } 12800008 - input method manager service error.
|
* @throws { BusinessError } 12800008 - input method manager service error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
@ -301,7 +314,8 @@ declare namespace inputMethod {
|
|||||||
* @param { InputMethodProperty } inputMethodProperty - indicates the target input method.
|
* @param { InputMethodProperty } inputMethodProperty - indicates the target input method.
|
||||||
* @param { InputMethodSubtype } inputMethodSubtype - indicates the target input method subtype.
|
* @param { InputMethodSubtype } inputMethodSubtype - indicates the target input method subtype.
|
||||||
* @returns { Promise<boolean> } the promise returned by the function.
|
* @returns { Promise<boolean> } the promise returned by the function.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800005 - configuration persisting error.
|
* @throws { BusinessError } 12800005 - configuration persisting error.
|
||||||
* @throws { BusinessError } 12800008 - input method manager service error.
|
* @throws { BusinessError } 12800008 - input method manager service error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
@ -322,7 +336,8 @@ declare namespace inputMethod {
|
|||||||
* @returns { Promise<void> } the promise returned by the function.
|
* @returns { Promise<void> } the promise returned by the function.
|
||||||
* @throws { BusinessError } 201 - permissions check fails.
|
* @throws { BusinessError } 201 - permissions check fails.
|
||||||
* @throws { BusinessError } 202 - not system application.
|
* @throws { BusinessError } 202 - not system application.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800005 - configuration persisting error.
|
* @throws { BusinessError } 12800005 - configuration persisting error.
|
||||||
* @throws { BusinessError } 12800008 - input method manager service error.
|
* @throws { BusinessError } 12800008 - input method manager service error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
@ -420,7 +435,8 @@ declare namespace inputMethod {
|
|||||||
* If true, the panel being queried is shown.
|
* If true, the panel being queried is shown.
|
||||||
* If false, the panel being queried is hidden.
|
* If false, the panel being queried is hidden.
|
||||||
* @throws { BusinessError } 202 - not system application.
|
* @throws { BusinessError } 202 - not system application.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800008 - input method manager service error.
|
* @throws { BusinessError } 12800008 - input method manager service error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
* @systemapi
|
* @systemapi
|
||||||
@ -433,7 +449,8 @@ declare namespace inputMethod {
|
|||||||
*
|
*
|
||||||
* @param { InputMethodProperty } inputMethodProperty - the property of the specified inputmethod.
|
* @param { InputMethodProperty } inputMethodProperty - the property of the specified inputmethod.
|
||||||
* @param { AsyncCallback<Array<InputMethodSubtype>> } callback - the callback of listInputMethodSubtype.
|
* @param { AsyncCallback<Array<InputMethodSubtype>> } callback - the callback of listInputMethodSubtype.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800001 - package manager error.
|
* @throws { BusinessError } 12800001 - package manager error.
|
||||||
* @throws { BusinessError } 12800008 - input method manager service error.
|
* @throws { BusinessError } 12800008 - input method manager service error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
@ -449,7 +466,8 @@ declare namespace inputMethod {
|
|||||||
*
|
*
|
||||||
* @param { InputMethodProperty } inputMethodProperty - Indicates the specified input method.
|
* @param { InputMethodProperty } inputMethodProperty - Indicates the specified input method.
|
||||||
* @returns { Promise<Array<InputMethodSubtype>> } the promise returned by the function.
|
* @returns { Promise<Array<InputMethodSubtype>> } the promise returned by the function.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800001 - package manager error.
|
* @throws { BusinessError } 12800001 - package manager error.
|
||||||
* @throws { BusinessError } 12800008 - input method manager service error.
|
* @throws { BusinessError } 12800008 - input method manager service error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
@ -486,7 +504,8 @@ declare namespace inputMethod {
|
|||||||
* If true, collect enabled input methods.
|
* If true, collect enabled input methods.
|
||||||
* If false, collect disabled input methods.
|
* If false, collect disabled input methods.
|
||||||
* @param { AsyncCallback<Array<InputMethodProperty>> } callback - the callback of getInputMethods.
|
* @param { AsyncCallback<Array<InputMethodProperty>> } callback - the callback of getInputMethods.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800001 - package manager error.
|
* @throws { BusinessError } 12800001 - package manager error.
|
||||||
* @throws { BusinessError } 12800008 - input method manager service error.
|
* @throws { BusinessError } 12800008 - input method manager service error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
@ -501,7 +520,8 @@ declare namespace inputMethod {
|
|||||||
* If true, collect enabled input methods.
|
* If true, collect enabled input methods.
|
||||||
* If false, collect disabled input methods.
|
* If false, collect disabled input methods.
|
||||||
* @returns { Promise<Array<InputMethodProperty>> } the promise returned by the function.
|
* @returns { Promise<Array<InputMethodProperty>> } the promise returned by the function.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
|
||||||
* @throws { BusinessError } 12800001 - package manager error.
|
* @throws { BusinessError } 12800001 - package manager error.
|
||||||
* @throws { BusinessError } 12800008 - input method manager service error.
|
* @throws { BusinessError } 12800008 - input method manager service error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
@ -516,7 +536,8 @@ declare namespace inputMethod {
|
|||||||
* If true, collect enabled input methods.
|
* If true, collect enabled input methods.
|
||||||
* If false, collect disabled input methods.
|
* If false, collect disabled input methods.
|
||||||
* @returns { Array<InputMethodProperty> } the list of inputmethod.
|
* @returns { Array<InputMethodProperty> } the list of inputmethod.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
|
||||||
* @throws { BusinessError } 12800001 - bundle manager error.
|
* @throws { BusinessError } 12800001 - bundle manager error.
|
||||||
* @throws { BusinessError } 12800008 - input method manager service error.
|
* @throws { BusinessError } 12800008 - input method manager service error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
@ -626,7 +647,8 @@ declare namespace inputMethod {
|
|||||||
* @param { boolean } showKeyboard - show the keyboard or not when attach the input method.
|
* @param { boolean } showKeyboard - show the keyboard or not when attach the input method.
|
||||||
* @param { TextConfig } textConfig - indicates the config of the textInput.
|
* @param { TextConfig } textConfig - indicates the config of the textInput.
|
||||||
* @param { AsyncCallback<void> } callback - the callback of attach.
|
* @param { AsyncCallback<void> } callback - the callback of attach.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800003 - input method client error.
|
* @throws { BusinessError } 12800003 - input method client error.
|
||||||
* @throws { BusinessError } 12800008 - input method manager service error.
|
* @throws { BusinessError } 12800008 - input method manager service error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
@ -640,7 +662,8 @@ declare namespace inputMethod {
|
|||||||
* @param { boolean } showKeyboard - show the keyboard or not when attach the input method.
|
* @param { boolean } showKeyboard - show the keyboard or not when attach the input method.
|
||||||
* @param { TextConfig } textConfig - indicates the config of the textInput.
|
* @param { TextConfig } textConfig - indicates the config of the textInput.
|
||||||
* @returns { Promise<void> } the promise returned by the function.
|
* @returns { Promise<void> } the promise returned by the function.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800003 - input method client error.
|
* @throws { BusinessError } 12800003 - input method client error.
|
||||||
* @throws { BusinessError } 12800008 - input method manager service error.
|
* @throws { BusinessError } 12800008 - input method manager service error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
@ -724,7 +747,8 @@ declare namespace inputMethod {
|
|||||||
*
|
*
|
||||||
* @param { number } windowId - the window ID of the application currently bound to the input method.
|
* @param { number } windowId - the window ID of the application currently bound to the input method.
|
||||||
* @param { AsyncCallback<void> } callback - the callback of setCallingWindow.
|
* @param { AsyncCallback<void> } callback - the callback of setCallingWindow.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800003 - input method client error.
|
* @throws { BusinessError } 12800003 - input method client error.
|
||||||
* @throws { BusinessError } 12800008 - input method manager service error.
|
* @throws { BusinessError } 12800008 - input method manager service error.
|
||||||
* @throws { BusinessError } 12800009 - input method client is detached.
|
* @throws { BusinessError } 12800009 - input method client is detached.
|
||||||
@ -739,7 +763,8 @@ declare namespace inputMethod {
|
|||||||
*
|
*
|
||||||
* @param { number } windowId - the window ID of the application currently bound to the input method.
|
* @param { number } windowId - the window ID of the application currently bound to the input method.
|
||||||
* @returns { Promise<void> } the promise returned by the function.
|
* @returns { Promise<void> } the promise returned by the function.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800003 - input method client error.
|
* @throws { BusinessError } 12800003 - input method client error.
|
||||||
* @throws { BusinessError } 12800008 - input method manager service error.
|
* @throws { BusinessError } 12800008 - input method manager service error.
|
||||||
* @throws { BusinessError } 12800009 - input method client is detached.
|
* @throws { BusinessError } 12800009 - input method client is detached.
|
||||||
@ -753,7 +778,8 @@ declare namespace inputMethod {
|
|||||||
*
|
*
|
||||||
* @param { CursorInfo } cursorInfo - the CursorInfo object.
|
* @param { CursorInfo } cursorInfo - the CursorInfo object.
|
||||||
* @param { AsyncCallback<void> } callback - the callback of updateCursor.
|
* @param { AsyncCallback<void> } callback - the callback of updateCursor.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800003 - input method client error.
|
* @throws { BusinessError } 12800003 - input method client error.
|
||||||
* @throws { BusinessError } 12800008 - input method manager service error.
|
* @throws { BusinessError } 12800008 - input method manager service error.
|
||||||
* @throws { BusinessError } 12800009 - input method client is detached.
|
* @throws { BusinessError } 12800009 - input method client is detached.
|
||||||
@ -767,7 +793,8 @@ declare namespace inputMethod {
|
|||||||
*
|
*
|
||||||
* @param { CursorInfo } cursorInfo - the CursorInfo object.
|
* @param { CursorInfo } cursorInfo - the CursorInfo object.
|
||||||
* @returns { Promise<void> } the promise returned by the function.
|
* @returns { Promise<void> } the promise returned by the function.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800003 - input method client error.
|
* @throws { BusinessError } 12800003 - input method client error.
|
||||||
* @throws { BusinessError } 12800008 - input method manager service error.
|
* @throws { BusinessError } 12800008 - input method manager service error.
|
||||||
* @throws { BusinessError } 12800009 - input method client is detached.
|
* @throws { BusinessError } 12800009 - input method client is detached.
|
||||||
@ -783,7 +810,8 @@ declare namespace inputMethod {
|
|||||||
* @param { number } start - start position of selected text.
|
* @param { number } start - start position of selected text.
|
||||||
* @param { number } end - end position of selected text.
|
* @param { number } end - end position of selected text.
|
||||||
* @param { AsyncCallback<void> } callback - the callback of changeSelection.
|
* @param { AsyncCallback<void> } callback - the callback of changeSelection.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800003 - input method client error.
|
* @throws { BusinessError } 12800003 - input method client error.
|
||||||
* @throws { BusinessError } 12800008 - input method manager service error.
|
* @throws { BusinessError } 12800008 - input method manager service error.
|
||||||
* @throws { BusinessError } 12800009 - input method client is detached.
|
* @throws { BusinessError } 12800009 - input method client is detached.
|
||||||
@ -799,7 +827,8 @@ declare namespace inputMethod {
|
|||||||
* @param { number } start - start position of selected text.
|
* @param { number } start - start position of selected text.
|
||||||
* @param { number } end - end position of selected text.
|
* @param { number } end - end position of selected text.
|
||||||
* @returns { Promise<void> } the promise returned by the function.
|
* @returns { Promise<void> } the promise returned by the function.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800003 - input method client error.
|
* @throws { BusinessError } 12800003 - input method client error.
|
||||||
* @throws { BusinessError } 12800008 - input method manager service error.
|
* @throws { BusinessError } 12800008 - input method manager service error.
|
||||||
* @throws { BusinessError } 12800009 - input method client is detached.
|
* @throws { BusinessError } 12800009 - input method client is detached.
|
||||||
@ -813,7 +842,8 @@ declare namespace inputMethod {
|
|||||||
*
|
*
|
||||||
* @param { InputAttribute } attribute - the InputAttribute object.
|
* @param { InputAttribute } attribute - the InputAttribute object.
|
||||||
* @param { AsyncCallback<void> } callback - the callback of updateAttribute.
|
* @param { AsyncCallback<void> } callback - the callback of updateAttribute.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800003 - input method client error.
|
* @throws { BusinessError } 12800003 - input method client error.
|
||||||
* @throws { BusinessError } 12800008 - input method manager service error.
|
* @throws { BusinessError } 12800008 - input method manager service error.
|
||||||
* @throws { BusinessError } 12800009 - input method client is detached.
|
* @throws { BusinessError } 12800009 - input method client is detached.
|
||||||
@ -827,7 +857,8 @@ declare namespace inputMethod {
|
|||||||
*
|
*
|
||||||
* @param { InputAttribute } attribute - the InputAttribute object.
|
* @param { InputAttribute } attribute - the InputAttribute object.
|
||||||
* @returns { Promise<void> } the promise returned by the function.
|
* @returns { Promise<void> } the promise returned by the function.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800003 - input method client error.
|
* @throws { BusinessError } 12800003 - input method client error.
|
||||||
* @throws { BusinessError } 12800008 - input method manager service error.
|
* @throws { BusinessError } 12800008 - input method manager service error.
|
||||||
* @throws { BusinessError } 12800009 - input method client is detached.
|
* @throws { BusinessError } 12800009 - input method client is detached.
|
||||||
@ -939,7 +970,8 @@ declare namespace inputMethod {
|
|||||||
* @param { Callback<Range> } callback - processes selectByRange command. The range of selection is provided for
|
* @param { Callback<Range> } callback - processes selectByRange command. The range of selection is provided for
|
||||||
* this callback, and subscribers are expected to select corresponding text in callback according to
|
* this callback, and subscribers are expected to select corresponding text in callback according to
|
||||||
* the range.
|
* the range.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
* @since 10
|
* @since 10
|
||||||
*/
|
*/
|
||||||
@ -964,7 +996,8 @@ declare namespace inputMethod {
|
|||||||
* @param { Callback<Movement> } callback - processes selectByMovement command. The movement of cursor is provided
|
* @param { Callback<Movement> } callback - processes selectByMovement command. The movement of cursor is provided
|
||||||
* for this callback, and subscribers are expected to select corresponding text in callback according to
|
* for this callback, and subscribers are expected to select corresponding text in callback according to
|
||||||
* the movement.
|
* the movement.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
* @since 10
|
* @since 10
|
||||||
*/
|
*/
|
||||||
@ -987,7 +1020,8 @@ declare namespace inputMethod {
|
|||||||
* @param { 'insertText' } type - event type, fixed as 'insertText'.
|
* @param { 'insertText' } type - event type, fixed as 'insertText'.
|
||||||
* @param { function } callback - processes insertText command. The text of insert is provided for this callback.
|
* @param { function } callback - processes insertText command. The text of insert is provided for this callback.
|
||||||
* Subscribers are expected to process the inserted text and update changes in editor by changeSelection and updateCursor as needed.
|
* Subscribers are expected to process the inserted text and update changes in editor by changeSelection and updateCursor as needed.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
|
||||||
* @throws { BusinessError } 12800009 - input method client is detached.
|
* @throws { BusinessError } 12800009 - input method client is detached.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
* @since 10
|
* @since 10
|
||||||
@ -1013,7 +1047,8 @@ declare namespace inputMethod {
|
|||||||
* @param { function } callback - processes deleteLeft command. The length of
|
* @param { function } callback - processes deleteLeft command. The length of
|
||||||
* delete is provided for this callback. Subscribers are expected to delete specified length of text
|
* delete is provided for this callback. Subscribers are expected to delete specified length of text
|
||||||
* to the left of the cursor and update changes in editor by changeSelection and updateCursor as needed.
|
* to the left of the cursor and update changes in editor by changeSelection and updateCursor as needed.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800009 - input method client is detached.
|
* @throws { BusinessError } 12800009 - input method client is detached.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
* @since 10
|
* @since 10
|
||||||
@ -1039,7 +1074,8 @@ declare namespace inputMethod {
|
|||||||
* @param { function } callback - processes deleteRight command. The length of
|
* @param { function } callback - processes deleteRight command. The length of
|
||||||
* delete is provided for this callback. Subscribers are expected to delete specified length of text
|
* delete is provided for this callback. Subscribers are expected to delete specified length of text
|
||||||
* to the right of the cursor and update changes in editor by changeSelection and updateCursor as needed.
|
* to the right of the cursor and update changes in editor by changeSelection and updateCursor as needed.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800009 - input method client is detached.
|
* @throws { BusinessError } 12800009 - input method client is detached.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
* @since 10
|
* @since 10
|
||||||
@ -1063,7 +1099,8 @@ declare namespace inputMethod {
|
|||||||
* @param { 'sendKeyboardStatus' } type - event type, fixed as 'sendKeyboardStatus'.
|
* @param { 'sendKeyboardStatus' } type - event type, fixed as 'sendKeyboardStatus'.
|
||||||
* @param { function } callback - processes sendKeyboardStatus command.
|
* @param { function } callback - processes sendKeyboardStatus command.
|
||||||
* The keyboardStatus is provided for this callback.
|
* The keyboardStatus is provided for this callback.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800009 - input method client is detached.
|
* @throws { BusinessError } 12800009 - input method client is detached.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
* @since 10
|
* @since 10
|
||||||
@ -1088,7 +1125,8 @@ declare namespace inputMethod {
|
|||||||
* @param { function } callback - processes sendFunctionKey command.
|
* @param { function } callback - processes sendFunctionKey command.
|
||||||
* The functionKey is provided for this callback.Subscribers are expected to complete the
|
* The functionKey is provided for this callback.Subscribers are expected to complete the
|
||||||
* corresponding task based on the value of functionKey.
|
* corresponding task based on the value of functionKey.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800009 - input method client is detached.
|
* @throws { BusinessError } 12800009 - input method client is detached.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
* @since 10
|
* @since 10
|
||||||
@ -1113,7 +1151,8 @@ declare namespace inputMethod {
|
|||||||
* @param { function } callback - processes moveCursor command. The direction of
|
* @param { function } callback - processes moveCursor command. The direction of
|
||||||
* cursor is provided for this callback. Subscribers are expected to move the cursor and update changes
|
* cursor is provided for this callback. Subscribers are expected to move the cursor and update changes
|
||||||
* in editor by changeSelection and updateCursor.
|
* in editor by changeSelection and updateCursor.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800009 - input method client is detached.
|
* @throws { BusinessError } 12800009 - input method client is detached.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
* @since 10
|
* @since 10
|
||||||
@ -1137,7 +1176,8 @@ declare namespace inputMethod {
|
|||||||
* @param { 'handleExtendAction' } type - event type, fixed as 'handleExtendAction'.
|
* @param { 'handleExtendAction' } type - event type, fixed as 'handleExtendAction'.
|
||||||
* @param { function } callback - processes handleExtendAction command. The action code
|
* @param { function } callback - processes handleExtendAction command. The action code
|
||||||
* is provided for this callback.
|
* is provided for this callback.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800009 - input method client is detached.
|
* @throws { BusinessError } 12800009 - input method client is detached.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
* @since 10
|
* @since 10
|
||||||
@ -1161,7 +1201,8 @@ declare namespace inputMethod {
|
|||||||
* @param { 'getLeftTextOfCursor' } type - event type, fixed as 'getLeftTextOfCursor'.
|
* @param { 'getLeftTextOfCursor' } type - event type, fixed as 'getLeftTextOfCursor'.
|
||||||
* @param { function } callback - processes getLeftTextOfCursor command. The callback
|
* @param { function } callback - processes getLeftTextOfCursor command. The callback
|
||||||
* must be a synchronization method and will block the input method application.
|
* must be a synchronization method and will block the input method application.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800009 - input method client is detached.
|
* @throws { BusinessError } 12800009 - input method client is detached.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
* @since 10
|
* @since 10
|
||||||
@ -1185,7 +1226,8 @@ declare namespace inputMethod {
|
|||||||
* @param { 'getRightTextOfCursor' } type - event type, fixed as 'getRightTextOfCursor'.
|
* @param { 'getRightTextOfCursor' } type - event type, fixed as 'getRightTextOfCursor'.
|
||||||
* @param { function } callback - processes getRightTextOfCursor command. The callback
|
* @param { function } callback - processes getRightTextOfCursor command. The callback
|
||||||
* must be a synchronization method and will block the input method application.
|
* must be a synchronization method and will block the input method application.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800009 - input method client is detached.
|
* @throws { BusinessError } 12800009 - input method client is detached.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
* @since 10
|
* @since 10
|
||||||
|
161
api/@ohos.inputMethodEngine.d.ts
vendored
161
api/@ohos.inputMethodEngine.d.ts
vendored
@ -370,7 +370,7 @@ declare namespace inputMethodEngine {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Indicates the possible data types of the command.
|
* Indicates the possible data types of the command.
|
||||||
*
|
* @typedef { number | string | boolean }
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
* @since 12
|
* @since 12
|
||||||
*/
|
*/
|
||||||
@ -666,7 +666,8 @@ declare namespace inputMethodEngine {
|
|||||||
* @param { BaseContext } ctx - indicates the context on which the window depends.
|
* @param { BaseContext } ctx - indicates the context on which the window depends.
|
||||||
* @param { PanelInfo } info - the info of panel to be created.
|
* @param { PanelInfo } info - the info of panel to be created.
|
||||||
* @param { AsyncCallback<Panel> } callback - the callback of createPanel.
|
* @param { AsyncCallback<Panel> } callback - the callback of createPanel.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800004 - not an input method extension.
|
* @throws { BusinessError } 12800004 - not an input method extension.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
* @since 10
|
* @since 10
|
||||||
@ -680,7 +681,8 @@ declare namespace inputMethodEngine {
|
|||||||
* @param { BaseContext } ctx - indicates the context on which the window depends.
|
* @param { BaseContext } ctx - indicates the context on which the window depends.
|
||||||
* @param { PanelInfo } info - the info of panel to be created.
|
* @param { PanelInfo } info - the info of panel to be created.
|
||||||
* @returns { Promise<Panel> } the promise returned by the function.
|
* @returns { Promise<Panel> } the promise returned by the function.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800004 - not an input method extension.
|
* @throws { BusinessError } 12800004 - not an input method extension.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
* @since 10
|
* @since 10
|
||||||
@ -692,7 +694,8 @@ declare namespace inputMethodEngine {
|
|||||||
*
|
*
|
||||||
* @param { Panel } panel - to be destroyed.
|
* @param { Panel } panel - to be destroyed.
|
||||||
* @param { AsyncCallback<void> } callback - the callback of destroyPanel.
|
* @param { AsyncCallback<void> } callback - the callback of destroyPanel.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
* @since 10
|
* @since 10
|
||||||
*/
|
*/
|
||||||
@ -703,7 +706,8 @@ declare namespace inputMethodEngine {
|
|||||||
*
|
*
|
||||||
* @param { Panel } panel - to be destroyed.
|
* @param { Panel } panel - to be destroyed.
|
||||||
* @returns { Promise<void> } the promise returned by the function.
|
* @returns { Promise<void> } the promise returned by the function.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
* @since 10
|
* @since 10
|
||||||
*/
|
*/
|
||||||
@ -870,7 +874,8 @@ declare namespace inputMethodEngine {
|
|||||||
*
|
*
|
||||||
* @param { number } action - action indicates the function of "enter" key.
|
* @param { number } action - action indicates the function of "enter" key.
|
||||||
* @param { AsyncCallback<boolean> } callback - the callback of sendKeyFunction.
|
* @param { AsyncCallback<boolean> } callback - the callback of sendKeyFunction.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800003 - input method client error.
|
* @throws { BusinessError } 12800003 - input method client error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
* @since 9
|
* @since 9
|
||||||
@ -882,7 +887,8 @@ declare namespace inputMethodEngine {
|
|||||||
*
|
*
|
||||||
* @param { number } action - action indicates the function of "enter" key.
|
* @param { number } action - action indicates the function of "enter" key.
|
||||||
* @returns { Promise<boolean> } the promise returned by the function.
|
* @returns { Promise<boolean> } the promise returned by the function.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800003 - input method client error.
|
* @throws { BusinessError } 12800003 - input method client error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
* @since 9
|
* @since 9
|
||||||
@ -892,9 +898,10 @@ declare namespace inputMethodEngine {
|
|||||||
/**
|
/**
|
||||||
* Delete text forward.
|
* Delete text forward.
|
||||||
*
|
*
|
||||||
* @param { number } length - length of text which will be deleted forward.
|
* @param { number } length - length of text which will be deleted forward. It can't be less than 0.
|
||||||
* @param { AsyncCallback<boolean> } callback - the callback of deleteForward.
|
* @param { AsyncCallback<boolean> } callback - the callback of deleteForward.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800002 - Input method engine error.
|
* @throws { BusinessError } 12800002 - Input method engine error.
|
||||||
* @throws { BusinessError } 12800003 - input method client error.
|
* @throws { BusinessError } 12800003 - input method client error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
@ -905,9 +912,10 @@ declare namespace inputMethodEngine {
|
|||||||
/**
|
/**
|
||||||
* Delete text forward.
|
* Delete text forward.
|
||||||
*
|
*
|
||||||
* @param { number } length - length of text which will be deleted forward.
|
* @param { number } length - length of text which will be deleted forward. It can't be less than 0.
|
||||||
* @returns { Promise<boolean> } the promise returned by the function.
|
* @returns { Promise<boolean> } the promise returned by the function.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800002 - Input method engine error.
|
* @throws { BusinessError } 12800002 - Input method engine error.
|
||||||
* @throws { BusinessError } 12800003 - input method client error.
|
* @throws { BusinessError } 12800003 - input method client error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
@ -918,8 +926,9 @@ declare namespace inputMethodEngine {
|
|||||||
/**
|
/**
|
||||||
* Delete text forward.
|
* Delete text forward.
|
||||||
*
|
*
|
||||||
* @param { number } length - length of text which will be deleted forward.
|
* @param { number } length - length of text which will be deleted forward. It can't be less than 0.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800002 - input method engine error.
|
* @throws { BusinessError } 12800002 - input method engine error.
|
||||||
* @throws { BusinessError } 12800003 - input method client error.
|
* @throws { BusinessError } 12800003 - input method client error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
@ -930,9 +939,10 @@ declare namespace inputMethodEngine {
|
|||||||
/**
|
/**
|
||||||
* Delete text backward.
|
* Delete text backward.
|
||||||
*
|
*
|
||||||
* @param { number } length - length of text which will be deleted backward.
|
* @param { number } length - length of text which will be deleted backward. It can't be less than 0.
|
||||||
* @param { AsyncCallback<boolean> } callback - the callback of deleteBackward.
|
* @param { AsyncCallback<boolean> } callback - the callback of deleteBackward.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800002 - Input method engine error.
|
* @throws { BusinessError } 12800002 - Input method engine error.
|
||||||
* @throws { BusinessError } 12800003 - input method client error.
|
* @throws { BusinessError } 12800003 - input method client error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
@ -943,9 +953,10 @@ declare namespace inputMethodEngine {
|
|||||||
/**
|
/**
|
||||||
* Delete text backward.
|
* Delete text backward.
|
||||||
*
|
*
|
||||||
* @param { number } length - length of text which will be deleted backward.
|
* @param { number } length - length of text which will be deleted backward. It can't be less than 0.
|
||||||
* @returns { Promise<boolean> } the promise returned by the function.
|
* @returns { Promise<boolean> } the promise returned by the function.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800002 - Input method engine error.
|
* @throws { BusinessError } 12800002 - Input method engine error.
|
||||||
* @throws { BusinessError } 12800003 - input method client error.
|
* @throws { BusinessError } 12800003 - input method client error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
@ -956,8 +967,9 @@ declare namespace inputMethodEngine {
|
|||||||
/**
|
/**
|
||||||
* Delete text backward.
|
* Delete text backward.
|
||||||
*
|
*
|
||||||
* @param { number } length - length of text which will be deleted backward.
|
* @param { number } length - length of text which will be deleted backward. It can't be less than 0.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800002 - input method engine error.
|
* @throws { BusinessError } 12800002 - input method engine error.
|
||||||
* @throws { BusinessError } 12800003 - input method client error.
|
* @throws { BusinessError } 12800003 - input method client error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
@ -970,7 +982,8 @@ declare namespace inputMethodEngine {
|
|||||||
*
|
*
|
||||||
* @param { string } text - text which will be inserted.
|
* @param { string } text - text which will be inserted.
|
||||||
* @param { AsyncCallback<boolean> } callback - the callback of insertText.
|
* @param { AsyncCallback<boolean> } callback - the callback of insertText.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800002 - Input method engine error.
|
* @throws { BusinessError } 12800002 - Input method engine error.
|
||||||
* @throws { BusinessError } 12800003 - input method client error.
|
* @throws { BusinessError } 12800003 - input method client error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
@ -983,7 +996,8 @@ declare namespace inputMethodEngine {
|
|||||||
*
|
*
|
||||||
* @param { string } text - text which will be inserted.
|
* @param { string } text - text which will be inserted.
|
||||||
* @returns { Promise<boolean> } the promise returned by the function.
|
* @returns { Promise<boolean> } the promise returned by the function.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800002 - Input method engine error.
|
* @throws { BusinessError } 12800002 - Input method engine error.
|
||||||
* @throws { BusinessError } 12800003 - input method client error.
|
* @throws { BusinessError } 12800003 - input method client error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
@ -995,7 +1009,8 @@ declare namespace inputMethodEngine {
|
|||||||
* Insert text into Editor.
|
* Insert text into Editor.
|
||||||
*
|
*
|
||||||
* @param { string } text - text which will be inserted.
|
* @param { string } text - text which will be inserted.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800002 - input method engine error.
|
* @throws { BusinessError } 12800002 - input method engine error.
|
||||||
* @throws { BusinessError } 12800003 - input method client error.
|
* @throws { BusinessError } 12800003 - input method client error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
@ -1006,9 +1021,10 @@ declare namespace inputMethodEngine {
|
|||||||
/**
|
/**
|
||||||
* Get the text before cursor.
|
* Get the text before cursor.
|
||||||
*
|
*
|
||||||
* @param { number } length - the length of text which will be got.
|
* @param { number } length - the length of text which will be got. It can't be less than 0.
|
||||||
* @param { AsyncCallback<string> } callback - the callback of getForward.
|
* @param { AsyncCallback<string> } callback - the callback of getForward.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800003 - input method client error.
|
* @throws { BusinessError } 12800003 - input method client error.
|
||||||
* @throws { BusinessError } 12800006 - Input method controller error.
|
* @throws { BusinessError } 12800006 - Input method controller error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
@ -1019,9 +1035,10 @@ declare namespace inputMethodEngine {
|
|||||||
/**
|
/**
|
||||||
* Get the text before cursor.
|
* Get the text before cursor.
|
||||||
*
|
*
|
||||||
* @param { number } length - the length of text which will be got.
|
* @param { number } length - the length of text which will be got. It can't be less than 0.
|
||||||
* @returns { Promise<string> } the promise returned by the function.
|
* @returns { Promise<string> } the promise returned by the function.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800003 - input method client error.
|
* @throws { BusinessError } 12800003 - input method client error.
|
||||||
* @throws { BusinessError } 12800006 - Input method controller error.
|
* @throws { BusinessError } 12800006 - Input method controller error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
@ -1032,9 +1049,10 @@ declare namespace inputMethodEngine {
|
|||||||
/**
|
/**
|
||||||
* Get the text before cursor.
|
* Get the text before cursor.
|
||||||
*
|
*
|
||||||
* @param { number } length - the length of text which will be got.
|
* @param { number } length - the length of text which will be got. It can't be less than 0.
|
||||||
* @returns { string } the text string before cursor.
|
* @returns { string } the text string before cursor.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800003 - input method client error.
|
* @throws { BusinessError } 12800003 - input method client error.
|
||||||
* @throws { BusinessError } 12800006 - input method controller error.
|
* @throws { BusinessError } 12800006 - input method controller error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
@ -1045,9 +1063,10 @@ declare namespace inputMethodEngine {
|
|||||||
/**
|
/**
|
||||||
* Get the text after cursor.
|
* Get the text after cursor.
|
||||||
*
|
*
|
||||||
* @param { number } length - the length of text which will be got.
|
* @param { number } length - the length of text which will be got.It can't be less than 0.
|
||||||
* @param { AsyncCallback<string> } callback - the callback of getBackward.
|
* @param { AsyncCallback<string> } callback - the callback of getBackward.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800003 - input method client error.
|
* @throws { BusinessError } 12800003 - input method client error.
|
||||||
* @throws { BusinessError } 12800006 - Input method controller error.
|
* @throws { BusinessError } 12800006 - Input method controller error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
@ -1058,9 +1077,10 @@ declare namespace inputMethodEngine {
|
|||||||
/**
|
/**
|
||||||
* Get the text after cursor.
|
* Get the text after cursor.
|
||||||
*
|
*
|
||||||
* @param { number } length - the length of text which will be got.
|
* @param { number } length - the length of text which will be got.It can't be less than 0.
|
||||||
* @returns { Promise<string> } the promise returned by the function.
|
* @returns { Promise<string> } the promise returned by the function.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800003 - input method client error.
|
* @throws { BusinessError } 12800003 - input method client error.
|
||||||
* @throws { BusinessError } 12800006 - Input method controller error.
|
* @throws { BusinessError } 12800006 - Input method controller error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
@ -1071,9 +1091,10 @@ declare namespace inputMethodEngine {
|
|||||||
/**
|
/**
|
||||||
* Get the text after cursor.
|
* Get the text after cursor.
|
||||||
*
|
*
|
||||||
* @param { number } length - the length of text which will be got.
|
* @param { number } length - the length of text which will be got. It can't be less than 0.
|
||||||
* @returns { string } the text string after cursor.
|
* @returns { string } the text string after cursor.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800003 - input method client error.
|
* @throws { BusinessError } 12800003 - input method client error.
|
||||||
* @throws { BusinessError } 12800006 - input method controller error.
|
* @throws { BusinessError } 12800006 - input method controller error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
@ -1114,9 +1135,10 @@ declare namespace inputMethodEngine {
|
|||||||
/**
|
/**
|
||||||
* Move cursor from input method.
|
* Move cursor from input method.
|
||||||
*
|
*
|
||||||
* @param { number } direction - Indicates the distance of cursor to be moved.
|
* @param { number } direction - Indicates the distance of cursor to be moved. It can't be less than 0.
|
||||||
* @param { AsyncCallback<void> } callback - the callback of moveCursor.
|
* @param { AsyncCallback<void> } callback - the callback of moveCursor.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800003 - input method client error.
|
* @throws { BusinessError } 12800003 - input method client error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
* @since 9
|
* @since 9
|
||||||
@ -1126,9 +1148,10 @@ declare namespace inputMethodEngine {
|
|||||||
/**
|
/**
|
||||||
* Move cursor from input method.
|
* Move cursor from input method.
|
||||||
*
|
*
|
||||||
* @param { number } direction - Indicates the distance of cursor to be moved.
|
* @param { number } direction - Indicates the distance of cursor to be moved. It can't be less than 0.
|
||||||
* @returns { Promise<void> } the promise returned by the function.
|
* @returns { Promise<void> } the promise returned by the function.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800003 - input method client error.
|
* @throws { BusinessError } 12800003 - input method client error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
* @since 9
|
* @since 9
|
||||||
@ -1138,8 +1161,9 @@ declare namespace inputMethodEngine {
|
|||||||
/**
|
/**
|
||||||
* Move cursor from input method.
|
* Move cursor from input method.
|
||||||
*
|
*
|
||||||
* @param { number } direction - Indicates the distance of cursor to be moved.
|
* @param { number } direction - Indicates the distance of cursor to be moved. It can't be less than 0.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800003 - input method client error.
|
* @throws { BusinessError } 12800003 - input method client error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
* @since 10
|
* @since 10
|
||||||
@ -1151,7 +1175,8 @@ declare namespace inputMethodEngine {
|
|||||||
*
|
*
|
||||||
* @param { Range } range - indicates the range of selected text in editor.
|
* @param { Range } range - indicates the range of selected text in editor.
|
||||||
* @param { AsyncCallback<void> } callback - the callback of selectByRange.
|
* @param { AsyncCallback<void> } callback - the callback of selectByRange.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800003 - input method client error.
|
* @throws { BusinessError } 12800003 - input method client error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
* @since 10
|
* @since 10
|
||||||
@ -1163,7 +1188,8 @@ declare namespace inputMethodEngine {
|
|||||||
*
|
*
|
||||||
* @param { Range } range - indicates the range of selected text in editor.
|
* @param { Range } range - indicates the range of selected text in editor.
|
||||||
* @returns { Promise<void> } the promise returned by the function.
|
* @returns { Promise<void> } the promise returned by the function.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800003 - input method client error.
|
* @throws { BusinessError } 12800003 - input method client error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
* @since 10
|
* @since 10
|
||||||
@ -1174,7 +1200,8 @@ declare namespace inputMethodEngine {
|
|||||||
* Select text in editor by range.
|
* Select text in editor by range.
|
||||||
*
|
*
|
||||||
* @param { Range } range - indicates the range of selected text in editor.
|
* @param { Range } range - indicates the range of selected text in editor.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800003 - input method client error.
|
* @throws { BusinessError } 12800003 - input method client error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
* @since 10
|
* @since 10
|
||||||
@ -1186,7 +1213,8 @@ declare namespace inputMethodEngine {
|
|||||||
*
|
*
|
||||||
* @param { Movement } movement - indicates the movement of cursor when selecting.
|
* @param { Movement } movement - indicates the movement of cursor when selecting.
|
||||||
* @param { AsyncCallback<void> } callback - the callback of selectByMovement.
|
* @param { AsyncCallback<void> } callback - the callback of selectByMovement.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800003 - input method client error.
|
* @throws { BusinessError } 12800003 - input method client error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
* @since 10
|
* @since 10
|
||||||
@ -1198,7 +1226,8 @@ declare namespace inputMethodEngine {
|
|||||||
*
|
*
|
||||||
* @param { Movement } movement - indicates the movement of cursor when selecting.
|
* @param { Movement } movement - indicates the movement of cursor when selecting.
|
||||||
* @returns { Promise<void> } the promise returned by the function.
|
* @returns { Promise<void> } the promise returned by the function.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800003 - input method client error.
|
* @throws { BusinessError } 12800003 - input method client error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
* @since 10
|
* @since 10
|
||||||
@ -1209,7 +1238,8 @@ declare namespace inputMethodEngine {
|
|||||||
* Select text in editor by cursor movement.
|
* Select text in editor by cursor movement.
|
||||||
*
|
*
|
||||||
* @param { Movement } movement - indicates the movement of cursor when selecting.
|
* @param { Movement } movement - indicates the movement of cursor when selecting.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800003 - input method client error.
|
* @throws { BusinessError } 12800003 - input method client error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
* @since 10
|
* @since 10
|
||||||
@ -1256,7 +1286,8 @@ declare namespace inputMethodEngine {
|
|||||||
*
|
*
|
||||||
* @param { ExtendAction } action - action code which will be send.
|
* @param { ExtendAction } action - action code which will be send.
|
||||||
* @param { AsyncCallback<void> } callback - the callback of sendExtendAction.
|
* @param { AsyncCallback<void> } callback - the callback of sendExtendAction.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800003 - input method client error.
|
* @throws { BusinessError } 12800003 - input method client error.
|
||||||
* @throws { BusinessError } 12800006 - Input method controller error.
|
* @throws { BusinessError } 12800006 - Input method controller error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
@ -1269,7 +1300,8 @@ declare namespace inputMethodEngine {
|
|||||||
*
|
*
|
||||||
* @param { ExtendAction } action - action code which will be send.
|
* @param { ExtendAction } action - action code which will be send.
|
||||||
* @returns { Promise<void> } the promise returned by the function.
|
* @returns { Promise<void> } the promise returned by the function.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800003 - input method client error.
|
* @throws { BusinessError } 12800003 - input method client error.
|
||||||
* @throws { BusinessError } 12800006 - Input method controller error.
|
* @throws { BusinessError } 12800006 - Input method controller error.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
@ -1282,7 +1314,8 @@ declare namespace inputMethodEngine {
|
|||||||
*
|
*
|
||||||
* @param { Record<string, CommandDataType> } commandData - command data which will be send.Max size 32KB.
|
* @param { Record<string, CommandDataType> } commandData - command data which will be send.Max size 32KB.
|
||||||
* @returns { Promise<void> } the promise returned by the function.
|
* @returns { Promise<void> } the promise returned by the function.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @throws { BusinessError } 12800003 - input method client error.
|
* @throws { BusinessError } 12800003 - input method client error.
|
||||||
* @throws { BusinessError } 12800010 - not default input method configured by system.
|
* @throws { BusinessError } 12800010 - not default input method configured by system.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
@ -1501,7 +1534,8 @@ declare namespace inputMethodEngine {
|
|||||||
*
|
*
|
||||||
* @param { string } path - the path of ui content.
|
* @param { string } path - the path of ui content.
|
||||||
* @param { AsyncCallback<void> } callback - the callback of setUiContent.
|
* @param { AsyncCallback<void> } callback - the callback of setUiContent.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
* @since 10
|
* @since 10
|
||||||
*/
|
*/
|
||||||
@ -1513,7 +1547,8 @@ declare namespace inputMethodEngine {
|
|||||||
*
|
*
|
||||||
* @param { string } path - the path of ui content.
|
* @param { string } path - the path of ui content.
|
||||||
* @returns { Promise<void> } the promise returned by the function.
|
* @returns { Promise<void> } the promise returned by the function.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
* @since 10
|
* @since 10
|
||||||
*/
|
*/
|
||||||
@ -1526,7 +1561,8 @@ declare namespace inputMethodEngine {
|
|||||||
* @param { string } path - the path of ui content.
|
* @param { string } path - the path of ui content.
|
||||||
* @param { LocalStorage } storage - the data object shared within the content instance loaded by the panel.
|
* @param { LocalStorage } storage - the data object shared within the content instance loaded by the panel.
|
||||||
* @param { AsyncCallback<void> } callback - the callback of setUiContent.
|
* @param { AsyncCallback<void> } callback - the callback of setUiContent.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
* @since 10
|
* @since 10
|
||||||
*/
|
*/
|
||||||
@ -1539,7 +1575,8 @@ declare namespace inputMethodEngine {
|
|||||||
* @param { string } path - the path of ui content.
|
* @param { string } path - the path of ui content.
|
||||||
* @param { LocalStorage } storage - the data object shared within the content instance loaded by the panel.
|
* @param { LocalStorage } storage - the data object shared within the content instance loaded by the panel.
|
||||||
* @returns { Promise<void> } the promise returned by the function.
|
* @returns { Promise<void> } the promise returned by the function.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
* @since 10
|
* @since 10
|
||||||
*/
|
*/
|
||||||
@ -1551,7 +1588,8 @@ declare namespace inputMethodEngine {
|
|||||||
* @param { number } width - the new width of the panel.
|
* @param { number } width - the new width of the panel.
|
||||||
* @param { number } height - the new height of the panel.
|
* @param { number } height - the new height of the panel.
|
||||||
* @param { AsyncCallback<void> } callback - the callback of resize.
|
* @param { AsyncCallback<void> } callback - the callback of resize.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
* @since 10
|
* @since 10
|
||||||
*/
|
*/
|
||||||
@ -1563,7 +1601,8 @@ declare namespace inputMethodEngine {
|
|||||||
* @param { number } width - the new width of the panel.
|
* @param { number } width - the new width of the panel.
|
||||||
* @param { number } height - the new height of the panel.
|
* @param { number } height - the new height of the panel.
|
||||||
* @returns { Promise<void> } the promise returned by the function.
|
* @returns { Promise<void> } the promise returned by the function.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
* @since 10
|
* @since 10
|
||||||
*/
|
*/
|
||||||
@ -1576,7 +1615,8 @@ declare namespace inputMethodEngine {
|
|||||||
* @param { number } x - the x-coordinate of the new position.
|
* @param { number } x - the x-coordinate of the new position.
|
||||||
* @param { number } y - the y-coordinate of the new position.
|
* @param { number } y - the y-coordinate of the new position.
|
||||||
* @param { AsyncCallback<void> } callback - the callback of moveTo.
|
* @param { AsyncCallback<void> } callback - the callback of moveTo.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
* @since 10
|
* @since 10
|
||||||
*/
|
*/
|
||||||
@ -1589,7 +1629,8 @@ declare namespace inputMethodEngine {
|
|||||||
* @param { number } x - the x-coordinate of the new position.
|
* @param { number } x - the x-coordinate of the new position.
|
||||||
* @param { number } y - the y-coordinate of the new position.
|
* @param { number } y - the y-coordinate of the new position.
|
||||||
* @returns { Promise<void> } the promise returned by the function.
|
* @returns { Promise<void> } the promise returned by the function.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
* @since 10
|
* @since 10
|
||||||
*/
|
*/
|
||||||
@ -1681,7 +1722,8 @@ declare namespace inputMethodEngine {
|
|||||||
* and show it again at appropriate opportunity.</p>
|
* and show it again at appropriate opportunity.</p>
|
||||||
*
|
*
|
||||||
* @param { PanelFlag } flag - the callback of changeFlag.
|
* @param { PanelFlag } flag - the callback of changeFlag.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
* @since 10
|
* @since 10
|
||||||
*/
|
*/
|
||||||
@ -1694,7 +1736,8 @@ declare namespace inputMethodEngine {
|
|||||||
* @param { boolean } isPrivacyMode - if the value is true, the privacy mode will be set,
|
* @param { boolean } isPrivacyMode - if the value is true, the privacy mode will be set,
|
||||||
* otherwise the non-privacy mode will be set.
|
* otherwise the non-privacy mode will be set.
|
||||||
* @throws { BusinessError } 201 - permissions check fails.
|
* @throws { BusinessError } 201 - permissions check fails.
|
||||||
* @throws { BusinessError } 401 - parameter error.
|
* @throws { BusinessError } 401 - parameter error. Possible causes:
|
||||||
|
* 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.
|
||||||
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
* @syscap SystemCapability.MiscServices.InputMethodFramework
|
||||||
* @since 11
|
* @since 11
|
||||||
*/
|
*/
|
||||||
|
Loading…
Reference in New Issue
Block a user