From 8e23c403c0cad85c5d07ab3c02f9588647c28440 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=9E=97=E9=92=9F=E5=8D=81=E4=BA=94?= <1031275939@qq.com> Date: Thu, 28 Aug 2025 07:55:51 +0000 Subject: [PATCH 1/4] =?UTF-8?q?arkts1.2=20=E6=94=B9=E9=80=A0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: liuzhiwei --- api/@ohos.accessibility.GesturePath.d.ts | 17 +- api/@ohos.accessibility.GesturePoint.d.ts | 25 +- api/@ohos.accessibility.config.d.ts | 288 +++++++-- api/@ohos.accessibility.d.ts | 417 +++++++++--- ...ication.AccessibilityExtensionAbility.d.ts | 132 ++-- .../AccessibilityExtensionContext.d.ts | 596 +++++++++++------- kits/@kit.AccessibilityKit.d.ts | 11 +- 7 files changed, 1071 insertions(+), 415 deletions(-) diff --git a/api/@ohos.accessibility.GesturePath.d.ts b/api/@ohos.accessibility.GesturePath.d.ts index 7e5758735f..5c661dac5a 100644 --- a/api/@ohos.accessibility.GesturePath.d.ts +++ b/api/@ohos.accessibility.GesturePath.d.ts @@ -24,32 +24,35 @@ import type { GesturePoint } from './@ohos.accessibility.GesturePoint'; * Indicates the path of the gesture. * * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export declare class GesturePath { /** * A constructor used to create a GesturePath object. * - * @param { number } durationTime - Indicates the duration of the gesture. + * @param { long } durationTime - Indicates the duration of the gesture. * @syscap SystemCapability.BarrierFree.Accessibility.Core * @since 9 * @deprecated since 12 */ - constructor(durationTime: number); + constructor(durationTime: long); /** * Indicates the position of the points that make up the gesture. * * @type { Array } * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ points: Array; /** * Indicates the duration of the gesture. * - * @type { number } + * @type { long } * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - durationTime: number; + durationTime: long; } diff --git a/api/@ohos.accessibility.GesturePoint.d.ts b/api/@ohos.accessibility.GesturePoint.d.ts index c6d9afb51d..9c25b39925 100644 --- a/api/@ohos.accessibility.GesturePoint.d.ts +++ b/api/@ohos.accessibility.GesturePoint.d.ts @@ -22,33 +22,38 @@ * Indicates the point of the gesture. * * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export declare class GesturePoint { + /*** if arkts 1.1 */ /** * A constructor used to create a GesturePoint object. * - * @param { number } positionX - Indicates the X coordinate of point. - * @param { number } positionY - Indicates the Y coordinate of point. + * @param { long } positionX - Indicates the X coordinate of point. + * @param { long } positionY - Indicates the Y coordinate of point. * @syscap SystemCapability.BarrierFree.Accessibility.Core * @since 9 * @deprecated since 12 */ - constructor(positionX: number, positionY: number); + constructor(positionX: long, positionY: long); + /*** endif */ /** * Indicates the X coordinate of point. * - * @type { number } + * @type { long } * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - positionX: number; + positionX: long; /** * Indicates the Y coordinate of point. * - * @type { number } + * @type { long } * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - positionY: number; + positionY: long; } diff --git a/api/@ohos.accessibility.config.d.ts b/api/@ohos.accessibility.config.d.ts index f3ccfb8953..66d8556c03 100644 --- a/api/@ohos.accessibility.config.d.ts +++ b/api/@ohos.accessibility.config.d.ts @@ -17,9 +17,15 @@ * @file * @kit AccessibilityKit */ - +/*** if arkts 1.1 */ import type accessibility from './@ohos.accessibility'; import type { AsyncCallback, Callback } from './@ohos.base'; +/*** endif */ + +/*** if arkts 1.2 */ +import accessibility from './@ohos.accessibility'; +import { AsyncCallback, Callback } from './@ohos.base'; +/*** endif */ /** * Configuration of the accessibility. @@ -36,7 +42,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 +51,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 +78,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 +208,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 +217,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 +226,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; @@ -216,6 +253,21 @@ declare namespace config { */ function enableAbility(name: string, capability: Array): Promise; + /** + * Enable the accessibility extension ability. + * + * @permission ohos.permission.WRITE_ACCESSIBILITY_CONFIG + * @param { string } name Indicates the accessibility extension name, in "bundleName/abilityName" format. + * @param { Array } capability Indicates the ability. + * @returns { Promise } + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @systemapi + * @since 20 + * @arkts 1.2 + */ + function enableAbilityReturnsPromise(name: string, capability: Array): Promise; + /** * Enable the accessibility extension ability. * @@ -242,6 +294,32 @@ declare namespace config { callback: AsyncCallback ): void; + /** + * Enable the accessibility extension ability. + * + * @permission ohos.permission.WRITE_ACCESSIBILITY_CONFIG + * @param { string } name Indicates the accessibility extension name, in "bundleName/abilityName" format. + * @param { Array } capability Indicates the ability. + * @param { AsyncCallback } callback + * @throws { BusinessError } 201 - Permission verification failed. + * The application does not have the permission required to call the API. + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @systemapi + * @since 20 + * @arkts 1.2 + */ + function enableAbilityWithCallback( + name: string, + capability: Array, + callback: AsyncCallback + ): void; + + /** + * @since 20 + * @arkts 1.2 + */ + overload enableAbility{ enableAbilityReturnsPromise, enableAbilityWithCallback }; + /** * Disable the accessibility extension ability. * @@ -262,6 +340,21 @@ declare namespace config { */ function disableAbility(name: string): Promise; + /** + * Disable the accessibility extension ability. + * + * @permission ohos.permission.WRITE_ACCESSIBILITY_CONFIG + * @param { string } name Indicates the accessibility extension name, in "bundleName/abilityName" format. + * @returns { Promise } + * @throws { BusinessError } 201 - Permission verification failed. + * The application does not have the permission required to call the API. + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @systemapi + * @since 20 + * @arkts 1.2 + */ + function disableAbilityReturnsPromise(name: string): Promise; + /** * Disable the accessibility extension ability. * @@ -282,6 +375,27 @@ declare namespace config { */ function disableAbility(name: string, callback: AsyncCallback): void; + /** + * Disable the accessibility extension ability. + * + * @permission ohos.permission.WRITE_ACCESSIBILITY_CONFIG + * @param { string } name Indicates the accessibility extension name, in "bundleName/abilityName" format. + * @param { AsyncCallback } callback + * @throws { BusinessError } 201 - Permission verification failed. + * The application does not have the permission required to call the API. + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @systemapi + * @since 20 + * @arkts 1.2 + */ + function disableAbilityWithCallback(name: string, callback: AsyncCallback): void; + + /** + * @since 20 + * @arkts 1.2 + */ + overload disableAbility{ disableAbilityReturnsPromise, disableAbilityWithCallback }; + /** * Register the listener that watches for changes in the enabled status of accessibility extensions. * @@ -297,7 +411,8 @@ declare namespace config { * 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; @@ -316,7 +431,8 @@ declare namespace config { * 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; @@ -335,7 +451,8 @@ declare namespace config { * 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; @@ -354,7 +471,8 @@ declare namespace config { * 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; @@ -370,6 +488,7 @@ declare namespace config { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ function setMagnificationState(state: boolean): void; @@ -398,11 +517,26 @@ declare namespace config { * 3. Parameter verification failed. * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi - * @since arkts {'1.1':'9', '1.2':'20'} - * @arkts 1.1&1.2 + * @since 9 */ set(value: T): Promise; + /** + * Setting configuration value. + * + * @permission ohos.permission.WRITE_ACCESSIBILITY_CONFIG + * @param { T } value Indicates the value. + * @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. + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @systemapi + * @since 20 + * @arkts 1.2 + */ + setReturnsPromise(value: T): Promise; + /** * Setting configuration value. * @@ -418,11 +552,32 @@ declare namespace config { * 3. Parameter verification failed. * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi - * @since arkts {'1.1':'9', '1.2':'20'} - * @arkts 1.1&1.2 + * @since 9 */ set(value: T, callback: AsyncCallback): void; + /** + * Setting configuration value. + * + * @permission ohos.permission.WRITE_ACCESSIBILITY_CONFIG + * @param { T } value Indicates the value. + * @param { AsyncCallback } callback + * @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. + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @systemapi + * @since 20 + * @arkts 1.2 + */ + setWithCallback(value: T, callback: AsyncCallback): void; + + /** + * @since 20 + * @arkts 1.2 + */ + overload set { setReturnsPromise, setWithCallback }; + /** * Getting configuration value. * @@ -432,11 +587,22 @@ declare namespace config { * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi - * @since arkts {'1.1':'9', '1.2':'20'} - * @arkts 1.1&1.2 + * @since 9 */ get(): Promise; + /** + * Getting configuration value. + * + * @returns { Promise } + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @systemapi + * @since 20 + * @arkts 1.2 + */ + getReturnsPromise(): Promise; + /** * Getting configuration value. * @@ -444,11 +610,28 @@ declare namespace config { * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi - * @since arkts {'1.1':'9', '1.2':'20'} - * @arkts 1.1&1.2 + * @since 9 */ get(callback: AsyncCallback): void; + /** + * Getting configuration value. + * + * @param { AsyncCallback } callback + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @systemapi + * @since 20 + * @arkts 1.2 + */ + getWithCallback(callback: AsyncCallback): void; + + /** + * @since 20 + * @arkts 1.2 + */ + overload get { getReturnsPromise, getWithCallback }; + /** * Register the listener to listen for configuration changes. * @@ -463,7 +646,8 @@ declare namespace config { * 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; @@ -477,7 +661,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; } @@ -488,7 +673,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'; @@ -498,7 +684,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'; @@ -508,8 +695,9 @@ 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'; } -export default config; +export default config; \ No newline at end of file diff --git a/api/@ohos.accessibility.d.ts b/api/@ohos.accessibility.d.ts index 4d5bfc6002..376ecc742f 100644 --- a/api/@ohos.accessibility.d.ts +++ b/api/@ohos.accessibility.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (C) 2021-2025 Huawei Device Co., Ltd. + * Copyright (C) 2025 Huawei Device Co., Ltd. * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at @@ -18,17 +18,24 @@ * @kit AccessibilityKit */ +/*** if arkts 1.1 */ import type { AsyncCallback } from './@ohos.base'; import type { Callback } from './@ohos.base'; +/*** endif */ +/*** if arkts 1.2 */ +import { AsyncCallback } from './@ohos.base'; +import { Callback } from './@ohos.base'; +/*** endif */ import { Resource } from './global/resource'; /** * Accessibility action that the ability can execute. * - * @enum { number } + * @enum { int } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ export enum AccessibilityAction { /** @@ -37,6 +44,7 @@ export enum AccessibilityAction { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ ACCESSIBILITY_FOCUS = 0, @@ -46,6 +54,7 @@ export enum AccessibilityAction { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ CLEAR_ACCESSIBILITY_FOCUS = 1, @@ -55,6 +64,7 @@ export enum AccessibilityAction { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ FOCUS = 2, @@ -64,6 +74,7 @@ export enum AccessibilityAction { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ CLEAR_FOCUS = 3, @@ -73,6 +84,7 @@ export enum AccessibilityAction { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ CLICK = 4, @@ -82,6 +94,7 @@ export enum AccessibilityAction { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ LONG_CLICK = 5, @@ -91,6 +104,7 @@ export enum AccessibilityAction { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ CUT = 6, @@ -100,6 +114,7 @@ export enum AccessibilityAction { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ COPY = 7, @@ -109,6 +124,7 @@ export enum AccessibilityAction { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ PASTE = 8, @@ -118,6 +134,7 @@ export enum AccessibilityAction { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ SELECT = 9, @@ -127,6 +144,7 @@ export enum AccessibilityAction { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ SET_TEXT = 10, @@ -136,6 +154,7 @@ export enum AccessibilityAction { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ SCROLL_FORWARD = 11, @@ -145,6 +164,7 @@ export enum AccessibilityAction { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ SCROLL_BACKWARD = 12, @@ -154,6 +174,7 @@ export enum AccessibilityAction { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ SET_SELECTION = 13, @@ -163,6 +184,7 @@ export enum AccessibilityAction { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ SET_CURSOR_POSITION = 14, @@ -172,6 +194,7 @@ export enum AccessibilityAction { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ HOME = 15, @@ -181,6 +204,7 @@ export enum AccessibilityAction { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ BACK = 16, @@ -190,6 +214,7 @@ export enum AccessibilityAction { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ RECENT_TASK = 17, @@ -199,6 +224,7 @@ export enum AccessibilityAction { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ NOTIFICATION_CENTER = 18, @@ -208,6 +234,7 @@ export enum AccessibilityAction { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ CONTROL_CENTER = 19, @@ -217,18 +244,19 @@ export enum AccessibilityAction { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ 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 @@ -238,6 +266,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_ACCESSIBILITY_FOCUS = 0, @@ -247,6 +276,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_ACCESSIBILITY_FOCUS_CLEAR = 1, @@ -256,6 +286,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_CLICK = 2, @@ -265,6 +296,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_LONG_CLICK = 3, @@ -274,6 +306,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_SELECT = 4, @@ -283,6 +316,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_HOVER_ENTER = 5, @@ -292,6 +326,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_HOVER_EXIT = 6, @@ -301,6 +336,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_FOCUS = 7, @@ -310,6 +346,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_TEXT_UPDATE = 8, @@ -319,6 +356,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_TEXT_SELECTION_UPDATE = 9, @@ -328,6 +366,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_SCROLL = 10, @@ -337,6 +376,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_REQUEST_FOCUS_FOR_ACCESSIBILITY = 11, @@ -346,6 +386,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_ANNOUNCE_FOR_ACCESSIBILITY = 12, @@ -355,6 +396,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, @@ -364,6 +406,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_ANNOUNCE_FOR_ACCESSIBILITY_NOT_INTERRUPT = 14, @@ -373,6 +416,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_ELEMENT_INFO_CHANGE = 15, @@ -382,6 +426,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_SCROLLING = 16, @@ -392,6 +437,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_WINDOW_ADD = 17, @@ -401,6 +447,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_WINDOW_REMOVE = 18, @@ -410,6 +457,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_WINDOW_BOUNDS = 19, @@ -419,6 +467,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_WINDOW_ACTIVE = 20, @@ -428,6 +477,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_WINDOW_FOCUS = 21, @@ -437,6 +487,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_WINDOW_PROPERTY = 22, @@ -446,6 +497,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_WINDOW_LAYER = 23, @@ -456,6 +508,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_TOUCH_BEGIN = 24, @@ -465,6 +518,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_TOUCH_END = 25, @@ -475,6 +529,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_PAGE_CONTENT_UPDATE = 26, @@ -484,6 +539,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_PAGE_STATE_UPDATE = 27, @@ -493,6 +549,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_PAGE_OPEN = 28, @@ -502,6 +559,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_PAGE_CLOSE = 29, @@ -512,6 +570,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_SWIPE_LEFT = 30, @@ -521,6 +580,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_SWIPE_LEFT_THEN_RIGHT = 31, @@ -530,6 +590,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_SWIPE_LEFT_THEN_UP = 32, @@ -539,6 +600,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_SWIPE_LEFT_THEN_DOWN = 33, @@ -548,6 +610,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_SWIPE_RIGHT = 34, @@ -557,6 +620,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_SWIPE_RIGHT_THEN_LEFT = 35, @@ -566,6 +630,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_SWIPE_RIGHT_THEN_UP = 36, @@ -575,6 +640,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_SWIPE_RIGHT_THEN_DOWN = 37, @@ -584,6 +650,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_SWIPE_UP = 38, @@ -593,6 +660,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_SWIPE_UP_THEN_LEFT = 39, @@ -602,6 +670,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_SWIPE_UP_THEN_RIGHT = 40, @@ -611,6 +680,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_SWIPE_UP_THEN_DOWN = 41, @@ -620,6 +690,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_SWIPE_DOWN = 42, @@ -629,6 +700,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_SWIPE_DOWN_THEN_LEFT = 43, @@ -638,6 +710,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_SWIPE_DOWN_THEN_RIGHT = 44, @@ -647,6 +720,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_SWIPE_DOWN_THEN_UP = 45, @@ -656,6 +730,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_TWO_FINGER_SINGLE_TAP = 46, @@ -665,6 +740,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_TWO_FINGER_DOUBLE_TAP = 47, @@ -674,6 +750,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, @@ -683,6 +760,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_TWO_FINGER_TRIPLE_TAP = 49, @@ -692,6 +770,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, @@ -701,6 +780,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_THREE_FINGER_SINGLE_TAP = 51, @@ -710,6 +790,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_THREE_FINGER_DOUBLE_TAP = 52, @@ -719,6 +800,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, @@ -728,6 +810,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_THREE_FINGER_TRIPLE_TAP = 54, @@ -737,6 +820,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, @@ -746,6 +830,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_FOUR_FINGER_SINGLE_TAP = 56, @@ -755,6 +840,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_FOUR_FINGER_DOUBLE_TAP = 57, @@ -764,6 +850,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, @@ -773,6 +860,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_FOUR_FINGER_TRIPLE_TAP = 59, @@ -782,6 +870,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, @@ -791,6 +880,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_THREE_FINGER_SWIPE_UP = 61, @@ -800,6 +890,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_THREE_FINGER_SWIPE_DOWN = 62, @@ -809,6 +900,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_THREE_FINGER_SWIPE_LEFT = 63, @@ -818,6 +910,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_THREE_FINGER_SWIPE_RIGHT = 64, @@ -827,6 +920,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_FOUR_FINGER_SWIPE_UP = 65, @@ -836,6 +930,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_FOUR_FINGER_SWIPE_DOWN = 66, @@ -845,6 +940,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_FOUR_FINGER_SWIPE_LEFT = 67, @@ -854,6 +950,7 @@ export enum AccessibilityEventType { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ TYPE_FOUR_FINGER_SWIPE_RIGHT = 68 } @@ -889,7 +986,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. @@ -897,7 +995,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'; @@ -985,7 +1084,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'; @@ -1000,7 +1100,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'; @@ -1107,7 +1208,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; @@ -1152,7 +1254,8 @@ declare namespace accessibility { * 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, @@ -1170,7 +1273,8 @@ declare namespace accessibility { * 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, @@ -1185,7 +1289,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, @@ -1226,11 +1331,21 @@ declare namespace accessibility { * 2. Incorrect parameter types; * 3. Parameter verification failed. * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since arkts {'1.1':'9', '1.2':'20'} - * @arkts 1.1&1.2 + * @since 9 */ function sendAccessibilityEvent(event: EventInfo, callback: AsyncCallback): void; + /** + * Send accessibility event. + * + * @param { EventInfo } event The object of the accessibility {@code EventInfo} . + * @param { AsyncCallback } callback Asynchronous callback interface. + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 20 + * @arkts 1.2 + */ + function sendAccessibilityEventWithCallback(event: EventInfo, callback: AsyncCallback): void; + /** * Send accessibility event. * @@ -1241,16 +1356,32 @@ declare namespace accessibility { * 2. Incorrect parameter types; * 3. Parameter verification failed. * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since arkts {'1.1':'9', '1.2':'20'} - * @arkts 1.1&1.2 + * @since 9 */ function sendAccessibilityEvent(event: EventInfo): Promise; + /** + * Send accessibility event. + * + * @param { EventInfo } event The object of the accessibility {@code EventInfo} . + * @returns { Promise } Returns {@code true} if success ; returns {@code false} otherwise. + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 20 + * @arkts 1.2 + */ + function sendAccessibilityEventReturnsPromise(event: EventInfo): Promise; + + /** + * @arkts 1.2 + */ + overload sendAccessibilityEvent { sendAccessibilityEventWithCallback, sendAccessibilityEventReturnsPromise }; + /** * Gets touch mode type. * @returns { string } Returns touch mode type, include 'singleTouchMode', 'doubleTouchMode', and 'none'. * @syscap SystemCapability.BarrierFree.Accessibility.Core * @since 20 + * @arkts 1.1&1.2 */ function getTouchModeSync(): string; @@ -1278,10 +1409,21 @@ declare namespace accessibility { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @crossplatform * @since 20 - * @arkts 1.1&1.2 */ function on(type: 'accessibilityStateChange', callback: Callback): void; + /** + * Register the observe of the accessibility state changed. + * + * @param { 'accessibilityStateChange' } type state event type. + * @param { Callback } callback Asynchronous callback interface. + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @crossplatform + * @since 20 + * @arkts 1.2 + */ + function onAccessibilityStateChange(type: 'accessibilityStateChange', callback: Callback): void; + /** * Register the observe of the touchGuide state changed. * @@ -1292,11 +1434,21 @@ declare namespace accessibility { * 2. Incorrect parameter types; * 3. Parameter verification failed. * @syscap SystemCapability.BarrierFree.Accessibility.Vision - * @since arkts {'1.1':'7', '1.2':'20'} - * @arkts 1.1&1.2 + * @since 7 */ function on(type: 'touchGuideStateChange', callback: Callback): void; + /** + * Register the observe of the touchGuide state changed. + * + * @param { 'touchGuideStateChange' } type state event type. + * @param { Callback } callback Asynchronous callback interface. + * @syscap SystemCapability.BarrierFree.Accessibility.Vision + * @since 20 + * @arkts 1.2 + */ + function onTouchGuideStateChange(type: 'touchGuideStateChange', callback: Callback): void; + /** * Register the observe of the screen reader state changed. * @param { 'screenReaderStateChange' } type state event type. @@ -1306,25 +1458,44 @@ declare namespace accessibility { * 2. Incorrect parameter types; * 3. Parameter verification failed. * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since arkts {'1.1':'18', '1.2':'20'} - * @arkts 1.1&1.2 + * @since 18 */ function on(type: 'screenReaderStateChange', callback: Callback): void; + /** + * Register the observe of the screen reader state changed. + * @param { 'screenReaderStateChange' } type state event type. + * @param { Callback } callback callback Asynchronous callback interface. + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 20 + * @arkts 1.2 + */ + function onScreenReaderStateChange(type: 'screenReaderStateChange', callback: Callback): void; + /** * Register the observe of the touch mode changed. * @param { 'touchModeChange' } type touch mode change. * @param { Callback } callback callback Asynchronous callback interface. - * @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 20 - * @arkts 1.1&1.2 */ function on(type: 'touchModeChange', callback: Callback): void; + /** + * Register the observe of the touch mode changed. + * @param { 'touchModeChange' } type touch mode change. + * @param { Callback } callback callback Asynchronous callback interface. + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 20 + * @arkts 1.2 + */ + function onTouchModeChange(type: 'touchModeChange', callback: Callback): void; + + /** + * @arkts 1.2 + */ + overload on { onAccessibilityStateChange, onTouchGuideStateChange, onScreenReaderStateChange, onTouchModeChange}; + /** * Unregister the observe of the accessibility state changed. * @@ -1349,10 +1520,21 @@ declare namespace accessibility { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @crossplatform * @since 20 - * @arkts 1.1&1.2 */ function off(type: 'accessibilityStateChange', callback?: Callback): void; + /** + * Unregister the observe of the accessibility state changed. + * + * @param { 'accessibilityStateChange' } type state event type + * @param { Callback } [callback] Asynchronous callback interface. + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @crossplatform + * @since 20 + * @arkts 1.2 + */ + function offAccessibilityStateChange(type: 'accessibilityStateChange', callback?: Callback): void; + /** * Unregister the observe of the touchGuide state changed. * @@ -1363,39 +1545,65 @@ declare namespace accessibility { * 2. Incorrect parameter types; * 3. Parameter verification failed. * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since arkts {'1.1':'7', '1.2':'20'} - * @arkts 1.1&1.2 + * @since 7 */ function off(type: 'touchGuideStateChange', callback?: Callback): void; + /** + * Unregister the observe of the touchGuide state changed. + * + * @param { 'touchGuideStateChange' } type state event type + * @param { Callback } [callback] Asynchronous callback interface. + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 20 + * @arkts 1.2 + */ + function offTouchGuideStateChange(type: 'touchGuideStateChange', callback?: Callback): void; + /** * 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: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @param { Callback } [callback] callback Asynchronous callback interface. * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since arkts {'1.1':'18', '1.2':'20'} - * @arkts 1.1&1.2 + * @since 18 */ function off(type: 'screenReaderStateChange', callback?: Callback): void; + /** + * Unregister the observe of the screen reader state changed. + * @param { 'screenReaderStateChange' } type state event type + * @param { Callback } [callback] callback Asynchronous callback interface. + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 20 + * @arkts 1.2 + */ + function offScreenReaderStateChange(type: 'screenReaderStateChange', callback?: Callback): void; + /** * Unregister the observe of the touch mode changed. * @param { 'touchModeChange' } type touch mode change. - * @param { Callback } callback callback Asynchronous callback interface. - * @throws { BusinessError } 401 Parameter error. Possible causes: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @param { Callback } [callback] callback Asynchronous callback interface. * @syscap SystemCapability.BarrierFree.Accessibility.Core * @since 20 - * @arkts 1.1&1.2 */ function off(type: 'touchModeChange', callback?: Callback): void; + /** + * Unregister the observe of the touch mode changed. + * @param { 'touchModeChange' } type touch mode change. + * @param { Callback } [callback] callback Asynchronous callback interface. + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 20 + * @arkts 1.2 + */ + function offTouchModeChange(type: 'touchModeChange', callback?: Callback): void; + + /** + * @since 20 + * @arkts 1.2 + */ + overload off { offAccessibilityStateChange, offTouchGuideStateChange, offScreenReaderStateChange, offTouchModeChange}; + /** * Get the captions manager. * @@ -1497,7 +1705,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'; /** @@ -1505,7 +1714,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'; @@ -1514,7 +1724,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 { /** @@ -1522,44 +1733,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; } /** @@ -1567,7 +1784,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 { /** @@ -1575,7 +1793,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; @@ -1584,7 +1803,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; @@ -1593,7 +1813,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; /** @@ -1601,7 +1822,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; @@ -1610,7 +1832,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; @@ -1619,7 +1842,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; @@ -1628,7 +1852,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; @@ -1637,7 +1862,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; @@ -1646,7 +1872,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; @@ -1655,7 +1882,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; } @@ -1671,11 +1899,11 @@ declare namespace accessibility { /** * A constructor used to create a EventInfo object. * - * @param { Object } jsonObject - Character string in JSON format required for creating an object. + * @param jsonObject - Character string in JSON format required for creating an object. * @syscap SystemCapability.BarrierFree.Accessibility.Core * @since 7 */ - constructor(jsonObject: Object); + constructor(jsonObject); /** * A constructor used to create a EventInfo object. * @@ -1725,11 +1953,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. @@ -1778,43 +2007,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. @@ -1829,7 +2063,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 2e77bb9146..a260fcb30a 100644 --- a/api/@ohos.application.AccessibilityExtensionAbility.d.ts +++ b/api/@ohos.application.AccessibilityExtensionAbility.d.ts @@ -17,7 +17,7 @@ * @file * @kit AccessibilityKit */ - +/*** if arkts 1.1 */ import type accessibility from './@ohos.accessibility'; import type { KeyEvent } from './@ohos.multimodalInput.keyEvent'; import type { @@ -27,11 +27,42 @@ import type { FocusType as _FocusType, WindowType as _WindowType, Rect as _Rect, - Parameter as _Parameter, } from './application/AccessibilityExtensionContext'; import type * as _AccessibilityExtensionContext from './application/AccessibilityExtensionContext'; import { AccessibilityEventType } from './@ohos.accessibility'; +/** + * The accessibility extension context. Used to configure, query information, and inject gestures. + * + * @typedef {_AccessibilityExtensionContext.default} + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 10 + */ +export type AccessibilityExtensionContext = _AccessibilityExtensionContext.default; +/*** endif */ +/*** if arkts 1.2 */ +import accessibility from './@ohos.accessibility'; +import { KeyEvent } from './@ohos.multimodalInput.keyEvent'; +import { + AccessibilityElement as _AccessibilityElement, + ElementAttributeValues as _ElementAttributeValues, + FocusDirection as _FocusDirection, + FocusType as _FocusType, + WindowType as _WindowType, + Rect as _Rect, +} from './application/AccessibilityExtensionContext'; +import AccessibilityExtensionContext from './application/AccessibilityExtensionContext'; +import { AccessibilityEventType } from './@ohos.accessibility'; +/** + * The accessibility extension context. Used to configure, query information, and inject gestures. + * + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @systemapi + * @since 20 + * @arkts 1.2 + */ +export { AccessibilityExtensionContext }; +/*** endif */ /** * Indicates an accessibility element. @@ -39,7 +70,8 @@ import { AccessibilityEventType } from './@ohos.accessibility'; * * @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; @@ -48,7 +80,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; @@ -57,7 +90,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; @@ -66,7 +100,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; @@ -75,7 +110,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; @@ -84,7 +120,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; @@ -93,42 +130,36 @@ 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; /** - * Indicates executeAction parameter. + * Indicates the AccessibilityActionParameter of the AccessibiltyAction. * - * @typedef {_Parameter} * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @systemapi * @since 20 + * @arkts 1.1&1.2 */ -export type Parameter = _Parameter; - -/** - * The accessibility extension context. Used to configure, query information, and inject gestures. - * - * @typedef {_AccessibilityExtensionContext.default} - * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 10 - */ - -export type AccessibilityExtensionContext = _AccessibilityExtensionContext.default; +export { AccessibilityActionParameter } from './application/AccessibilityExtensionContext'; /** * 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; @@ -180,6 +211,7 @@ export default class AccessibilityExtensionAbility { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ onAccessibilityConnect(): void; @@ -192,6 +224,7 @@ export default class AccessibilityExtensionAbility { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ onAccessibilityDisconnect(): void; @@ -205,6 +238,7 @@ export default class AccessibilityExtensionAbility { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ onAccessibilityEventInfo(event: AccessibilityEventInfo): void; @@ -219,10 +253,13 @@ export default class AccessibilityExtensionAbility { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ 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,6 +268,7 @@ export default class AccessibilityExtensionAbility { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ export declare interface AccessibilityEventInfo { /** @@ -240,6 +278,7 @@ export declare interface AccessibilityEventInfo { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ eventType: AccessibilityEventType; @@ -250,18 +289,20 @@ export declare interface AccessibilityEventInfo { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ target?: AccessibilityElement; /** * TimeStamp * - * @type { ?number } + * @type { ?long } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ - timestamp?: number; + timestamp?: long; /** * The content of add/remove accessibility extraInfo text. @@ -270,6 +311,7 @@ export declare interface AccessibilityEventInfo { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ extraInfo?: string; } @@ -280,7 +322,8 @@ export 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 */ export declare interface AccessibilityEvent { /** @@ -288,7 +331,8 @@ export declare interface AccessibilityEvent { * * @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; @@ -297,34 +341,38 @@ export 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; @@ -334,6 +382,7 @@ export declare interface AccessibilityEvent { * @type { ?string } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @since 20 + * @arkts 1.1&1.2 */ extraInfo?: string; } @@ -361,7 +410,8 @@ export 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' | @@ -379,7 +429,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'; @@ -388,6 +439,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 c56f156b7a..36ac35b45c 100644 --- a/api/application/AccessibilityExtensionContext.d.ts +++ b/api/application/AccessibilityExtensionContext.d.ts @@ -18,21 +18,33 @@ * @kit AccessibilityKit */ -import type { AsyncCallback, BusinessError, Callback } from '../@ohos.base'; +/*** if arkts 1.1 */ +import type { AsyncCallback, BusinessError } from '../@ohos.base'; import ExtensionContext from './ExtensionContext'; import type accessibility from '../@ohos.accessibility'; import type { GesturePath } from '../@ohos.accessibility.GesturePath'; import type Want from '../@ohos.app.ability.Want'; -import { AccessibilityAction } from '../@ohos.accessibility'; +/*** endif */ + +/*** if arkts 1.2 */ +import { AsyncCallback, Callback } from '../@ohos.base'; +import {BusinessError} from '../@ohos.base'; +import { GesturePath } from '../@ohos.accessibility.GesturePath'; +import ExtensionContext from './ExtensionContext'; +import accessibility from '../@ohos.accessibility'; +import type { AccessibilityAction } from '@ohos.accessibility'; +import Want from '../@ohos.app.ability.Want'; +/*** 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. * @@ -112,7 +124,7 @@ export default class AccessibilityExtensionContext extends ExtensionContext { /** * Get window root element. * - * @param { number } windowId Indicates the window ID. + * @param { int } windowId Indicates the window ID. * @param { AsyncCallback } callback Indicates the listener. * @throws { BusinessError } 401 - Input parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; @@ -123,12 +135,12 @@ export default class AccessibilityExtensionContext extends ExtensionContext { * @since 9 * @deprecated since 12 */ - getWindowRootElement(windowId: number, callback: AsyncCallback): void; + getWindowRootElement(windowId: int, callback: AsyncCallback): void; /** * Get window root element. * - * @param { number } [windowId] Indicates the window ID. + * @param { int } [windowId] Indicates the window ID. * @returns { Promise } * @throws { BusinessError } 401 - Input parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; @@ -139,7 +151,7 @@ export default class AccessibilityExtensionContext extends ExtensionContext { * @since 9 * @deprecated since 12 */ - getWindowRootElement(windowId?: number): Promise; + getWindowRootElement(windowId?: int ): Promise; /** * Get window root element. @@ -158,7 +170,7 @@ export default class AccessibilityExtensionContext extends ExtensionContext { /** * Get window list. * - * @param { number } displayId Indicates the display ID. + * @param { long } displayId Indicates the display ID. * @param { AsyncCallback> } callback Indicates the listener. * @throws { BusinessError } 401 - Input parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; @@ -169,12 +181,12 @@ export default class AccessibilityExtensionContext extends ExtensionContext { * @since 9 * @deprecated since 12 */ - getWindows(displayId: number, callback: AsyncCallback>): void; + getWindows(displayId: long, callback: AsyncCallback>): void; /** * Get window list. * - * @param { number } displayId Indicates the display ID. + * @param { long } displayId Indicates the display ID. * @returns { Promise> } * @throws { BusinessError } 401 - Input parameter error. Possible causes: * 1. Mandatory parameters are left unspecified; @@ -185,7 +197,7 @@ export default class AccessibilityExtensionContext extends ExtensionContext { * @since 9 * @deprecated since 12 */ - getWindows(displayId?: number): Promise>; + getWindows(displayId?: long): Promise>; /** * Get window list. @@ -262,42 +274,37 @@ export default class AccessibilityExtensionContext extends ExtensionContext { * 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: - * 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: - * 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. @@ -308,6 +315,7 @@ export default class AccessibilityExtensionContext extends ExtensionContext { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ holdRunningLockSync(): void; @@ -320,6 +328,7 @@ export default class AccessibilityExtensionContext extends ExtensionContext { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ unholdRunningLockSync(): void; @@ -334,6 +343,7 @@ export default class AccessibilityExtensionContext extends ExtensionContext { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ on(type: 'preDisconnect', callback: Callback): void; @@ -348,6 +358,7 @@ export default class AccessibilityExtensionContext extends ExtensionContext { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ off(type: 'preDisconnect', callback?: Callback): void; @@ -360,6 +371,7 @@ export default class AccessibilityExtensionContext extends ExtensionContext { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ notifyDisconnect(): void; @@ -375,6 +387,7 @@ export default class AccessibilityExtensionContext extends ExtensionContext { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ getAccessibilityFocusedElement(): Promise; @@ -382,7 +395,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. @@ -391,14 +404,15 @@ export default class AccessibilityExtensionContext extends ExtensionContext { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ - 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. @@ -406,8 +420,9 @@ export default class AccessibilityExtensionContext extends ExtensionContext { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ - getAccessibilityWindowsSync(displayId?: number): Array; + getAccessibilityWindowsSync(displayId?: long): Array; } /** @@ -416,9 +431,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 { +interface AccessibilityElement { /** * Get a list of attribute names. * @@ -546,22 +562,26 @@ declare interface AccessibilityElement { /** * Get the position of cursor in TextInput. * - * @param { AsyncCallback } callback Indicates the listener. + * @param { AsyncCallback } callback Indicates the listener. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * * @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 } + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @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. @@ -575,7 +595,8 @@ declare interface AccessibilityElement { * @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; @@ -687,7 +708,8 @@ declare interface AccessibilityElement { * 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 +717,15 @@ 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: - * 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; - * 3. Parameter verification failed. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * * @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. @@ -714,6 +734,7 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ accessibilityFocused?: boolean; @@ -724,6 +745,7 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ bundleName?: string; @@ -734,6 +756,7 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ checkable?: boolean; @@ -744,6 +767,7 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ checked?: boolean; @@ -754,18 +778,20 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 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 * @systemapi * @since 20 + * @arkts 1.1&1.2 */ - componentId?: number; + componentId?: long; /** * Indicates the component type to which the element belongs. @@ -774,6 +800,7 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ componentType?: string; @@ -784,18 +811,20 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ contents?: Array; /** * Indicates the index of the current item. * - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ - currentIndex?: number; + currentIndex?: int; /** * Indicates the description of the element. @@ -804,6 +833,7 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ description?: string; @@ -814,18 +844,20 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 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 * @systemapi * @since 20 + * @arkts 1.1&1.2 */ - endIndex?: number; + endIndex?: int; /** * Indicates the string of error state. @@ -834,6 +866,7 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ error?: string; @@ -844,6 +877,7 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ focusable?: boolean; @@ -854,18 +888,20 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ hintText?: string; /** * Indicates the type of input text. * - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ - inputType?: number; + inputType?: int; /** * Indicates the inspector key. @@ -874,6 +910,7 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ inspectorKey?: string; @@ -884,6 +921,7 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ isActive?: boolean; @@ -894,6 +932,7 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ isEnable?: boolean; @@ -904,6 +943,7 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ isHint?: boolean; @@ -914,6 +954,7 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ isFocused?: boolean; @@ -924,6 +965,7 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ isPassword?: boolean; @@ -934,18 +976,20 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ isVisible?: boolean; /** * Indicates the total count of the items. * - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ - itemCount?: number; + itemCount?: int; /** * Indicates the last content. @@ -954,18 +998,20 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ lastContent?: string; /** * Indicates the display layer of the element. * - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ - layer?: number; + layer?: int; /** * Indicates whether the element is long clickable. @@ -974,18 +1020,20 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ longClickable?: boolean; /** * Indicates the page id. * - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ - pageId?: number; + pageId?: int; /** * Indicates whether the element supports multiple lines of text. @@ -994,6 +1042,7 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ pluralLineSupported?: boolean; @@ -1004,6 +1053,7 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ rect?: Rect; @@ -1014,6 +1064,7 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ resourceName?: string; @@ -1024,6 +1075,7 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ screenRect?: Rect; @@ -1034,6 +1086,7 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ scrollable?: boolean; @@ -1044,18 +1097,20 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 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 * @systemapi * @since 20 + * @arkts 1.1&1.2 */ - startIndex?: number; + startIndex?: int; /** * Indicates the text of the element. @@ -1064,18 +1119,20 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 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 * @systemapi * @since 20 + * @arkts 1.1&1.2 */ - textLengthLimit?: number; + textLengthLimit?: int; /** * Indicates the unit of movement of the element text as it is read. @@ -1084,6 +1141,7 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ textMoveUnit?: accessibility.TextMoveUnit; @@ -1094,6 +1152,7 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ triggerAction?: AccessibilityAction; @@ -1104,58 +1163,64 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ type?: WindowType; /** * Indicates the maximum value. * - * @type { ?number } + * @type { ?double } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ - valueMax?: number; + valueMax?: double; /** * Indicates the minimum value. * - * @type { ?number } + * @type { ?double } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ - valueMin?: number; + valueMin?: double; /** * Indicates the current value. * - * @type { ?number } + * @type { ?double } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ - valueNow?: number; + valueNow?: double; /** * Indicates the window id. * - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ - windowId?: number; + windowId?: int; /** * Indicates the offset. * - * @type { ?number } + * @type { ?double } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ - offset?: number; + offset?: double; /** * Indicates the text type. @@ -1164,6 +1229,7 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ textType?: string; @@ -1174,6 +1240,7 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ accessibilityText?: string; @@ -1184,6 +1251,7 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ hotArea?: Rect; @@ -1194,28 +1262,31 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ customComponentType?: string; /** * Indicates the component next accessibility focus id. * - * @type { ?number } + * @type { ?long } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ - accessibilityNextFocusId?: number; + accessibilityNextFocusId?: long; /** * Indicates the component previous accessibility focus id. * - * @type { ?number } + * @type { ?long } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ - accessibilityPreviousFocusId?: number; + accessibilityPreviousFocusId?: long; /** * Indicates the extra info of the element. @@ -1224,6 +1295,7 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ extraInfo?: string; @@ -1234,6 +1306,7 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ accessibilityScrollable?: boolean; @@ -1244,6 +1317,7 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ supportedActionNames?: Array; @@ -1254,6 +1328,7 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ accessibilityGroup?: boolean; @@ -1264,18 +1339,20 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ accessibilityLevel?: string; /** * Indicates the navDestination id of component. * - * @type { ?number } + * @type { ?long } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ - navDestinationId?: number; + navDestinationId?: long; /** * Indicates the current item in grid of component. @@ -1284,6 +1361,7 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ currentItem?: AccessibilityGrid; @@ -1294,6 +1372,7 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ spans?: AccessibilitySpan[]; @@ -1304,18 +1383,20 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ accessibilityVisible?: boolean; /** * Indicates the main windowId of component. * - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ - mainWindowId?: number; + mainWindowId?: int; /** * Indicates whether the component need clip. @@ -1324,35 +1405,38 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ clip?: boolean; /** * Indicates the parent element id of component. * - * @type { ?number } + * @type { ?long } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ - parentId?: number; + parentId?: long; /** * Indicates the children elements id list of component. * - * @type { ?Array } + * @type { ?Array } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ - childrenIds?: Array; + childrenIds?: Array; /** * Execute the specified action. * * @permission ohos.permission.ACCESSIBILITY_EXTENSION_ABILITY * @param { AccessibilityAction } action Indicates the action to execute. - * @param { Parameter } [parameters] Indicates the parameters needed to execute the action. + * @param { AccessibilityActionParameter } [parameters] Indicates the parameters needed to execute the action. * @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. @@ -1360,8 +1444,9 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ - executeAction(action: AccessibilityAction, parameters?: Parameter): Promise; + executeAction(action: AccessibilityAction, parameters?: AccessibilityActionParameter): Promise; /** * Get element's parent. @@ -1373,6 +1458,7 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ getParent(): Promise; @@ -1386,6 +1472,7 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ getChildren(): Promise>; @@ -1399,6 +1486,7 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ getRoot(): Promise; @@ -1414,6 +1502,7 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ findElementByContent(condition: string): Promise>; @@ -1429,6 +1518,7 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ findElementByFocusDirection(condition: FocusDirection): Promise; @@ -1444,6 +1534,7 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ findElementsByAccessibilityHintText(condition: string): Promise>; @@ -1451,7 +1542,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. @@ -1459,8 +1550,9 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ - findElementById(condition: number): Promise; + findElementById(condition: long): Promise; } /** @@ -1470,26 +1562,29 @@ declare interface AccessibilityElement { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ interface AccessibilityGrid { /** * The row index in grid. * - * @type { number } + * @type { int } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ - rowIndex: number; + rowIndex: int ; /** * The colum index in grid. * - * @type { number } + * @type { int } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ - columnIndex: number; + columnIndex: int ; } /** @@ -1499,17 +1594,19 @@ interface AccessibilityGrid { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ interface AccessibilitySpan { /** * The id of span. * - * @type { number } + * @type { int } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ - spanId: number; + spanId: int ; /** * The text of span. * @@ -1517,6 +1614,7 @@ interface AccessibilitySpan { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ spanText: string; /** @@ -1526,6 +1624,7 @@ interface AccessibilitySpan { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ accessibilityText: string; /** @@ -1535,6 +1634,7 @@ interface AccessibilitySpan { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ accessibilityDescription: string; /** @@ -1544,6 +1644,7 @@ interface AccessibilitySpan { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ accessibilityLevel: string; } @@ -1554,8 +1655,9 @@ interface AccessibilitySpan { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ -export declare class Parameter { +declare class AccessibilityActionParameter { /** * Indicates the text to set for AccessibilityAction.SET_TEXT. * @@ -1563,6 +1665,7 @@ export declare class Parameter { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ setText?: string; /** @@ -1572,6 +1675,7 @@ export declare class Parameter { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ selectTextBegin?: string; /** @@ -1581,6 +1685,7 @@ export declare class Parameter { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ selectTextEnd?: string; /** @@ -1590,6 +1695,7 @@ export declare class Parameter { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ selectTextInForWard?: boolean; /** @@ -1599,6 +1705,7 @@ export declare class Parameter { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ offset?: string; /** @@ -1608,6 +1715,7 @@ export declare class Parameter { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ spanId?: string; /** @@ -1617,22 +1725,18 @@ export declare class Parameter { * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since 20 + * @arkts 1.1&1.2 */ scrollType?: string; } -/** - * Indicates the possible attributes of the element and the type of the attribute value. - * - * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 - */ /** * Indicates the possible attributes of the element and the type of the attribute value. * * @typedef ElementAttributeValues * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 11 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ interface ElementAttributeValues { /** @@ -1640,7 +1744,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 */ accessibilityFocused: boolean; /** @@ -1648,7 +1753,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 +1762,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 +1771,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 +1780,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 +1789,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 +1816,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 +1843,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 +1870,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 +1879,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 +1906,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 +1915,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 +1924,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 +1933,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 +1942,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 +1951,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 +2014,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 +2023,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 +2032,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 +2041,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 +2050,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 +2059,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 +2068,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 +2113,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 +2122,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 +2185,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 +2194,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,7 +2248,8 @@ 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'; @@ -2097,7 +2258,8 @@ type FocusDirection = 'up' | 'down' | 'left' | 'right' | 'forward' | 'backward'; * * @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'; @@ -2106,7 +2268,8 @@ type FocusType = 'accessibility' | 'normal'; * * @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'; @@ -2115,39 +2278,48 @@ type WindowType = 'application' | 'system'; * * @typedef Rect * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ 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; } + +export default AccessibilityExtensionContext; +export {AccessibilityElement, AccessibilityActionParameter, ElementAttributeValues, Rect, FocusDirection, FocusType, + WindowType, AccessibilityGrid, AccessibilitySpan}; diff --git a/kits/@kit.AccessibilityKit.d.ts b/kits/@kit.AccessibilityKit.d.ts index 07af29fa55..200e3a798a 100644 --- a/kits/@kit.AccessibilityKit.d.ts +++ b/kits/@kit.AccessibilityKit.d.ts @@ -18,19 +18,20 @@ * @kit AccessibilityKit */ +/*** if arkts 1.1&1.2 */ import config from '@ohos.accessibility.config'; import accessibility from '@ohos.accessibility'; 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, AccessibilityActionParameter as Parameter, + ElementAttributeValues, FocusDirection, FocusType, Rect, WindowType, AccessibilityEvent, AccessibilityEventInfo } from '@ohos.application.AccessibilityExtensionAbility'; import { AccessibilityAction, AccessibilityEventType } from '@ohos.accessibility'; export { - AccessibilityElement, AccessibilityExtensionAbility, AccessibilityExtensionContext, + AccessibilityElement, AccessibilityExtensionAbility, AccessibilityExtensionContext, Parameter, ElementAttributeKeys, ElementAttributeValues, FocusDirection, FocusType, GesturePath, GesturePoint, Rect, WindowType, accessibility, config, AccessibilityEvent, AccessibilityEventInfo, - AccessibilityAction, AccessibilityEventType, Parameter + AccessibilityAction, AccessibilityEventType }; +/*** endif */ \ No newline at end of file -- Gitee From c7fbf90c850737cd6fcbef2135dc550bca31497f Mon Sep 17 00:00:00 2001 From: liuzhiwei Date: Tue, 2 Sep 2025 10:31:44 +0800 Subject: [PATCH 2/4] =?UTF-8?q?=E5=90=8C=E6=AD=A50702=E5=88=86=E6=94=AF?= =?UTF-8?q?=E4=BB=A3=E7=A0=81=E6=95=B4=E6=94=B9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: liuzhiwei --- api/@ohos.accessibility.GesturePoint.d.ts | 16 +-- api/@ohos.accessibility.config.d.ts | 31 ++--- api/@ohos.accessibility.d.ts | 54 ++++---- ...ication.AccessibilityExtensionAbility.d.ts | 46 ++----- .../AccessibilityExtensionContext.d.ts | 129 +++++++++--------- 5 files changed, 126 insertions(+), 150 deletions(-) diff --git a/api/@ohos.accessibility.GesturePoint.d.ts b/api/@ohos.accessibility.GesturePoint.d.ts index 9c25b39925..10c0d3a164 100644 --- a/api/@ohos.accessibility.GesturePoint.d.ts +++ b/api/@ohos.accessibility.GesturePoint.d.ts @@ -26,34 +26,32 @@ * @arkts 1.1&1.2 */ export declare class GesturePoint { - /*** if arkts 1.1 */ /** * A constructor used to create a GesturePoint object. * - * @param { long } positionX - Indicates the X coordinate of point. - * @param { long } positionY - Indicates the Y coordinate of point. + * @param { double } positionX - Indicates the X coordinate of point. + * @param { double } positionY - Indicates the Y coordinate of point. * @syscap SystemCapability.BarrierFree.Accessibility.Core * @since 9 * @deprecated since 12 */ - constructor(positionX: long, positionY: long); - /*** endif */ + constructor(positionX: double, positionY: double); /** * Indicates the X coordinate of point. * - * @type { long } + * @type { double } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @since arkts {'1.1':'9', '1.2':'20'} * @arkts 1.1&1.2 */ - positionX: long; + positionX: double; /** * Indicates the Y coordinate of point. * - * @type { long } + * @type { double } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @since arkts {'1.1':'9', '1.2':'20'} * @arkts 1.1&1.2 */ - positionY: long; + positionY: double; } diff --git a/api/@ohos.accessibility.config.d.ts b/api/@ohos.accessibility.config.d.ts index 66d8556c03..bf000b27c0 100644 --- a/api/@ohos.accessibility.config.d.ts +++ b/api/@ohos.accessibility.config.d.ts @@ -17,15 +17,9 @@ * @file * @kit AccessibilityKit */ -/*** if arkts 1.1 */ + import type accessibility from './@ohos.accessibility'; import type { AsyncCallback, Callback } from './@ohos.base'; -/*** endif */ - -/*** if arkts 1.2 */ -import accessibility from './@ohos.accessibility'; -import { AsyncCallback, Callback } from './@ohos.base'; -/*** endif */ /** * Configuration of the accessibility. @@ -241,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. @@ -278,7 +272,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. @@ -329,7 +323,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. @@ -364,7 +358,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. @@ -405,7 +399,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. @@ -425,7 +419,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. @@ -445,7 +439,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. @@ -465,7 +459,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. @@ -483,7 +477,6 @@ declare namespace config { * @param { boolean } state Indicates that whether trigger display magnification. * @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 } 801 - Capability not supported. Failed to call the API due to limited device capabilities. * @throws { BusinessError } 9300007 - Trigger magnification failed. * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi @@ -511,7 +504,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. @@ -546,7 +539,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. @@ -640,7 +633,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. diff --git a/api/@ohos.accessibility.d.ts b/api/@ohos.accessibility.d.ts index 376ecc742f..238c2fa703 100644 --- a/api/@ohos.accessibility.d.ts +++ b/api/@ohos.accessibility.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (C) 2025 Huawei Device Co., Ltd. + * Copyright (C) 2021-2025 Huawei Device Co., Ltd. * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at @@ -18,14 +18,8 @@ * @kit AccessibilityKit */ -/*** if arkts 1.1 */ import type { AsyncCallback } from './@ohos.base'; import type { Callback } from './@ohos.base'; -/*** endif */ -/*** if arkts 1.2 */ -import { AsyncCallback } from './@ohos.base'; -import { Callback } from './@ohos.base'; -/*** endif */ import { Resource } from './global/resource'; /** @@ -1249,7 +1243,7 @@ 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. @@ -1268,7 +1262,7 @@ 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. @@ -1326,7 +1320,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. @@ -1351,7 +1345,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. @@ -1390,7 +1384,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. @@ -1402,7 +1396,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. @@ -1429,7 +1423,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. @@ -1453,7 +1447,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. @@ -1476,6 +1470,10 @@ declare namespace accessibility { * Register the observe of the touch mode changed. * @param { 'touchModeChange' } type touch mode change. * @param { Callback } callback callback Asynchronous callback interface. + * @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 20 */ @@ -1501,7 +1499,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. @@ -1513,7 +1511,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. @@ -1540,7 +1538,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. @@ -1563,7 +1561,11 @@ 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. + * @param { Callback } callback callback Asynchronous callback interface. + * @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 18 */ @@ -1582,7 +1584,11 @@ declare namespace accessibility { /** * Unregister the observe of the touch mode changed. * @param { 'touchModeChange' } type touch mode change. - * @param { Callback } [callback] callback Asynchronous callback interface. + * @param { Callback } callback callback Asynchronous callback interface. + * @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 20 */ @@ -1644,7 +1650,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. @@ -1659,7 +1665,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. @@ -1674,7 +1680,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. @@ -1689,7 +1695,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. diff --git a/api/@ohos.application.AccessibilityExtensionAbility.d.ts b/api/@ohos.application.AccessibilityExtensionAbility.d.ts index a260fcb30a..979805936d 100644 --- a/api/@ohos.application.AccessibilityExtensionAbility.d.ts +++ b/api/@ohos.application.AccessibilityExtensionAbility.d.ts @@ -17,7 +17,7 @@ * @file * @kit AccessibilityKit */ -/*** if arkts 1.1 */ + import type accessibility from './@ohos.accessibility'; import type { KeyEvent } from './@ohos.multimodalInput.keyEvent'; import type { @@ -28,41 +28,8 @@ import type { WindowType as _WindowType, Rect as _Rect, } from './application/AccessibilityExtensionContext'; -import type * as _AccessibilityExtensionContext from './application/AccessibilityExtensionContext'; -import { AccessibilityEventType } from './@ohos.accessibility'; -/** - * The accessibility extension context. Used to configure, query information, and inject gestures. - * - * @typedef {_AccessibilityExtensionContext.default} - * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since 10 - */ -export type AccessibilityExtensionContext = _AccessibilityExtensionContext.default; -/*** endif */ - -/*** if arkts 1.2 */ -import accessibility from './@ohos.accessibility'; -import { KeyEvent } from './@ohos.multimodalInput.keyEvent'; -import { - AccessibilityElement as _AccessibilityElement, - ElementAttributeValues as _ElementAttributeValues, - FocusDirection as _FocusDirection, - FocusType as _FocusType, - WindowType as _WindowType, - Rect as _Rect, -} from './application/AccessibilityExtensionContext'; import AccessibilityExtensionContext from './application/AccessibilityExtensionContext'; import { AccessibilityEventType } from './@ohos.accessibility'; -/** - * The accessibility extension context. Used to configure, query information, and inject gestures. - * - * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @systemapi - * @since 20 - * @arkts 1.2 - */ -export { AccessibilityExtensionContext }; -/*** endif */ /** * Indicates an accessibility element. @@ -145,6 +112,17 @@ export type Rect = _Rect; */ export { AccessibilityActionParameter } from './application/AccessibilityExtensionContext'; +/** + * The accessibility extension context. Used to configure, query information, and inject gestures. + * + * @typedef {_AccessibilityExtensionContext.default} + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 + */ + +export { AccessibilityExtensionContext }; + /** * class of accessibility extension ability. * diff --git a/api/application/AccessibilityExtensionContext.d.ts b/api/application/AccessibilityExtensionContext.d.ts index 36ac35b45c..bb14268352 100644 --- a/api/application/AccessibilityExtensionContext.d.ts +++ b/api/application/AccessibilityExtensionContext.d.ts @@ -18,23 +18,12 @@ * @kit AccessibilityKit */ -/*** if arkts 1.1 */ -import type { AsyncCallback, BusinessError } from '../@ohos.base'; +import type { AsyncCallback, BusinessError, Callback } from '../@ohos.base'; import ExtensionContext from './ExtensionContext'; import type accessibility from '../@ohos.accessibility'; import type { GesturePath } from '../@ohos.accessibility.GesturePath'; import type Want from '../@ohos.app.ability.Want'; -/*** endif */ - -/*** if arkts 1.2 */ -import { AsyncCallback, Callback } from '../@ohos.base'; -import {BusinessError} from '../@ohos.base'; -import { GesturePath } from '../@ohos.accessibility.GesturePath'; -import ExtensionContext from './ExtensionContext'; -import accessibility from '../@ohos.accessibility'; -import type { AccessibilityAction } from '@ohos.accessibility'; -import Want from '../@ohos.app.ability.Want'; -/*** endif */ +import { AccessibilityAction } from '../@ohos.accessibility'; /** * The accessibility extension context. Used to configure, query information, and inject gestures. @@ -50,7 +39,7 @@ declare class AccessibilityExtensionContext extends ExtensionContext { * * @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. @@ -65,7 +54,7 @@ declare 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. @@ -80,7 +69,7 @@ declare 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. @@ -96,7 +85,7 @@ declare 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. @@ -110,7 +99,7 @@ declare 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. @@ -126,7 +115,7 @@ declare class AccessibilityExtensionContext extends ExtensionContext { * * @param { int } 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. @@ -140,9 +129,9 @@ declare class AccessibilityExtensionContext extends ExtensionContext { /** * Get window root element. * - * @param { int } [windowId] Indicates the window ID. + * @param { int } [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. @@ -151,12 +140,12 @@ declare class AccessibilityExtensionContext extends ExtensionContext { * @since 9 * @deprecated since 12 */ - getWindowRootElement(windowId?: int ): Promise; + getWindowRootElement(windowId?: int): Promise; /** * 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. @@ -170,9 +159,9 @@ declare class AccessibilityExtensionContext extends ExtensionContext { /** * Get window list. * - * @param { long } displayId Indicates the display ID. + * @param { long } 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. @@ -188,7 +177,7 @@ declare class AccessibilityExtensionContext extends ExtensionContext { * * @param { long } 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. @@ -202,7 +191,7 @@ declare 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. @@ -218,7 +207,7 @@ declare 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. @@ -235,7 +224,7 @@ declare 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. @@ -251,7 +240,7 @@ declare 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. @@ -268,7 +257,7 @@ declare 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. @@ -282,9 +271,13 @@ declare class AccessibilityExtensionContext extends ExtensionContext { /** * get all subElements in window. * @param { int } windowId Indicates the window ID. - * @param { long } [elementId] Indicates the elementId. + * @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 - 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 @@ -298,6 +291,10 @@ declare class AccessibilityExtensionContext extends ExtensionContext { * @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 - 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 @@ -424,6 +421,7 @@ declare class AccessibilityExtensionContext extends ExtensionContext { */ getAccessibilityWindowsSync(displayId?: long): Array; } +export default AccessibilityExtensionContext; /** * Indicates an accessibility element. @@ -434,7 +432,7 @@ declare class AccessibilityExtensionContext extends ExtensionContext { * @since arkts {'1.1':'9', '1.2':'20'} * @arkts 1.1&1.2 */ -interface AccessibilityElement { +export declare interface AccessibilityElement { /** * Get a list of attribute names. * @@ -459,7 +457,7 @@ 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. @@ -478,7 +476,7 @@ 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. @@ -515,7 +513,7 @@ 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. @@ -532,7 +530,7 @@ 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. @@ -548,7 +546,7 @@ 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. @@ -563,7 +561,6 @@ interface AccessibilityElement { * Get the position of cursor in TextInput. * * @param { AsyncCallback } callback Indicates the listener. - * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since arkts {'1.1':'12', '1.2':'20'} @@ -575,7 +572,6 @@ interface AccessibilityElement { * Get the position of cursor in TextInput. * * @returns { Promise } - * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @syscap SystemCapability.BarrierFree.Accessibility.Core * @systemapi * @since arkts {'1.1':'12', '1.2':'20'} @@ -588,7 +584,7 @@ interface AccessibilityElement { * * @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. @@ -606,7 +602,7 @@ 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. @@ -622,7 +618,7 @@ 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. @@ -638,7 +634,7 @@ 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. @@ -654,7 +650,7 @@ 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. @@ -670,7 +666,7 @@ 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. @@ -686,7 +682,7 @@ 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. @@ -702,7 +698,7 @@ 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. @@ -719,7 +715,10 @@ interface AccessibilityElement { * @param { 'elementId' } type The type of query condition is element id. * @param { long } condition Indicates the specific content to be queried. * @returns { Promise } - * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * + * @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 arkts {'1.1':'12', '1.2':'20'} @@ -1657,7 +1656,7 @@ interface AccessibilitySpan { * @since 20 * @arkts 1.1&1.2 */ -declare class AccessibilityActionParameter { +export declare class AccessibilityActionParameter { /** * Indicates the text to set for AccessibilityAction.SET_TEXT. * @@ -1730,15 +1729,21 @@ declare class AccessibilityActionParameter { scrollType?: string; } +/** + * Indicates the possible attributes of the element and the type of the attribute value. + * + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 9 + */ /** * Indicates the possible attributes of the element and the type of the attribute value. * * @typedef ElementAttributeValues * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since arkts {'1.1':'9', '1.2':'20'} + * @since arkts {'1.1':'11', '1.2':'20'} * @arkts 1.1&1.2 */ -interface ElementAttributeValues { +export interface ElementAttributeValues { /** * Indicates accessibility focus state. * @@ -2200,12 +2205,12 @@ interface ElementAttributeValues { hotArea: Rect; /** * Indicates the component next accessibility focus id. - * @type { ?long } + * @type { ?long } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @since arkts {'1.1':'18', '1.2':'20'} * @arkts 1.1&1.2 */ - accessibilityNextFocusId?: long ; + accessibilityNextFocusId?: long; /** * Indicates the custom component type. * @@ -2226,12 +2231,12 @@ interface ElementAttributeValues { /** * Indicates the component Previous accessibility focus id. * - * @type { ?long } + * @type { ?long } * @syscap SystemCapability.BarrierFree.Accessibility.Core * @since arkts {'1.1':'18', '1.2':'20'} * @arkts 1.1&1.2 */ - accessibilityPreviousFocusId?: long ; + accessibilityPreviousFocusId?: long; /** * Indicates whether the element is scrollable for accessibility. * @@ -2251,7 +2256,7 @@ interface ElementAttributeValues { * @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. @@ -2261,7 +2266,7 @@ type FocusDirection = 'up' | 'down' | 'left' | 'right' | 'forward' | 'backward'; * @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. @@ -2271,7 +2276,7 @@ type FocusType = 'accessibility' | 'normal'; * @since arkts {'1.1':'9', '1.2':'20'} * @arkts 1.1&1.2 */ -type WindowType = 'application' | 'system'; +export type WindowType = 'application' | 'system'; /** * Indicates rectangle. @@ -2281,7 +2286,7 @@ type WindowType = 'application' | 'system'; * @since arkts {'1.1':'9', '1.2':'20'} * @arkts 1.1&1.2 */ -interface Rect { +export interface Rect { /** * The left position of Rect * @@ -2319,7 +2324,3 @@ interface Rect { */ height: int; } - -export default AccessibilityExtensionContext; -export {AccessibilityElement, AccessibilityActionParameter, ElementAttributeValues, Rect, FocusDirection, FocusType, - WindowType, AccessibilityGrid, AccessibilitySpan}; -- Gitee From 955fb349c37fcf8914b1a58f561ba0a79c3e3dca Mon Sep 17 00:00:00 2001 From: liuzhiwei Date: Wed, 3 Sep 2025 15:46:42 +0800 Subject: [PATCH 3/4] =?UTF-8?q?=E5=90=8C=E6=AD=A50702=E4=BF=AE=E6=94=B9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: liuzhiwei --- ....application.AccessibilityExtensionAbility.d.ts | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/api/@ohos.application.AccessibilityExtensionAbility.d.ts b/api/@ohos.application.AccessibilityExtensionAbility.d.ts index 979805936d..217c9f304f 100644 --- a/api/@ohos.application.AccessibilityExtensionAbility.d.ts +++ b/api/@ohos.application.AccessibilityExtensionAbility.d.ts @@ -28,7 +28,13 @@ 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'; /** @@ -117,11 +123,11 @@ export { AccessibilityActionParameter } from './application/AccessibilityExtensi * * @typedef {_AccessibilityExtensionContext.default} * @syscap SystemCapability.BarrierFree.Accessibility.Core - * @since arkts {'1.1':'10', '1.2':'20'} - * @arkts 1.1&1.2 + * @since 10 */ - -export { AccessibilityExtensionContext }; +/*** if arkts 1.1 */ +export type AccessibilityExtensionContext = _AccessibilityExtensionContext.default; +/*** endif */ /** * class of accessibility extension ability. -- Gitee From 08ad291920ffd842c63d09267130e4fdb69ec7c7 Mon Sep 17 00:00:00 2001 From: liuzhiwei Date: Thu, 4 Sep 2025 09:58:47 +0800 Subject: [PATCH 4/4] =?UTF-8?q?=E9=97=A8=E7=A6=81=E9=97=AE=E9=A2=98?= =?UTF-8?q?=E4=BF=AE=E6=94=B9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: liuzhiwei --- api/application/AccessibilityExtensionContext.d.ts | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/api/application/AccessibilityExtensionContext.d.ts b/api/application/AccessibilityExtensionContext.d.ts index bb14268352..bdb0adab4c 100644 --- a/api/application/AccessibilityExtensionContext.d.ts +++ b/api/application/AccessibilityExtensionContext.d.ts @@ -124,7 +124,7 @@ declare class AccessibilityExtensionContext extends ExtensionContext { * @since 9 * @deprecated since 12 */ - getWindowRootElement(windowId: int, callback: AsyncCallback): void; + getWindowRootElement(windowId: number, callback: AsyncCallback): void; /** * Get window root element. @@ -140,7 +140,7 @@ declare class AccessibilityExtensionContext extends ExtensionContext { * @since 9 * @deprecated since 12 */ - getWindowRootElement(windowId?: int): Promise; + getWindowRootElement(windowId?: number): Promise; /** * Get window root element. @@ -170,7 +170,7 @@ declare class AccessibilityExtensionContext extends ExtensionContext { * @since 9 * @deprecated since 12 */ - getWindows(displayId: long, callback: AsyncCallback>): void; + getWindows(displayId: number, callback: AsyncCallback>): void; /** * Get window list. @@ -186,7 +186,7 @@ declare class AccessibilityExtensionContext extends ExtensionContext { * @since 9 * @deprecated since 12 */ - getWindows(displayId?: long): Promise>; + getWindows(displayId?: number): Promise>; /** * Get window list. -- Gitee