mirror of
https://gitee.com/openharmony/interface_sdk-js
synced 2024-11-23 07:10:52 +00:00
493 lines
18 KiB
TypeScript
493 lines
18 KiB
TypeScript
/*
|
|
* Copyright (c) 2022 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
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
/**
|
|
* @file
|
|
* @kit AccessibilityKit
|
|
*/
|
|
|
|
import type accessibility from './@ohos.accessibility';
|
|
import type { AsyncCallback, Callback } from './@ohos.base';
|
|
|
|
/**
|
|
* Configuration of the accessibility.
|
|
*
|
|
* @namespace config
|
|
* @syscap SystemCapability.BarrierFree.Accessibility.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
declare namespace config {
|
|
/**
|
|
* Indicates the configuration of daltonization state.
|
|
*
|
|
* @syscap SystemCapability.BarrierFree.Accessibility.Core
|
|
* @systemapi
|
|
* @since 11
|
|
*/
|
|
const daltonizationState: Config<boolean>;
|
|
/**
|
|
* Indicates the configuration of audio mono.
|
|
*
|
|
* @syscap SystemCapability.BarrierFree.Accessibility.Core
|
|
* @systemapi
|
|
* @since 10
|
|
*/
|
|
const audioMono: Config<boolean>;
|
|
/**
|
|
* Indicates the configuration of audio balance.
|
|
*
|
|
* @syscap SystemCapability.BarrierFree.Accessibility.Core
|
|
* @systemapi
|
|
* @since 10
|
|
*/
|
|
const audioBalance: Config<number>;
|
|
/**
|
|
* Indicates the configuration of high-contrast text.
|
|
*
|
|
* @syscap SystemCapability.BarrierFree.Accessibility.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
var highContrastText: Config<boolean>;
|
|
/**
|
|
* Indicates the configuration of invert color.
|
|
*
|
|
* @syscap SystemCapability.BarrierFree.Accessibility.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
var invertColor: Config<boolean>;
|
|
/**
|
|
* Indicates the configuration of daltonization color filter.
|
|
*
|
|
* @syscap SystemCapability.BarrierFree.Accessibility.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
var daltonizationColorFilter: Config<DaltonizationColorFilter>;
|
|
/**
|
|
* Indicates the configuration of content timeout.
|
|
*
|
|
* @syscap SystemCapability.BarrierFree.Accessibility.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
var contentTimeout: Config<number>;
|
|
/**
|
|
* Indicates the configuration of animation state.
|
|
*
|
|
* @syscap SystemCapability.BarrierFree.Accessibility.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
var animationOff: Config<boolean>;
|
|
/**
|
|
* Indicates the configuration of brightness discount.
|
|
*
|
|
* @syscap SystemCapability.BarrierFree.Accessibility.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
var brightnessDiscount: Config<number>;
|
|
/**
|
|
* Indicates the configuration of mouse key state.
|
|
*
|
|
* @syscap SystemCapability.BarrierFree.Accessibility.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
var mouseKey: Config<boolean>;
|
|
/**
|
|
* Indicates the configuration of mouse auto click.
|
|
*
|
|
* @syscap SystemCapability.BarrierFree.Accessibility.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
var mouseAutoClick: Config<number>;
|
|
/**
|
|
* Indicates the configuration of short key state.
|
|
*
|
|
* @syscap SystemCapability.BarrierFree.Accessibility.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
var shortkey: Config<boolean>;
|
|
/**
|
|
* Indicates the configuration of short key target.
|
|
*
|
|
* @syscap SystemCapability.BarrierFree.Accessibility.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
var shortkeyTarget: Config<string>;
|
|
/**
|
|
* Indicates the configuration of short key multi targets.
|
|
*
|
|
* @syscap SystemCapability.BarrierFree.Accessibility.Core
|
|
* @systemapi
|
|
* @since 11
|
|
*/
|
|
const shortkeyMultiTargets: Config<Array<string>>;
|
|
/**
|
|
* Indicates the configuration of captions state.
|
|
*
|
|
* @syscap SystemCapability.BarrierFree.Accessibility.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
var captions: Config<boolean>;
|
|
/**
|
|
* Indicates the configuration of captions style.
|
|
*
|
|
* @syscap SystemCapability.BarrierFree.Accessibility.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
var captionsStyle: Config<accessibility.CaptionsStyle>;
|
|
/**
|
|
* Indicates the configuration of click response time.
|
|
*
|
|
* @syscap SystemCapability.BarrierFree.Accessibility.Core
|
|
* @systemapi
|
|
* @since 11
|
|
*/
|
|
const clickResponseTime: Config<ClickResponseTime>;
|
|
/**
|
|
* Indicates the configuration of ignore repeat click.
|
|
*
|
|
* @syscap SystemCapability.BarrierFree.Accessibility.Core
|
|
* @systemapi
|
|
* @since 11
|
|
*/
|
|
const ignoreRepeatClick: Config<boolean>;
|
|
/**
|
|
* Indicates the configuration of ignore repeat click interval.
|
|
*
|
|
* @syscap SystemCapability.BarrierFree.Accessibility.Core
|
|
* @systemapi
|
|
* @since 11
|
|
*/
|
|
const repeatClickInterval: Config<RepeatClickInterval>;
|
|
/**
|
|
* Indicates the configuration of screen magnification.
|
|
*
|
|
* @syscap SystemCapability.BarrierFree.Accessibility.Core
|
|
* @systemapi
|
|
* @since 12
|
|
*/
|
|
const screenMagnification: Config<boolean>;
|
|
|
|
/**
|
|
* 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<accessibility.Capability> } capability Indicates the ability.
|
|
* @returns { Promise<void> }
|
|
* @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:
|
|
* 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types;
|
|
* 3. Parameter verification failed.
|
|
* @throws { BusinessError } 9300001 - Invalid bundle name or ability name.
|
|
* @throws { BusinessError } 9300002 - Target ability already enabled.
|
|
* @syscap SystemCapability.BarrierFree.Accessibility.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function enableAbility(name: string, capability: Array<accessibility.Capability>): Promise<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<accessibility.Capability> } capability Indicates the ability.
|
|
* @param { AsyncCallback<void> } 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.
|
|
* @throws { BusinessError } 401 - Input parameter error. Possible causes:
|
|
* 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types;
|
|
* 3. Parameter verification failed.
|
|
* @throws { BusinessError } 9300001 - Invalid bundle name or ability name.
|
|
* @throws { BusinessError } 9300002 - Target ability already enabled.
|
|
* @syscap SystemCapability.BarrierFree.Accessibility.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function enableAbility(
|
|
name: string,
|
|
capability: Array<accessibility.Capability>,
|
|
callback: AsyncCallback<void>
|
|
): void;
|
|
|
|
/**
|
|
* 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<void> }
|
|
* @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:
|
|
* 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types;
|
|
* 3. Parameter verification failed.
|
|
* @throws { BusinessError } 9300001 - Invalid bundle name or ability name.
|
|
* @syscap SystemCapability.BarrierFree.Accessibility.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function disableAbility(name: string): Promise<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<void> } 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.
|
|
* @throws { BusinessError } 401 - Input parameter error. Possible causes:
|
|
* 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types;
|
|
* 3. Parameter verification failed.
|
|
* @throws { BusinessError } 9300001 - Invalid bundle name or ability name.
|
|
* @syscap SystemCapability.BarrierFree.Accessibility.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function disableAbility(name: string, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* Register the listener that watches for changes in the enabled status of accessibility extensions.
|
|
*
|
|
* @permission ohos.permission.READ_ACCESSIBILITY_CONFIG
|
|
* @param { 'enabledAccessibilityExtensionListChange' } type Indicates the type of event.
|
|
* @param { Callback<void> } callback Indicates the listener.
|
|
* @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:
|
|
* 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types;
|
|
* 3. Parameter verification failed.
|
|
* @syscap SystemCapability.BarrierFree.Accessibility.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function on(type: 'enabledAccessibilityExtensionListChange', callback: Callback<void>): void;
|
|
|
|
/**
|
|
* Register the listener that watches for changes in the installed status of accessibility extensions.
|
|
*
|
|
* @permission ohos.permission.READ_ACCESSIBILITY_CONFIG
|
|
* @param { 'installedAccessibilityListChange' } type Indicates the type of event.
|
|
* @param { Callback<void> } callback Indicates the listener.
|
|
* @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:
|
|
* 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types;
|
|
* 3. Parameter verification failed.
|
|
* @syscap SystemCapability.BarrierFree.Accessibility.Core
|
|
* @systemapi
|
|
* @since 12
|
|
*/
|
|
function on(type: 'installedAccessibilityListChange', callback: Callback<void>): void;
|
|
|
|
/**
|
|
* Unregister listener that watches for changes in the enabled status of accessibility extensions.
|
|
*
|
|
* @permission ohos.permission.READ_ACCESSIBILITY_CONFIG
|
|
* @param { 'enabledAccessibilityExtensionListChange' } type Indicates the type of event.
|
|
* @param { Callback<void> } callback Indicates the listener.
|
|
* @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:
|
|
* 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types;
|
|
* 3. Parameter verification failed.
|
|
* @syscap SystemCapability.BarrierFree.Accessibility.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
function off(type: 'enabledAccessibilityExtensionListChange', callback?: Callback<void>): void;
|
|
|
|
/**
|
|
* Unregister listener that watches for changes in the installed status of accessibility extensions.
|
|
*
|
|
* @permission ohos.permission.READ_ACCESSIBILITY_CONFIG
|
|
* @param { 'installedAccessibilityListChange' } type Indicates the type of event.
|
|
* @param { Callback<void> } callback Indicates the listener.
|
|
* @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:
|
|
* 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types;
|
|
* 3. Parameter verification failed.
|
|
* @syscap SystemCapability.BarrierFree.Accessibility.Core
|
|
* @systemapi
|
|
* @since 12
|
|
*/
|
|
function off(type: 'installedAccessibilityListChange', callback?: Callback<void>): void;
|
|
|
|
/**
|
|
* Indicates setting, getting, and listening to changes in configuration.
|
|
*
|
|
* @typedef Config<T>
|
|
* @syscap SystemCapability.BarrierFree.Accessibility.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
interface Config<T> {
|
|
/**
|
|
* Setting configuration value.
|
|
*
|
|
* @permission ohos.permission.WRITE_ACCESSIBILITY_CONFIG
|
|
* @param { T } value Indicates the value.
|
|
* @returns { Promise<void> }
|
|
* @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:
|
|
* 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types;
|
|
* 3. Parameter verification failed.
|
|
* @syscap SystemCapability.BarrierFree.Accessibility.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
set(value: T): Promise<void>;
|
|
|
|
/**
|
|
* Setting configuration value.
|
|
*
|
|
* @permission ohos.permission.WRITE_ACCESSIBILITY_CONFIG
|
|
* @param { T } value Indicates the value.
|
|
* @param { AsyncCallback<void> } 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.
|
|
* @throws { BusinessError } 401 - Input parameter error. Possible causes:
|
|
* 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types;
|
|
* 3. Parameter verification failed.
|
|
* @syscap SystemCapability.BarrierFree.Accessibility.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
set(value: T, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* Getting configuration value.
|
|
*
|
|
* @returns { Promise<T> }
|
|
* @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 9
|
|
*/
|
|
get(): Promise<T>;
|
|
|
|
/**
|
|
* Getting configuration value.
|
|
*
|
|
* @param { AsyncCallback<T> } callback
|
|
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
|
|
* @syscap SystemCapability.BarrierFree.Accessibility.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
get(callback: AsyncCallback<T>): void;
|
|
|
|
/**
|
|
* Register the listener to listen for configuration changes.
|
|
*
|
|
* @permission ohos.permission.READ_ACCESSIBILITY_CONFIG
|
|
* @param { Callback<T> } callback Indicates the listener.
|
|
* @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:
|
|
* 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types;
|
|
* 3. Parameter verification failed.
|
|
* @syscap SystemCapability.BarrierFree.Accessibility.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
on(callback: Callback<T>): void;
|
|
|
|
/**
|
|
* Unregister the listener to listen for configuration changes.
|
|
*
|
|
* @permission ohos.permission.READ_ACCESSIBILITY_CONFIG
|
|
* @param { Callback<T> } callback Indicates the listener.
|
|
* @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 9
|
|
*/
|
|
off(callback?: Callback<T>): void;
|
|
}
|
|
|
|
/**
|
|
* Indicates the type of daltonization color filter.
|
|
*
|
|
* @typedef {'Normal' | 'Protanomaly' | 'Deuteranomaly' | 'Tritanomaly'}
|
|
* @syscap SystemCapability.BarrierFree.Accessibility.Core
|
|
* @systemapi
|
|
* @since 9
|
|
*/
|
|
type DaltonizationColorFilter = 'Normal' | 'Protanomaly' | 'Deuteranomaly' | 'Tritanomaly';
|
|
|
|
/**
|
|
* Indicates the type of click response time.
|
|
*
|
|
* @typedef {'Short' | 'Medium' | 'Long'}
|
|
* @syscap SystemCapability.BarrierFree.Accessibility.Core
|
|
* @systemapi
|
|
* @since 11
|
|
*/
|
|
type ClickResponseTime = 'Short' | 'Medium' | 'Long';
|
|
|
|
/**
|
|
* Indicates the type of ignore repeat click interval.
|
|
*
|
|
* @typedef {'Shortest' | 'Short' | 'Medium' | 'Long' | 'Longest'}
|
|
* @syscap SystemCapability.BarrierFree.Accessibility.Core
|
|
* @systemapi
|
|
* @since 11
|
|
*/
|
|
type RepeatClickInterval = 'Shortest' | 'Short' | 'Medium' | 'Long' | 'Longest';
|
|
}
|
|
export default config;
|