From 4261bee449726e24379f11d0d95f4f1f05782a53 Mon Sep 17 00:00:00 2001 From: "ester.zhou" Date: Mon, 22 Aug 2022 15:13:05 +0800 Subject: [PATCH] update docs (7405) Signed-off-by: ester.zhou --- .../reference/apis/Readme-EN.md | 2 + ...js-apis-accessibility-extension-context.md | 238 ++++++++++++++++++ ...plication-AccessibilityExtensionAbility.md | 231 +++++++++++++++++ .../apis/js-apis-system-parameter.md | 4 +- 4 files changed, 473 insertions(+), 2 deletions(-) create mode 100644 en/application-dev/reference/apis/js-apis-accessibility-extension-context.md create mode 100644 en/application-dev/reference/apis/js-apis-application-AccessibilityExtensionAbility.md diff --git a/en/application-dev/reference/apis/Readme-EN.md b/en/application-dev/reference/apis/Readme-EN.md index edee55c375..1d49a12635 100644 --- a/en/application-dev/reference/apis/Readme-EN.md +++ b/en/application-dev/reference/apis/Readme-EN.md @@ -34,6 +34,8 @@ - [@ohos.ability.wantConstant](js-apis-ability-wantConstant.md) - [@ohos.application.abilityDelegatorRegistry](js-apis-abilityDelegatorRegistry.md) - [@ohos.application.abilityManager](js-apis-application-abilityManager.md) + - [@ohos.application.AccessibilityExtensionAbility](js-apis-accessibility-extension-context.md) + - [@ohos.application.AccessibilityExtensionAbility](js-apis-application-AccessibilityExtensionAbility.md) - [@ohos.application.appManager](js-apis-appmanager.md) - [@ohos.application.Configuration](js-apis-configuration.md) - [@ohos.application.ConfigurationConstant](js-apis-configurationconstant.md) diff --git a/en/application-dev/reference/apis/js-apis-accessibility-extension-context.md b/en/application-dev/reference/apis/js-apis-accessibility-extension-context.md new file mode 100644 index 0000000000..f8323a391a --- /dev/null +++ b/en/application-dev/reference/apis/js-apis-accessibility-extension-context.md @@ -0,0 +1,238 @@ +# AccessibilityExtensionContext + +The **AccessibilityExtensionContext** module, inherited from **ExtensionContext**, provides context for **Accessibility Extension** abilities. + +You can use the APIs of this module to configure the concerned information, obtain root information, and inject gestures. + +> **NOTE** +> +> The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version. +> The APIs of this module can be used only in the stage model. + +## Modules to Import + +```js +import AccessibilityExtensionAbility from '@ohos.application.AccessibilityExtensionAbility' +``` + +## FocusDirection + +Enumerates the focus directions. + +**System capability**: SystemCapability.BarrierFree.Accessibility.Core + +| Name | Description | +| -------- | ------- | +| up | Search for the next focusable item above the current item in focus.| +| down | Search for the next focusable item below the current item in focus.| +| left | Search for the next focusable item on the left of the current item in focus.| +| right | Search for the next focusable item on the right the current item in focus.| +| forward | Search for the next focusable item before the current item in focus.| +| backward | Search for the next focusable item after the current item in focus.| + +## FocusType + +Enumerates of the focus types. + +**System capability**: SystemCapability.BarrierFree.Accessibility.Core + +| Name | Description | +| ------------- | ----------- | +| accessibility | Accessibility focus.| +| normal | Normal focus. | + +## Rect + +Defines a rectangle. + +**System capability**: SystemCapability.BarrierFree.Accessibility.Core + +**Parameters** + +| Name | Type | Readable | Writable | Description | +| ------ | ------ | ---- | ---- | --------- | +| left | number | Yes | No | Left boundary of the rectangle.| +| top | number | Yes | No | Top boundary of the rectangle.| +| width | number | Yes | No | Width of the rectangle. | +| height | number | Yes | No | Height of the rectangle. | + +## WindowType + +Enumerates the window types. + +**System capability**: SystemCapability.BarrierFree.Accessibility.Core + +| Name | Description | +| ----------- | --------- | +| application | Application window.| +| system | System window.| + +## AccessibilityExtensionContext.setEventTypeFilter + +setEventTypeFilter(type: Array): Promise\; + +Sets the concerned event type. + +**System capability**: SystemCapability.BarrierFree.Accessibility.Core + +**Parameters** + +| Name | Type | Mandatory | Description | +| ---- | ---------------------------------------- | ---- | -------- | +| type | Array<[EventType](js-apis-accessibility.md#EventType)> | Yes | Event type.| + +**Return value** + +| Type | Description | +| ---------------------- | --------------------- | +| Promise<boolean> | Promise used to return the result.| + +**Example** + +```ts +this.context.setEventTypeFilter(['click', 'longClick']); +``` + +## AccessibilityExtensionContext.setTargetBundleName + +setTargetBundleName(targetNames: Array\): Promise\; + +Sets the concerned target bundle. + +**System capability**: SystemCapability.BarrierFree.Accessibility.Core + +**Parameters** + +| Name | Type | Mandatory | Description | +| ----------- | ------------------- | ---- | -------- | +| targetNames | Array<string> | Yes | Name of the target bundle.| + +**Return value** + +| Type | Description | +| ---------------------- | --------------------- | +| Promise<boolean> | Promise used to return the result.| + +**Example** + +```ts +this.context.setTargetBundleName(['com.ohos.mms']); +``` + +## AccessibilityExtensionContext.getFocusElement + +getFocusElement(isAccessibilityFocus?: boolean): Promise\; + +Obtains the focus element. + +**System capability**: SystemCapability.BarrierFree.Accessibility.Core + +**Parameters** + +| Name | Type | Mandatory | Description | +| -------------------- | ------- | ---- | ------------------- | +| isAccessibilityFocus | boolean | No | Whether the obtained focus element is an accessibility focus. The default value is false.| + +**Return value** + +| Type | Description | +| ----------------------------------- | ---------------------- | +| Promise<AccessibilityElement> | Promise used to return the current focus element.| + +**Example** + +```ts +this.context.getFocusElement().then(focusElement => { + console.log("AxExtensionAbility getFocusElement success"); +}) +``` + +## AccessibilityExtensionContext.getWindowRootElement + +getWindowRootElement(windowId?: number): Promise\; + +Obtains the root element of a window. + +**System capability**: SystemCapability.BarrierFree.Accessibility.Core + +**Parameters** + +| Name | Type | Mandatory | Description | +| -------- | ------ | ---- | --------------------------- | +| windowId | number | No | Window for which you want to obtain the root element. If this parameter is not specified, it indicates the current active window.| + +**Return value** + +| Type | Description | +| ----------------------------------- | ----------------------- | +| Promise<AccessibilityElement> | Promise used to return the root element.| + +**Example** + +```ts +this.context.getWindowRootElement().then(rootElement => { + console.log("AxExtensionAbility getWindowRootElement success"); +}) +``` + +## AccessibilityExtensionContext.getWindows + +getWindows(displayId?: number): Promise>; + +Obtains the list of windows visible to users. + +**System capability**: SystemCapability.BarrierFree.Accessibility.Core + +**Parameters** + +| Name | Type | Mandatory | Description | +| --------- | ------ | ---- | ------------------------- | +| displayId | number | No | Screen from which the window information is obtained. If this parameter is not specified, it indicates the default home screen.| + +**Return value** + +| Type | Description | +| ---------------------------------------- | ------------------------ | +| Promise<Array<AccessibilityElement>> | Promise used to return the window list. | + +**Example** + +```ts +this.context.getWindows().then(windows => { + console.log("AxExtensionAbility getWindows success"); +}) +``` + +## AccessibilityExtensionContext.gestureInject + +gestureInject(gesturePath: GesturePath, listener: Callback\): Promise\ { + console.info('gestureInject result: ' + result); +}) +``` diff --git a/en/application-dev/reference/apis/js-apis-application-AccessibilityExtensionAbility.md b/en/application-dev/reference/apis/js-apis-application-AccessibilityExtensionAbility.md new file mode 100644 index 0000000000..2b4b2d249a --- /dev/null +++ b/en/application-dev/reference/apis/js-apis-application-AccessibilityExtensionAbility.md @@ -0,0 +1,231 @@ +# Accessibility Extension Ability + +The **AccessibilityExtensionAbility** module is based on the ExtensionAbility framework and provides the **AccessibilityExtensionAbility**. + +>**NOTE** +> +>The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version. +> +>The APIs of this module can be used only in the stage model. + +## Modules to Import + +```ts +import AccessibilityExtensionAbility from '@ohos.application.AccessibilityExtensionAbility' +``` + +## AccessibilityEvent + +Defines an accessibility event. + +**System capability**: SystemCapability.BarrierFree.Accessibility.Core + +### Attributes + +| Name | Type | Readable | Writable | Description | +| --------- | ---------------------------------------- | ---- | ---- | ---------- | +| eventType | [EventType](js-apis-accessibility.md#EventType) \| [WindowUpdateType](js-apis-accessibility.md#WindowUpdateType) \| [TouchGuideType](touchguidetype) \| [GestureType](gesturetype) \| [PageUpdateType](pageupdatetype) | Yes | No | Event type. | +| target | AccessibilityElement | Yes | No | Target component where the event occurs.| +| timeStamp | number | Yes | No | Timestamp of the event. | + +## GesturePath + +Defines a gesture path. + +**System capability**: SystemCapability.BarrierFree.Accessibility.Core + +### Attributes + +| Name | Type | Readable | Writable | Description | +| ------------ | ---------------------------------------- | ---- | ---- | ------ | +| points | Array<[GesturePoint](gesturepoint)> | Yes | Yes | An array of gesture touch points. | +| durationTime | number | Yes | Yes | Total time consumed by the gesture.| + +### constructor + +constructor(durationTime: number) + +A constructor used to create a **GesturePath** object. + +**Parameters** + +| Name | Type | Mandatory | Description | +| ------------ | ------ | ---- | ------ | +| durationTime | number | Yes | Total time consumed by the gesture.| + +**Example** + +```typescript +let gesturePath = new GesturePath(100); +``` + +## GesturePoint + +Defines a gesture touch point. + +**System capability**: SystemCapability.BarrierFree.Accessibility.Core + +### Attributes + +| Name | Type | Readable | Writable | Description | +| --------- | ------ | ---- | ---- | ------- | +| positionX | number | Yes | Yes | X-coordinate of the touch point.| +| positionY | number | Yes | Yes | Y-coordinate of the touch point.| + +### constructor + +constructor(positionX: number, positionY: number) + +A constructor used to create a **GesturePoint** object. + +**Parameters** + +| Name | Type | Mandatory | Description | +| --------- | ------ | ---- | ------- | +| positionX | number | Yes | X-coordinate of the touch point.| +| positionY | number | Yes | Y-coordinate of the touch point.| + +**Example** + +```typescript +let gesturePoint = new GesturePoint(100, 200); +``` + +## GestureType + +Enumerates gesture types. + +**System capability**: SystemCapability.BarrierFree.Accessibility.Core + +| Name | Description | +| ------------- | ------------ | +| left | Left gesture. | +| leftThenRight | Left-then-right gesture.| +| leftThenUp | Left-then-up gesture.| +| leftThenDown | Left-then-down gesture.| +| right | Right gesture. | +| rightThenLeft | Right-then-left gesture.| +| rightThenUp | Right-then-up gesture.| +| rightThenDown | Right-then-down gesture.| +| up | Up gesture. | +| upThenLeft | Up-then-left gesture.| +| upThenRight | Up-then-right gesture.| +| upThenDown | Up-then-down gesture.| +| down | Down gesture. | +| downThenLeft | Down-then-left gesture.| +| downThenRight | Down-then-right gesture.| +| downThenUp | Down-then-up gesture.| + +## PageUpdateType + +Enumerates the page refresh types. + +**System capability**: SystemCapability.BarrierFree.Accessibility.Core + +| Name | Description | +| ----------------- | --------- | +| pageContentUpdate | Update of the page content.| +| pageStateUpdate | Update of the page status.| + +## TouchGuideType + +Enumerates the touch guide event types. + +**System capability**: SystemCapability.BarrierFree.Accessibility.Core + +| Name | Description | +| ---------- | ------------ | +| touchBegin | A touch starts in touch guide mode.| +| touchEnd | A touch ends in touch guide mode.| + +## AccessibilityExtensionAbility.onConnect + +onConnect(): void; + +Called when the **AccessibilityExtensionAbility** is enabled and connected to the system service. In this API, you can initialize service logic. This API can be overridden as required. + +**System capability**: SystemCapability.BarrierFree.Accessibility.Core + +**Parameters** + +None + +**Example** + +```ts +onConnect(): void { + console.log("AxExtensionAbility onConnect"); +} +``` + +## AccessibilityExtensionAbility.onDisconnect + +onDisconnect(): void; + +Called when the **AccessibilityExtensionAbility** is disabled and disconnected from the system service. In this API, you can implement the service logic of resource release and exit. This API can be overridden as required. + +**System capability**: SystemCapability.BarrierFree.Accessibility.Core + +**Parameters** + +None + +**Example** + +```ts +onDisconnect(): void { + console.log("AxExtensionAbility onDisconnect"); +} +``` + +## AccessibilityExtensionAbility.onAccessibilityEvent + +onAccessibilityEvent(event: AccessibilityEvent): void; + +Called when an event that matches the specified bundle and event type occurs. In this API, you can implement event-specific service logic. Generally, this API needs to be overridden. + +**System capability**: SystemCapability.BarrierFree.Accessibility.Core + +**Parameters** + +| Name | Type | Mandatory | Description | +| ----- | ---------------------------------------- | ---- | --------------- | +| event | [AccessibilityEvent](accessibilityevent) | Yes | Accessibility event. No value is returned.| + +**Example** + +```ts +onAccessibilityEvent(event: AccessibilityEvent): void { + console.log("AxExtensionAbility onAccessibilityEvent"); + if (event.eventType == 'click') { + console.log("AxExtensionAbility onAccessibilityEvent: click"); + } +} +``` + +## AccessibilityExtensionAbility.onKeyEvent + +onKeyEvent(keyEvent: inputEventClient.KeyEvent): boolean; + +Called when a physical key is pressed. In this API, you can determine whether to intercept the key event based on the service. + +**System capability**: SystemCapability.BarrierFree.Accessibility.Core + +**Parameters** + +| Name | Type | Mandatory | Description | +| -------- | ---------------------------------------- | ---- | ----------------------- | +| keyEvent | [KeyEvent](js-apis-inputeventclient.md#KeyEvent) | Yes | Key event. If **true** is returned, the key is intercepted.| + +**Example** + +```ts +onKeyEvent(keyEvent: inputEventClient.KeyEvent): boolean { + console.log("AxExtensionAbility onKeyEvent"); + if (keyEvent.keyCode == 22) { + console.log("AxExtensionAbility onKeyEvent: intercept 22"); + return true; + } + return false; +} +``` diff --git a/en/application-dev/reference/apis/js-apis-system-parameter.md b/en/application-dev/reference/apis/js-apis-system-parameter.md index 999c894303..cf95a96259 100644 --- a/en/application-dev/reference/apis/js-apis-system-parameter.md +++ b/en/application-dev/reference/apis/js-apis-system-parameter.md @@ -7,7 +7,7 @@ ## Modules to Import ```ts -import parameter from '@ohos.systemParameter' +import parameter from '@ohos.systemparameter' ``` @@ -216,7 +216,7 @@ Sets a value for the attribute with the specified key. This API uses a promise t | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | key | string | Yes| Key of the system attribute.| -| value| string | Yes | System attribute value to set.| +| value| string | Yes| System attribute value to set.| **Return value** -- GitLab