diff --git a/api/@ohos.accessibility.config.d.ts b/api/@ohos.accessibility.config.d.ts index 09fea52272c8fda2ba773a0c2301a25d3ea0f5b4..01af62f9e2eb2019d17e52d5172bcd87845af99c 100644 --- a/api/@ohos.accessibility.config.d.ts +++ b/api/@ohos.accessibility.config.d.ts @@ -36,7 +36,8 @@ declare namespace config { * * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ const daltonizationState: Config; /** @@ -44,17 +45,20 @@ declare namespace config { * * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ const audioMono: Config; /** * Indicates the configuration of audio balance. * + * @type { Config } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - const audioBalance: Config; + const audioBalance: Config; /** * Indicates the configuration of high-contrast text. * @@ -68,105 +72,129 @@ declare namespace config { /** * Indicates the configuration of invert color. * + * @type { Config } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - var invertColor: Config; + let invertColor: Config; /** * Indicates the configuration of daltonization color filter. * + * @type { Config } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - var daltonizationColorFilter: Config; + let daltonizationColorFilter: Config; /** * Indicates the configuration of content timeout. * + * @type { Config } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - var contentTimeout: Config; + let contentTimeout: Config; /** * Indicates the configuration of animation state. * + * @type { Config } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - var animationOff: Config; + let animationOff: Config; /** * Indicates the configuration of brightness discount. * + * @type { Config } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - var brightnessDiscount: Config; + let brightnessDiscount: Config; /** * Indicates the configuration of mouse key state. * + * @type { Config } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - var mouseKey: Config; + let mouseKey: Config; /** * Indicates the configuration of mouse auto click. * + * @type { Config } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - var mouseAutoClick: Config; + let mouseAutoClick: Config; /** * Indicates the configuration of short key state. * + * @type { Config } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - var shortkey: Config; + let shortkey: Config; /** * Indicates the configuration of short key target. * + * @type { Config } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - var shortkeyTarget: Config; + let shortkeyTarget: Config; /** * Indicates the configuration of short key multi targets. * * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ const shortkeyMultiTargets: Config>; /** * Indicates the configuration of captions state. * + * @type { Config } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - var captions: Config; + let captions: Config; /** * Indicates the configuration of captions style. * + * @type { Config } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - var captionsStyle: Config; + let captionsStyle: Config; /** * Indicates the configuration of click response time. * * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ const clickResponseTime: Config; /** @@ -174,7 +202,8 @@ declare namespace config { * * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ const ignoreRepeatClick: Config; /** @@ -182,7 +211,8 @@ declare namespace config { * * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ const repeatClickInterval: Config; /** @@ -190,7 +220,8 @@ declare namespace config { * * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ const screenMagnification: Config; @@ -204,7 +235,7 @@ declare namespace config { * @throws { BusinessError } 201 - Permission verification failed. * The application does not have the permission required to call the API. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. @@ -212,7 +243,8 @@ declare namespace config { * @throws { BusinessError } 9300002 - Target ability already enabled. * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function enableAbility(name: string, capability: Array): Promise; @@ -226,7 +258,7 @@ declare namespace config { * @throws { BusinessError } 201 - Permission verification failed. * The application does not have the permission required to call the API. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. @@ -234,7 +266,8 @@ declare namespace config { * @throws { BusinessError } 9300002 - Target ability already enabled. * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function enableAbility( name: string, @@ -251,14 +284,15 @@ declare namespace config { * @throws { BusinessError } 201 - Permission verification failed. * The application does not have the permission required to call the API. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 9300001 - Invalid bundle name or ability name. * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function disableAbility(name: string): Promise; @@ -271,14 +305,15 @@ declare namespace config { * @throws { BusinessError } 201 - Permission verification failed. * The application does not have the permission required to call the API. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 9300001 - Invalid bundle name or ability name. * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function disableAbility(name: string, callback: AsyncCallback): void; @@ -291,13 +326,14 @@ declare namespace config { * @throws { BusinessError } 201 - Permission verification failed. * The application does not have the permission required to call the API. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function on(type: 'enabledAccessibilityExtensionListChange', callback: Callback): void; @@ -310,13 +346,14 @@ declare namespace config { * @throws { BusinessError } 201 - Permission verification failed. * The application does not have the permission required to call the API. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function on(type: 'installedAccessibilityListChange', callback: Callback): void; @@ -329,13 +366,14 @@ declare namespace config { * @throws { BusinessError } 201 - Permission verification failed. * The application does not have the permission required to call the API. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function off(type: 'enabledAccessibilityExtensionListChange', callback?: Callback): void; @@ -348,13 +386,14 @@ declare namespace config { * @throws { BusinessError } 201 - Permission verification failed. * The application does not have the permission required to call the API. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function off(type: 'installedAccessibilityListChange', callback?: Callback): void; @@ -391,7 +430,7 @@ declare namespace config { * @throws { BusinessError } 201 - Permission verification failed. * The application does not have the permission required to call the API. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. @@ -426,7 +465,7 @@ declare namespace config { * @throws { BusinessError } 201 - Permission verification failed. * The application does not have the permission required to call the API. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. @@ -518,13 +557,14 @@ declare namespace config { * @throws { BusinessError } 201 - Permission verification failed. * The application does not have the permission required to call the API. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ on(callback: Callback): void; @@ -538,7 +578,8 @@ declare namespace config { * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ off(callback?: Callback): void; } @@ -549,7 +590,8 @@ declare namespace config { * @typedef {'Normal' | 'Protanomaly' | 'Deuteranomaly' | 'Tritanomaly'} * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ type DaltonizationColorFilter = 'Normal' | 'Protanomaly' | 'Deuteranomaly' | 'Tritanomaly'; @@ -559,7 +601,8 @@ declare namespace config { * @typedef {'Short' | 'Medium' | 'Long'} * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ type ClickResponseTime = 'Short' | 'Medium' | 'Long'; @@ -569,7 +612,8 @@ declare namespace config { * @typedef {'Shortest' | 'Short' | 'Medium' | 'Long' | 'Longest'} * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ type RepeatClickInterval = 'Shortest' | 'Short' | 'Medium' | 'Long' | 'Longest'; } diff --git a/api/@ohos.accessibility.d.ts b/api/@ohos.accessibility.d.ts index 0f04d961ab1d4bb58decd1c3194d1e161dc7be29..5e07589bc014e383438d5f2557e498fa0f5b59c0 100644 --- a/api/@ohos.accessibility.d.ts +++ b/api/@ohos.accessibility.d.ts @@ -25,7 +25,7 @@ import { Resource } from './global/resource'; /** * Accessibility action that the ability can execute. * - * @enum { number } + * @enum { int } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 @@ -211,15 +211,6 @@ export enum AccessibilityAction { */ CONTROL_CENTER = 19, - /** - * Common - * - * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @systemapi - * @since 20 - */ - COMMON = 20, - /** * SpanClick * @@ -227,17 +218,17 @@ export enum AccessibilityAction { * @systemapi * @since 20 */ - SPAN_CLICK = 21 + SPAN_CLICK = 20 } - /** * AccessibilityEvent type * - * @enum { number } + * @enum { int } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ export enum AccessibilityEventType { //EventType @@ -247,6 +238,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_ACCESSIBILITY_FOCUS = 0, @@ -256,6 +248,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_ACCESSIBILITY_FOCUS_CLEAR = 1, @@ -265,6 +258,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_CLICK = 2, @@ -274,6 +268,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_LONG_CLICK = 3, @@ -283,6 +278,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_SELECT = 4, @@ -292,6 +288,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_HOVER_ENTER = 5, @@ -301,6 +298,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_HOVER_EXIT = 6, @@ -310,6 +308,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_FOCUS = 7, @@ -319,6 +318,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_TEXT_UPDATE = 8, @@ -328,6 +328,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_TEXT_SELECTION_UPDATE = 9, @@ -337,6 +338,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_SCROLL = 10, @@ -346,6 +348,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_REQUEST_FOCUS_FOR_ACCESSIBILITY = 11, @@ -355,6 +358,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_ANNOUNCE_FOR_ACCESSIBILITY = 12, @@ -364,6 +368,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_REQUEST_FOCUS_FOR_ACCESSIBILITY_NOT_INTERRUPT = 13, @@ -373,6 +378,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_ANNOUNCE_FOR_ACCESSIBILITY_NOT_INTERRUPT = 14, @@ -382,6 +388,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_ELEMENT_INFO_CHANGE = 15, @@ -391,6 +398,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_SCROLLING = 16, @@ -401,6 +409,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_WINDOW_ADD = 17, @@ -410,6 +419,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_WINDOW_REMOVE = 18, @@ -419,6 +429,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_WINDOW_BOUNDS = 19, @@ -428,6 +439,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_WINDOW_ACTIVE = 20, @@ -437,6 +449,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_WINDOW_FOCUS = 21, @@ -446,6 +459,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_WINDOW_PROPERTY = 22, @@ -455,6 +469,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_WINDOW_LAYER = 23, @@ -465,6 +480,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_TOUCH_BEGIN = 24, @@ -474,6 +490,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_TOUCH_END = 25, @@ -484,6 +501,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_PAGE_CONTENT_UPDATE = 26, @@ -493,6 +511,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_PAGE_STATE_UPDATE = 27, @@ -502,6 +521,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_PAGE_OPEN = 28, @@ -511,6 +531,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_PAGE_CLOSE = 29, @@ -521,6 +542,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_SWIPE_LEFT = 30, @@ -530,6 +552,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_SWIPE_LEFT_THEN_RIGHT = 31, @@ -539,6 +562,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_SWIPE_LEFT_THEN_UP = 32, @@ -548,6 +572,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_SWIPE_LEFT_THEN_DOWN = 33, @@ -557,6 +582,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_SWIPE_RIGHT = 34, @@ -566,6 +592,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_SWIPE_RIGHT_THEN_LEFT = 35, @@ -575,6 +602,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_SWIPE_RIGHT_THEN_UP = 36, @@ -584,6 +612,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_SWIPE_RIGHT_THEN_DOWN = 37, @@ -593,6 +622,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_SWIPE_UP = 38, @@ -602,6 +632,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_SWIPE_UP_THEN_LEFT = 39, @@ -611,6 +642,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_SWIPE_UP_THEN_RIGHT = 40, @@ -620,6 +652,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_SWIPE_UP_THEN_DOWN = 41, @@ -629,6 +662,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_SWIPE_DOWN = 42, @@ -638,6 +672,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_SWIPE_DOWN_THEN_LEFT = 43, @@ -647,6 +682,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_SWIPE_DOWN_THEN_RIGHT = 44, @@ -656,6 +692,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_SWIPE_DOWN_THEN_UP = 45, @@ -665,6 +702,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_TWO_FINGER_SINGLE_TAP = 46, @@ -674,6 +712,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_TWO_FINGER_DOUBLE_TAP = 47, @@ -683,6 +722,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_TWO_FINGER_DOUBLE_TAP_AND_HOLD = 48, @@ -692,6 +732,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_TWO_FINGER_TRIPLE_TAP = 49, @@ -701,6 +742,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_TWO_FINGER_TRIPLE_TAP_AND_HOLD = 50, @@ -710,6 +752,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_THREE_FINGER_SINGLE_TAP = 51, @@ -719,6 +762,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_THREE_FINGER_DOUBLE_TAP = 52, @@ -728,6 +772,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_THREE_FINGER_DOUBLE_TAP_AND_HOLD = 53, @@ -737,6 +782,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_THREE_FINGER_TRIPLE_TAP = 54, @@ -746,6 +792,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_THREE_FINGER_TRIPLE_TAP_AND_HOLD = 55, @@ -755,6 +802,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_FOUR_FINGER_SINGLE_TAP = 56, @@ -764,6 +812,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_FOUR_FINGER_DOUBLE_TAP = 57, @@ -773,6 +822,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_FOUR_FINGER_DOUBLE_TAP_AND_HOLD = 58, @@ -782,6 +832,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_FOUR_FINGER_TRIPLE_TAP = 59, @@ -791,6 +842,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_FOUR_FINGER_TRIPLE_TAP_AND_HOLD = 60, @@ -800,6 +852,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_THREE_FINGER_SWIPE_UP = 61, @@ -809,6 +862,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_THREE_FINGER_SWIPE_DOWN = 62, @@ -818,6 +872,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_THREE_FINGER_SWIPE_LEFT = 63, @@ -827,6 +882,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_THREE_FINGER_SWIPE_RIGHT = 64, @@ -836,6 +892,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_FOUR_FINGER_SWIPE_UP = 65, @@ -845,6 +902,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_FOUR_FINGER_SWIPE_DOWN = 66, @@ -854,6 +912,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_FOUR_FINGER_SWIPE_LEFT = 67, @@ -863,6 +922,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_FOUR_FINGER_SWIPE_RIGHT = 68 } @@ -898,7 +958,8 @@ declare namespace accessibility { * *{ 'audible' | 'generic' | 'haptic' | 'spoken' | 'visual' } * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * The type of the Ability app. @@ -906,7 +967,8 @@ declare namespace accessibility { * { 'audible' | 'generic' | 'haptic' | 'spoken' | 'visual' | 'all' } * @typedef {'audible' | 'generic' | 'haptic' | 'spoken' | 'visual' | 'all'} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ type AbilityType = 'audible' | 'generic' | 'haptic' | 'spoken' | 'visual' | 'all'; @@ -994,7 +1056,8 @@ declare namespace accessibility { * * @typedef {'enable' | 'disable' | 'install'} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ type AbilityState = 'enable' | 'disable' | 'install'; @@ -1009,7 +1072,8 @@ declare namespace accessibility { * * @typedef {'retrieve' | 'touchGuide' | 'keyEventObserver' | 'zoom' | 'gesture'} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ type Capability = 'retrieve' | 'touchGuide' | 'keyEventObserver' | 'zoom' | 'gesture'; @@ -1116,7 +1180,8 @@ declare namespace accessibility { * Checks screen reader ability (which is used by talkback) is enabled. * @returns { boolean } Returns true if the screen reader is enabled; return false otherwise. * @syscap SystemCapability.BarrierFree.Accessibility.Vision - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function isScreenReaderOpenSync(): boolean; @@ -1156,12 +1221,13 @@ declare namespace accessibility { * @param { AbilityType } abilityType The type of the accessibility ability. {@code AbilityType} eg.spoken * @param { AbilityState } stateType The state of the accessibility ability. {@code AbilityState} eg.installed * @returns { Promise> } Returns the list of abilityInfos. - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getAccessibilityExtensionList( abilityType: AbilityType, @@ -1174,12 +1240,13 @@ declare namespace accessibility { * @param { AbilityType } abilityType The type of the accessibility ability. {@code AbilityType} eg.spoken * @param { AbilityState } stateType The state of the accessibility ability. {@code AbilityState} eg.installed * @param { AsyncCallback> } callback - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getAccessibilityExtensionList( abilityType: AbilityType, @@ -1194,7 +1261,8 @@ declare namespace accessibility { * @param { AbilityState } stateType The state of the accessibility ability. {@code AbilityState} eg.installed * @returns { Array } Returns the list of abilityInfos. * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function getAccessibilityExtensionListSync( abilityType: AbilityType, @@ -1230,7 +1298,7 @@ declare namespace accessibility { * * @param { EventInfo } event The object of the accessibility {@code EventInfo} . * @param { AsyncCallback } callback Asynchronous callback interface. - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. @@ -1255,7 +1323,7 @@ declare namespace accessibility { * * @param { EventInfo } event The object of the accessibility {@code EventInfo} . * @returns { Promise } Returns {@code true} if success ; returns {@code false} otherwise. - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. @@ -1293,7 +1361,7 @@ declare namespace accessibility { * * @param { 'accessibilityStateChange' } type state event type. * @param { Callback } callback Asynchronous callback interface. - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. @@ -1305,7 +1373,7 @@ declare namespace accessibility { * * @param { 'accessibilityStateChange' } type state event type. * @param { Callback } callback Asynchronous callback interface. - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. @@ -1332,7 +1400,7 @@ declare namespace accessibility { * * @param { 'touchGuideStateChange' } type state event type. * @param { Callback } callback Asynchronous callback interface. - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. @@ -1356,7 +1424,7 @@ declare namespace accessibility { * Register the observe of the screen reader state changed. * @param { 'screenReaderStateChange' } type state event type. * @param { Callback } callback callback Asynchronous callback interface. - * @throws { BusinessError } 401 Input parameter error. Possible causes: + * @throws { BusinessError } 401 Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. @@ -1375,11 +1443,6 @@ declare namespace accessibility { */ function onScreenReaderStateChange(type: 'screenReaderStateChange', callback: Callback): void; - /** - * @arkts 1.2 - */ - overload on { onAccessibilityStateChange, onTouchGuideStateChange, onScreenReaderStateChange }; - /** * Register the observe of the touch mode changed. * @param { 'touchModeChange' } type touch mode change. @@ -1393,12 +1456,17 @@ declare namespace accessibility { */ function on(type: 'touchModeChange', callback: Callback): void; + /** + * @arkts 1.2 + */ + overload on { onAccessibilityStateChange, onTouchGuideStateChange, onScreenReaderStateChange}; + /** * Unregister the observe of the accessibility state changed. * * @param { 'accessibilityStateChange' } type state event type * @param { Callback } callback Asynchronous callback interface. - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. @@ -1410,7 +1478,7 @@ declare namespace accessibility { * * @param { 'accessibilityStateChange' } type state event type * @param { Callback } callback Asynchronous callback interface. - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. @@ -1437,7 +1505,7 @@ declare namespace accessibility { * * @param { 'touchGuideStateChange' } type state event type * @param { Callback } callback Asynchronous callback interface. - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. @@ -1461,7 +1529,7 @@ declare namespace accessibility { * Unregister the observe of the screen reader state changed. * @param { 'screenReaderStateChange' } type state event type * @param { Callback } callback callback Asynchronous callback interface. - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. @@ -1480,11 +1548,6 @@ declare namespace accessibility { */ function offScreenReaderStateChange(type: 'screenReaderStateChange', callback?: Callback): void; - /** - * @arkts 1.2 - */ - overload off { offAccessibilityStateChange, offTouchGuideStateChange, offScreenReaderStateChange }; - /** * Unregister the observe of the touch mode changed. * @param { 'touchModeChange' } type touch mode change. @@ -1498,6 +1561,12 @@ declare namespace accessibility { */ function off(type: 'touchModeChange', callback?: Callback): void; + /** + * @since 20 + * @arkts 1.2 + */ + overload off { offAccessibilityStateChange, offTouchGuideStateChange, offScreenReaderStateChange}; + /** * Get the captions manager. * @@ -1538,7 +1607,7 @@ declare namespace accessibility { * * @param { 'enableChange' } type * @param { Callback } callback - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. @@ -1553,7 +1622,7 @@ declare namespace accessibility { * * @param { 'styleChange' } type * @param { Callback } callback - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. @@ -1568,7 +1637,7 @@ declare namespace accessibility { * * @param { 'enableChange' } type * @param { Callback } callback - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. @@ -1583,7 +1652,7 @@ declare namespace accessibility { * * @param { 'styleChange' } type * @param { Callback } callback - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. @@ -1599,7 +1668,8 @@ declare namespace accessibility { * * @typedef {'none' | 'raised' | 'depressed' | 'uniform' | 'dropShadow'} * @syscap SystemCapability.BarrierFree.Accessibility.Hearing - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ type CaptionsFontEdgeType = 'none' | 'raised' | 'depressed' | 'uniform' | 'dropShadow'; /** @@ -1607,7 +1677,8 @@ declare namespace accessibility { * * @typedef {'default' | 'monospacedSerif' | 'serif' | 'monospacedSansSerif' | 'sansSerif' | 'casual' | 'cursive' | 'smallCapitals'} * @syscap SystemCapability.BarrierFree.Accessibility.Hearing - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ type CaptionsFontFamily = 'default' | 'monospacedSerif' | 'serif' | 'monospacedSansSerif' | 'sansSerif' | 'casual' | 'cursive' | 'smallCapitals'; @@ -1616,7 +1687,8 @@ declare namespace accessibility { * * @typedef CaptionsStyle * @syscap SystemCapability.BarrierFree.Accessibility.Hearing - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ interface CaptionsStyle { /** @@ -1624,44 +1696,50 @@ declare namespace accessibility { * * @type {CaptionsFontFamily} * @syscap SystemCapability.BarrierFree.Accessibility.Hearing - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ fontFamily: CaptionsFontFamily; /** * Indicates the font scaling of captions. - * @type { number } + * @type { int } * @syscap SystemCapability.BarrierFree.Accessibility.Hearing - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ - fontScale: number; + fontScale: int; /** * Indicates the font color of captions. - * @type { number | string } + * @type { int | string } * @syscap SystemCapability.BarrierFree.Accessibility.Hearing - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ - fontColor: number | string; + fontColor: int | string; /** * Indicates the edge type of the captions font. * @type { CaptionsFontEdgeType } * @syscap SystemCapability.BarrierFree.Accessibility.Hearing - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ fontEdgeType: CaptionsFontEdgeType; /** * Indicates the background color of captions. - * @type { number | string } + * @type { int | string } * @syscap SystemCapability.BarrierFree.Accessibility.Hearing - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ - backgroundColor: number | string; + backgroundColor: int | string; /** * Indicates the window color of captions. - * @type { number | string } + * @type { int | string } * @syscap SystemCapability.BarrierFree.Accessibility.Hearing - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ - windowColor: number | string; + windowColor: int | string; } /** @@ -1669,7 +1747,8 @@ declare namespace accessibility { * * @typedef AccessibilityAbilityInfo * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ interface AccessibilityAbilityInfo { /** @@ -1677,7 +1756,8 @@ declare namespace accessibility { * @type { string } * @readonly * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly id: string; @@ -1686,7 +1766,8 @@ declare namespace accessibility { * @type { string } * @readonly * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly name: string; @@ -1695,7 +1776,8 @@ declare namespace accessibility { * @type { string } * @readonly * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly bundleName: string; /** @@ -1703,7 +1785,8 @@ declare namespace accessibility { * @type { Array } * @readonly * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly targetBundleNames: Array; @@ -1712,7 +1795,8 @@ declare namespace accessibility { * @type { Array } * @readonly * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly abilityTypes: Array; @@ -1721,7 +1805,8 @@ declare namespace accessibility { * @type { Array } * @readonly * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly capabilities: Array; @@ -1730,7 +1815,8 @@ declare namespace accessibility { * @type { string } * @readonly * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly description: string; @@ -1739,7 +1825,8 @@ declare namespace accessibility { * @type { Array } * @readonly * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly eventTypes: Array; @@ -1748,7 +1835,8 @@ declare namespace accessibility { * @type { boolean } * @readonly * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly needHide: boolean; @@ -1757,7 +1845,8 @@ declare namespace accessibility { * @type { string } * @readonly * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly label: string; } @@ -1827,11 +1916,12 @@ declare namespace accessibility { /** * The page id of the event source. - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ - pageId?: number; + pageId?: int; /** * The accessibility event description. @@ -1880,43 +1970,48 @@ declare namespace accessibility { /** * The start index of listed items on the screen. - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ - beginIndex?: number; + beginIndex?: int; /** * The index of the current item on the screen. - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ - currentIndex?: number; + currentIndex?: int; /** * The end index of listed items on the screen. - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ - endIndex?: number; + endIndex?: int; /** * The total of the items, talkback used it when scroll. - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ - itemCount?: number; + itemCount?: int; /** * The id of element. - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - elementId?: number; + elementId?: int; /** * The content of announce accessibility text. @@ -1931,7 +2026,8 @@ declare namespace accessibility { * The content of announce accessibility text. * @type { ?Resource } * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ textResourceAnnouncedForAccessibility?: Resource; diff --git a/api/@ohos.application.AccessibilityExtensionAbility.d.ts b/api/@ohos.application.AccessibilityExtensionAbility.d.ts index 2a4c4cb24ab83702cbecae7a436ed3a35c55d698..99cc713f2d265c4858507c10ba1bedbf1860bc70 100644 --- a/api/@ohos.application.AccessibilityExtensionAbility.d.ts +++ b/api/@ohos.application.AccessibilityExtensionAbility.d.ts @@ -28,17 +28,23 @@ import type { WindowType as _WindowType, Rect as _Rect, } from './application/AccessibilityExtensionContext'; +/*** if arkts 1.1 */ import type * as _AccessibilityExtensionContext from './application/AccessibilityExtensionContext'; +/*** endif */ +/*** if arkts 1.2 */ +import AccessibilityExtensionContext from './application/AccessibilityExtensionContext'; +export { AccessibilityExtensionContext }; +/*** endif */ import { AccessibilityEventType } from './@ohos.accessibility'; - /** * Indicates an accessibility element. * Supports querying element attributes, requesting execution actions, and finding child elements by condition. * * @typedef {_AccessibilityElement} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ export type AccessibilityElement = _AccessibilityElement; @@ -47,7 +53,8 @@ export type AccessibilityElement = _AccessibilityElement; * * @typedef {_ElementAttributeValues} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ export type ElementAttributeValues = _ElementAttributeValues; @@ -56,7 +63,8 @@ export type ElementAttributeValues = _ElementAttributeValues; * * @typedef {_FocusDirection} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ export type FocusDirection = _FocusDirection; @@ -65,7 +73,8 @@ export type FocusDirection = _FocusDirection; * * @typedef {keyof ElementAttributeValues} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ export type ElementAttributeKeys = keyof ElementAttributeValues; @@ -74,7 +83,8 @@ export type ElementAttributeKeys = keyof ElementAttributeValues; * * @typedef {_FocusType} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ export type FocusType = _FocusType; @@ -83,7 +93,8 @@ export type FocusType = _FocusType; * * @typedef {_WindowType} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ export type WindowType = _WindowType; @@ -92,7 +103,8 @@ export type WindowType = _WindowType; * * @typedef {_Rect} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ export type Rect = _Rect; @@ -112,22 +124,25 @@ export { Parameter } from './application/AccessibilityExtensionContext'; * @syscap SystemCapability.BarrierFree.Accessibility.Core * @since 10 */ - +/*** if arkts 1.1 */ export type AccessibilityExtensionContext = _AccessibilityExtensionContext.default; +/*** endif */ /** * class of accessibility extension ability. * * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ -export default class AccessibilityExtensionAbility { +declare class AccessibilityExtensionAbility { /** * Indicates accessibility extension ability context. * * @type {AccessibilityExtensionContext} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ context: AccessibilityExtensionContext; @@ -179,6 +194,7 @@ export default class AccessibilityExtensionAbility { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ onAccessibilityConnect(): void; @@ -191,6 +207,7 @@ export default class AccessibilityExtensionAbility { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ onAccessibilityDisconnect(): void; @@ -222,6 +239,8 @@ export default class AccessibilityExtensionAbility { onAccessibilityKeyEvent(keyEvent: KeyEvent): boolean; } +export default AccessibilityExtensionAbility; + /** * Indicates the accessibility event. * It provides the event type and the target element of the event if any. @@ -231,7 +250,7 @@ export default class AccessibilityExtensionAbility { * @systemapi * @since 20 */ -declare interface AccessibilityEventInfo { +export declare interface AccessibilityEventInfo { /** * EventType * @@ -255,12 +274,12 @@ declare interface AccessibilityEventInfo { /** * TimeStamp * - * @type { ?number } + * @type { ?long } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 */ - timestamp?: number; + timestamp?: long; /** * The content of add/remove accessibility extraInfo text. @@ -279,15 +298,17 @@ declare interface AccessibilityEventInfo { * * @typedef AccessibilityEvent * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ -declare interface AccessibilityEvent { +export declare interface AccessibilityEvent { /** * EventType * * @type { accessibility.EventType | accessibility.WindowUpdateType | TouchGuideType | GestureType | PageUpdateType } * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ eventType: accessibility.EventType | accessibility.WindowUpdateType | TouchGuideType | GestureType | PageUpdateType; @@ -296,34 +317,38 @@ declare interface AccessibilityEvent { * * @type { ?AccessibilityElement } * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ target?: AccessibilityElement; /** * TimeStamp * - * @type { ?number } + * @type { ?long } * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - timeStamp?: number; + timeStamp?: long; /** * ElementId * - * @type { ?number } + * @type { ?long } * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - elementId?: number; + elementId?: long; /** * The content of announce accessibility text. * * @type { ?string } * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ textAnnouncedForAccessibility?: string; @@ -333,6 +358,7 @@ declare interface AccessibilityEvent { * @type { ?string } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @since 20 + * @arkts 1.1&1.2 */ extraInfo?: string; } @@ -360,7 +386,8 @@ declare interface AccessibilityEvent { * 'fourFingerSwipeUp' | 'fourFingerSwipeDown' | 'fourFingerSwipeLeft' | 'fourFingerSwipeRight' } * @typedef {'left' | 'leftThenRight' | 'leftThenUp' | 'leftThenDown' | 'right' | 'rightThenLeft' | 'rightThenUp' | 'rightThenDown' | 'up' | 'upThenLeft' | 'upThenRight' | 'upThenDown' | 'down' | 'downThenLeft' | 'downThenRight' | 'downThenUp' | 'twoFingerSingleTap' | 'twoFingerDoubleTap' | 'twoFingerDoubleTapAndHold' | 'twoFingerTripleTap' | 'twoFingerTripleTapAndHold' | 'threeFingerSingleTap' | 'threeFingerDoubleTap' | 'threeFingerDoubleTapAndHold' | 'threeFingerTripleTap' | 'threeFingerTripleTapAndHold' | 'fourFingerSingleTap' | 'fourFingerDoubleTap' | 'fourFingerDoubleTapAndHold' | 'fourFingerTripleTap' | 'fourFingerTripleTapAndHold' | 'threeFingerSwipeUp' | 'threeFingerSwipeDown' | 'threeFingerSwipeLeft' | 'threeFingerSwipeRight' | 'fourFingerSwipeUp' | 'fourFingerSwipeDown' | 'fourFingerSwipeLeft' | 'fourFingerSwipeRight'} * @syscap SystemCapability.BarrierFree.Accessibility.Core -* @since 11 +* @since arkts {'1.1':'11', '1.2':'20'} +* @arkts 1.1&1.2 */ type GestureType = 'left' | 'leftThenRight' | 'leftThenUp' | 'leftThenDown' | 'right' | 'rightThenLeft' | 'rightThenUp' | 'rightThenDown' | @@ -378,7 +405,8 @@ type GestureType = 'left' | 'leftThenRight' | 'leftThenUp' | 'leftThenDown' | * * @typedef {'pageContentUpdate' | 'pageStateUpdate'} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ type PageUpdateType = 'pageContentUpdate' | 'pageStateUpdate'; @@ -387,6 +415,7 @@ type PageUpdateType = 'pageContentUpdate' | 'pageStateUpdate'; * * @typedef {'touchBegin' | 'touchEnd'} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ type TouchGuideType = 'touchBegin' | 'touchEnd'; diff --git a/api/application/AccessibilityExtensionContext.d.ts b/api/application/AccessibilityExtensionContext.d.ts index c56f156b7ac5bf4144269ba71feec48930507fa7..c4c6159bd8ee4a24e6824a71283b31f54bfb70d8 100644 --- a/api/application/AccessibilityExtensionContext.d.ts +++ b/api/application/AccessibilityExtensionContext.d.ts @@ -21,24 +21,30 @@ import type { AsyncCallback, BusinessError, Callback } from '../@ohos.base'; import ExtensionContext from './ExtensionContext'; import type accessibility from '../@ohos.accessibility'; +/*** if arkts 1.1 */ import type { GesturePath } from '../@ohos.accessibility.GesturePath'; +/*** endif */ import type Want from '../@ohos.app.ability.Want'; + +/*** if arkts 1.1 */ import { AccessibilityAction } from '../@ohos.accessibility'; +/*** endif */ /** * The accessibility extension context. Used to configure, query information, and inject gestures. * * @extends ExtensionContext * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ -export default class AccessibilityExtensionContext extends ExtensionContext { +declare class AccessibilityExtensionContext extends ExtensionContext { /** * Set the bundle names that is interested in sending the event. * * @param { Array } targetNames The bundle names that are interested in sending the event. * @param { AsyncCallback } callback Indicates the listener. - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. @@ -53,7 +59,7 @@ export default class AccessibilityExtensionContext extends ExtensionContext { * * @param { Array } targetNames The bundle names that are interested in sending the event. * @returns { Promise } - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. @@ -68,7 +74,7 @@ export default class AccessibilityExtensionContext extends ExtensionContext { * * @param { boolean } isAccessibilityFocus Indicates whether the acquired element has an accessibility focus. * @param { AsyncCallback } callback Indicates the listener. - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. @@ -84,7 +90,7 @@ export default class AccessibilityExtensionContext extends ExtensionContext { * * @param { boolean } isAccessibilityFocus Indicates whether the acquired element has an accessibility focus. * @returns { Promise } - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. @@ -98,7 +104,7 @@ export default class AccessibilityExtensionContext extends ExtensionContext { /** * Get focus element. * @param { AsyncCallback } callback Indicates the listener. - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. @@ -114,7 +120,7 @@ export default class AccessibilityExtensionContext extends ExtensionContext { * * @param { number } windowId Indicates the window ID. * @param { AsyncCallback } callback Indicates the listener. - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. @@ -130,7 +136,7 @@ export default class AccessibilityExtensionContext extends ExtensionContext { * * @param { number } [windowId] Indicates the window ID. * @returns { Promise } - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. @@ -144,7 +150,7 @@ export default class AccessibilityExtensionContext extends ExtensionContext { /** * Get window root element. * @param { AsyncCallback } callback Indicates the listener. - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. @@ -160,7 +166,7 @@ export default class AccessibilityExtensionContext extends ExtensionContext { * * @param { number } displayId Indicates the display ID. * @param { AsyncCallback> } callback Indicates the listener. - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. @@ -176,7 +182,7 @@ export default class AccessibilityExtensionContext extends ExtensionContext { * * @param { number } displayId Indicates the display ID. * @returns { Promise> } - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. @@ -190,7 +196,7 @@ export default class AccessibilityExtensionContext extends ExtensionContext { /** * Get window list. * @param { AsyncCallback> } callback Indicates the listener. - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. @@ -206,7 +212,7 @@ export default class AccessibilityExtensionContext extends ExtensionContext { * * @param { GesturePath } gesturePath Indicates the gesture path. * @param { AsyncCallback } callback Indicates the listener. - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. @@ -223,7 +229,7 @@ export default class AccessibilityExtensionContext extends ExtensionContext { * * @param { GesturePath } gesturePath Indicates the gesture path. * @returns { Promise } - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. @@ -239,7 +245,7 @@ export default class AccessibilityExtensionContext extends ExtensionContext { * Inject gesture path events. * * @param { GesturePath } gesturePath Indicates the gesture path. - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. @@ -256,48 +262,51 @@ export default class AccessibilityExtensionContext extends ExtensionContext { * @param { Want } want - Indicates the start options. * @returns { Promise } * @throws { BusinessError } 201 - The application does not have the permission required to call the API. - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ startAbility(want: Want): Promise; /** * get all subElements in window. - * @param { number } windowId Indicates the window ID. - * @param { number } elementId Indicates the elementId. + * @param { int } windowId Indicates the window ID. + * @param { long } elementId Indicates the elementId. * @returns { Promise> } * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 9300003 - No accessibility permission to perform the operation. * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ - getElements(windowId: number, elementId?: number): Promise>; + getElements(windowId: int, elementId?: long): Promise>; /** * Get default focused element ids. - * @param { number } windowId Indicates whether the windowid can be used as the default focus. - * @returns { Promise> } + * @param { int } windowId Indicates whether the windowid can be used as the default focus. + * @returns { Promise> } * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 9300003 - No accessibility permission to perform the operation. * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ - getDefaultFocusedElementIds(windowId: number): Promise>; + getDefaultFocusedElementIds(windowId: int): Promise>; /** * Hold running lock to prevent screen turning off automatically. @@ -382,7 +391,7 @@ export default class AccessibilityExtensionContext extends ExtensionContext { * Get window root element. * * @permission ohos.permission.ACCESSIBILITY_EXTENSION_ABILITY - * @param { number } [windowId] Indicates the window ID. + * @param { int } [windowId] Indicates the window ID. * @returns { Promise } * @throws { BusinessError } 201 - Permission verification failed.The application does not have the permission required to call the API. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. @@ -392,13 +401,13 @@ export default class AccessibilityExtensionContext extends ExtensionContext { * @systemapi * @since 20 */ - getRootInActiveWindow(windowId?: number): Promise; + getRootInActiveWindow(windowId?: int): Promise; /** * Get window list. * * @permission ohos.permission.ACCESSIBILITY_EXTENSION_ABILITY - * @param { number } [displayId] Indicates the display ID. If this parameter is not provided, indicates the default displayId. + * @param { long } [displayId] Indicates the display ID. If this parameter is not provided, indicates the default displayId. * @returns { Array } * @throws { BusinessError } 201 - Permission verification failed.The application does not have the permission required to call the API. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. @@ -407,8 +416,9 @@ export default class AccessibilityExtensionContext extends ExtensionContext { * @systemapi * @since 20 */ - getAccessibilityWindowsSync(displayId?: number): Array; + getAccessibilityWindowsSync(displayId?: long): Array; } +export default AccessibilityExtensionContext; /** * Indicates an accessibility element. @@ -416,9 +426,10 @@ export default class AccessibilityExtensionContext extends ExtensionContext { * * @typedef AccessibilityElement * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ -declare interface AccessibilityElement { +export declare interface AccessibilityElement { /** * Get a list of attribute names. * @@ -443,7 +454,7 @@ declare interface AccessibilityElement { * * @param { T } attributeName Indicates the attribute name. * @param { AsyncCallback } callback Indicates the listener. - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. @@ -462,7 +473,7 @@ declare interface AccessibilityElement { * * @param { T } attributeName Indicates the attribute name. * @returns { Promise } - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. @@ -499,7 +510,7 @@ declare interface AccessibilityElement { * @param { string } actionName Indicates the action name. * @param { object } parameters Indicates the parameters needed to execute the action. * @param { AsyncCallback } callback Indicates the listener. - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. @@ -516,7 +527,7 @@ declare interface AccessibilityElement { * @param { string } actionName Indicates the action name. * @param { object } parameters Indicates the parameters needed to execute the action. * @returns { Promise } - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. @@ -532,7 +543,7 @@ declare interface AccessibilityElement { * * @param { string } actionName Indicates the action name. * @param { AsyncCallback } callback Indicates the listener. - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. @@ -546,36 +557,39 @@ declare interface AccessibilityElement { /** * Get the position of cursor in TextInput. * - * @param { AsyncCallback } callback Indicates the listener. + * @param { AsyncCallback } callback Indicates the listener. * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - getCursorPosition(callback: AsyncCallback): void; + getCursorPosition(callback: AsyncCallback): void; /** * Get the position of cursor in TextInput. * - * @returns { Promise } + * @returns { Promise } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - getCursorPosition(): Promise; + getCursorPosition(): Promise; /** * Set the screen curtain enable or disable. * * @param { boolean } isEnable Indicates whether the screen curtain is enabled. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @throws { BusinessError } 9300003 - No accessibility permission to perform the operation. * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ enableScreenCurtain(isEnable: boolean): void; @@ -585,7 +599,7 @@ declare interface AccessibilityElement { * @param { 'content' } type The type of query condition is content. * @param { string } condition Indicates the specific content to be queried. * @param { AsyncCallback> } callback Indicates the listener. - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. @@ -601,7 +615,7 @@ declare interface AccessibilityElement { * @param { 'content' } type The type of query condition is content. * @param { string } condition Indicates the specific content to be queried. * @returns { Promise> } - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. @@ -617,7 +631,7 @@ declare interface AccessibilityElement { * @param { 'focusType' } type The type of query condition is focus type. * @param { FocusType } condition Indicates the type of focus to query. * @param { AsyncCallback } callback Indicates the listener. - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. @@ -633,7 +647,7 @@ declare interface AccessibilityElement { * @param { 'focusType' } type The type of query condition is focus type. * @param { FocusType } condition Indicates the type of focus to query. * @returns { Promise } - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. @@ -649,7 +663,7 @@ declare interface AccessibilityElement { * @param { 'focusDirection' } type The type of query condition is focus direction. * @param { FocusDirection } condition Indicates the direction of search focus to query. * @param { AsyncCallback } callback Indicates the listener. - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. @@ -665,7 +679,7 @@ declare interface AccessibilityElement { * @param { 'focusDirection' } type The type of query condition is focus direction. * @param { FocusDirection } condition Indicates the direction of search focus to query. * @returns { Promise } - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. @@ -681,13 +695,14 @@ declare interface AccessibilityElement { * @param { 'textType' } type The type of query condition is text type. * @param { string } condition Indicates the specific content to be queried. * @returns { Promise> } - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ findElement(type: 'textType', condition: string): Promise>; @@ -695,17 +710,18 @@ declare interface AccessibilityElement { * Find elements that match the condition. * * @param { 'elementId' } type The type of query condition is element id. - * @param { number } condition Indicates the specific content to be queried. + * @param { long } condition Indicates the specific content to be queried. * @returns { Promise } - * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * 3. Parameter verification failed. * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - findElement(type: 'elementId', condition: number): Promise; + findElement(type: 'elementId', condition: long): Promise; /** * Indicates accessibility focus state. @@ -760,12 +776,12 @@ declare interface AccessibilityElement { /** * Indicates the component ID to which the element belongs. * - * @type { ?number } + * @type { ?long } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 */ - componentId?: number; + componentId?: long; /** * Indicates the component type to which the element belongs. @@ -790,12 +806,12 @@ declare interface AccessibilityElement { /** * Indicates the index of the current item. * - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 */ - currentIndex?: number; + currentIndex?: int; /** * Indicates the description of the element. @@ -820,12 +836,12 @@ declare interface AccessibilityElement { /** * Indicates the list index of the last item displayed on the screen. * - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 */ - endIndex?: number; + endIndex?: int; /** * Indicates the string of error state. @@ -860,12 +876,12 @@ declare interface AccessibilityElement { /** * Indicates the type of input text. * - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 */ - inputType?: number; + inputType?: int; /** * Indicates the inspector key. @@ -940,12 +956,12 @@ declare interface AccessibilityElement { /** * Indicates the total count of the items. * - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 */ - itemCount?: number; + itemCount?: int; /** * Indicates the last content. @@ -960,12 +976,12 @@ declare interface AccessibilityElement { /** * Indicates the display layer of the element. * - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 */ - layer?: number; + layer?: int; /** * Indicates whether the element is long clickable. @@ -980,12 +996,12 @@ declare interface AccessibilityElement { /** * Indicates the page id. * - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 */ - pageId?: number; + pageId?: int; /** * Indicates whether the element supports multiple lines of text. @@ -1050,12 +1066,12 @@ declare interface AccessibilityElement { /** * Indicates the list index of the first item displayed on the screen. * - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 */ - startIndex?: number; + startIndex?: int; /** * Indicates the text of the element. @@ -1070,12 +1086,12 @@ declare interface AccessibilityElement { /** * Indicates the maximum length limit of the element text. * - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 */ - textLengthLimit?: number; + textLengthLimit?: int; /** * Indicates the unit of movement of the element text as it is read. @@ -1110,52 +1126,52 @@ declare interface AccessibilityElement { /** * Indicates the maximum value. * - * @type { ?number } + * @type { ?double } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 */ - valueMax?: number; + valueMax?: double; /** * Indicates the minimum value. * - * @type { ?number } + * @type { ?double } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 */ - valueMin?: number; + valueMin?: double; /** * Indicates the current value. * - * @type { ?number } + * @type { ?double } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 */ - valueNow?: number; + valueNow?: double; /** * Indicates the window id. * - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 */ - windowId?: number; + windowId?: int; /** * Indicates the offset. * - * @type { ?number } + * @type { ?double } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 */ - offset?: number; + offset?: double; /** * Indicates the text type. @@ -1200,22 +1216,22 @@ declare interface AccessibilityElement { /** * Indicates the component next accessibility focus id. * - * @type { ?number } + * @type { ?long } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 */ - accessibilityNextFocusId?: number; + accessibilityNextFocusId?: long; /** * Indicates the component previous accessibility focus id. * - * @type { ?number } + * @type { ?long } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 */ - accessibilityPreviousFocusId?: number; + accessibilityPreviousFocusId?: long; /** * Indicates the extra info of the element. @@ -1270,12 +1286,12 @@ declare interface AccessibilityElement { /** * Indicates the navDestination id of component. * - * @type { ?number } + * @type { ?long } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 */ - navDestinationId?: number; + navDestinationId?: long; /** * Indicates the current item in grid of component. @@ -1310,12 +1326,12 @@ declare interface AccessibilityElement { /** * Indicates the main windowId of component. * - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 */ - mainWindowId?: number; + mainWindowId?: int; /** * Indicates whether the component need clip. @@ -1330,22 +1346,22 @@ declare interface AccessibilityElement { /** * Indicates the parent element id of component. * - * @type { ?number } + * @type { ?long } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 */ - parentId?: number; + parentId?: long; /** * Indicates the children elements id list of component. * - * @type { ?Array } + * @type { ?Array } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 */ - childrenIds?: Array; + childrenIds?: Array; /** * Execute the specified action. @@ -1451,7 +1467,7 @@ declare interface AccessibilityElement { * Find elements that match the elementId. * * @permission ohos.permission.ACCESSIBILITY_EXTENSION_ABILITY - * @param { number } condition Indicates the elementId to query. + * @param { long } condition Indicates the elementId to query. * @returns { Promise } * @throws { BusinessError } 201 - Permission verification failed.The application does not have the permission required to call the API. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. @@ -1460,7 +1476,7 @@ declare interface AccessibilityElement { * @systemapi * @since 20 */ - findElementById(condition: number): Promise; + findElementById(condition: long): Promise; } /** @@ -1475,21 +1491,21 @@ interface AccessibilityGrid { /** * The row index in grid. * - * @type { number } + * @type { int } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 */ - rowIndex: number; + rowIndex: int; /** * The colum index in grid. * - * @type { number } + * @type { int } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 */ - columnIndex: number; + columnIndex: int; } /** @@ -1504,12 +1520,12 @@ interface AccessibilitySpan { /** * The id of span. * - * @type { number } + * @type { int } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 */ - spanId: number; + spanId: int; /** * The text of span. * @@ -1632,15 +1648,17 @@ export declare class Parameter { * * @typedef ElementAttributeValues * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ -interface ElementAttributeValues { +export interface ElementAttributeValues { /** * Indicates accessibility focus state. * * @type {boolean} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ accessibilityFocused: boolean; /** @@ -1648,7 +1666,8 @@ interface ElementAttributeValues { * * @type {string} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ bundleName: string; /** @@ -1656,7 +1675,8 @@ interface ElementAttributeValues { * * @type {boolean} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ checkable: boolean; /** @@ -1664,7 +1684,8 @@ interface ElementAttributeValues { * * @type {boolean} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ checked: boolean; /** @@ -1672,7 +1693,8 @@ interface ElementAttributeValues { * * @type {Array} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ children: Array; /** @@ -1680,23 +1702,26 @@ interface ElementAttributeValues { * * @type {boolean} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ clickable: boolean; /** * Indicates the component ID to which the element belongs. * - * @type {number} + * @type {long} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - componentId: number; + componentId: long; /** * Indicates the component type to which the element belongs. * * @type {string} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ componentType: string; /** @@ -1704,23 +1729,26 @@ interface ElementAttributeValues { * * @type {Array} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ contents: Array; /** * Indicates the index of the current item. * - * @type {number} + * @type {int} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - currentIndex: number; + currentIndex: int; /** * Indicates the description of the element. * * @type {string} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ description: string; /** @@ -1728,23 +1756,26 @@ interface ElementAttributeValues { * * @type {boolean} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ editable: boolean; /** * Indicates the list index of the last item displayed on the screen. * - * @type {number} + * @type {int} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - endIndex: number; + endIndex: int; /** * Indicates the string of error state. * * @type {string} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ error: string; /** @@ -1752,7 +1783,8 @@ interface ElementAttributeValues { * * @type {boolean} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ focusable: boolean; /** @@ -1760,23 +1792,26 @@ interface ElementAttributeValues { * * @type {string} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ hintText: string; /** * Indicates the type of input text. * - * @type {number} + * @type {int} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - inputType: number; + inputType: int; /** * Indicates the inspector key. * * @type {string} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ inspectorKey: string; /** @@ -1784,7 +1819,8 @@ interface ElementAttributeValues { * * @type {boolean} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ isActive: boolean; /** @@ -1792,7 +1828,8 @@ interface ElementAttributeValues { * * @type {boolean} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ isEnable: boolean; /** @@ -1800,7 +1837,8 @@ interface ElementAttributeValues { * * @type {boolean} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ isHint: boolean; /** @@ -1808,7 +1846,8 @@ interface ElementAttributeValues { * * @type {boolean} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ isFocused: boolean; /** @@ -1816,7 +1855,8 @@ interface ElementAttributeValues { * * @type {boolean} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ isPassword: boolean; /** @@ -1824,55 +1864,62 @@ interface ElementAttributeValues { * * @type {boolean} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ isVisible: boolean; /** * Indicates the total count of the items. * - * @type {number} + * @type {int} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - itemCount: number; + itemCount: int; /** * Indicates the last content. * * @type {string} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ lastContent: string; /** * Indicates the display layer of the element. * - * @type {number} + * @type {int} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - layer: number; + layer: int; /** * Indicates whether the element is long clickable. * * @type {boolean} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ longClickable: boolean; /** * Indicates the page id. * - * @type {number} + * @type {int} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - pageId: number; + pageId: int; /** * Indicates the parent of the element. * * @type {AccessibilityElement} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ parent: AccessibilityElement; /** @@ -1880,7 +1927,8 @@ interface ElementAttributeValues { * * @type {boolean} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ pluralLineSupported: boolean; /** @@ -1888,7 +1936,8 @@ interface ElementAttributeValues { * * @type {Rect} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ rect: Rect; /** @@ -1896,7 +1945,8 @@ interface ElementAttributeValues { * * @type {string} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ resourceName: string; /** @@ -1904,7 +1954,8 @@ interface ElementAttributeValues { * * @type {AccessibilityElement} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ rootElement: AccessibilityElement; /** @@ -1912,7 +1963,8 @@ interface ElementAttributeValues { * * @type {Rect} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ screenRect: Rect; /** @@ -1920,7 +1972,8 @@ interface ElementAttributeValues { * * @type {boolean} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ scrollable: boolean; /** @@ -1928,39 +1981,44 @@ interface ElementAttributeValues { * * @type {boolean} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ selected: boolean; /** * Indicates the list index of the first item displayed on the screen. * - * @type {number} + * @type {int} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - startIndex: number; + startIndex: int; /** * Indicates the text of the element. * * @type {string} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ text: string; /** * Indicates the maximum length limit of the element text. * - * @type {number} + * @type {int} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - textLengthLimit: number; + textLengthLimit: int; /** * Indicates the unit of movement of the element text as it is read. * * @type {accessibility.TextMoveUnit} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ textMoveUnit: accessibility.TextMoveUnit; /** @@ -1968,7 +2026,8 @@ interface ElementAttributeValues { * * @type {accessibility.Action} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ triggerAction: accessibility.Action; /** @@ -1976,55 +2035,62 @@ interface ElementAttributeValues { * * @type {WindowType} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ type: WindowType; /** * Indicates the maximum value. * - * @type {number} + * @type {double} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - valueMax: number; + valueMax: double; /** * Indicates the minimum value. * - * @type {number} + * @type {double} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - valueMin: number; + valueMin: double; /** * Indicates the current value. * - * @type {number} + * @type {double} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - valueNow: number; + valueNow: double; /** * Indicates the window id. * - * @type {number} + * @type {int} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - windowId: number; + windowId: int; /** * Indicates the offset. * - * @type {number} + * @type {double} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - offset: number; + offset: double; /** * Indicates the text type. * * @type {string} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ textType: string; /** @@ -2032,7 +2098,8 @@ interface ElementAttributeValues { * * @type {string} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ accessibilityText: string; /** @@ -2040,45 +2107,51 @@ interface ElementAttributeValues { * * @type {Rect} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ hotArea: Rect; /** * Indicates the component next accessibility focus id. - * @type { ?number } + * @type { ?long } * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ - accessibilityNextFocusId?: number; + accessibilityNextFocusId?: long; /** * Indicates the custom component type. * * @type { ?string } * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ customComponentType?: string; /** * Indicates the extra info of the element. * @type { ?string } * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ extraInfo?: string; /** * Indicates the component Previous accessibility focus id. * - * @type { ?number } + * @type { ?long } * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ - accessibilityPreviousFocusId?: number; + accessibilityPreviousFocusId?: long; /** * Indicates whether the element is scrollable for accessibility. * * @type { ?boolean } * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ accessibilityScrollable?: boolean; } @@ -2088,66 +2161,74 @@ interface ElementAttributeValues { * * @typedef {'up' | 'down' | 'left' | 'right' | 'forward' | 'backward'} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ -type FocusDirection = 'up' | 'down' | 'left' | 'right' | 'forward' | 'backward'; +export type FocusDirection = 'up' | 'down' | 'left' | 'right' | 'forward' | 'backward'; /** * Indicates the type of the focus. * * @typedef {'accessibility' | 'normal'} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ -type FocusType = 'accessibility' | 'normal'; +export type FocusType = 'accessibility' | 'normal'; /** * Indicates the type of the window. * * @typedef {'application' | 'system'} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ -type WindowType = 'application' | 'system'; +export type WindowType = 'application' | 'system'; /** * Indicates rectangle. * * @typedef Rect * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ -interface Rect { +export interface Rect { /** * The left position of Rect * - * @type { number } + * @type { int } * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - left: number; + left: int; /** * The top position of Rect * - * @type { number } + * @type { int } * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - top: number; + top: int; /** * The width position of Rect * - * @type { number } + * @type { int } * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - width: number; + width: int; /** * The height position of Rect * - * @type { number } + * @type { int } * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - height: number; + height: int; } diff --git a/kits/@kit.AccessibilityKit.d.ts b/kits/@kit.AccessibilityKit.d.ts index 940ba1b65a145f1be22ad9001c857d54f375b360..67adab0e38d21000aee039e60a0426b7b4111a91 100644 --- a/kits/@kit.AccessibilityKit.d.ts +++ b/kits/@kit.AccessibilityKit.d.ts @@ -21,22 +21,21 @@ /*** if arkts 1.1&1.2 */ import config from '@ohos.accessibility.config'; import accessibility from '@ohos.accessibility'; -/*** endif */ import { GesturePath } from '@ohos.accessibility.GesturePath'; import { GesturePoint } from '@ohos.accessibility.GesturePoint'; import AccessibilityExtensionAbility, { - AccessibilityElement, AccessibilityExtensionContext, ElementAttributeKeys, - ElementAttributeValues, FocusDirection, FocusType, Rect, WindowType, AccessibilityEvent, AccessibilityEventInfo, - Parameter + AccessibilityElement, ElementAttributeKeys, AccessibilityExtensionContext, + ElementAttributeValues, FocusDirection, FocusType, Rect, WindowType, AccessibilityEvent } from '@ohos.application.AccessibilityExtensionAbility'; -import { AccessibilityAction, AccessibilityEventType } from '@ohos.accessibility'; export { AccessibilityElement, AccessibilityExtensionAbility, AccessibilityExtensionContext, ElementAttributeKeys, ElementAttributeValues, FocusDirection, FocusType, GesturePath, - GesturePoint, Rect, WindowType, accessibility, config, AccessibilityEvent, AccessibilityEventInfo, - AccessibilityAction, AccessibilityEventType, Parameter + GesturePoint, Rect, WindowType, accessibility, config, AccessibilityEvent }; - -/*** if arkts 1.2 */ -export { accessibility, config }; +/*** endif */ +/*** if arkts 1.1 */ +import { Parameter, AccessibilityEventInfo +} from '@ohos.application.AccessibilityExtensionAbility'; +import { AccessibilityAction, AccessibilityEventType } from '@ohos.accessibility'; +export { Parameter, AccessibilityEventInfo, AccessibilityAction, AccessibilityEventType }; /*** endif */ \ No newline at end of file