updateLoginToken method
@detail api
@author hanchenchen.c
@brief 更新用户用于登录的 Token
Token 有一定的有效期,当 Token 过期时,需调用此方法更新登录的 Token 信息。
调用 login{@link #RTCEngine#login} 方法登录时,如果使用了过期的 Token 将导致登录失败,并会收到 onLoginResult{@link #IRTCEngineEventHandler#onLoginResult} 回调通知,错误码为 LOGIN_ERROR_CODE_INVALID_TOKEN。此时需要重新获取 Token,并调用此方法更新 Token。
@param token
更新的动态密钥
@return
- 0: 调用成功。
- < 0 : 调用失败。查看 ReturnStatus{@link #ReturnStatus} 获得更多错误说明
@note
- 如果 Token 无效导致登录失败,则调用此方法更新 Token 后,SDK 会自动重新登录,而用户不需要自己调用 login{@link #RTCEngine#login} 方法。
- Token 过期时,如果已经成功登录,则不会受到影响。Token 过期的错误会在下一次使用过期 Token 登录时,或因本地网络状况不佳导致断网重新登录时通知给用户。
Implementation
Future<int?> updateLoginToken(string token) async {
$a() => ($instance as $p_a.RTCEngine).updateLoginToken(token);
$i() => ($instance as $p_i.ByteRTCEngine).updateLoginToken(token);
if (Platform.isAndroid) {
return $a();
} else if (Platform.isIOS) {
return $i();
} else {
throw UnsupportedError(
'Not Support Platform ${Platform.operatingSystem}');
}
}