Waiting Room helper interface. More...

#include <IMeetingQAHelper.h>

Public Member Functions
virtual	~IMeetingQAHelper ()

virtual ZRCSDKError	RegisterSink (IMeetingQAHelperSink *pSink)=0
	Register waiting room helper callback sink.

virtual ZRCSDKError	DeregisterSink (IMeetingQAHelperSink *pSink)=0
	Deregister waiting room helper callback sink.

virtual ZRCSDKError	BecomeMainZRC (bool mainZRC)=0
	Request to become main ZRC, only main ZRC can operate message. If quit Q&A UI, you should release main ZRC.

virtual ZRCSDKError	CreateQuestion (const std::string &context, bool isAnonymous)=0
	The attendee can call this API to create question.

virtual ZRCSDKError	CreateAnswer (const std::string &context, const std::string &questionID, bool isPrivate)=0
	The host / co-host or panelist can call this API to create answer.

virtual ZRCSDKError	CreateComment (const std::string &context, const std::string &questionID)=0
	The attendee can call this API to create comment.

virtual ZRCSDKError	DeleteMessage (const std::string &messageID)=0
	The host or co-host can call this API to delete message.

virtual ZRCSDKError	DismissQuestion (const std::string &messageID)=0
	The host or co-host can call this API to dismiss question.

virtual ZRCSDKError	ReopenQuestion (const std::string &messageID)=0
	The host or co-host can call this API to reopen question.

virtual ZRCSDKError	StartComposing (const std::string &messageID)=0
	The host / co-host or panelist can call this API to start composing answer.

virtual ZRCSDKError	StopComposing (const std::string &messageID)=0
	The host / co-host or panelist can call this API to stop composing answer.

virtual ZRCSDKError	StartLiving (const std::string &messageID)=0
	The host / co-host or panelist can call this API to start living answer.

virtual ZRCSDKError	StopLiving (const std::string &messageID)=0
	The host / co-host or panelist can call this API to stop living answer.

virtual ZRCSDKError	UpvoteQuestion (const std::string &messageID)=0
	The participant can call this API to upvote question.

virtual ZRCSDKError	RevokeUpvoteQuestion (const std::string &messageID)=0
	The participant can call this API to revoke upvote question.

virtual ZRCSDKError	EnableMeetingQA (bool enable)=0
	The host or co-host can call this API to enable Q&A feature.

virtual ZRCSDKError	AllowSubmitQuestions (bool allow)=0
	The host or co-host can call this API to allow submit questions.

virtual ZRCSDKError	AllowAnonymousQuestions (bool allow)=0
	The host or co-host can call this API to allow submit questions anonymously.

virtual ZRCSDKError	AllowViewAllQuestions (bool allow)=0
	The host or co-host can call this API to allow view all questions.

virtual ZRCSDKError	AllowUpvote (bool allow)=0
	The host or co-host can call this API to allow upvote.

virtual ZRCSDKError	AllowComment (bool allow)=0
	The host or co-host can call this API to allow comment.

virtual ZRCSDKError	ShowOnZR (bool show)=0
	The main ZRC can call this API to show Q&A UI on ZR.

virtual ZRCSDKError	IsMainZRC (bool &isMainZRC)=0
	Query if is main ZRC.

virtual ZRCSDKError	GetAllMessages (std::vector< MeetingQAMessage > &messages)=0
	Get all messages.

virtual ZRCSDKError	IsMeetingQAEnabled (bool &isEnabled)=0
	Query if meeting Q&A feature enabled.

virtual ZRCSDKError	IsAllowSubmitQuestions (bool &isAllow)=0
	Query if allow submit questions.

virtual ZRCSDKError	IsAllowAnonymousQuestions (bool &isAllow)=0
	Query if allow anonymous questions.

virtual ZRCSDKError	IsAllowViewAllQuestions (bool &isAllow)=0
	Query if allow view all questions.

virtual ZRCSDKError	IsAllowUpvote (bool &isAllow)=0
	Query if allow upvote.

virtual ZRCSDKError	IsAllowComment (bool &isAllow)=0
	Query if allow comment.

virtual ZRCSDKError	IsShowOnZR (bool &isShow)=0
	Query if Q&A UI shown on ZR.

Detailed Description

Waiting Room helper interface.

Definition at line 186 of file IMeetingQAHelper.h.

Constructor & Destructor Documentation

◆ ~IMeetingQAHelper()

virtual IMeetingQAHelper::~IMeetingQAHelper ( )

inlinevirtual

Definition at line 189 of file IMeetingQAHelper.h.

189{}

Member Function Documentation

◆ AllowAnonymousQuestions()

virtual ZRCSDKError IMeetingQAHelper::AllowAnonymousQuestions ( bool allow )

pure virtual

The host or co-host can call this API to allow submit questions anonymously.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

allow TRUE indicates allow submit questions anonymously.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ AllowComment()

virtual ZRCSDKError IMeetingQAHelper::AllowComment ( bool allow )

pure virtual

The host or co-host can call this API to allow comment.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

allow TRUE indicates allow comment.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ AllowSubmitQuestions()

virtual ZRCSDKError IMeetingQAHelper::AllowSubmitQuestions ( bool allow )

pure virtual

The host or co-host can call this API to allow submit questions.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

allow TRUE indicates allow submit questions.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ AllowUpvote()

virtual ZRCSDKError IMeetingQAHelper::AllowUpvote ( bool allow )

pure virtual

The host or co-host can call this API to allow upvote.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

allow TRUE indicates allow upvote.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ AllowViewAllQuestions()

virtual ZRCSDKError IMeetingQAHelper::AllowViewAllQuestions ( bool allow )

pure virtual

The host or co-host can call this API to allow view all questions.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

allow TRUE indicates allow view all questions.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ BecomeMainZRC()

virtual ZRCSDKError IMeetingQAHelper::BecomeMainZRC ( bool mainZRC )

pure virtual

Request to become main ZRC, only main ZRC can operate message. If quit Q&A UI, you should release main ZRC.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

mainZRC TRUE indicates become main ZRC.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ CreateAnswer()

virtual ZRCSDKError IMeetingQAHelper::CreateAnswer	(	const std::string &	context,
		const std::string &	questionID,
		bool	isPrivate
	)

pure virtual

The host / co-host or panelist can call this API to create answer.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

context	the answer content.
questionID	indicates answer which question.
isPrivate	TRUE indicates the answer is private.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ CreateComment()

virtual ZRCSDKError IMeetingQAHelper::CreateComment	(	const std::string &	context,
		const std::string &	questionID
	)

pure virtual

The attendee can call this API to create comment.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

context	the comment content.
questionID	indicates comment which question.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ CreateQuestion()

virtual ZRCSDKError IMeetingQAHelper::CreateQuestion	(	const std::string &	context,
		bool	isAnonymous
	)

pure virtual

The attendee can call this API to create question.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

context	the question content.
isAnonymous	TRUE indicates the question is anonymous.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ DeleteMessage()

virtual ZRCSDKError IMeetingQAHelper::DeleteMessage ( const std::string & messageID )

pure virtual

The host or co-host can call this API to delete message.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

messageID the message ID.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ DeregisterSink()

virtual ZRCSDKError IMeetingQAHelper::DeregisterSink ( IMeetingQAHelperSink * pSink )

pure virtual

Deregister waiting room helper callback sink.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

pSink A pointer to the IMeetingQAHelperSink that receives the waiting room helper callback.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ DismissQuestion()

virtual ZRCSDKError IMeetingQAHelper::DismissQuestion ( const std::string & messageID )

pure virtual

The host or co-host can call this API to dismiss question.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

messageID the message ID.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ EnableMeetingQA()

virtual ZRCSDKError IMeetingQAHelper::EnableMeetingQA ( bool enable )

pure virtual

The host or co-host can call this API to enable Q&A feature.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

enable TRUE indicates enable Q&A feature.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ GetAllMessages()

virtual ZRCSDKError IMeetingQAHelper::GetAllMessages ( std::vector< MeetingQAMessage > & messages )

pure virtual

Get all messages.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

[out] messages contains questions and answers.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ IsAllowAnonymousQuestions()

virtual ZRCSDKError IMeetingQAHelper::IsAllowAnonymousQuestions ( bool & isAllow )

pure virtual

Query if allow anonymous questions.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

[out] isAllow TRUE indicates allow anonymous questions.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ IsAllowComment()

virtual ZRCSDKError IMeetingQAHelper::IsAllowComment ( bool & isAllow )

pure virtual

Query if allow comment.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

[out] isAllow TRUE indicates allow comment.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ IsAllowSubmitQuestions()

virtual ZRCSDKError IMeetingQAHelper::IsAllowSubmitQuestions ( bool & isAllow )

pure virtual

Query if allow submit questions.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

[out] isAllow TRUE indicates allow submit questions.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ IsAllowUpvote()

virtual ZRCSDKError IMeetingQAHelper::IsAllowUpvote ( bool & isAllow )

pure virtual

Query if allow upvote.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

[out] isAllow TRUE indicates allow upvote.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ IsAllowViewAllQuestions()

virtual ZRCSDKError IMeetingQAHelper::IsAllowViewAllQuestions ( bool & isAllow )

pure virtual

Query if allow view all questions.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

[out] isAllow TRUE indicates allow view all questions.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ IsMainZRC()

virtual ZRCSDKError IMeetingQAHelper::IsMainZRC ( bool & isMainZRC )

pure virtual

Query if is main ZRC.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

[out] isMainZRC TRUE indicates is main ZRC.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ IsMeetingQAEnabled()

virtual ZRCSDKError IMeetingQAHelper::IsMeetingQAEnabled ( bool & isEnabled )

pure virtual

Query if meeting Q&A feature enabled.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

[out] isEnabled TRUE indicates meeting Q&A feature enabled.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ IsShowOnZR()

virtual ZRCSDKError IMeetingQAHelper::IsShowOnZR ( bool & isShow )

pure virtual

Query if Q&A UI shown on ZR.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

[out] isShow TRUE indicates Q&A UI shown on ZR.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ RegisterSink()

virtual ZRCSDKError IMeetingQAHelper::RegisterSink ( IMeetingQAHelperSink * pSink )

pure virtual

Register waiting room helper callback sink.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

pSink A pointer to the IMeetingQAHelperSink that receives the waiting room helper callback.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ ReopenQuestion()

virtual ZRCSDKError IMeetingQAHelper::ReopenQuestion ( const std::string & messageID )

pure virtual

The host or co-host can call this API to reopen question.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

messageID the message ID.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ RevokeUpvoteQuestion()

virtual ZRCSDKError IMeetingQAHelper::RevokeUpvoteQuestion ( const std::string & messageID )

pure virtual

The participant can call this API to revoke upvote question.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

messageID the message ID.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ ShowOnZR()

virtual ZRCSDKError IMeetingQAHelper::ShowOnZR ( bool show )

pure virtual

The main ZRC can call this API to show Q&A UI on ZR.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

show	TRUE indicates show Q&A UI on ZR.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ StartComposing()

virtual ZRCSDKError IMeetingQAHelper::StartComposing ( const std::string & messageID )

pure virtual

The host / co-host or panelist can call this API to start composing answer.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

messageID the message ID.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ StartLiving()

virtual ZRCSDKError IMeetingQAHelper::StartLiving ( const std::string & messageID )

pure virtual

The host / co-host or panelist can call this API to start living answer.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

messageID the message ID.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ StopComposing()

virtual ZRCSDKError IMeetingQAHelper::StopComposing ( const std::string & messageID )

pure virtual

The host / co-host or panelist can call this API to stop composing answer.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

messageID the message ID.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ StopLiving()

virtual ZRCSDKError IMeetingQAHelper::StopLiving ( const std::string & messageID )

pure virtual

The host / co-host or panelist can call this API to stop living answer.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

messageID the message ID.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ UpvoteQuestion()

virtual ZRCSDKError IMeetingQAHelper::UpvoteQuestion ( const std::string & messageID )

pure virtual

The participant can call this API to upvote question.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

messageID the message ID.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IMeetingQAHelper()

Member Function Documentation

◆ AllowAnonymousQuestions()

◆ AllowComment()

◆ AllowSubmitQuestions()

◆ AllowUpvote()

◆ AllowViewAllQuestions()

◆ BecomeMainZRC()

◆ CreateAnswer()

◆ CreateComment()

◆ CreateQuestion()

◆ DeleteMessage()

◆ DeregisterSink()

◆ DismissQuestion()

◆ EnableMeetingQA()

◆ GetAllMessages()

◆ IsAllowAnonymousQuestions()

◆ IsAllowComment()

◆ IsAllowSubmitQuestions()

◆ IsAllowUpvote()

◆ IsAllowViewAllQuestions()

◆ IsMainZRC()

◆ IsMeetingQAEnabled()

◆ IsShowOnZR()

◆ RegisterSink()

◆ ReopenQuestion()

◆ RevokeUpvoteQuestion()

◆ ShowOnZR()

◆ StartComposing()

◆ StartLiving()

◆ StopComposing()

◆ StopLiving()

◆ UpvoteQuestion()