輔助功能

導(dǎo)入模塊

import accessibility from '@ohos.accessibility';

AbilityState

輔助應(yīng)用狀態(tài)類型。

系統(tǒng)能力：以下各項對應(yīng)的系統(tǒng)能力均為 SystemCapability.BarrierFree.Accessibility.Core

AbilityType

無障礙輔助應(yīng)用類型。

系統(tǒng)能力：以下各項對應(yīng)的系統(tǒng)能力均為 SystemCapability.BarrierFree.Accessibility.Core

AccessibilityAbilityInfo

輔助應(yīng)用信息。

系統(tǒng)能力：以下各項對應(yīng)的系統(tǒng)能力均為 SystemCapability.BarrierFree.Accessibility.Core

屬性

Action

應(yīng)用所支持的目標(biāo)動作。

系統(tǒng)能力：以下各項對應(yīng)的系統(tǒng)能力均為 SystemCapability.BarrierFree.Accessibility.Core

Capability

輔助應(yīng)用能力類型。

系統(tǒng)能力：以下各項對應(yīng)的系統(tǒng)能力均為 SystemCapability.BarrierFree.Accessibility.Core

CaptionsFontEdgeType8+

字幕字體邊緣類型。

系統(tǒng)能力：以下各項對應(yīng)的系統(tǒng)能力均為 SystemCapability.BarrierFree.Accessibility.Hearing

CaptionsFontFamily8+

字幕字體。

系統(tǒng)能力：以下各項對應(yīng)的系統(tǒng)能力均為 SystemCapability.BarrierFree.Accessibility.Hearing

CaptionsStyle8+

字幕風(fēng)格。

系統(tǒng)能力：以下各項對應(yīng)的系統(tǒng)能力均為 SystemCapability.BarrierFree.Accessibility.Hearing

CaptionsManager8+

字幕配置管理，在調(diào)用CaptionsManager的方法前，需要先通過 accessibility.getCaptionsManager()獲取 CaptionsManager實例。

系統(tǒng)能力：以下各項對應(yīng)的系統(tǒng)能力均為SystemCapability.BarrierFree.Accessibility.Hearing

屬性

on('enableChange')

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

監(jiān)聽字幕配置啟用狀態(tài)變化事件，使用callback異步回調(diào)。

參數(shù)：

示例：

let captionsManager = accessibility.getCaptionsManager();
try {
    captionsManager.on('enableChange', (data) => {
        console.info('subscribe caption manager enable state change, result: ' + JSON.stringify(data));
    });
} catch (exception) {
    console.error('failed to subscribe caption manager enable state change, because ' + JSON.stringify(exception));
}

on('styleChange')

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

監(jiān)聽字幕風(fēng)格變化事件，使用callback異步回調(diào)。

參數(shù)：

示例：

let captionStyle;
let captionsManager = accessibility.getCaptionsManager();
try {
    captionsManager.on('styleChange', (data) => {
        captionStyle = data;
        console.info('subscribe caption manager style state change, result: ' + JSON.stringify(data));
    });
} catch (exception) {
    console.error('failed to subscribe caption manager style state change, because ' + JSON.stringify(exception));
}

off('enableChange')

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

取消監(jiān)聽字幕配置啟用狀態(tài)變化事件，使用callback異步回調(diào)。

參數(shù)：

示例：

let captionsManager = accessibility.getCaptionsManager();
try {
    captionsManager.off('enableChange', (data) => {
        console.info('Unsubscribe caption manager enable state change, result: ' + JSON.stringify(data));
    });
} catch (exception) {
    console.error('failed to Unsubscribe caption manager enable state change, because ' + JSON.stringify(exception));
}

off('styleChange')

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

取消字幕風(fēng)格變化監(jiān)聽事件，使用callback異步回調(diào)。

參數(shù)：

示例：

let captionStyle;
let captionsManager = accessibility.getCaptionsManager();
try {
    captionsManager.off('styleChange', (data) => {
        captionStyle = data;
        console.info('Unsubscribe caption manager style state change, result: ' + JSON.stringify(data));
    });
} catch (exception) {
    console.error('failed to Unsubscribe caption manager style state change, because ' + JSON.stringify(exception));
}

EventInfo

界面變更事件。

系統(tǒng)能力：以下各項對應(yīng)的系統(tǒng)能力均為 SystemCapability.BarrierFree.Accessibility.Core

屬性

constructor

constructor(jsonObject)

構(gòu)造函數(shù)。

系統(tǒng)能力：SystemCapability.BarrierFree.Accessibility.Core

參數(shù)：

示例：

let eventInfo = new accessibility.EventInfo({
  'type':'click',
  'bundleName':'com.example.MyApplication',
  'triggerAction':'click'
});

EventType

無障礙事件類型。

系統(tǒng)能力：以下各項對應(yīng)的系統(tǒng)能力均為 SystemCapability.BarrierFree.Accessibility.Core

TextMoveUnit

文本無障礙導(dǎo)航移動粒度；當(dāng)前版本暫不支持。

系統(tǒng)能力：以下各項對應(yīng)的系統(tǒng)能力均為 SystemCapability.BarrierFree.Accessibility.Core

WindowUpdateType

窗口變化類型。

系統(tǒng)能力：以下各項對應(yīng)的系統(tǒng)能力均為 SystemCapability.BarrierFree.Accessibility.Core

accessibility.getAbilityLists(deprecated)

getAbilityLists(abilityType: AbilityType, stateType: AbilityState): Promise<Array<AccessibilityAbilityInfo>>

查詢輔助應(yīng)用列表，使用Promise異步回調(diào)。

系統(tǒng)能力：SystemCapability.BarrierFree.Accessibility.Core

參數(shù)：

返回值：

示例：

let abilityType = 'spoken';
let abilityState = 'enable';
let abilityList: accessibility.AccessibilityInfo[];
try {
    accessibility.getAbilityLists(abilityType, abilityState).then((data) => {
        for (let item of data) {
            console.info(item.id);
            console.info(item.name);
            console.info(item.description);
            console.info(item.bundleName);
            extensionList.push(item);
        }
        console.info('get accessibility extension list success');
    }).catch((err) => {
        console.error('failed to get accessibility extension list because ' + JSON.stringify(err));
    });
} catch (exception) {
    console.error('failed to get accessibility extension list because ' + JSON.stringify(exception));
}

accessibility.getAbilityLists(deprecated)

getAbilityLists(abilityType: AbilityType, stateType: AbilityState,callback: AsyncCallback<Array<AccessibilityAbilityInfo>>): void

查詢輔助應(yīng)用列表，使用callback異步回調(diào)。

系統(tǒng)能力：SystemCapability.BarrierFree.Accessibility.Core

參數(shù)：

示例：

let abilityType = 'spoken';
let abilityState = 'enable';
let abilityList: accessibility.AccessibilityInfo[];
try {
    accessibility.getAbilityLists(abilityType, abilityState, (err, data) => {
        if (err) {
            console.error('failed to get accessibility extension list because ' + JSON.stringify(err));
            return;
        }
        for (let item of data) {
            console.info(item.id);
            console.info(item.name);
            console.info(item.description);
            console.info(item.bundleName);
            abilityList.push(item);
        }
        console.info('get accessibility extension list success');
    }).catch((err) => {
        console.error('failed to get accessibility extension list because ' + JSON.stringify(err));
    });
} catch (exception) {
    console.error('failed to get accessibility extension list because ' + JSON.stringify(exception));
}

accessibility.getAccessibilityExtensionList9+

getAccessibilityExtensionList(abilityType: AbilityType, stateType: AbilityState): Promise<Array<AccessibilityAbilityInfo>>

查詢輔助應(yīng)用列表，使用Promise異步回調(diào)。

系統(tǒng)能力：SystemCapability.BarrierFree.Accessibility.Core

參數(shù)：

返回值：

示例：

let abilityType : accessibility.AbilityType = 'spoken';
let abilityState : accessibility.AbilityState = 'enable';
let extensionList: accessibility.AccessibilityAbilityInfo[] = [];
try {
    accessibility.getAccessibilityExtensionList(abilityType, abilityState).then((data) => {
        for (let item of data) {
            console.info(item.id);
            console.info(item.name);
            console.info(item.description);
            console.info(item.bundleName);
            extensionList.push(item);
        }
        console.info('get accessibility extension list success');
    }).catch((err) => {
        console.error('failed to get accessibility extension list because ' + JSON.stringify(err));
    });
} catch (exception) {
    console.error('failed to get accessibility extension list because ' + JSON.stringify(exception));
}

accessibility.getAccessibilityExtensionList9+

getAccessibilityExtensionList(abilityType: AbilityType, stateType: AbilityState, callback: AsyncCallback<Array<AccessibilityAbilityInfo>>): void

查詢輔助應(yīng)用列表，使用callback異步回調(diào)。

系統(tǒng)能力：SystemCapability.BarrierFree.Accessibility.Core

參數(shù)：

示例：

let abilityType : accessibility.AbilityType = 'spoken';
let abilityState : accessibility.AbilityState = 'enable';
let extensionList: accessibility.AccessibilityAbilityInfo[] = [];
try {
    accessibility.getAccessibilityExtensionList(abilityType, abilityState, (err, data) => {
        if (err) {
            console.error('failed to get accessibility extension list because ' + JSON.stringify(err));
            return;
        }
        for (let item of data) {
            console.info(item.id);
            console.info(item.name);
            console.info(item.description);
            console.info(item.bundleName);
            extensionList.push(item);
        }
        console.info('get accessibility extension list success');
    });
} catch (exception) {
    console.error('failed to get accessibility extension list because ' + JSON.stringify(exception));
}

accessibility.getCaptionsManager8+

getCaptionsManager(): CaptionsManager

獲取無障礙字幕配置管理實例；當(dāng)前版本暫不支持。

系統(tǒng)能力：SystemCapability.BarrierFree.Accessibility.Hearing

返回值：

示例：

let captionsManager = accessibility.getCaptionsManager();

accessibility.on('accessibilityStateChange')

on(type: 'accessibilityStateChange', callback: Callback<boolean>): void

監(jiān)聽輔助應(yīng)用啟用狀態(tài)變化事件，使用callback異步回調(diào)。

系統(tǒng)能力：以下各項對應(yīng)的系統(tǒng)能力有所不同，詳見下表。

參數(shù)：

示例：

try {
    accessibility.on('accessibilityStateChange', (data) => {
        console.info('subscribe accessibility state change, result: ' + JSON.stringify(data));
    });
} catch (exception) {
    console.error('failed to subscribe accessibility state change, because ' + JSON.stringify(exception));
}

accessibility.on('touchGuideStateChange')

on(type: 'touchGuideStateChange', callback: Callback<boolean>): void

監(jiān)聽觸摸瀏覽功能啟用狀態(tài)變化事件，使用callback異步回。

系統(tǒng)能力：以下各項對應(yīng)的系統(tǒng)能力有所不同，詳見下表。

參數(shù)：

示例：

try {
    accessibility.on('touchGuideStateChange', (data) => {
        console.info('subscribe touch guide state change, result: ' + JSON.stringify(data));
    });
} catch (exception) {
    console.error('failed to subscribe touch guide state change, because ' + JSON.stringify(exception));
}

accessibility.off('accessibilityStateChange')

off(type: 'accessibilityStateChange', callback?: Callback<boolean>): void

取消監(jiān)聽輔助應(yīng)用啟用狀態(tài)變化事件，使用callback異步回調(diào)。

系統(tǒng)能力：以下各項對應(yīng)的系統(tǒng)能力有所不同，詳見下表。

參數(shù)：

示例：

try {
    accessibility.off('accessibilityStateChange', (data) => {
        console.info('Unsubscribe accessibility state change, result: ' + JSON.stringify(data));
    });
} catch (exception) {
    console.error('failed to Unsubscribe accessibility state change, because ' + JSON.stringify(exception));
}

accessibility.off('touchGuideStateChange')

off(type: 'touchGuideStateChange', callback?: Callback<boolean>): void

取消監(jiān)聽觸摸瀏覽啟用狀態(tài)變化事件，使用callback異步回調(diào)。

系統(tǒng)能力：以下各項對應(yīng)的系統(tǒng)能力有所不同，詳見下表。

參數(shù)：

示例：

try {
    accessibility.off('touchGuideStateChange', (data) => {
        console.info('Unsubscribe touch guide state change, result: ' + JSON.stringify(data));
    });
} catch (exception) {
    console.error('failed to Unsubscribe touch guide state change, because ' + JSON.stringify(exception));
}

accessibility.isOpenAccessibility

isOpenAccessibility(): Promise<boolean>

判斷是否啟用了輔助功能, 使用Promise異步回調(diào)。

系統(tǒng)能力：SystemCapability.BarrierFree.Accessibility.Core

返回值：

示例：

accessibility.isOpenAccessibility().then((data) => {
    console.info('success data:isOpenAccessibility : ' + JSON.stringify(data))
}).catch((err) => {
    console.error('failed to  isOpenAccessibility because ' + JSON.stringify(err));
});

accessibility.isOpenAccessibility

isOpenAccessibility(callback: AsyncCallback<boolean>): void

判斷是否啟用了輔助功能，使用callback異步回調(diào)。

系統(tǒng)能力：SystemCapability.BarrierFree.Accessibility.Core

參數(shù)：

示例：

accessibility.isOpenAccessibility((err, data) => {
    if (err) {
        console.error('failed to isOpenAccessibility because ' + JSON.stringify(err));
        return;
    }
    console.info('success data:isOpenAccessibility : ' + JSON.stringify(data))
});

accessibility.isOpenTouchGuide

isOpenTouchGuide(): Promise<boolean>

判斷觸摸瀏覽模式是否開啟, 使用Promise異步回調(diào)。

系統(tǒng)能力：SystemCapability.BarrierFree.Accessibility.Vision

返回值：

示例：

accessibility.isOpenTouchGuide().then((data) => {
    console.info('success data:isOpenTouchGuide : ' + JSON.stringify(data))
}).catch((err) => {
    console.error('failed to  isOpenTouchGuide because ' + JSON.stringify(err));
});

accessibility.isOpenTouchGuide

isOpenTouchGuide(callback: AsyncCallback<boolean>): void

判斷觸摸瀏覽模式是否開啟, 使用callback異步回調(diào)。

系統(tǒng)能力：SystemCapability.BarrierFree.Accessibility.Vision

參數(shù)：

示例：

accessibility.isOpenTouchGuide((err, data) => {
    if (err) {
        console.error('failed to isOpenTouchGuide because ' + JSON.stringify(err));
        return;
    }
    console.info('success data:isOpenTouchGuide : ' + JSON.stringify(data))
});

accessibility.sendEvent(deprecated)

sendEvent(event: EventInfo): Promise<void>

發(fā)送無障礙事件, 使用Promise異步回調(diào)。

系統(tǒng)能力：SystemCapability.BarrierFree.Accessibility.Core

參數(shù)：

返回值：

示例：

let eventInfo = new accessibility.EventInfo({
  'type':'click',
  'bundleName':'com.example.MyApplication',
  'triggerAction':'click'
});
accessibility.sendEvent(eventInfo).then(() => {
    console.info('send event success');
}).catch((err) => {
    console.error('failed to sendEvent because ' + JSON.stringify(err));
});

accessibility.sendEvent(deprecated)

sendEvent(event: EventInfo, callback: AsyncCallback<void>): void

發(fā)送無障礙事件, 使用callback異步回調(diào)。

系統(tǒng)能力：SystemCapability.BarrierFree.Accessibility.Core

參數(shù)：

示例：

let eventInfo = new accessibility.EventInfo({
  'type':'click',
  'bundleName':'com.example.MyApplication',
  'triggerAction':'click'
});
accessibility.sendEvent(eventInfo, (err, data) => {
    if (err) {
        console.error('failed to sendEvent because ' + JSON.stringify(err));
        return;
    }
    console.info('sendEvent success');
});

accessibility.sendAccessibilityEvent9+

sendAccessibilityEvent(event: EventInfo): Promise<void>

發(fā)送無障礙事件, 使用Promise異步回調(diào)。

系統(tǒng)能力：SystemCapability.BarrierFree.Accessibility.Core

參數(shù)：

返回值：

示例：

let eventInfo = new accessibility.EventInfo({
    'type':'click',
    'bundleName':'com.example.MyApplication',
    'triggerAction':'click'
});
try {
    accessibility.sendAccessibilityEvent(eventInfo).then(() => {
        console.info('send event success');
    }).catch((err) => {
        console.error('failed to send event because ' + JSON.stringify(err));
    });
} catch (exception) {
    console.error('failed to send event because ' + JSON.stringify(exception));
}

accessibility.sendAccessibilityEvent9+

sendAccessibilityEvent(event: EventInfo, callback: AsyncCallback<void>): void

發(fā)送無障礙事件, 使用callback異步回調(diào)。

系統(tǒng)能力：SystemCapability.BarrierFree.Accessibility.Core

參數(shù)：

示例：

let eventInfo = new accessibility.EventInfo({
    'type':'click',
    'bundleName':'com.example.MyApplication',
    'triggerAction':'click'
});
try {
    accessibility.sendAccessibilityEvent(eventInfo, (err: BusinessError<void>) => {
        if (err) {
            console.error('failed to send event because ' + JSON.stringify(err));
            return;
        }
        console.info('send event success');
    });
} catch (exception) {
    console.error('failed to send event because ' + JSON.stringify(exception));
}