registerLocalUserAccount abstract method

Future<void> registerLocalUserAccount({
  1. required String appId,
  2. required String userAccount,
})

注册本地用户 User Account。

该方法为本地用户注册一个 User Account。注册成功后，该 User Account 即可标识该本地用户的身份，用户可以使用它加入频道。 该方法为可选。如果你希望用户使用 User Account 加入频道，可参考下列任意一种方式实现： 先调用 registerLocalUserAccount 方法注册 Account，再调用 joinChannelWithUserAccount 方法加入频道，可以缩短进入频道的时间。 直接调用 joinChannelWithUserAccount 方法加入频道。 请确保在该方法中设置的 userAccount 在频道中的唯一性。 为保证通信质量，请确保频道内使用同一类型的数据标识用户身份。即同一频道内需要统一使用 UID 或 User Account。如果有用户通过 Web SDK 加入频道，请确保 Web 加入的用户也是同样类型。

  • appId 你的项目在控制台注册的 App ID。
  • userAccount 用户 User Account。该参数用于标识实时音视频互动频道中的用户。你需要自行设置和管理用户的 User Account，并确保同一频道中每个用户的 User Account 是唯一的。该参数为必填，最大不超过 255 字节，不可填 null 。以下为支持的字符集范围（共 89 个字符）： 26 个小写英文字母 a-z 26 个大写英文字母 A-Z 10 个数字 0-9 空格 "!"、"#"、"$"、"%"、"&"、"("、")"、"+"、"-"、":"、";"、"<"、"="、"."、">"、"?"、"@"、""、""、"^"、"_"、"{"、"}"、"|"、"~"、","

Returns 方法成功调用时，无返回值；方法调用失败时，会抛出 AgoraRtcException 异常，你需要捕获异常并进行处理。详见错误码了解详情和解决建议。

Implementation

Future<void> registerLocalUserAccount(
    {required String appId, required String userAccount});