更新时间:2024-02-17 GMT+08:00
分享

登录

登录分为帐号密码鉴权登录和App ID鉴权登录。

login:password:

接口描述

该接口用于通过帐号密码鉴权登录。

注意事项

  1. 创建会议,被邀入会等功能只有在登录后才能使用,若不登录,将无法体验完整会议功能。
  2. 回调error表示错误信息,nil表示成功。

方法定义

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

参数描述

表1 参数说明

参数

是否必须

类型

描述

account

NSString *

登录帐号

password

NSString *

登录密码

callback

HWMSDKLoginCompleteHandler

参数Error表示错误信息,nil表示成功。

返回值

表2 登录返回HWMLoginResult

参数

类型

描述

userUuid

NSString *

账号uuid

account

NSString *

登录账号

thirdAccount

NSString *

appid登录的三方账号

示例代码

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
/// 登录处理
/// 认证鉴权用的帐号密码建议在配置文件或者环境变量中密文存放,使用时解密,确保安全
- (void)login {
    NSString *account = @"******";
    NSString *password = getPassword();
    [[HWMSdk getOpenApi] login:account password:password callback:^(NSError * _Nullable error, HWMLoginResult * _Nullable result) {
        if (error == nil) {
            NSLog(@"登录成功");
        }else{
            NSLog(@"登录失败"); 
        }
    }];
}

login:

接口描述

该接口用于通过App ID鉴权登录。

注意事项

  1. 创建会议,被邀入会等功能只有在登录后才能使用,若不登录,将无法体验完整会议功能。
  2. 回调error表示错误信息,nil表示成功。

方法定义

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

参数描述

表3 HWMAppIDLoginParam参数说明

参数

是否必须

类型

描述

signature

NSString *

从第三方服务端获取的鉴权签名信息

thirdUserId

NSString *

第三方用户的帐号

expireTime

NSInteger

signature 过期时间,单位为秒的时间戳,为0时表示不会过期

nonce

NSString *

随机数

userName

NSString *

用户名

userEmail

NSString *

邮箱

userPhone

NSString *

手机号

corpId

NSString *

SP下有多个企业的时候需要传入corpId

deptCode

NSString *

部门编码

返回值

参考:表登录返回HWMLoginResult

示例代码

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
/// AppId 登录接口
- (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(@"登录成功");
        }else{
            NSLog(@"登录失败");
        }
    }];
}

loginBySSO:

接口描述

该接口用于通过SSO的方式登录和鉴权。

注意事项

除匿名入会外,在使用其他业务之前必须进行成功登录。

方法定义

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

参数描述

表4 HWMSSOLoginParam参数说明

参数

是否必须

类型

描述

domain

NSString *

企业域名

userTicket

NSString *

code

authServerType

HWMOpenAuthServerType

鉴权服务器类型

表5 枚举HWMOpenAuthServerType说明

描述

HWMOpenAuthServerTypeOauth2

单点登录

返回值

参考:表登录返回HWMLoginResult

示例代码
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
/// SSO 登录接口
- (void)login {
    HWMSSOLoginParam *param = [[HWMSSOLoginParam alloc] init];
    param.domain = domain;
    param.code = code;
    param.authServerType = HWMOpenAuthServerTypeOauth2;
    [[HWMSdk getOpenApi] loginBySSO:param callback:^(NSError * _Nullable error, HWMLoginResult * _Nullable result) {
        if (error == nil) {
            NSLog(@"登录成功");
        }else{
            NSLog(@"登录失败");
        }
    }];
}
分享:

    相关文档

    相关产品