registerLocalUserAccount method Null safety

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

注册本地用户 User Account。

该方法为本地用户注册一个 User Account。注册成功后，该 User Account 即可标识该本地用户的身份，用户可以使用它加入频道。

成功注册 User Account 后，本地会触发 RtcEngineEventHandler.localUserRegistered 回调， 告知本地用户的 UID 和 User Account。

该方法为可选。如果你希望用户使用 User Account 加入频道，可以选用以下两种方式：

两种方式的区别在于，提前调用 RtcEngine.registerLocalUserAccount，可以缩短使用 RtcEngine.joinChannelWithUserAccount 进入频道的时间。

Note

  • userAccount 不能为空，否则该方法不生效。
  • 请确保在该方法中设置的 userAccount 在频道中的唯一性。
  • 为保证通信质量，请确保频道内使用同一类型的数据标识用户身份。即同一频道内需要统一使用 UID 或 User Account。 如果有用户通过 Agora Web SDK 加入频道，请确保 Web 加入的用户也是同样类型。

Parameter appId 你的项目在 Agora 控制台注册的 App ID。

Parameter userAccount 用户 User Account。该参数为必填，最大不超过 255 字节，不可填 null。请确保注册的 User Account 的唯一性。以下为支持的字符集范围（共 89 个字符）：

  • 26 个小写英文字母 a-z
  • 26 个大写英文字母 A-Z
  • 10 个数字 0-9
  • 空格
  • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ","

Implementation

@override
Future<void> registerLocalUserAccount(String appId, String userAccount) {
  return _invokeMethod('registerLocalUserAccount', {
    'appId': appId,
    'userAccount': userAccount,
  });
}