Updated on 2023-03-23 GMT+08:00

App ID Login

Function

This API is used to log in to the system using an app ID. You must log in to Huawei Cloud Meeting before using functions such as creating meetings and being invited into meetings. If you do not log in, you cannot experience complete meeting functions.

Function Prototype

loginByAppId(appIdAuthInfo: AppIdAuthInfo, onLoginResult?: (ret: SDKERR, reason: string, loginResult: LoginResult) => void): voidloginByAppId(appIdAuthInfo: AppIdAuthInfo, onLoginResult?: (ret: SDKERR, reason: string, loginResult: LoginResult) => void): void

Request Parameters

Table 1 Input parameter description
Parameter Mandatory Type Description
appIdAuthInfo Y AppIdAuthInfo App ID authentication information.
onLoginResult Y (ret: SDKERR, reason: string, loginResult: LoginResult) => void Login callback.
Table 2 AppIdAuthInfo
Parameter Mandatory Type Description
corpId N string Enterprise ID. This parameter is mandatory only in SP mode. Do not configure this parameter in single-enterprise mode. Otherwise, the authentication fails.
thirdUserId Y string Unique ID of a third-party account.
userName N string Username. If this parameter is left blank, the value of this parameter is the same as that of thirdUserId by default.
signature Y string Authentication signature obtained from the third-party server.
nonce Y string Nonce value obtained from the third-party server, which is used by the Huawei Cloud server to verify the validity of the authentication signature.
expireTime Y number Validity period timestamp of the authentication signature obtained from the third-party server, in seconds. 0 indicates that the authentication signature never expires.
userEmail N string Email address of the user.
userPhone N string Mobile number of the user.
deptCode N string Department ID.

Return Values

void

Callback Method Parameters

(ret: SDKERR, reason: string, loginResult: LoginResult) => void

Table 3 Input parameter description
Parameter Type Description
ret For details about SDKERR, see Error Code Reference. Error code.
reason string Error description.
loginResult LoginResult Login result.
Table 4 LoginResult
Parameter Type Description
userUuid string UUID, which is the unique user ID allocated by the system.
account string Account.
thirdAccount string Third-party account.