ZOOM Windows SDK  5.2.42037.1112
Classes | Typedefs | Enumerations
auth_service_interface.h File Reference

Authentication Service Interface. More...

#include "zoom_sdk_def.h"

Go to the source code of this file.

Classes

struct  tagAuthParam
 SDK Authentication parameter with sdk key/secret. Here are more detailed structural descriptions. More...
 
struct  tagAuthContext
 SDK Authentication parameter with jwt token. Here are more detailed structural descriptions. More...
 
struct  tagLoginParam4Email
 SDK parameter for login via email. Here are more detailed structural descriptions. More...
 
struct  tagLoginParam4SSO
 SDK parameter for login via SSO. Here are more detailed structural descriptions. More...
 
struct  tagLoginParam
 Account login parameter. 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 tagAuthParam AuthParam
 
typedef struct tagAuthContext AuthContext
 
typedef struct tagLoginParam4Email LoginParam4Email
 
typedef struct tagLoginParam4SSO LoginParam4SSO
 
typedef struct tagLoginParam LoginParam
 

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
}
 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  LoginType { LoginType_Unknown, LoginType_Email, LoginType_SSO }
 User login type. Here are more detailed structural descriptions. More...
 

Detailed Description

Authentication Service Interface.

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.

◆ 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.

◆ LoginType

enum LoginType

User login type. Here are more detailed structural descriptions.

Enumerator
LoginType_Unknown 

Unknown type.

LoginType_Email 

Login with work mailbox.

LoginType_SSO 

Login with SSO token.