Appearance
sync
最后更新时间 2026-04-17
sync(options) 用于同步指定群组的基础状态与成员计数信息。
- 接口标识：
group.sync - 请求类型：
GroupSyncRequest - 当前状态：可接入
该接口适用于群组详情预加载、群信息刷新和群资料状态对齐场景。业务方可以通过该接口快速确认目标群组的同步状态与成员规模。
注意事项
- 调用前必须已完成 bootstrap 和 login。
- 该接口主要返回群组同步结果与基础状态，不代替群组完整管理能力。
- 如果目标群组不存在或当前用户无访问权限，业务方应展示清晰的不可用提示。
- 当前实现阶段为 浅实现，当前可接入状态为 可接入。
- 当前方法已纳入
release/phase0正式发布承诺。
支持说明
该接口用于四端统一的群组状态同步入口。
| 应用能力 | Android | iOS | Harmony | PC | 发布状态 |
|---|---|---|---|---|---|
| SDK Wrapper | 支持 | 支持 | 支持 | 支持 | 已纳入 release/phase0 |
发布基线：
- android: Android 8.0+ (API 26)
- ios: iOS 15+
- harmony: HarmonyOS NEXT API 12+
- pc: Host OS with supported native bridge runtime
输入
该接口接收 GroupSyncRequest 请求对象，字段定义如下。
| 名称 | 数据类型 | 是否必填 | 默认值 | 描述 |
|---|---|---|---|---|
group_id | String | 是 | - | 目标群组标识。 |
说明
请求对象由业务方传入，用于触发上层 SDK API 调用。平台 wrapper 可以按各自语言习惯封装参数对象，但字段语义必须与 GroupSyncRequest 保持一致。
输出
该接口成功后返回 GroupSyncResponse 业务结果，字段定义如下。
| 名称 | 数据类型 | 描述 |
|---|---|---|
group_id | String | 当前同步结果对应的群组标识。 |
sync_state | String | 群组同步状态；用于表示当前结果来自 baseline 还是 delta 语义。 |
member_count | usize | 同步结果中的群成员数量。 |
status | String | 接口处理状态；浅实现返回 ready。 |
状态与前置条件
- 调用前置条件：
runtime.bootstrap、auth.login - 当前 SDK 状态要求：当前用户会话有效，且目标群组可访问。
- 调用成功后状态：成功后不会改变 SDK 状态，返回当前群组同步快照。
- 建议后续调用：
conversation.getSnapshot、message.getTimeline
示例代码
平台调用示例
| 平台 | 正式入口 | 绑定方式 | 错误返回方式 |
|---|---|---|---|
| Android | com.robin.sdk.RobinSdk | kotlin-java-facade | result-error-object |
| iOS | RobinSdk | swift-facade | throws-result-enum |
| Harmony | RobinSdk | arkts-js-facade | result-code-object |
| PC | robin_sdk_bridge | native-bridge-facade | bridge-error-code |
说明
当前仓库尚未提供该方法的真实平台 facade 调用代码片段。你可以先根据以下真实入口信息接入平台 wrapper；后续如补充 docs/examples/<platform>/group-sync.*，页面会自动渲染对应平台示例。
错误码
| 错误码 | 描述 | 排查建议 |
|---|---|---|
action_not_enabled | 当前接口能力未开放，或当前发布范围不支持该调用。 | 检查接口是否已纳入当前发布范围，并确认目标平台已支持该能力。 |