@ohos.accessibility.config (System Accessibility Configuration)

The System Accessibility Configuration module allows you to configure system accessibility features, including accessibility extension, high-contrast text, mouse buttons, and captions.

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 provided by this module are system APIs.

Modules to Import

import config from '@ohos.accessibility.config';

Attributes

System capability: SystemCapability.BarrierFree.Accessibility.Core

enableAbility

enableAbility(name: string, capability: Array<accessibility.Capability>): Promise<void>;

Enables an accessibility extension ability. This API uses a promise to return the result.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Parameters

Return value

Error codes

For details about the error codes, see Accessibility Error Codes.

Example

import accessibility from '@ohos.accessibility';
import config from '@ohos.accessibility.config';

let name: string = 'com.ohos.example/axExtension';
let capability : accessibility.Capability[] = ['retrieve'];
try {
    config.enableAbility(name, capability).then(() => {
      console.info('enable ability succeed');
    }).catch((err: object) => {
      console.error('failed to enable ability, because ' + JSON.stringify(err));
    });
} catch (exception) {
    console.error('failed to enable ability, because ' + JSON.stringify(exception));
};

enableAbility

enableAbility(name: string, capability: Array<accessibility.Capability>, callback: AsyncCallback<void>): void;

Enables an accessibility extension ability. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Parameters

Error codes

For details about the error codes, see Accessibility Error Codes.

Example

import accessibility from '@ohos.accessibility';
import config from '@ohos.accessibility.config';
import { BusinessError } from '@ohos.base';

let name: string = 'com.ohos.example/axExtension';
let capability: accessibility.Capability[] = ['retrieve'];
try {
    config.enableAbility(name, capability, (err: BusinessError<void>) => {
        if (err) {
            console.error('failed to enable ability, because ' + JSON.stringify(err));
            return;
        }
        console.info('enable ability succeed');
    });
} catch (exception) {
    console.error('failed to enable ability, because ' + JSON.stringify(exception));
};

disableAbility

disableAbility(name: string): Promise<void>;

Disables an accessibility extension ability. This API uses a promise to return the result.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Parameters

Return value

Error codes

For details about the error codes, see Accessibility Error Codes.

Example

import accessibility from '@ohos.accessibility';
import config from '@ohos.accessibility.config';

let name: string = 'com.ohos.example/axExtension';
try {
    config.disableAbility(name).then(() => {
      console.info('disable ability succeed');
    }).catch((err: object) => {
      console.error('failed to disable ability, because ' + JSON.stringify(err));
    });
} catch (exception) {
    console.error('failed to disable ability, because ' + JSON.stringify(exception));
};

disableAbility

disableAbility(name: string, callback: AsyncCallback<void>): void;

Disables an accessibility extension ability. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Parameters

Error codes

For details about the error codes, see Accessibility Error Codes.

Example

import accessibility from '@ohos.accessibility';
import config from '@ohos.accessibility.config';
import { BusinessError } from '@ohos.base';

let name: string = 'com.ohos.example/axExtension';
try {
    config.disableAbility(name, (err: BusinessError<void>) => {
        if (err) {
            console.error('failed to enable ability, because ' + JSON.stringify(err));
            return;
        }
        console.info('disable succeed');
    });
} catch (exception) {
    console.error('failed to enable ability, because ' + JSON.stringify(exception));
};

on('enabledAccessibilityExtensionListChange')

on(type: 'enabledAccessibilityExtensionListChange', callback: Callback<void>): void;

Adds a listener for changes in the list of enabled accessibility extension abilities. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Parameters

Example

import config from '@ohos.accessibility.config';

try {
    config.on('enabledAccessibilityExtensionListChange', () => {
        console.info('subscribe enabled accessibility extension list change state success');
    });
} catch (exception) {
    console.error('failed to subscribe enabled accessibility extension list change state, because ' +
    JSON.stringify(exception));
};

off('enabledAccessibilityExtensionListChange')

off(type: 'enabledAccessibilityExtensionListChange', callback?: Callback<void>): void;

Cancels the listener for changes in the list of enabled accessibility extension abilities. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Parameters

Example

import config from '@ohos.accessibility.config';

try {
    config.off('enabledAccessibilityExtensionListChange', () => {
        console.info('Unsubscribe enabled accessibility extension list change state success');
    });
} catch (exception) {
    console.error('failed to Unsubscribe enabled accessibility extension list change state, because ' +
    JSON.stringify(exception));
};

Config

Implements configuration, acquisition, and listening for attributes.

set

set(value: T): Promise<void>;

Sets the attribute value. This API uses a promise to return the result.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Parameters

Return value

Example

import config from '@ohos.accessibility.config';

let value: boolean = true;
try {
    config.highContrastText.set(value).then(() => {
        console.info('set highContrastText succeed');
    }).catch((err: object) => {
        console.error('failed to set highContrastText, because ' + JSON.stringify(err));
    });
} catch (exception) {
    console.error('failed to set config, because ' + JSON.stringify(exception));
};

set

set(value: T, callback: AsyncCallback<void>): void;

Sets the attribute value. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Parameters

Example

import config from '@ohos.accessibility.config';
import { BusinessError } from '@ohos.base';

let value: boolean = true;
try {
    config.highContrastText.set(value, (err: BusinessError<void>) => {
        if (err) {
            console.error('failed to set highContrastText, because ' + JSON.stringify(err));
            return;
        }
        console.info('set highContrastText succeed');
    });
} catch (exception) {
    console.error('failed to set config, because ' + JSON.stringify(exception));
};

get

get(): Promise<T>;

Obtains the attribute value. This API uses a promise to return the result.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Return value

Example

import config from '@ohos.accessibility.config';
import { BusinessError } from '@ohos.base';

let value: boolean;
config.highContrastText.get().then((data: boolean) => {
    value = data;
    console.info('get highContrastText success');
}).catch((err: object) => {
    console.error('failed to get highContrastText, because ' + JSON.stringify(err));
});

get

get(callback: AsyncCallback<T>): void;

Obtains the attribute value. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Parameters

Example

import config from '@ohos.accessibility.config';
import { BusinessError } from '@ohos.base';

let value: boolean;
config.highContrastText.get((err: BusinessError<void>, data: boolean) => {
    if (err) {
        console.error('failed to get highContrastText, because ' + JSON.stringify(err));
        return;
    }
    value = data;
    console.info('get highContrastText success');
});

on

on(callback: Callback<T>): void;

Adds a listener for attribute changes. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Parameters

Example

import config from '@ohos.accessibility.config';

try {
    config.highContrastText.on((data: boolean) => {
        console.info('subscribe highContrastText success, result: ' + JSON.stringify(data));
    });
} catch (exception) {
    console.error('failed subscribe highContrastText, because ' + JSON.stringify(exception));
}

off

off(callback?: Callback<T>): void;

Cancels the listener for attribute changes. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Parameters

Example

import config from '@ohos.accessibility.config';

config.highContrastText.off((data: boolean) => {
    console.info('Unsubscribe highContrastText success, result: ' + JSON.stringify(data));
});

DaltonizationColorFilter

Enumerates the daltonization filters.

System capability: SystemCapability.BarrierFree.Accessibility.Core