Skip to content

Commit 20d12b4

Browse files
committed
docs(documents): 更新 AccessibilityNodeInfo 类的文档说明
- 补充了多个方法的参数和返回值说明 - 修正了部分方法的参数类型和顺序 - 增加了方法的简要描述和使用示例
1 parent 1a1e240 commit 20d12b4

File tree

1 file changed

+30
-51
lines changed

1 file changed

+30
-51
lines changed

documents.md

Lines changed: 30 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -374,40 +374,33 @@ gesture(
374374
```
375375

376376
参数:
377-
- ``:
377+
- `path`:手势路径,使用Path对象定义手势轨迹
378+
- `startTime`:指定手势的起始时间。如果设为0,表示立即开始手势
379+
- `duration`:执行手势的持续时间(毫秒)
378380

379381
返回值:
380-
- ``:
382+
- `Boolean`:手势是否执行成功
381383
---
382384

383385
#### 获取当前元素在屏幕中的范围大小
384386
`AccessibilityNodeInfo.getBoundsInScreen(): Rect`
385387

386-
参数:
387-
- ``:
388-
389388
返回值:
390-
- ``:
389+
- `Rect`:返回一个Rect对象,包含元素在屏幕中的位置和大小信息(left, top, right, bottom)
391390
---
392391

393392
#### 点击当前元素
394393
`AccessibilityNodeInfo.click(): Boolean`
395394

396-
参数:
397-
- ``:
398-
399395
返回值:
400-
- ``:
396+
- `Boolean`:点击操作是否执行成功
401397
---
402398

403399
#### 长按当前元素
404400
`AccessibilityNodeInfo.longClick(): Boolean`
405401

406-
参数:
407-
- ``:
408-
409402
返回值:
410-
- ``:
403+
- `Boolean`:长按操作是否执行成功
411404
---
412405

413406
#### 根据坐标执行手势
@@ -420,10 +413,12 @@ gestureClick(
420413
```
421414

422415
参数:
423-
- ``:
416+
- `x`:点击位置的x坐标
417+
- `y`:点击位置的y坐标
418+
- `duration`:点击持续时间(毫秒),默认为10毫秒
424419

425420
返回值:
426-
- ``:
421+
- `Boolean`:手势是否执行成功
427422
---
428423

429424
#### 在当前元素范围下执行点击手势
@@ -437,108 +432,92 @@ AccessibilityNodeInfo.nodeGestureClick(
437432
```
438433

439434
参数:
440-
- ``:
435+
- `offsetX`:点击位置相对于元素左边界的偏移量,默认为屏幕宽度的1.953%
436+
- `offsetY`:点击位置相对于元素上边界的偏移量,默认为屏幕宽度的1.953%
437+
- `switchWindowIntervalDelay`:浮窗切换显示状态的延迟时间(毫秒),默认250毫秒
438+
- `duration`:点击持续时间(毫秒),默认25毫秒
441439

442440
返回值:
443-
- ``:
441+
- `Boolean`:手势是否执行成功
444442
---
445443

446444
#### 返回
447445
`back(): Boolean`
448446

449-
参数:
450-
- ``:
451-
452447
返回值:
453-
- ``:
448+
- `Boolean`:返回操作是否执行成功
454449
---
455450

456451
#### 回到主页
457452
`home(): Boolean`
458453

459-
参数:
460-
- ``:
461-
462454
返回值:
463-
- ``:
455+
- `Boolean`:回到主页操作是否执行成功
464456
---
465457

466458
#### 显示通知栏
467459
`notifications(): Boolean`
468460

469-
参数:
470-
- ``:
471-
472461
返回值:
473-
- ``:
462+
- `Boolean`:显示通知栏操作是否执行成功
474463
---
475464

476465
#### 显示最近任务列表
477466
`recentApps(): Boolean`
478467

479-
参数:
480-
- ``:
481-
482468
返回值:
483-
- ``:
469+
- `Boolean`:显示最近任务列表操作是否执行成功
484470
---
485471

486472
#### 粘贴文本到当前元素
487473
`AccessibilityNodeInfo.paste(text: String?): Boolean`
488474

489475
参数:
490-
- ``:
476+
- `text`:要粘贴的文本内容
491477

492478
返回值:
493-
- ``:
479+
- `Boolean`:粘贴操作是否执行成功
494480
---
495481

496482
#### 选择当前元素的文本
497483
`AccessibilityNodeInfo.selectionText(selectionStart: Int, selectionEnd: Int): Boolean`
498484

499485
参数:
500-
- ``:
486+
- `selectionStart`:选择文本的起始位置
487+
- `selectionEnd`:选择文本的结束位置
501488

502489
返回值:
503-
- ``:
490+
- `Boolean`:文本选择操作是否执行成功
504491
---
505492

506493
#### 修改当前元素文本
507494
`AccessibilityNodeInfo.setNodeText(text: String?): Boolean`
508495

509496
参数:
510-
- ``:
497+
- `text`:要设置的新文本内容
511498

512499
返回值:
513-
- ``:
500+
- `Boolean`:文本修改操作是否执行成功
514501
---
515502

516503
#### 向前滚动(元素需要是可滚动的)
517504
`AccessibilityNodeInfo.scrollForward(): Boolean`
518505

519-
参数:
520-
- ``:
521-
522506
返回值:
523-
- ``:
507+
- `Boolean`:向前滚动操作是否执行成功,false可作为滚动到底部的判断依据
524508
---
525509

526510
#### 向后滚动(元素需要是可滚动的)
527511
`AccessibilityNodeInfo.scrollBackward(): Boolean`
528512

529-
参数:
530-
- ``:
531-
532513
返回值:
533-
- ``:
514+
- `Boolean`:向后滚动操作是否执行成功,false可作为滚动到顶部的判断依据
534515
---
535516

536517
#### 在控制台输出当前元素信息
537518
`AccessibilityNodeInfo.logNode(tag: String = LOG_TAG)`
538519

539520
参数:
540-
- ``:
521+
- `tag`:日志标签,默认为LOG_TAG("assists_log")
541522

542-
返回值:
543-
- ``:
544523
---

0 commit comments

Comments
 (0)