輔助功能

說(shuō)明： 本模塊首批接口從 API version 7 開始支持。后續(xù)版本的新增接口，采用上角標(biāo)單獨(dú)標(biāo)記接口的起始版本。 開發(fā)前請(qǐng)熟悉鴻蒙開發(fā)指導(dǎo)文檔 ：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]點(diǎn)擊或者復(fù)制轉(zhuǎn)到。

導(dǎo)入模塊

import accessibility from '@ohos.accessibility';

AbilityState

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

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

AbilityType

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

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

AccessibilityAbilityInfo

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

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

屬性

Action

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

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

Capability

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

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

aptionsFontEdgeType8+

字幕字體邊緣類型。

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

CaptionsFontFamily8+

字幕字體。

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

CaptionsStyle8+

字幕風(fēng)格。

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

CaptionsManager8+

字幕配置。

屬性

方法

下列 API 示例中都需要使用 [accessibility.getCaptionsManager()]獲取 captionsManager 實(shí)例，再通過(guò)此實(shí)例調(diào)用對(duì)應(yīng)的方法。

on('enableChange')

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

注冊(cè)字幕配置啟用的監(jiān)聽函數(shù)。

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

• 參數(shù)：

  參數(shù)名	參數(shù)類型	必填	說(shuō)明
  type	string	是	監(jiān)聽字幕配置啟用狀態(tài)。
  callback	Callback	是	回調(diào)函數(shù)，在啟用狀態(tài)變化時(shí)將狀態(tài)通過(guò)此函數(shù)進(jìn)行通知。

• 示例

  captionsManager.on('enableChange',(data) = > {
      console.info('success data:subscribeStateObserver : ' + JSON.stringify(data))
  })
  

on('styleChange')

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

注冊(cè)字幕風(fēng)格變化的監(jiān)聽函數(shù)。

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

• 參數(shù)：

  參數(shù)名	參數(shù)類型	必填	說(shuō)明
  type	string	是	監(jiān)聽字幕風(fēng)格變化。
  callback	Callback<[CaptionsStyle]>	是	回調(diào)函數(shù)，在字幕風(fēng)格變化時(shí)通過(guò)此函數(shù)進(jìn)行通知。

• 示例

  captionsManager.on('styleChange',(data) = > {
      console.info('success data:subscribeStateObserver : ' + JSON.stringify(data))
  })
  

off('enableChange')

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

移除字幕配置啟用的監(jiān)聽函數(shù)。

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

• 參數(shù)：

  參數(shù)名	參數(shù)類型	必填	說(shuō)明
  type	string	是	監(jiān)聽字幕配置啟用狀態(tài)。
  callback	Callback	否	回調(diào)函數(shù)，在啟用狀態(tài)變化時(shí)將狀態(tài)通過(guò)此函數(shù)進(jìn)行通知。

• 示例

  captionsManager.off('enableChange')
  

off('styleChange')

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

移除字幕風(fēng)格變化的監(jiān)聽函數(shù)。

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

• 參數(shù)：

  參數(shù)名	參數(shù)類型	必填	說(shuō)明
  type	string	是	字幕風(fēng)格變化。
  callback	Callback<[CaptionsStyle]>	否	回調(diào)函數(shù)，在字幕風(fēng)格變化時(shí)通過(guò)此函數(shù)進(jìn)行通知。

• 示例

  captionsManager.off('styleChange')
  

EventInfo

界面變更事件。

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

屬性

方法

constructor

constructor(jsonObject)

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

• 參數(shù)：

  參數(shù)名	參數(shù)類型	必填	說(shuō)明
  jsonObject	string	是	創(chuàng)建對(duì)象所需要的 JSON 格式字符串。

• 示例

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

EventType

無(wú)障礙事件類型。

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

TextMoveUnit

文本無(wú)障礙導(dǎo)航移動(dòng)粒度。

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

WindowUpdateType

窗口變化類型。

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

accessibility.getAbilityLists

getAbilityLists(abilityType: AbilityType, stateType: AbilityState): Promise>

查詢輔助應(yīng)用列表。

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

• 參數(shù)：

  參數(shù)名	參數(shù)類型	必填	說(shuō)明
  abilityType	[AbilityType]	是	輔助應(yīng)用的類型。
  stateType	[AbilityState]	是	輔助應(yīng)用的狀態(tài)。

• 返回值：

  類型	說(shuō)明
  Promise>	返回輔助應(yīng)用信息列表。

• 示例

  accessibility.getAbilityLists("spoken", "enable")
      .then((data) = > {
          console.info('success data:getAbilityList1 : ' + JSON.stringify(data));
          for (let item of data) {
              console.info(item.id);
              console.info(item.name);
              console.info(item.description);
              console.info(item.abilityTypes);
              console.info(item.eventTypes);
              console.info(item.capabilities);
              console.info(item.packageName);
              console.info(item.filterBundleNames);
              console.info(item.bundleName);
          }
      }).catch((error) = > {
          console.error('failed to  getAbilityList1 because ' + JSON.stringify(error));
      })
  

accessibility.getAbilityLists

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

查詢輔助應(yīng)用列表。

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

• 參數(shù)：

  參數(shù)名	參數(shù)類型	必填	說(shuō)明
  abilityType	[AbilityType]	是	輔助應(yīng)用的類型。
  stateType	[AbilityState]	是	輔助應(yīng)用的狀態(tài)。
  callback	AsyncCallback>	是	回調(diào)函數(shù)，返回輔助應(yīng)用信息列表。

• 示例

  accessibility.getAbilityLists("visual", "enable", (err, data) = > {
      if (err) {
          console.error('failed to getAbilityList2 because ' + JSON.stringify(err));
          return;
      }
      console.info('success data:getAbilityList2 : ' + JSON.stringify(data));
      for (let item of data) {
          console.info(item.id);
          console.info(item.name);
          console.info(item.description);
          console.info(item.abilityTypes);
          console.info(item.eventTypes);
          console.info(item.capabilities);
          console.info(item.packageName);
          console.info(item.filterBundleNames);
          console.info(item.bundleName);
      }
  })
  

accessibility.getCaptionsManager8+

getCaptionsManager(): CaptionsManager

獲取無(wú)障礙字幕配置。

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

• 返回值：

  類型	說(shuō)明
  [CaptionsManager]	無(wú)障礙字幕配置管理。

• 示例

  captionsManager = accessibility.getCaptionsManager()
  

accessibility.on('accessibilityStateChange' | 'touchGuideStateChange')

on(type: 'accessibilityStateChange' | 'touchGuideStateChange', callback: Callback): void

啟用輔助應(yīng)用和觸摸瀏覽功能的狀態(tài)變化監(jiān)聽。

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

• 參數(shù)：

  參數(shù)名	參數(shù)類型	必填	說(shuō)明
  type	string	是	監(jiān)聽的事件類型。 - type 為'accessibilityStateChange'時(shí)表示監(jiān)聽類型為輔助功能啟用狀態(tài)變化監(jiān)聽； 系統(tǒng)能力 ：SystemCapability.Barrierfree.Accessibility.Core - type 為'touchGuideStateChange'時(shí)表示監(jiān)聽類型為觸摸瀏覽啟用狀態(tài)變化監(jiān)聽。 系統(tǒng)能力 ：SystemCapability.Barrierfree.Accessibility.Vision
  callback	Callback	是	回調(diào)函數(shù)，在啟用狀態(tài)變化時(shí)將狀態(tài)通過(guò)此函數(shù)進(jìn)行通知。

• 示例

  accessibility.on('accessibilityStateChange',(data) = > { 
      console.info('success data:subscribeStateObserver : ' + JSON.stringify(data))
  })
  

accessibility.off('accessibilityStateChange' | 'touchGuideStateChange')

off(type: ‘a(chǎn)ccessibilityStateChange ’ | ‘touchGuideStateChange’, callback?: Callback): void

關(guān)閉輔助應(yīng)用和觸摸瀏覽功能的狀態(tài)變化監(jiān)聽。

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

• 參數(shù)：

  參數(shù)名	參數(shù)類型	必填	說(shuō)明
  type	string	否	監(jiān)聽的事件類型。 - type 為'accessibilityStateChange'時(shí)表示監(jiān)聽類型為輔助功能啟用狀態(tài)變化監(jiān)聽； 系統(tǒng)能力 ：SystemCapability.Barrierfree.Accessibility.Core - type 為'touchGuideStateChange'時(shí)表示監(jiān)聽類型為觸摸瀏覽啟用狀態(tài)變化監(jiān)聽。 系統(tǒng)能力 ：SystemCapability.Barrierfree.Accessibility.Vision
  callback	Callback	否	要取消的監(jiān)聽回調(diào)函數(shù)。

• 示例

  accessibility.off('accessibilityStateChange',(data) = > {
      console.info('success data:unSubscribeStateObserver : ' + JSON.stringify(data))
  })
  

accessibility.isOpenAccessibility

isOpenAccessibility(): Promise

判斷是否啟用了輔助功能。

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

• 返回值：

  類型	說(shuō)明
  Promise	如果輔助功能已啟用，則返回 true；否則返回 false。

• 示例

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

accessibility.isOpenAccessibility

isOpenAccessibility(callback: AsyncCallback): void

判斷是否啟用了輔助功能。

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

• 參數(shù)

  參數(shù)名	參數(shù)類型	必填	說(shuō)明
  callback	AsyncCallback	是	回調(diào)函數(shù)，如果輔助功能已啟用，則返回 true；否則返回 false。

• 示例

  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

判斷觸摸瀏覽模式是否開啟。

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

• 返回值：

  類型	說(shuō)明
  Promise	如果觸摸瀏覽模式已開啟，則返回 true；否則返回 false。

• 示例

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

accessibility.isOpenTouchGuide

isOpenTouchGuide(callback: AsyncCallback): void

判斷觸摸瀏覽模式是否開啟。

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

• 參數(shù)

  參數(shù)名	參數(shù)類型	必填	說(shuō)明
  callback	AsyncCallback	是	回調(diào)函數(shù)，如果觸摸瀏覽模式已開啟，則返回 true；否則返回 false。

• 示例

  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

sendEvent(event: EventInfo): Promise

發(fā)送無(wú)障礙事件。

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

• 參數(shù)：

  參數(shù)名	參數(shù)類型	必填	說(shuō)明
  event	[EventInfo]	是	無(wú)障礙事件對(duì)象。

• 返回值：

  類型	說(shuō)明
  Promise	以 Promise 形式返回結(jié)果，如果發(fā)送無(wú)障礙事件成功，則 data 有數(shù)據(jù)返回；如果發(fā)送無(wú)障礙事件失敗，則 err 有數(shù)據(jù)返回。

• 示例

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

accessibility.sendEvent

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

發(fā)送無(wú)障礙事件。

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

• 參數(shù)：

  參數(shù)名	參數(shù)類型	必填	說(shuō)明
  event	[EventInfo]	是	輔助事件對(duì)象。
  callback	AsyncCallback	是	回調(diào)函數(shù)，如果發(fā)送無(wú)障礙事件成功，則 AsyncCallback 中 data 有數(shù)據(jù)返回；如果發(fā)送無(wú)障礙事件失敗，則 AsyncCallback 中 err 有數(shù)據(jù)返回。HarmonyOS與OpenHarmony鴻蒙文檔籽料：mau123789是v直接拿

  

• 示例

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