iOS API
Instance Methods | Properties | List of all members
MobileRTCAuthService Class Reference

The method provides support for authorizing MobileRTC. More...

#import <MobileRTCAuthService.h>

Inheritance diagram for MobileRTCAuthService:

Instance Methods

(void) - sdkAuth
 Authenticate SDK. More...
 
(BOOL) - isLoggedIn
 Check whether mobileRTC is logged-in or not. More...
 
(MobileRTCUserType) - getUserType
 Get user type. More...
 
(BOOL) - loginWithEmail:password:rememberMe:
 Specify to login MobileRTC with working email. More...
 
(BOOL) - loginWithSSOToken:rememberMe:
 Specify to login MobileRTC with SSO (Single-Sign-On). More...
 
(BOOL) - isEmailLoginEnabled
 Query if it is enabled to login with email. More...
 
(BOOL) - logoutRTC
 Specify to logout MobileRTC. More...
 
(nullable MobileRTCAccountInfo *) - getAccountInfo
 Specify to get the profile information of logged-in user. More...
 

Properties

id< MobileRTCAuthDelegate > delegate
 The property to receive authentication/login events.
 
NSString * clientKey
 APP Key got from zoom.us. More...
 
NSString * clientSecret
 APP secret got from zoom.us. More...
 
NSString * jwtToken
 jwt auth token. More...
 

Detailed Description

The method provides support for authorizing MobileRTC.

Warning
Users should authorize MobileRTC before using it to avoid invalid functions in MobileRTC.

Method Documentation

◆ getAccountInfo()

- (nullable MobileRTCAccountInfo*) getAccountInfo

Specify to get the profile information of logged-in user.

Returns
The profile information of logged-in user.
Warning
You can only get the instance successfully of logged-in user.

◆ getUserType()

- (MobileRTCUserType) getUserType

Get user type.

Returns
One of the user types listed in MobileRTCUserType.
Warning
The method is optional. The default user type is MobileRTCUserType_APIUser. User who logs in MobileRTC with working email is MobileRTCUserType_ZoomUser; User who logs in MobileRTC with SSO is MobileRTCUserType_SSOUser.

◆ isEmailLoginEnabled()

- (BOOL) isEmailLoginEnabled

Query if it is enabled to login with email.

Returns
YES means enable, otherwise not.
Warning
You need call the function after auth successfull.

◆ isLoggedIn()

- (BOOL) isLoggedIn

Check whether mobileRTC is logged-in or not.

Returns
YES indicates logged-in. Otherwise not.
Warning
The method is optional, ignore it if you do not log in with working email or SSO.

◆ loginWithEmail:password:rememberMe:()

- (BOOL) loginWithEmail: (nonnull NSString *)  email
password: (nonnull NSString *)  password
rememberMe: (BOOL)  rememberMe 

Specify to login MobileRTC with working email.

Parameters
emailLogin email address.
passwordLogin password.
Returns
YES indicates to call the method successfully. Otherwise not.
Warning
The method is optional, ignore it if you do not have a working email for MobileRTC.

◆ loginWithSSOToken:rememberMe:()

- (BOOL) loginWithSSOToken: (nonnull NSString *)  token
rememberMe: (BOOL)  rememberMe 

Specify to login MobileRTC with SSO (Single-Sign-On).

Parameters
tokenUser's token information.
Returns
YES indicates to call the method successfully. Otherwise not.
Warning
The method is optional, ignore it if you do not login MobileRTC with SSO.

◆ logoutRTC()

- (BOOL) logoutRTC

Specify to logout MobileRTC.

Returns
YES indicates to call the method successfully. Otherwise not.
Warning
The method is optional, ignore it if you do not login MobileRTC.

◆ sdkAuth()

- (void) sdkAuth

Authenticate SDK.

Warning
if you want to auth with jwt token, please fill the token property. Otherwise, please fill the client key and client secret property.
If the key or secret of client is blank, user will get error:MobileRTCAuthError_KeyOrSecretEmpty via onMobileRTCAuthReturn defined in MobileRTCAuthDelegate.

Property Documentation

◆ clientKey

- (NSString*) clientKey
readwritenonatomicretain

APP Key got from zoom.us.

Warning
Keep the value as a secret. DO NOT publish it.

◆ clientSecret

- (NSString*) clientSecret
readwritenonatomicretain

APP secret got from zoom.us.

Warning
Keep the value as a secret. DO NOT publish it.

◆ jwtToken

- (NSString*) jwtToken
readwritenonatomicretain

jwt auth token.

Warning
Keep the value as a secret. DO NOT publish it. If jwtToken is nil or empty,We will user your appKey and appSecret to Auth, We recommend using JWT Token, and generate JWT Token on your web backend.

The documentation for this class was generated from the following file: