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. 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
	SDK authentication parameter with jwt token.

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 }
	Enumeration of SDK authentication result. More...
enum	LOGINSTATUS { LOGIN_IDLE , LOGIN_PROCESSING , LOGIN_SUCCESS , LOGIN_FAILED }
	Enumeration of SDK login status. 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 }
	Enumeration of SDK login failed reason. More...
enum	SDKNotificationServiceStatus {   SDK_Notification_Service_None = 0 , SDK_Notification_Service_Starting , SDK_Notification_Service_Started , SDK_Notification_Service_StartFailed ,   SDK_Notification_Service_Closed }
	Enumeration of the type for notification service status. More...
enum	SDKNotificationServiceError {   SDK_Notification_Service_Error_Success = 0 , SDK_Notification_Service_Error_Unknown , SDK_Notification_Service_Error_Internal_Error , SDK_Notification_Service_Error_Invalid_Token ,   SDK_Notification_Service_Error_Multi_Connect , SDK_Notification_Service_Error_Network_Issue , SDK_Notification_Service_Error_Max_Duration }
	Enumeration of notification service error codes. More...
enum	LoginType { LoginType_Unknown , LoginType_SSO }
	Enumeration of user login type. More...

Detailed Description

Authentication Service Interface.

Definition in file auth_service_interface.h.

Typedef Documentation

AuthContext

typedef struct tagAuthContext AuthContext

SDK authentication parameter with jwt token.

Enumeration Type Documentation

AuthResult

enum AuthResult

Enumeration of SDK authentication result.

Enumerator
AUTHRET_SUCCESS	Authentication is successful.
AUTHRET_KEYORSECRETEMPTY	The key or secret to authenticate is empty.
AUTHRET_KEYORSECRETWRONG	he 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	Account does not support this SDK version.
AUTHRET_JWTTOKENWRONG	The jwt token to authenticate is wrong.
AUTHRET_LIMIT_EXCEEDED_EXCEPTION	The authentication rate limit is exceeded.

Definition at line 14 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

Enumeration of SDK login failed reason.

Enumerator
LoginFail_None	No failure, login successful.
LoginFail_EmailLoginDisable	Email login is disabled.
LoginFail_UserNotExist	User does not exist.
LoginFail_WrongPassword	Incorrect password.
LoginFail_AccountLocked	Account is locked.
LoginFail_SDKNeedUpdate	SDK needs to be updated.
LoginFail_TooManyFailedAttempts	Too many failed login attempts.
LoginFail_SMSCodeError	Incorrect SMS verification code.
LoginFail_SMSCodeExpired	SMS verification code has expired.
LoginFail_PhoneNumberFormatInValid	Invalid phone number format.
LoginFail_LoginTokenInvalid	Invalid login token.
LoginFail_UserDisagreeLoginDisclaimer	User disagreed with the login disclaimer.
LoginFail_Mfa_Required	Multi-factor authentication is required.
LoginFail_Need_Bitrthday_ask	User needs to provide birthday.
LoginFail_OtherIssue	Other unspecified issue.

Definition at line 62 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

Enumeration of SDK login status.

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

Definition at line 47 of file auth_service_interface.h.

{
    LOGIN_IDLE,
    LOGIN_PROCESSING,
    LOGIN_SUCCESS,
    LOGIN_FAILED,
};

LoginType

enum LoginType

Enumeration of user login type.

Enumerator
LoginType_Unknown	Unknown login type.
LoginType_SSO	Login with SSO token.

Definition at line 185 of file auth_service_interface.h.

{
    LoginType_Unknown,
    LoginType_SSO,
};

SDKNotificationServiceError

enum SDKNotificationServiceError

Enumeration of notification service error codes.

Enumerator
SDK_Notification_Service_Error_Success	Operation completed successfully.
SDK_Notification_Service_Error_Unknown	An unknown error occurred.
SDK_Notification_Service_Error_Internal_Error	An internal error occurred. Retry the operation.
SDK_Notification_Service_Error_Invalid_Token	The provided token is invalid.
SDK_Notification_Service_Error_Multi_Connect	Multiple connections detected. This happens when the same user or resource logs in again on the same device. The previous login application will receive this error.
SDK_Notification_Service_Error_Network_Issue	A network issue prevented the operation from succeeding.
SDK_Notification_Service_Error_Max_Duration	The client has been connected for too long (over 24 hours). The server will disconnect the session. The client must reconnect or log in again.

Definition at line 116 of file auth_service_interface.h.

{
    SDK_Notification_Service_Error_Success = 0,
    SDK_Notification_Service_Error_Unknown,
    SDK_Notification_Service_Error_Internal_Error,
    SDK_Notification_Service_Error_Invalid_Token,
    SDK_Notification_Service_Error_Multi_Connect,
    SDK_Notification_Service_Error_Network_Issue,
    SDK_Notification_Service_Error_Max_Duration, 
}SDKNotificationServiceError;

SDKNotificationServiceStatus

enum SDKNotificationServiceStatus

Enumeration of the type for notification service status.

Enumerator
SDK_Notification_Service_None	No service status.
SDK_Notification_Service_Starting	Notification service is starting.
SDK_Notification_Service_Started	Notification service has started successfully.
SDK_Notification_Service_StartFailed	Failed to start the notification service.
SDK_Notification_Service_Closed	Notification service has been closed.

Definition at line 99 of file auth_service_interface.h.

{
    SDK_Notification_Service_None = 0,
    SDK_Notification_Service_Starting,
    SDK_Notification_Service_Started,   
    SDK_Notification_Service_StartFailed,
    SDK_Notification_Service_Closed,
}SDKNotificationServiceStatus;