使用说明

在使用AccessibilityExtensionContext的功能前，需要通过AccessibilityExtensionAbility子类实例获取AccessibilityExtensionContex的实例。

import AccessibilityExtensionAbility from '@ohos.application.AccessibilityExtensionAbility';
let axContext;
class MainAbility extends AccessibilityExtensionAbility {
    onConnect(): void {
        console.log('AxExtensionAbility onConnect');
        axContext = this.context;
    }
}

FocusDirection

表示查询下一焦点元素的方向。

系统能力：以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core

FocusType

表示查询焦点元素的类型。

系统能力：以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core

Rect

表示矩形区域。

系统能力：以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core

WindowType

表示窗口的类型。

系统能力：以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core

AccessibilityExtensionContext.setTargetBundleName

setTargetBundleName(targetNames: Array<string>): Promise<void>;

设置关注的目标包名，使用Promise异步回调。

系统能力： SystemCapability.BarrierFree.Accessibility.Core

参数：

返回值：

示例：

let targetNames = ['com.ohos.xyz'];
try {
    axContext.setTargetBundleName(targetNames).then(() => {
        console.info('set target bundle names success');
    }).catch((err) => {
        console.error('failed to set target bundle names, because ' + JSON.stringify(err));
    });
} catch (exception) {
    console.error('failed to set target bundle names, because ' + JSON.stringify(exception));
};

AccessibilityExtensionContext.setTargetBundleName

setTargetBundleName(targetNames: Array<string>, callback: AsyncCallback<void>): void;

设置关注的目标包名，使用callback异步回调。

系统能力： SystemCapability.BarrierFree.Accessibility.Core

参数：

示例：

let targetNames = ['com.ohos.xyz'];
try {
    axContext.setTargetBundleName(targetNames, (err, data) => {
        if (err && err.code) {
            console.error('failed to set target bundle names, because ' + JSON.stringify(err));
            return;
        }
        console.info('set target bundle names success');
    });
} catch (exception) {
    console.error('failed to set target bundle names, because ' + JSON.stringify(exception));
};

AccessibilityExtensionContext.getFocusElement

getFocusElement(isAccessibilityFocus?: boolean): Promise<AccessibilityElement>;

获取焦点元素, 使用Promise异步回调。

系统能力： SystemCapability.BarrierFree.Accessibility.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

示例：

let focusElement;
try {
    axContext.getFocusElement().then((data) => {
        focusElement = data;
        console.log('get focus element success');
    }).catch((err) => {
        console.error('failed to get focus element, because ' + JSON.stringify(err));
    });
} catch (exception) {
    console.error('failed to get focus element, because ' + JSON.stringify(exception));
}

AccessibilityExtensionContext.getFocusElement

getFocusElement(callback: AsyncCallback<AccessibilityElement>): void;

获取焦点元素, 使用callback异步回调。

系统能力： SystemCapability.BarrierFree.Accessibility.Core

参数：

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

示例：

let focusElement;
try {
    axContext.getFocusElement((err, data) => {
        if (err && err.code) {
            console.error('failed to get focus element, because ' + JSON.stringify(err));
            return;
        }
        focusElement = data;
        console.info('get focus element success');
    });
} catch (exception) {
    console.error('failed to get focus element, because ' + JSON.stringify(exception));
}

AccessibilityExtensionContext.getFocusElement

getFocusElement(isAccessibilityFocus: boolean, callback: AsyncCallback<AccessibilityElement>): void;

获取焦点元素, 使用callback异步回调。

系统能力： SystemCapability.BarrierFree.Accessibility.Core

参数：

示例：

let focusElement;
let isAccessibilityFocus = true;
try {
    axContext.getFocusElement(isAccessibilityFocus, (err, data) => {
    if (err && err.code) {
        console.error('failed to get focus element, because ' + JSON.stringify(err));
        return;
    }
    focusElement = data;
    console.info('get focus element success');
});
} catch (exception) {
    console.error('failed to get focus element, because ' + JSON.stringify(exception));
}

AccessibilityExtensionContext.getWindowRootElement

getWindowRootElement(windowId?: number): Promise<AccessibilityElement>;

获取指定窗口的根节点元素, 使用Promise异步回调。

系统能力： SystemCapability.BarrierFree.Accessibility.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

示例：

let rootElement;
try {
    axContext.getWindowRootElement().then((data) => {
        rootElement = data;
        console.log('get root element of the window success');
    }).catch((err) => {
        console.error('failed to get root element of the window, because ' + JSON.stringify(err));
    });
} catch (exception) {
    console.error('failed to get root element of the window, ' + JSON.stringify(exception));
}

AccessibilityExtensionContext.getWindowRootElement

getWindowRootElement(callback: AsyncCallback<AccessibilityElement>): void;

获取指定窗口的根节点元素, 使用callback异步回调。

系统能力： SystemCapability.BarrierFree.Accessibility.Core

参数：

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

示例：

let rootElement;
try {
    axContext.getWindowRootElement((err, data) => {
    if (err && err.code) {
        console.error('failed to get root element of the window, because ' + JSON.stringify(err));
        return;
    }
    rootElement = data;
    console.info('get root element of the window success');
});
} catch (exception) {
    console.error('failed to get root element of the window, because ' + JSON.stringify(exception));
}

AccessibilityExtensionContext.getWindowRootElement

getWindowRootElement(windowId: number, callback: AsyncCallback<AccessibilityElement>): void;

获取指定屏幕中的所有窗口, 使用callback异步回调。

系统能力： SystemCapability.BarrierFree.Accessibility.Core

参数：

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

示例：

let rootElement;
let windowId = 10;
try {
    axContext.getWindowRootElement(windowId, (err, data) => {
    if (err && err.code) {
        console.error('failed to get root element of the window, because ' + JSON.stringify(err));
        return;
    }
    rootElement = data;
    console.info('get root element of the window success');
});
} catch (exception) {
    console.error('failed to get root element of the window, because ' + JSON.stringify(exception));
}

AccessibilityExtensionContext.getWindows

getWindows(displayId?: number): Promise<Array<AccessibilityElement>>;

获取指定屏幕中的所有窗口, 使用Promise异步回调。

系统能力： SystemCapability.BarrierFree.Accessibility.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

示例：

let windows;
try {
    axContext.getWindows().then((data) => {
        windows = data;
        console.log('get windows success');
    }).catch((err) => {
        console.error('failed to get windows, because ' + JSON.stringify(err));
    });
} catch (exception) {
    console.error('failed to get windows, because ' + JSON.stringify(exception));
}

AccessibilityExtensionContext.getWindows

getWindows(callback: AsyncCallback<Array<AccessibilityElement>>): void;

获取指定屏幕中的所有窗口, 使用callback异步回调。

系统能力： SystemCapability.BarrierFree.Accessibility.Core

参数：

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

示例：

let windows;
try {
    axContext.getWindows((err, data) => {
        if (err && err.code) {
            console.error('failed to get windows, because ' + JSON.stringify(err));
            return;
        }
        windows = data;
        console.info('get windows success');
    });
} catch (exception) {
    console.error('failed to get windows, because ' + JSON.stringify(exception));
}

AccessibilityExtensionContext.getWindows

getWindows(displayId: number, callback: AsyncCallback<Array<AccessibilityElement>>): void;

获取指定屏幕中的所有窗口, 使用callback异步回调。

系统能力： SystemCapability.BarrierFree.Accessibility.Core

参数：

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

示例：

let windows;
let displayId = 10;
try {
    axContext.getWindows(displayId, (err, data) => {
        if (err && err.code) {
            console.error('failed to get windows, because ' + JSON.stringify(err));
            return;
        }
        windows = data;
        console.info('get windows success');
    });
} catch (exception) {
    console.error('failed to get windows, because ' + JSON.stringify(exception));
}

AccessibilityExtensionContext.injectGesture

injectGesture(gesturePath: GesturePath): Promise<void>;

注入手势，使用Promise异步回调。

系统能力： SystemCapability.BarrierFree.Accessibility.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

示例：

import GesturePath from '@ohos.accessibility.GesturePath';
import GesturePoint from '@ohos.accessibility.GesturePoint';
let gesturePath = new GesturePath.GesturePath(100);
try {
    for (let i = 0; i < 10; i++) {
        let gesturePoint = new GesturePoint.GesturePoint(100, i * 200);
        gesturePath.points.push(gesturePoint);
    }
    axContext.injectGesture(gesturePath).then(() => {
        console.info('inject gesture success');
    }).catch((err) => {
        console.error('failed to inject gesture, because ' + JSON.stringify(err));
    });
} catch (exception) {
    console.error('failed to inject gesture, because ' + JSON.stringify(exception));
}

AccessibilityExtensionContext.injectGesture

injectGesture(gesturePath: GesturePath, callback: AsyncCallback<void>): void

注入手势，使用callback异步回调。

系统能力： SystemCapability.BarrierFree.Accessibility.Core

参数：

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

示例：

import GesturePath from '@ohos.accessibility.GesturePath';
import GesturePoint from '@ohos.accessibility.GesturePoint';
let gesturePath = new GesturePath.GesturePath(100);
try {
    for (let i = 0; i < 10; i++) {
        let gesturePoint = new GesturePoint.GesturePoint(100, i * 200);
        gesturePath.points.push(gesturePoint);
    }
    axContext.injectGesture(gesturePath, (err, data) => {
        if (err && err.code) {
            console.error('failed to inject gesture, because ' + JSON.stringify(err));
            return;
        }
        console.info('inject gesture success');
    });
} catch (exception) {
    console.error('failed to inject gesture, because ' + JSON.stringify(exception));
}

AccessibilityElement9+

无障碍节点元素, 在调用AccessibilityElement的方法前，需要先通过AccessibilityExtensionContext.getFocusElement()或者AccessibilityExtensionContext.getWindowRootElement()获取AccessibilityElement实例。

系统能力：以下各项对应的系统能力均为SystemCapability.BarrierFree.Accessibility.Core

attributeNames

attributeNames<T extends keyof ElementAttributeValues>(): Promise<Array<T>>;

获取节点元素的所有属性名称，使用Promise异步回调。

系统能力： SystemCapability.BarrierFree.Accessibility.Core

返回值：

示例：

let rootElement;
let attributeNames;
rootElement.attributeNames().then((data) => {
    console.log('get attribute names success');
    attributeNames = data;
}).catch((err) => {
    console.log('failed to get attribute names, because '  + JSON.stringify(err));
});

attributeNames

attributeNames<T extends keyof ElementAttributeValues>(callback: AsyncCallback<Array<T>>): void;

获取节点元素的所有属性名称，使用callback异步回调。

系统能力： SystemCapability.BarrierFree.Accessibility.Core

参数：

示例：

let rootElement;
let attributeNames;
rootElement.attributeNames((err, data) => {
    if (err) {
        console.error('failed to get attribute names, because ' + JSON.stringify(err));
        return;
    }
    attributeNames = data;
    console.info('get attribute names success');
});

AccessibilityElement.attributeValue

attributeValue<T extends keyof ElementAttributeValues>(attributeName: T): Promise<ElementAttributeValues[T]>;

根据属性名称获取属性值，使用Promise异步回调。

系统能力： SystemCapability.BarrierFree.Accessibility.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

示例：

let attributeName = 'name';
let attributeValue;
let rootElement;
try {
    rootElement.attributeValue(attributeName).then((data) => {
        console.log('get attribute value by name success');
        attributeValue = data;
    }).catch((err) => {
        console.log('failed to get attribute value, because '  + JSON.stringify(err));
    });
} catch (exception) {
    console.log('failed to get attribute value, because ' + JSON.stringify(exception));
}

AccessibilityElement.attributeValue

attributeValue<T extends keyof ElementAttributeValues>(attributeName: T,

callback: AsyncCallback<ElementAttributeValues[T]>): void;

根据属性名称获取属性值，使用callback异步回调。

系统能力： SystemCapability.BarrierFree.Accessibility.Core

参数：

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

示例：

let rootElement;
let attributeValue;
let attributeName = 'name';
try {
    rootElement.attributeValue(attributeName, (err, data) => {
        if (err) {
            console.error('failed to get attribute value, because ' + JSON.stringify(err));
            return;
        }
        attributeValue = data;
        console.info('get attribute value success');
    });
} catch (exception) {
    console.log('failed to get attribute value, because ' + JSON.stringify(exception));
}

actionNames

actionNames(): Promise<Array<string>>;

获取节点元素支持的所有操作名称，使用Promise异步回调。

系统能力： SystemCapability.BarrierFree.Accessibility.Core

返回值：

示例：

let rootElement;
let actionNames;
rootElement.actionNames().then((data) => {
    console.log('get action names success');
    actionNames = data;
}).catch((err) => {
    console.log('failed to get action names because '  + JSON.stringify(err));
});

actionNames

actionNames(callback: AsyncCallback<Array<string>>): void;

获取节点元素支持的所有操作名称，使用callback异步回调。

系统能力： SystemCapability.BarrierFree.Accessibility.Core

参数：

示例：

let rootElement;
let actionNames;
rootElement.actionNames((err, data) => {
    if (err) {
        console.error('failed to get action names, because ' + JSON.stringify(err));
        return;
    }
    actionNames = data;
    console.info('get action names success');
});

performAction

performAction(actionName: string, parameters?: object): Promise<void>;

根据操作名称执行某个操作，使用Promise异步回调。

系统能力： SystemCapability.BarrierFree.Accessibility.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

示例：

let rootElement;
try {
    rootElement.performAction('action').then((data) => {
        console.info('perform action success');
    }).catch((err) => {
        console.log('failed to perform action, because '  + JSON.stringify(err));
    });
} catch (exception) {
    console.log('failed to perform action, because ' + JSON.stringify(exception));
}

performAction

performAction(actionName: string, callback: AsyncCallback<void>): void;

根据操作名称执行某个操作，使用callback异步回调。

系统能力： SystemCapability.BarrierFree.Accessibility.Core

参数：

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

示例：

let rootElement;
try {
    rootElement.performAction('action', (err, data) => {
        if (err) {
            console.error('failed to perform action, because ' + JSON.stringify(err));
            return;
        }
        console.info('perform action success');
    });
} catch (exception) {
    console.log('failed to perform action, because ' + JSON.stringify(exception));
}

performAction

performAction(actionName: string, parameters: object, callback: AsyncCallback<void>): void;

根据操作名称执行某个操作，使用callback异步回调。

系统能力： SystemCapability.BarrierFree.Accessibility.Core

参数：

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

示例：

let rootElement;
let actionName = 'action';
let parameters = {
    'setText': 'test text'
};
try {
    rootElement.performAction(actionName, parameters, (err, data) => {
        if (err) {
            console.error('failed to perform action, because ' + JSON.stringify(err));
            return;
        }
        console.info('perform action success');
    });
} catch (exception) {
    console.log('failed to perform action, because ' + JSON.stringify(exception));
}

findElement('content')

findElement(type: 'content', condition: string): Promise<Array<AccessibilityElement>>;

根据节点内容查询所有节点元素，使用Promise异步回调。

系统能力： SystemCapability.BarrierFree.Accessibility.Core

参数：

返回值：

示例：

let rootElement;
let type = 'content';
let condition = 'keyword';
let elements;
try {
    rootElement.findElement(type, condition).then((data) => {
        elements = data;
        console.log('find element success');
    }).catch((err) => {
        console.log('failed to find element, because '  + JSON.stringify(err));
    });
} catch (exception) {
    console.log('failed to find element, because ' + JSON.stringify(exception));
}

findElement('content')

findElement(type: 'content', condition: string, callback: AsyncCallback<Array<AccessibilityElement>>): void;

根据节点内容查询所有节点元素。

系统能力： SystemCapability.BarrierFree.Accessibility.Core

参数：

示例：

let rootElement;
let type = 'content';
let condition = 'keyword';
let elements;
try {
    rootElement.findElement(type, condition, (err, data) => {
        if (err) {
            console.error('failed to find element, because ' + JSON.stringify(err));
            return;
        }
        elements = data;
        console.info('find element success');
    });
} catch (exception) {
    console.log('failed to find element, because ' + JSON.stringify(exception));
}

findElement('focusType')

findElement(type: 'focusType', condition: FocusType): Promise<AccessibilityElement>;

根据焦点元素类型查询节点元素，使用Promise异步回调。

系统能力： SystemCapability.BarrierFree.Accessibility.Core

参数：

返回值：

示例：

let rootElement;
let type = 'focusType';
let condition = 'normal';
let element;
try {
    rootElement.findElement(type, condition).then((data) => {
        element = data;
        console.log('find element success');
    }).catch((err) => {
        console.log('failed to find element, because '  + JSON.stringify(err));
    });
} catch (exception) {
    console.log('failed to find element, because ' + JSON.stringify(exception));
}

findElement('focusType')

findElement(type: 'focusType', condition: FocusType, callback: AsyncCallback<AccessibilityElement>): void;

根据焦点元素类型查询节点元素，使用callback异步回调。

系统能力： SystemCapability.BarrierFree.Accessibility.Core

参数：

示例：

let rootElement;
let type = 'focusType';
let condition = 'normal';
let element;
try {
    rootElement.findElement(type, condition, (err, data) => {
        if (err) {
            console.error('failed to find element, because ' + JSON.stringify(err));
            return;
        }
        element = data;
        console.info('find element success');
    });
} catch (exception) {
    console.log('failed to find element, because ' + JSON.stringify(exception));
}

findElement('focusDirection')

findElement(type: 'focusDirection', condition: FocusDirection): Promise<AccessibilityElement>;

根据下一焦点元素方向查询节点元素，使用Promise异步回调。

系统能力： SystemCapability.BarrierFree.Accessibility.Core

参数：

返回值：

示例：

let rootElement;
let type = 'focusDirection';
let condition = 'up';
let element;
try {
    rootElement.findElement(type, condition).then((data) => {
        element = data;
        console.log('find element success');
    }).catch((err) => {
        console.log('failed to find element, because '  + JSON.stringify(err));
    });
} catch (exception) {
    console.log('failed to find element, because ' + JSON.stringify(exception));
}

findElement('focusDirection')

findElement(type: 'focusDirection', condition: FocusDirection, callback: AsyncCallback<AccessibilityElement>): void;

根据下一焦点元素方向查询所有节点元素，使用callback异步回调。

系统能力： SystemCapability.BarrierFree.Accessibility.Core

参数：

示例：

let rootElement;
let type = 'focusDirection';
let condition = 'up';
let elements;
try {
    rootElement.findElement(type, condition, (err, data) => {
        if (err) {
            console.error('failed to find element, because ' + JSON.stringify(err));
            return;
        }
        elements = data;
        console.info('find element success');
    });
} catch (exception) {
    console.log('failed to find element, because ' + JSON.stringify(exception));
}