ZOOM Windows SDK  5.2.41727.0928
Public Types | Public Member Functions | List of all members
IMeetingPasswordAndScreenNameHandler Class Referenceabstract

Meeting screen name and password handler. More...

#include <meeting_configuration_interface.h>

Public Types

enum  RequiredInfoType {
  REQUIRED_INFO_TYPE_NONE, REQUIRED_INFO_TYPE_Password, REQUIRED_INFO_TYPE_Password4WrongPassword, REQUIRED_INFO_TYPE_PasswordAndScreenName,
  REQUIRED_INFO_TYPE_ScreenName, REQUIRED_INFO_TYPE_MeetingIDAndScreenName
}
 Type of necessary information to join the meeting. Here are more detailed structural descriptions. More...
 

Public Member Functions

virtual RequiredInfoType GetRequiredInfoType ()=0
 Get the type of required information to be completed. More...
 
virtual bool InputMeetingPasswordAndScreenName (const wchar_t *meetingPassword, const wchar_t *screenName)=0
 Complete the password and screen name information. More...
 
virtual bool InputMeetingIDAndScreenName (const wchar_t *meetingID, const wchar_t *screenName)=0
 Complete the meeting id and screen name information. More...
 
virtual bool InputMeetingScreenName (const wchar_t *screenName)=0
 Complete the screen name. More...
 
virtual void Cancel ()=0
 Ignore the prompt of completing the information. More...
 

Detailed Description

Meeting screen name and password handler.

Remarks
If the user information is not completed, the SDK will take the instance of this class as a reference to remind the user to complete the information via IMeetingConfigurationEvent::onInputMeetingPasswordAndScreenNameNotification()callback.

Member Enumeration Documentation

◆ RequiredInfoType

Type of necessary information to join the meeting. Here are more detailed structural descriptions.

Enumerator
REQUIRED_INFO_TYPE_NONE 

Initialization.

REQUIRED_INFO_TYPE_Password 

The user needs to enter the password when joins the meeting. Via the InputMeetingPasswordAndScreenName() to specify the password information.

REQUIRED_INFO_TYPE_Password4WrongPassword 

If the password is invalid, the user needs to re-enter it. Via the InputMeetingPasswordAndScreenName() to specify the password information.

REQUIRED_INFO_TYPE_PasswordAndScreenName 

The user needs to enter the screen name and the password,via the InputMeetingPasswordAndScreenName() to specify the necessary information.

REQUIRED_INFO_TYPE_ScreenName 

The user needs to enter the screen name. Via the InputMeetingPasswordAndScreenName() to specify the screen name information.

REQUIRED_INFO_TYPE_MeetingIDAndScreenName 

The user needs to enter the screen name and the meeting id,via the InputMeetingMeetingIDAndScreenName() to specify the necessary information.

Member Function Documentation

◆ Cancel()

virtual void IMeetingPasswordAndScreenNameHandler::Cancel ( )
pure virtual

Ignore the prompt of completing the information.

Remarks
The SDK will destroy this object instance after calling this function.

◆ GetRequiredInfoType()

virtual RequiredInfoType IMeetingPasswordAndScreenNameHandler::GetRequiredInfoType ( )
pure virtual

Get the type of required information to be completed.

Returns
If the function succeeds, the return is enumerated in RequiredInfoType enum.

◆ InputMeetingIDAndScreenName()

virtual bool IMeetingPasswordAndScreenNameHandler::InputMeetingIDAndScreenName ( const wchar_t *  meetingID,
const wchar_t *  screenName 
)
pure virtual

Complete the meeting id and screen name information.

Remarks
The SDK will destroy the object instance after calling this function. Supplement with the correct information.

◆ InputMeetingPasswordAndScreenName()

virtual bool IMeetingPasswordAndScreenNameHandler::InputMeetingPasswordAndScreenName ( const wchar_t *  meetingPassword,
const wchar_t *  screenName 
)
pure virtual

Complete the password and screen name information.

Remarks
The SDK will destroy the object instance after calling this function. Supplement with the correct information.

◆ InputMeetingScreenName()

virtual bool IMeetingPasswordAndScreenNameHandler::InputMeetingScreenName ( const wchar_t *  screenName)
pure virtual

Complete the screen name.

Remarks
The SDK will destroy this object instance after calling this function. Complete the information by the correct function.

The documentation for this class was generated from the following file: