auth_service_interface.h

Go to the documentation of this file.

#ifndef _AUTH_SERVICE_INTERFACE_H_
#define _AUTH_SERVICE_INTERFACE_H_
#include "zoom_sdk_def.h"
 
BEGIN_ZOOM_SDK_NAMESPACE

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, 
};

enum LOGINSTATUS
{
    LOGIN_IDLE,
    LOGIN_PROCESSING,
    LOGIN_SUCCESS,
    LOGIN_FAILED,
};

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, 
};
#if defined(WIN32)
typedef enum
{
    SDK_Notification_Service_None = 0,
    SDK_Notification_Service_Starting,
    SDK_Notification_Service_Started,   
    SDK_Notification_Service_StartFailed,
    SDK_Notification_Service_Closed,
}SDKNotificationServiceStatus;

typedef enum
{
    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;
 
#endif

typedef struct tagAuthContext
{
    const zchar_t* jwt_token; 

    const zchar_t* publicAppKey;
    tagAuthContext()
    {
        jwt_token = nullptr;
        publicAppKey = nullptr;
    }
 
}AuthContext;

enum LoginType
{
    LoginType_Unknown,
    LoginType_SSO,
};

class IAccountInfo
{
public:
    virtual const zchar_t* GetDisplayName() = 0;
    virtual LoginType GetLoginType() = 0;
    virtual ~IAccountInfo(){};
};

class IAuthServiceEvent
{
public:
    virtual ~IAuthServiceEvent() {}

    virtual void onAuthenticationReturn(AuthResult ret) = 0;

    virtual void onLoginReturnWithReason(LOGINSTATUS ret, IAccountInfo* pAccountInfo, LoginFailReason reason) = 0;
    
    virtual void onLogout() = 0;

    virtual void onZoomIdentityExpired() = 0;

    virtual void onZoomAuthIdentityExpired() = 0;
#if defined(WIN32)
    virtual void onNotificationServiceStatus(SDKNotificationServiceStatus status, SDKNotificationServiceError error) = 0;
#endif
};
#if defined(WIN32)
class IDirectShareServiceHelper;
class IOutlookPluginIntegrationHelper;
class INotificationServiceHelper;
#endif
class IAuthService
{
public:
    virtual SDKError SetEvent(IAuthServiceEvent* pEvent) = 0;

    virtual SDKError SDKAuth(AuthContext& authContext) = 0;

    virtual AuthResult GetAuthResult() = 0;

    virtual const zchar_t* GetSDKIdentity() = 0;

     * @brief Gets SSO login web URL.
     * @param prefix_of_vanity_url The prefix of vanity URL. 
     * @return If the function succeeds, it returns the SSO login web URL. Otherwise, this function fails and returns nullptr.
     */
    virtual const zchar_t* GenerateSSOLoginWebURL(const zchar_t* prefix_of_vanity_url) = 0;

    virtual SDKError SSOLoginWithWebUriProtocol(const zchar_t* uri_protocol) = 0;

    
    virtual SDKError LogOut() = 0;

    virtual IAccountInfo* GetAccountInfo() = 0;

    virtual LOGINSTATUS GetLoginStatus() = 0;
#if defined(WIN32)
    virtual IDirectShareServiceHelper* GetDirectShareServiceHelper() = 0;

    virtual void EnableAutoRegisterNotificationServiceForLogin(bool bEnable) = 0;

    virtual SDKError RegisterNotificationService(const zchar_t* accessToken) = 0;

    virtual SDKError UnregisterNotificationService() = 0;

    virtual INotificationServiceHelper* GetNotificationServiceHelper() = 0;
#endif
};
END_ZOOM_SDK_NAMESPACE
#endif