设置黑名单与私有扩展

好友与黑名单relationship.set_block_with_extension

PLATFORM API

选择接入平台

平台选择会在 API 页面之间保留。下面始终展示该端真实公开入口。

当前平台iOSmacOSAndroid · JavaAndroid · KotlinWindowsHarmonyOSFlutterWebElectron小程序

移动端

桌面端

Web 与小程序

跨平台

iOS · Swift · Completion公开调用入口

func setBlock(查看 iOS 接入准备 →

调用参数

• blockedUserIDString必填

  对应对象的 ID；请使用 SDK 或服务端返回的原始值。

• isActiveBool必填

  是否启用该选项。

• mutationIDString必填

  本次写操作的幂等 ID；重试时保持不变。

• applicationExtensionJSONData必填

  业务扩展 JSON 对象；空字符串表示清除。

返回与后续处理

成功结果通过 onSuccess 返回，失败信息通过 onFailure 返回。方法本身返回可取消请求。

可复制代码

request = client.setBlock(
    blockedUserID: blockedUserID,
    isActive: isActive,
    mutationID: mutationID,
    applicationExtensionJSON: applicationExtensionJSON,
    onSuccess: { value in
        // 使用返回结果更新数据或页面
    },
    onFailure: { error in
        // 按 error.stableCode 处理
    }
)

功能说明

relationship.set_block_with_extension 属于“好友与黑名单”。上方平台选择器会显示当前端的真实方法名、参数和调用示例。

• 调用前提： 除非页面特别说明，该方法要求当前账号已经连接，输入也必须属于该账号。
• 详细规则： 查看本分类的参数和状态说明。
• 跨端提醒： 各端方法名遵循各自语言习惯，请直接复制当前平台的示例。

参数与调用方式

页面顶部会列出必填/可选参数、参数用途和可复制代码。iOS/macOS 默认使用 onSuccess/onFailure，Android 默认使用 Java CompletableFuture；Web、Electron 和小程序未提供的能力会明确显示“不支持”，不会给出无效示例。

需要幂等键或版本号的方法，请使用上一次成功查询返回的值；不要自行猜测或拼接。

返回、错误与取消

结果	应用怎么处理
成功	使用返回结果刷新当前数据或页面；收到后续事件时再重新查询。
invalid_argument	检查空值、数组数量、重复 ID 和页面标注的版本参数。
invalid_state	确认当前账号已连接，并且没有在登出或换号。
unsupported	当前 SDK 或服务端版本没有此能力；提示升级，不要当成空结果。
request_cancelled	停止当前等待；写操作再查询一次结果，避免重复提交。

完整错误字段见 模型、枚举与错误。