Meeting SDK for Windows API Reference
Loading...
Searching...
No Matches
IMeetingInputUserInfoHandler Class Referenceabstract

Input name and email handler. More...

#include <meeting_configuration_interface.h>

Public Member Functions

virtual ~IMeetingInputUserInfoHandler ()
 
virtual const zchar_tGetDefaultDisplayName ()=0
 Gets default display name.
 
virtual bool CanModifyDefaultDisplayName ()=0
 Determines whether the user can modify default display name.
 
virtual bool IsValidEmail (const zchar_t *email)=0
 Determines whether the inputted email is a valid email format. The email must meet the email format requirements. The email input by the logged in user must be the email of the logged in account.
 
virtual SDKError InputUserInfo (const zchar_t *name, const zchar_t *email)=0
 Completes the name and email information.
 
virtual void Cancel ()=0
 Ignore the prompt of completing the information.
 

Detailed Description

Input name and email handler.

Definition at line 183 of file meeting_configuration_interface.h.

Constructor & Destructor Documentation

◆ ~IMeetingInputUserInfoHandler()

virtual IMeetingInputUserInfoHandler::~IMeetingInputUserInfoHandler ( )
inlinevirtual

Definition at line 186 of file meeting_configuration_interface.h.

186{};

Member Function Documentation

◆ Cancel()

virtual void IMeetingInputUserInfoHandler::Cancel ( )
pure virtual

Ignore the prompt of completing the information.

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

◆ CanModifyDefaultDisplayName()

virtual bool IMeetingInputUserInfoHandler::CanModifyDefaultDisplayName ( )
pure virtual

Determines whether the user can modify default display name.

Returns
true if the user can modify default display name. Otherwise, false.

◆ GetDefaultDisplayName()

virtual const zchar_t * IMeetingInputUserInfoHandler::GetDefaultDisplayName ( )
pure virtual

Gets default display name.

Returns
If the function succeeds, it returns the default display name. Otherwise, this function fails and returns nullptr.

◆ InputUserInfo()

virtual SDKError IMeetingInputUserInfoHandler::InputUserInfo ( const zchar_t * name,
const zchar_t * email )
pure virtual

Completes the name and email information.

Parameters
nameThe user's name.
emailThe user's email.
Returns
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.
Note
The SDK will destroy this object instance after calling this function. Supplement with the correct information.

◆ IsValidEmail()

virtual bool IMeetingInputUserInfoHandler::IsValidEmail ( const zchar_t * email)
pure virtual

Determines whether the inputted email is a valid email format. The email must meet the email format requirements. The email input by the logged in user must be the email of the logged in account.

Parameters
emailThe email address to validate.
Returns
true if the email input is valid. Otherwise, false.