assistsx-js 0.0.2023 → 0.0.2025

package/dist/AssistsXAsync.d.ts

@@ -10,81 +10,95 @@ export declare class AssistsXAsync {
      * 执行异步调用
      * @param method 方法名
      * @param args 参数对象
+     * @param timeout 超时时间(秒)，默认30秒
      * @returns Promise<调用响应>
      */
     private static asyncCall;
     /**
      * 设置悬浮窗标志
      * @param flags 标志
+     * @param timeout 超时时间(秒)，默认30秒
      * @returns 是否设置成功
      */
-    static setOverlayFlags(flags: number): Promise<boolean>;
+    static setOverlayFlags(flags: number, timeout?: number): Promise<boolean>;
     /**
      * 设置悬浮窗标志
      * @param flags 标志
+     * @param timeout 超时时间(秒)，默认30秒
      * @returns 是否设置成功
      */
-    static setOverlayFlagList(flags: number[]): Promise<boolean>;
+    static setOverlayFlagList(flags: number[], timeout?: number): Promise<boolean>;
     /**
      * 获取所有符合条件的节点
      * @param filterClass 类名过滤
      * @param filterViewId 视图ID过滤
      * @param filterDes 描述过滤
      * @param filterText 文本过滤
+     * @param timeout 超时时间(秒)，默认30秒
      * @returns 节点数组
      */
-    static getAllNodes({ filterClass, filterViewId, filterDes, filterText, }?: {
+    static getAllNodes({ filterClass, filterViewId, filterDes, filterText, timeout, }?: {
         filterClass?: string;
         filterViewId?: string;
         filterDes?: string;
         filterText?: string;
+        timeout?: number;
     }): Promise<Node[]>;
     /**
      * 设置节点文本
      * @param node 目标节点
      * @param text 要设置的文本
+     * @param timeout 超时时间(秒)，默认30秒
      * @returns 是否设置成功
      */
-    static setNodeText(node: Node, text: string): Promise<boolean>;
+    static setNodeText(node: Node, text: string, timeout?: number): Promise<boolean>;
     /**
      * 对指定节点进行截图
      * @param nodes 要截图的节点数组
      * @param overlayHiddenScreenshotDelayMillis 截图延迟时间(毫秒)
+     * @param timeout 超时时间(秒)，默认30秒
      * @returns 截图路径数组
      */
-    static takeScreenshotNodes(nodes: Node[], overlayHiddenScreenshotDelayMillis?: number): Promise<string[]>;
-    static scanQR(): Promise<string>;
-    static loadWebViewOverlay(url: string, options?: WebFloatingWindowOptions): Promise<any>;
+    static takeScreenshotNodes(nodes: Node[], overlayHiddenScreenshotDelayMillis?: number, timeout?: number): Promise<string[]>;
+    static scanQR(timeout?: number): Promise<string>;
+    static loadWebViewOverlay(url: string, options?: WebFloatingWindowOptions & {
+        timeout?: number;
+    }): Promise<any>;
     /**
      * 点击节点
      * @param node 要点击的节点
+     * @param timeout 超时时间(秒)，默认30秒
      * @returns 是否点击成功
      */
-    static click(node: Node): Promise<boolean>;
+    static click(node: Node, timeout?: number): Promise<boolean>;
     /**
      * 长按节点
      * @param node 要长按的节点
+     * @param timeout 超时时间(秒)，默认30秒
      * @returns 是否长按成功
      */
-    static longClick(node: Node): Promise<boolean>;
+    static longClick(node: Node, timeout?: number): Promise<boolean>;
     /**
      * 启动应用
      * @param packageName 应用包名
+     * @param timeout 超时时间(秒)，默认30秒
      * @returns 是否启动成功
      */
-    static launchApp(packageName: string): Promise<boolean>;
+    static launchApp(packageName: string, timeout?: number): Promise<boolean>;
     /**
      * 获取当前应用包名
+     * @param timeout 超时时间(秒)，默认30秒
      * @returns 包名
      */
-    static getPackageName(): Promise<string>;
+    static getPackageName(timeout?: number): Promise<string>;
     /**
      * 显示悬浮提示
      * @param text 提示文本
      * @param delay 显示时长(毫秒)
+     * @param timeout 超时时间(秒)，默认30秒
      * @returns 是否显示成功
      */
-    static overlayToast(text: string, delay?: number): Promise<boolean>;
+    static overlayToast(text: string, delay?: number, timeout?: number): Promise<boolean>;
     /**
      * 通过ID查找节点
      * @param id 节点ID
@@ -92,13 +106,15 @@ export declare class AssistsXAsync {
      * @param filterText 文本过滤
      * @param filterDes 描述过滤
      * @param node 父节点范围
+     * @param timeout 超时时间(秒)，默认30秒
      * @returns 节点数组
      */
-    static findById(id: string, { filterClass, filterText, filterDes, node, }?: {
+    static findById(id: string, { filterClass, filterText, filterDes, node, timeout, }?: {
         filterClass?: string;
         filterText?: string;
         filterDes?: string;
         node?: Node;
+        timeout?: number;
     }): Promise<Node[]>;
     /**
      * 通过文本查找节点
@@ -107,13 +123,15 @@ export declare class AssistsXAsync {
      * @param filterViewId 视图ID过滤
      * @param filterDes 描述过滤
      * @param node 父节点范围
+     * @param timeout 超时时间(秒)，默认30秒
      * @returns 节点数组
      */
-    static findByText(text: string, { filterClass, filterViewId, filterDes, node, }?: {
+    static findByText(text: string, { filterClass, filterViewId, filterDes, node, timeout, }?: {
         filterClass?: string;
         filterViewId?: string;
         filterDes?: string;
         node?: Node;
+        timeout?: number;
     }): Promise<Node[]>;
     /**
      * 通过标签查找节点
@@ -122,128 +140,149 @@ export declare class AssistsXAsync {
      * @param filterViewId 视图ID过滤
      * @param filterDes 描述过滤
      * @param node 父节点范围
+     * @param timeout 超时时间(秒)，默认30秒
      * @returns 节点数组
      */
-    static findByTags(className: string, { filterText, filterViewId, filterDes, node, }?: {
+    static findByTags(className: string, { filterText, filterViewId, filterDes, node, timeout, }?: {
         filterText?: string;
         filterViewId?: string;
         filterDes?: string;
         node?: Node;
+        timeout?: number;
     }): Promise<Node[]>;
     /**
      * 查找所有匹配文本的节点
      * @param text 要查找的文本
+     * @param timeout 超时时间(秒)，默认30秒
      * @returns 节点数组
      */
-    static findByTextAllMatch(text: string): Promise<Node[]>;
+    static findByTextAllMatch(text: string, timeout?: number): Promise<Node[]>;
     /**
      * 检查是否包含指定文本
      * @param text 要检查的文本
+     * @param timeout 超时时间(秒)，默认30秒
      * @returns 是否包含
      */
-    static containsText(text: string): Promise<boolean>;
+    static containsText(text: string, timeout?: number): Promise<boolean>;
     /**
      * 获取所有文本
+     * @param timeout 超时时间(秒)，默认30秒
      * @returns 文本数组
      */
-    static getAllText(): Promise<string[]>;
+    static getAllText(timeout?: number): Promise<string[]>;
     /**
      * 查找第一个匹配标签的父节点
      * @param className 类名
+     * @param timeout 超时时间(秒)，默认30秒
      * @returns 父节点
      */
-    static findFirstParentByTags(node: Node, className: string): Promise<Node>;
+    static findFirstParentByTags(node: Node, className: string, timeout?: number): Promise<Node>;
     /**
      * 获取节点的所有子节点
      * @param node 父节点
+     * @param timeout 超时时间(秒)，默认30秒
      * @returns 子节点数组
      */
-    static getNodes(node: Node): Promise<Node[]>;
+    static getNodes(node: Node, timeout?: number): Promise<Node[]>;
     /**
      * 获取节点的直接子节点
      * @param node 父节点
+     * @param timeout 超时时间(秒)，默认30秒
      * @returns 子节点数组
      */
-    static getChildren(node: Node): Promise<Node[]>;
+    static getChildren(node: Node, timeout?: number): Promise<Node[]>;
     /**
      * 查找第一个可点击的父节点
      * @param node 起始节点
+     * @param timeout 超时时间(秒)，默认30秒
      * @returns 可点击的父节点
      */
-    static findFirstParentClickable(node: Node): Promise<Node>;
+    static findFirstParentClickable(node: Node, timeout?: number): Promise<Node>;
     /**
      * 获取节点在屏幕中的边界
      * @param node 目标节点
+     * @param timeout 超时时间(秒)，默认30秒
      * @returns 边界对象
      */
-    static getBoundsInScreen(node: Node): Promise<Bounds>;
+    static getBoundsInScreen(node: Node, timeout?: number): Promise<Bounds>;
     /**
      * 检查节点是否可见
      * @param node 目标节点
      * @param compareNode 比较节点
      * @param isFullyByCompareNode 是否完全可见
+     * @param timeout 超时时间(秒)，默认30秒
      * @returns 是否可见
      */
-    static isVisible(node: Node, { compareNode, isFullyByCompareNode, }?: {
+    static isVisible(node: Node, { compareNode, isFullyByCompareNode, timeout, }?: {
         compareNode?: Node;
         isFullyByCompareNode?: boolean;
+        timeout?: number;
     }): Promise<boolean>;
     /**
      * 执行点击手势
      * @param x 横坐标
      * @param y 纵坐标
      * @param duration 持续时间
+     * @param timeout 超时时间(秒)，默认30秒
      * @returns 是否成功
      */
-    static clickByGesture(x: number, y: number, duration: number): Promise<boolean>;
+    static clickByGesture(x: number, y: number, duration: number, timeout?: number): Promise<boolean>;
     /**
      * 返回操作
+     * @param timeout 超时时间(秒)，默认30秒
      * @returns 是否成功
      */
-    static back(): Promise<boolean>;
+    static back(timeout?: number): Promise<boolean>;
     /**
      * 回到主页
+     * @param timeout 超时时间(秒)，默认30秒
      * @returns 是否成功
      */
-    static home(): Promise<boolean>;
+    static home(timeout?: number): Promise<boolean>;
     /**
      * 打开通知栏
+     * @param timeout 超时时间(秒)，默认30秒
      * @returns 是否成功
      */
-    static notifications(): Promise<boolean>;
+    static notifications(timeout?: number): Promise<boolean>;
     /**
      * 显示最近应用
+     * @param timeout 超时时间(秒)，默认30秒
      * @returns 是否成功
      */
-    static recentApps(): Promise<boolean>;
+    static recentApps(timeout?: number): Promise<boolean>;
     /**
      * 在节点中粘贴文本
      * @param node 目标节点
      * @param text 要粘贴的文本
+     * @param timeout 超时时间(秒)，默认30秒
      * @returns 是否成功
      */
-    static paste(node: Node, text: string): Promise<boolean>;
-    static focus(node: Node): Promise<boolean>;
+    static paste(node: Node, text: string, timeout?: number): Promise<boolean>;
+    static focus(node: Node, timeout?: number): Promise<boolean>;
     /**
      * 选择文本
      * @param node 目标节点
      * @param selectionStart 选择起始位置
      * @param selectionEnd 选择结束位置
+     * @param timeout 超时时间(秒)，默认30秒
      * @returns 是否成功
      */
-    static selectionText(node: Node, selectionStart: number, selectionEnd: number): Promise<boolean>;
+    static selectionText(node: Node, selectionStart: number, selectionEnd: number, timeout?: number): Promise<boolean>;
     /**
      * 向前滚动
      * @param node 可滚动节点
+     * @param timeout 超时时间(秒)，默认30秒
      * @returns 是否成功
      */
-    static scrollForward(node: Node): Promise<boolean>;
+    static scrollForward(node: Node, timeout?: number): Promise<boolean>;
     /**
      * 向后滚动
      * @param node 可滚动节点
+     * @param timeout 超时时间(秒)，默认30秒
      * @returns 是否成功
      */
-    static scrollBackward(node: Node): Promise<boolean>;
+    static scrollBackward(node: Node, timeout?: number): Promise<boolean>;
     /**
      * 对节点执行点击手势
      * @param node 目标节点
@@ -251,13 +290,15 @@ export declare class AssistsXAsync {
      * @param offsetY Y轴偏移
      * @param switchWindowIntervalDelay 窗口切换延迟
      * @param clickDuration 点击持续时间
+     * @param timeout 超时时间(秒)，默认30秒
      * @returns 是否成功
      */
-    static clickNodeByGesture(node: Node, { offsetX, offsetY, switchWindowIntervalDelay, clickDuration, }?: {
+    static clickNodeByGesture(node: Node, { offsetX, offsetY, switchWindowIntervalDelay, clickDuration, timeout, }?: {
         offsetX?: number;
         offsetY?: number;
         switchWindowIntervalDelay?: number;
         clickDuration?: number;
+        timeout?: number;
     }): Promise<boolean>;
     /**
      * 对节点执行双击手势
@@ -267,20 +308,23 @@ export declare class AssistsXAsync {
      * @param switchWindowIntervalDelay 窗口切换延迟
      * @param clickDuration 点击持续时间
      * @param clickInterval 点击间隔
+     * @param timeout 超时时间(秒)，默认30秒
      * @returns 是否成功
      */
-    static doubleClickNodeByGesture(node: Node, { offsetX, offsetY, switchWindowIntervalDelay, clickDuration, clickInterval, }?: {
+    static doubleClickNodeByGesture(node: Node, { offsetX, offsetY, switchWindowIntervalDelay, clickDuration, clickInterval, timeout, }?: {
         offsetX?: number;
         offsetY?: number;
         switchWindowIntervalDelay?: number;
         clickDuration?: number;
         clickInterval?: number;
+        timeout?: number;
     }): Promise<boolean>;
     /**
      * 执行线型手势
      * @param startPoint
      * @param endPoint
      * @param param2
+     * @param timeout 超时时间(秒)，默认30秒
      * @returns
      */
     static performLinearGesture(startPoint: {
@@ -289,37 +333,42 @@ export declare class AssistsXAsync {
     }, endPoint: {
         x: number;
         y: number;
-    }, { duration }?: {
+    }, { duration, timeout }?: {
         duration?: number;
+        timeout?: number;
     }): Promise<boolean>;
-    static longPressNodeByGestureAutoPaste(node: Node, text: string, { matchedPackageName, matchedText, timeoutMillis, longPressDuration, }?: {
+    static longPressNodeByGestureAutoPaste(node: Node, text: string, { matchedPackageName, matchedText, timeoutMillis, longPressDuration, timeout, }?: {
         matchedPackageName?: string;
         matchedText?: string;
         timeoutMillis?: number;
         longPressDuration?: number;
+        timeout?: number;
     }): Promise<boolean>;
     static longPressGestureAutoPaste(point: {
         x: number;
         y: number;
-    }, text: string, { matchedPackageName, matchedText, timeoutMillis, longPressDuration, }?: {
+    }, text: string, { matchedPackageName, matchedText, timeoutMillis, longPressDuration, timeout, }?: {
         matchedPackageName?: string;
         matchedText?: string;
         timeoutMillis?: number;
         longPressDuration?: number;
+        timeout?: number;
     }): Promise<boolean>;
-    static getAppInfo(packageName: string): Promise<any>;
-    static getUniqueDeviceId(): Promise<any>;
-    static getAndroidID(): Promise<any>;
-    static getMacAddress(): Promise<any>;
-    static getDeviceInfo(): Promise<any>;
+    static getAppInfo(packageName: string, timeout?: number): Promise<any>;
+    static getUniqueDeviceId(timeout?: number): Promise<any>;
+    static getAndroidID(timeout?: number): Promise<any>;
+    static getMacAddress(timeout?: number): Promise<any>;
+    static getDeviceInfo(timeout?: number): Promise<any>;
     /**
      * 获取屏幕尺寸
+     * @param timeout 超时时间(秒)，默认30秒
      * @returns 屏幕尺寸对象
      */
-    static getScreenSize(): Promise<any>;
+    static getScreenSize(timeout?: number): Promise<any>;
     /**
      * 获取应用窗口尺寸
+     * @param timeout 超时时间(秒)，默认30秒
      * @returns 应用窗口尺寸对象
      */
-    static getAppScreenSize(): Promise<any>;
+    static getAppScreenSize(timeout?: number): Promise<any>;
 }