Updated on 2024-07-30 GMT+08:00

Login

You can log in using an account and password, or using an app ID.

login:password:

API Description

This API is used for login using an account and password.

Precautions

  1. 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.
  2. Error: Error information. nil: Success.

Method Definition

1
- (void)login:( NSString * _Nonnull )account password:( NSString * _Nonnull )password callback:(_Nonnull HWMSDKLoginCompleteHandler)callback;

Parameter Description

Table 1 Parameter description

Parameter

Mandatory

Type

Description

account

Yes

NSString *

Login account.

password

Yes

NSString *

Login password.

callback

No

HWMSDKLoginCompleteHandler

Error: Error information. nil: Success.

Return Values

Table 2 HWMLoginResult description

Parameter

Type

Description

userUuid

NSString *

Account UUID.

account

NSString *

Login account.

thirdAccount

NSString *

Third-party account for login using an app ID.

Sample Code

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
/// Login
/// It is recommended that accounts and passwords used for authentication be stored in ciphertext in the configuration file or as environment variables and be decrypted during usage.
- (void)login {
    NSString *account = getAccount();
    NSString *password = getPassword();
    [[HWMSdk getOpenApi] login:account password:password callback:^(NSError * _Nullable error, HWMLoginResult * _Nullable result) {
        if (error == nil) {
            NSLog(@"Login succeeded.");
        }else{
            NSLog(@"Login failed.");
        }
    }];
}

login:

API Description

This API is used for login using an app ID.

Precautions

  1. 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.
  2. Error: Error information. nil: Success.

Method Definition

1
- (void)login:(HWMAppIDLoginParam *)appidInfo callback:(HWMSDKLoginCompleteHandler)callback;

Parameter Description

Table 3 HWMAppIDLoginParam description

Parameter

Mandatory

Type

Description

signature

Yes

NSString *

Authentication signature obtained from the third-party server.

thirdUserId

Yes

NSString *

Third-party account.

expireTime

Yes

NSInteger

Signature expiration time. The value is a timestamp in seconds. If the value is 0, the signature will not expire.

nonce

Yes

NSString *

Random number.

userName

No

NSString *

Username.

userEmail

No

NSString *

Email address.

userPhone

No

NSString *

Mobile number.

corpId

No

NSString *

ID of the enterprise to which the user belongs. This parameter is mandatory only in SP mode. Do not set this parameter in single-enterprise mode. Otherwise, the authentication will fail.

deptCode

No

NSString *

Department code.

Return Values

For details, see Table 2.

Sample Code

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
/// App ID login API
- (void)login {
    HWMAppIDLoginParam *appidInfo = [[HWMAppIDLoginParam alloc] init];
    appidInfo.thirdUserId     = getThirdUserId();
    appidInfo.expireTime = 1599618620;
    appidInfo.nonce      = getNonce();
    appidInfo.userName   = getUserName();
    appidInfo.signature  = getSignature();
    [[HWMSdk getOpenApi] login:appidInfo callback:^(NSError * _Nullable error, HWMLoginResult * _Nullable result) {
        if (error == nil) {
            NSLog(@"Login succeeded.");
        }else{
            NSLog(@"Login failed.");
        }
    }];
}

loginBySSO:

API Description

This API is used for login using SSO authentication.

Precautions

  1. 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.
  2. Error: Error information. nil: Success.

Method Definition

1
- (void)loginBySSO:(HWMSSOLoginParam)param callback:(_Nonnull HWMSDKLoginCompleteHandler)callback;

Parameter Description

Table 4 HWMSSOLoginParam description

Parameter

Mandatory

Type

Description

domain

Yes

NSString *

Enterprise domain name.

userTicket

Yes

NSString *

code

authServerType

Yes

HWMAuthServerType

Authentication server type.

Table 5 Enumerated value of HWMAuthServerType

Value

Description

HWMSDKAuthServerTypeOauth2

SSO

Return Values

Table 2

Sample Code
1
2
3
4
5
6
7
8
/// SSO login API
[[HWMSdk getOpenApi] loginBySSO:ssoLoginParam callback:^(NSError * _Nullable error, HWMLoginResult * _Nullable result) {
    if (error) {
        [UIUtil showMessageWithError:error];
    } else {
        [UIUtil showMessage:@"SSO login succeeded." error:error];
    }
}];