joinChannelWithUserAccount method Null safety

Future<void> joinChannelWithUserAccount(
  1. String? token,
  2. String channelName,
  3. String userAccount,
  4. [ChannelMediaOptions? options]
)

使用 User Account 加入频道。

该方法允许本地用户使用 User Account 加入频道。成功加入频道后,会触发以下回调:

Note

为保证通信质量,请确保频道内使用同一类型的数据标识用户身份。即同一频道内需要统一使用 UID 或 User Account。 如果有用户通过 Agora Web SDK 加入频道,请确保 Web 加入的用户也是同样类型。

Parameter token 在 App 服务器端生成的用于鉴权的 Token。详见从服务端生成 Token

Parameter channelName 标识频道的频道名,最大不超过 64 字节。以下为支持的字符集范围(共 89 个字符):

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

Parameter userAccount 用户 User Account。该参数为必需,最大不超过 255 字节,不可为 null。请确保加入频道的 User Account 的唯一性。以下为支持的字符集范围(共 89 个字符):

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

Parameter options 频道媒体设置选项,详见 ChannelMediaOptions

Implementation

@override
Future<void> joinChannelWithUserAccount(
    String? token, String channelName, String userAccount,
    [ChannelMediaOptions? options]) {
  return _invokeMethod('joinChannelWithUserAccount', {
    'token': token,
    'channelName': channelName,
    'userAccount': userAccount,
    'options': options?.toJson(),
  });
}