auth_service_interface.h File Reference

Authentication Service Interface. More...

#include "zoom_sdk_def.h"

Go to the source code of this file.

Data Structures
struct	tagAuthContext
	SDK Authentication parameter with jwt token. Here are more detailed structural descriptions. More...
class	IAccountInfo
	Account information interface. More...
class	IAuthServiceEvent
	Authentication service callback event. More...
class	IAuthService
	Authentication Service Interface. More...

Typedefs
typedef struct tagAuthContext	AuthContext

Enumerations
enum	AuthResult {   AUTHRET_SUCCESS , AUTHRET_KEYORSECRETEMPTY , AUTHRET_KEYORSECRETWRONG , AUTHRET_ACCOUNTNOTSUPPORT ,   AUTHRET_ACCOUNTNOTENABLESDK , AUTHRET_UNKNOWN , AUTHRET_SERVICE_BUSY , AUTHRET_NONE ,   AUTHRET_OVERTIME , AUTHRET_NETWORKISSUE , AUTHRET_CLIENT_INCOMPATIBLE , AUTHRET_JWTTOKENWRONG ,   AUTHRET_LIMIT_EXCEEDED_EXCEPTION }
	SDK Authentication Result. Here are more detailed structural descriptions. More...
enum	LOGINSTATUS { LOGIN_IDLE , LOGIN_PROCESSING , LOGIN_SUCCESS , LOGIN_FAILED }
	Login status. Here are more detailed structural descriptions. More...
enum	LoginFailReason {   LoginFail_None = 0 , LoginFail_EmailLoginDisable , LoginFail_UserNotExist , LoginFail_WrongPassword ,   LoginFail_AccountLocked , LoginFail_SDKNeedUpdate , LoginFail_TooManyFailedAttempts , LoginFail_SMSCodeError ,   LoginFail_SMSCodeExpired , LoginFail_PhoneNumberFormatInValid , LoginFail_LoginTokenInvalid , LoginFail_UserDisagreeLoginDisclaimer ,   LoginFail_Mfa_Required , LoginFail_Need_Bitrthday_ask , LoginFail_OtherIssue = 100 }
enum	LoginType { LoginType_Unknown , LoginType_SSO }
	User login type. Here are more detailed structural descriptions. More...

Detailed Description

Authentication Service Interface.

Definition in file auth_service_interface.h.

Typedef Documentation

AuthContext

typedef struct tagAuthContext AuthContext

Enumeration Type Documentation

AuthResult

enum AuthResult

SDK Authentication Result. Here are more detailed structural descriptions.

Enumerator
AUTHRET_SUCCESS	Authentication is successful.
AUTHRET_KEYORSECRETEMPTY	The key or secret to authenticate is empty.
AUTHRET_KEYORSECRETWRONG	The key or secret to authenticate is wrong.
AUTHRET_ACCOUNTNOTSUPPORT	The user account does not support.
AUTHRET_ACCOUNTNOTENABLESDK	The user account is not enabled for SDK.
AUTHRET_UNKNOWN	Unknown error.
AUTHRET_SERVICE_BUSY	Service is busy.
AUTHRET_NONE	Initial status.
AUTHRET_OVERTIME	Time out.
AUTHRET_NETWORKISSUE	Network issues.
AUTHRET_CLIENT_INCOMPATIBLE
AUTHRET_JWTTOKENWRONG	Account does not support this SDK version. The jwt token to authenticate is wrong.
AUTHRET_LIMIT_EXCEEDED_EXCEPTION	The authentication rate limit is exceeded.

Definition at line 16 of file auth_service_interface.h.

{
    AUTHRET_SUCCESS,
    AUTHRET_KEYORSECRETEMPTY,
    AUTHRET_KEYORSECRETWRONG,
    AUTHRET_ACCOUNTNOTSUPPORT,
    AUTHRET_ACCOUNTNOTENABLESDK,
    AUTHRET_UNKNOWN,
    AUTHRET_SERVICE_BUSY,
    AUTHRET_NONE,
    AUTHRET_OVERTIME,
    AUTHRET_NETWORKISSUE,
    AUTHRET_CLIENT_INCOMPATIBLE, 
    AUTHRET_JWTTOKENWRONG, 
    AUTHRET_LIMIT_EXCEEDED_EXCEPTION, 
};

LoginFailReason

enum LoginFailReason

Enumerator
LoginFail_None
LoginFail_EmailLoginDisable
LoginFail_UserNotExist
LoginFail_WrongPassword
LoginFail_AccountLocked
LoginFail_SDKNeedUpdate
LoginFail_TooManyFailedAttempts
LoginFail_SMSCodeError
LoginFail_SMSCodeExpired
LoginFail_PhoneNumberFormatInValid
LoginFail_LoginTokenInvalid
LoginFail_UserDisagreeLoginDisclaimer
LoginFail_Mfa_Required
LoginFail_Need_Bitrthday_ask
LoginFail_OtherIssue

Definition at line 45 of file auth_service_interface.h.

{
    LoginFail_None = 0,
    LoginFail_EmailLoginDisable,
    LoginFail_UserNotExist,     
    LoginFail_WrongPassword,    
    LoginFail_AccountLocked,    
    LoginFail_SDKNeedUpdate,    
    LoginFail_TooManyFailedAttempts,    
    LoginFail_SMSCodeError,     
    LoginFail_SMSCodeExpired,   
    LoginFail_PhoneNumberFormatInValid,
    LoginFail_LoginTokenInvalid,
    LoginFail_UserDisagreeLoginDisclaimer,
    LoginFail_Mfa_Required,
    LoginFail_Need_Bitrthday_ask,
    LoginFail_OtherIssue = 100, 
};

LOGINSTATUS

enum LOGINSTATUS

Login status. Here are more detailed structural descriptions.

Enumerator
LOGIN_IDLE	Unlogged in.
LOGIN_PROCESSING	In process of login.
LOGIN_SUCCESS	Login successful.
LOGIN_FAILED	Login failed.

Definition at line 37 of file auth_service_interface.h.

{
    LOGIN_IDLE,
    LOGIN_PROCESSING,
    LOGIN_SUCCESS,
    LOGIN_FAILED,
};

LoginType

enum LoginType

User login type. Here are more detailed structural descriptions.

Enumerator
LoginType_Unknown	Unknown type.
LoginType_SSO	Login with SSO token.

Definition at line 126 of file auth_service_interface.h.

{
    LoginType_Unknown,
    LoginType_SSO,
};