login
API (Details) to login in.login
API are as follows:Parameter | Description | Remarks |
UserID | Unique user ID | It can contain up to 32 bytes of letters (a–z and A-Z), digits (0–9), underscores (_), and hyphens (-). |
UserSig | Login ticket | It is calculated by your business server to ensure security. For more information, see Generating UserSig. |
login
API in the following scenarios:login
API returns the ERR_USER_SIG_EXPIRED (6206)
or ERR_SVR_ACCOUNT_USERSIG_EXPIRED (70001)
error code. In this case, you need to generate a new userSig
to log in again.onUserSigExpired
callback (Details) when users are online. In this case, you need to generate a new userSig
to log in again.onKickedOffline
callback (Details). In this case, you can prompt the user and call login
to log in again.login
API in the following scenarios:login
function, as the IM SDK will automatically go online.import { TencentImSDKPlugin } from "react-native-tim-js";const userID = "your user id";const userSig = "userSig from your server";const res = await TencentImSDKPlugin.v2TIMManager.login(userID, userSig);if (res.code == 0) {// Logic for successful login} else {// Logic for failed login}
getLoginUser
(Details) to get the UserID
.
If the login fails, the UserID
will be empty.import { TencentImSDKPlugin } from "react-native-tim-js";// Get the `UserID` of the logged-in userconst getLoginUserRes = await TencentImSDKPlugin.v2TIMManager.getLoginUser();if (getLoginUserRes.code == 0) {userID = getLoginUserRes.data;}
getLoginStatus
(Details) to get the login status. If a user is logged in or logging in, don't call the login API frequently. The IM SDK supports the following login statuses:Login Status | Description |
V2TIM_STATUS_LOGINED (0) | Logged in |
V2TIM_STATUS_LOGINING (1) | Logging in |
V2TIM_STATUS_LOGOUT (2) | Not logged in |
import { TencentImSDKPlugin } from "react-native-tim-js";const getLoginStatusRes =await TencentImSDKPlugin.v2TIMManager.getLoginStatus();if (getLoginStatusRes.code == 0) {const status = getLoginStatusRes.data;if (status == 0) {// Logged in} else if (status == 1) {// Logging in} else if (status == 2) {// Not logged in}}
login
API (Details) to log in, if the limit specified by the multi-client login policy for your account is exceeded, a newly logged in instance will kick out an earlier one.
The one kicked out will receive onKickedOffline
(Details).logout
API (Details) to log out of the SDK, after which you will no longer receive new messages. Note that in this case, you also need to call unInitSDK
(Details) after the logout to uninitialize the SDK.import { TencentImSDKPlugin } from "react-native-tim-js";const logoutRes = await TencentImSDKPlugin.v2TIMManager.logout();if (logoutRes.code == 0) {}
alice
to bob
, just log bob in. You don't need to explicitly call logout alice
, as this operation will be handled automatically inside the IM SDK.
Was this page helpful?