功能简介
读取通讯录中的好友详情列表。
使用场景
- 需要批量读取通讯录资料时。
参数说明
输入参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 获取超时时间 | 整数 | 否 | 整次调用超时时间,单位:秒,默认 300。好友较多时可适当增大;设置过短可能导致列表不完整。 |
| 是否下载头像 | 布尔值 | 否 | 是否同时下载好友头像;为是时头像路径在输出「好友列表」每项字典的「头像」键中;本指令不提供单独保存目录参数。 |
| 头像等待时间 | 整数 | 否 | 开启下载头像时,下载前等待界面加载的时间,单位:秒,默认 3;填 0 表示几乎不额外等待。 |
输出参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 好友列表 | 列表 | 是 | 好友详情列表,元素为字典;字段以当前运行结果为准。会去掉完全重复的好友项。开启下载头像时,通常含「头像」键,值为该好友头像文件的本地保存路径。 |
注意事项
- 「获取超时时间」约束的是整次调用的耗时上限,不是空闲超时;过短往往只返回部分好友。
