このページは現在英語版のみで提供されており、日本語版も近日中に提供される予定です。ご利用いただきありがとうございます。
Log-in

Preparing SDKAppID
The SDKAppID is a unique identifier used to distinguish customer accounts. We recommend that each independent app apply for a new SDKAppID. Messages between different SDKAppIDs are naturally isolated and cannot interconnect. You must have the correct SDKAppID to perform initialization. You can view all SDKAppIDs in the Console, click the Create Application button to create a new SDKAppID.
﻿
﻿
﻿
Feature Description
You need to call the SDK login API to authenticate account identity and have permissions to use features. Upon success, you can enter a room and perform a series of operations.
Login
For first log in to account, you do not need to register first. Just log in directly. During log-in, if the SDK detects an unregistered account, it will automatically register. You can call the login(iOS & Mac / Android / Web) API to log in.
Key parameters of the login interface are as follows:
Parameter
Meaning
Description
UserID
Unique user ID for login
Use only letters (a-z, A-Z), digits (0-9), underscores (_), and hyphens (-). Length not exceeding 32 bytes.
UserSig
login ticket
The business server calculates to ensure security. For the calculation method, see user authentication.
You need to call the login interface in the following scenarios:
Use SDK features for the first time after App launch.
Kicked offline while connected: If a user is kicked while online, the SDK will notify you via the onKickedOffline callback. At this point, you can prompt the user via UI and call login to log in again.
No need to call the login interface in the following scenarios:
After the user's network disconnection and reconnection, there is no need to call the login function. The SDK will automatically go online.
When a login process is in progress, no need to perform duplicate login.
Note:
1. After successfully calling the SDK API to log in, MAU calculation will start. Based on business scenario, call the login API appropriately to avoid extremely high MAU.
2. In an App, the SDK does not support multiple accounts being online simultaneously. If multiple accounts are logged in at the same time, only the last logged-in account remains online.
Below is an example code:
Swift
Java
Web
let sdkAppId = 1400000000 // Set up your own SDK app ID 
let userId = "your user id"
let userSig = "userSig from your server"
﻿
TUIRoomEngine.login(sdkAppId: sdkAppId, userId: userId, userSig: userSig) {
    print("success") 
} onError: { code, message in
    // If the following error codes are returned, it means that an expired UserSig is in use. You need to generate a new one for login again.
    // 1. ERR_USER_SIG_EXPIRED(6206)
    // 2. ERR_SVR_ACCOUNT_USERSIG_EXPIRED(70001)
    // Note: For other error codes, do not call the log-in API here to avoid the SDK entering an infinite loop.
    print("failure, code:\(code), message:\(message)")
}
Context context = getApplicationContext();
int sdkAppId = 1400000000; // Set up your own sdkAppId
String userId = "your user id";
String userSig = "userSig from your server";
﻿
TUIRoomEngine.login(context, sdkAppId, userId, userSig,
        new TUIRoomDefine().ActionCallback() {
        @Override
        public void onSuccess() {
            Log.i("sdk", "success");
        }
﻿
        @Override
        public void onError(TUICommonDefine.Error error, String message) {
            // If the following error codes are returned, it means that an expired UserSig is in use. You need to generate a new one for login again.
            // 1. ERR_USER_SIG_EXPIRED(6206)
            // 2. ERR_SVR_ACCOUNT_USERSIG_EXPIRED(70001)
            // Note: For other error codes, do not call the log-in API here to avoid the SDK entering an infinite loop.
            Log.i("sdk", "failure code:" + error + ",message:" + message);
        }
    });
    
    
const sdkAppId = 1400000000; // Set up your own SDK app ID 
const userId = "your user id";
const userSig = "userSig from your server";
﻿
await TUIRoomEngine.login({ sdkAppId, userId, userSig });
Getting Logged-In User Basic Info
Upon successful log-in, obtain the logged-in user's basic info by calling getSelfInfo(iOS & Mac / Android / Web). If login failed, the retrieved login user UserID will be empty.
Below is an example code:
Swift
Java
Web
// Get logged-in user basic info
let selfUserInfo = TUIRoomEngine.getSelfInfo()
TUIRoomDefine.LoginUserInfo loginUserInfo = TUIRoomEngine.getSelfInfo();
const loginUserInfo = await TUIRoomEngine.getSelfInfo();
Modifying Logged-In User Basic Info
Upon successful log-in, modify the logged-in user's basic info by calling setSelfInfo(iOS & Mac / Android / Web).
Below is an example code:
Swift
Java
Web
let userInfo:TUILoginUserInfo = TUILoginUserInfo()
userInfo.userName = "xxx" // replace with your own userName
userInfo.avatarUrl = "xxx" // replace with your own avatarUrl
﻿
TUIRoomEngine.setSelfInfo(userInfo: userInfo) {
    // successfully set
} onError: {code, message in
    // failed to set
}
TUIRoomDefine.LoginUserInfo userInfo = new TUIRoomDefine.LoginUserInfo();
userInfo.userName = "xxx"; // replace with your own userName
userInfo.avatarUrl = "xxx"; // replace with your own avatarUrl
TUIRoomEngine.setSelfInfo(userInfo, new TUIRoomDefine.ActionCallback() {
    @Override
    public void onSuccess() {
        // successfully set
    }
    @Override
    public void onError(TUICommonDefine.Error error, String message) {
        // failed to set
    }
});
await TUIRoomEngine.setSelfInfo({
  userName: 'userName', // fill in your new username
  avatarUrl: 'avatarUrl',    // fill in your new profile photo url
});
Logout
Under normal circumstances, if your application lifecycle matches the SDK lifecycle, you can exit directly without logging out. However, in special scenarios, such as when you only use the SDK after entering specific interfaces and no longer use it after exiting, you can call the logout API (iOS & Mac / Android / Web) to log out of the SDK.
Below is an example code:
Swift
Java
New Option
TUIRoomEngine.logout {
    print("success")
} onError: { code, message in
    print("failure, code:\(code), message:\(message)")
}
TUIRoomEngine.logout(new TUIRoomDefine.ActionCallback() {
    @Override
    public void onSuccess() {
        Log.i("sdk","success");
    }
﻿
    @Override
    public void onError(TUICommonDefine.Error error, String message) {
        Log.i("sdk","error" + error + ",message" + message);
    }
});
await TUIRoomEngine.logout();
Account Switch
If you wish to implement account switch in application, only need to call login each time when switching accounts.
For example, if you are already logged in as alice, you can just switch to bob by directly logging in as bob. There is no need to explicitly call logout alice before logging in bob, as the SDK handles it automatically.
﻿
﻿
Parameter	Meaning	Description
UserID	Unique user ID for login	Use only letters (a-z, A-Z), digits (0-9), underscores (_), and hyphens (-). Length not exceeding 32 bytes.
UserSig	login ticket	The business server calculates to ensure security. For the calculation method, see user authentication.