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, 
};
 
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, 
};
 
typedef struct tagAuthParam
{
    const wchar_t* appKey;
    const wchar_t* appSecret;
    tagAuthParam()
    {
        appKey = NULL;
        appSecret = NULL;
    }
}AuthParam;
 
typedef struct tagAuthContext
{
    const wchar_t* jwt_token; 
    tagAuthContext()
    {
        jwt_token = NULL;
    }
 
}AuthContext;
enum LoginType
{
    LoginType_Unknown,
    LoginType_SSO,
};
 
typedef struct tagWebinarLegalNoticesExplainedInfo
{
    const wchar_t* explained_content;
    const wchar_t* url_register_account_owner;
    const wchar_t* url_register_terms;
    const wchar_t* url_register_privacy_policy;
    tagWebinarLegalNoticesExplainedInfo()
    {
        Reset();
    }
 
    void Reset()
    {
        explained_content = nullptr;
        url_register_account_owner = nullptr;
        url_register_terms = nullptr;
        url_register_privacy_policy = nullptr;
    }
}WebinarLegalNoticesExplainedInfo;
 
class IAccountInfo
{
public:
    virtual const wchar_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;
};
 
class IDirectShareServiceHelper;
class IOutlookPluginIntegrationHelper;
class IAuthService
{
public:
    virtual SDKError SetEvent(IAuthServiceEvent* pEvent) = 0;
 
    virtual SDKError SDKAuth(AuthParam& authParam) = 0;
 
    virtual SDKError SDKAuth(AuthContext& authContext) = 0;
 
    virtual AuthResult GetAuthResult() = 0;
 
    virtual const wchar_t* GetSDKIdentity() = 0;
 
    virtual const wchar_t* GenerateSSOLoginWebURL(const wchar_t* prefix_of_vanity_url) = 0;
 
    virtual SDKError SSOLoginWithWebUriProtocol(const wchar_t* uri_protocol) = 0;
    
    virtual SDKError LogOut() = 0;
 
    virtual IAccountInfo* GetAccountInfo() = 0;
 
    virtual LOGINSTATUS GetLoginStatus() = 0;
 
    virtual IDirectShareServiceHelper* GetDirectShareServiceHeler() = 0;
 
    virtual const wchar_t* getWebinalLegalNoticesPrompt() = 0;
 
    virtual bool getWebinalLegalNoticesExplained(WebinarLegalNoticesExplainedInfo& explained_info) = 0;
};
END_ZOOM_SDK_NAMESPACE
#endif