Meeting Chat helper interface. More...

#include <IMeetingChatHelper.h>

Public Member Functions
virtual	~IMeetingChatHelper ()

virtual ZRCSDKError	RegisterSink (IMeetingChatHelperSink *pSink)=0
	Register meeting chat helper callback sink.

virtual ZRCSDKError	DeregisterSink (IMeetingChatHelperSink *pSink)=0
	Deregister meeting chat helper callback sink.

virtual ZRCSDKError	IsNewChatExperience (bool &isNewChat)=0
	Query if new chat experience.

virtual ZRCSDKError	OpenChatPageOnZRC (bool open)=0
	Inform ZR that ZRC enters chat page.

virtual ZRCSDKError	ConfirmCMCTip ()=0
	Confirm CMC tip.

virtual ZRCSDKError	IsRequiredConfirmCMCTip (bool &required)=0
	Query if required to confirm CMC tip.

virtual ZRCSDKError	LoadThreadMessages ()=0
	Load more history thread messages. Start from the most history message, max size 20 one call.

virtual ZRCSDKError	LoadCommentMessages (const std::string &threadID)=0
	Load more history thread's comment messages. Start from the most history thread's comment message, max size 20 one call.

virtual ZRCSDKError	SendNewChatMessage (const std::string &threadID, int32_t receiverMeetingUserID, MeetingChatMSGSendToType chatMSGType, const std::string &text)=0
	Send new chat message.

virtual ZRCSDKError	DeleteNewChatMessage (const std::string &messageID)=0
	Delete new chat message.

virtual ZRCSDKError	EditNewChatMessage (const std::string &messageID, const std::string &text)=0
	Edit new chat message.

virtual ZRCSDKError	FetchNewChatEmojiDetail (const std::string &messageID, const std::string &emojiCode)=0
	Fetch new chat emoji detail.

virtual ZRCSDKError	IsOnlySelectedEmojisEnabled (bool &isOnlySelectedEmojisEnabled)=0
	Query if meeting chat only allows to react with selected emojis.

virtual ZRCSDKError	GetSelectedEmojisForReaction (std::string &selectedEmojis)=0
	Query allowed emojis to react to chat messages. Only needed when meeting chat only allows to react with selected emojis.

virtual ZRCSDKError	ReactNewChatEmoji (const std::string &messageID, bool add, const std::string &emojiCode)=0
	React new chat emoji.

virtual ZRCSDKError	IsReplyChatDisabled (bool &isReplyChatDisabled)=0
	Query if reply chat disabled.

virtual ZRCSDKError	IsEditMessageEnabled (bool &isEditMessageEnabled)=0
	Query if edit message enabled.

virtual ZRCSDKError	IsReactEmojiEnabled (bool &isReactEmojiEnabled)=0
	Query if react emoji enabled.

virtual ZRCSDKError	IsAllowHyperlinks (bool &isAllowHyperlinks)=0
	Query if allow hyper links.

virtual ZRCSDKError	IsReadyForLoadMessage (bool &isReadyForLoadMessage)=0
	Query if ready for load message.

virtual ZRCSDKError	GetNewMeetingChatMessageList (std::vector< NewMeetingChatThreadItem > &messages)=0
	Query loaded new meeting chat message list.

virtual ZRCSDKError	FetchChatMessages (int32_t start, int32_t count)=0
	Fetch chat message.

virtual ZRCSDKError	DeleteChatMessage (const std::string &messageID)=0
	Delete chat message.

virtual ZRCSDKError	SendChatMessage (int32_t receiverID, MeetingChatMSGSendToType type, const std::string &content)=0
	Send chat message.

virtual ZRCSDKError	GetOldMeetingChatMessages (std::vector< MeetingChatMessage > &messages)=0
	Query loaded old meeting chat message list.

virtual ZRCSDKError	GetWebinarChattedAttendees (std::vector< MeetingParticipant > &chattedAttendees)=0
	Query webinar chatted attendees, not include self.

virtual ZRCSDKError	ShowChatNotificationOnZR (bool show)=0
	Show chat notification on ZR.

virtual ZRCSDKError	ShowChatListOnZR (bool show)=0
	Show chat list on ZR.

virtual ZRCSDKError	SetChatPrivilege (MeetingChatPrivilegeType type)=0
	Update chat privilege for participants in normal meeting and attendees in webinar.

virtual ZRCSDKError	SetChatPanelistPrivilege (MeetingChatPanelistPrivilegeType type)=0
	Update Chat Panelist Privilege in webinar.

Detailed Description

Meeting Chat helper interface.

Definition at line 453 of file IMeetingChatHelper.h.

Constructor & Destructor Documentation

◆ ~IMeetingChatHelper()

virtual IMeetingChatHelper::~IMeetingChatHelper ( )

inlinevirtual

Definition at line 456 of file IMeetingChatHelper.h.

456{}

Member Function Documentation

◆ ConfirmCMCTip()

virtual ZRCSDKError IMeetingChatHelper::ConfirmCMCTip ( )

pure virtual

Confirm CMC tip.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

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

◆ DeleteChatMessage()

virtual ZRCSDKError IMeetingChatHelper::DeleteChatMessage ( const std::string & messageID )

pure virtual

Delete chat message.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

messageID Message ID

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

◆ DeleteNewChatMessage()

virtual ZRCSDKError IMeetingChatHelper::DeleteNewChatMessage ( const std::string & messageID )

pure virtual

Delete new chat message.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

messageID 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 IMeetingChatHelper::DeregisterSink ( IMeetingChatHelperSink * pSink )

pure virtual

Deregister meeting chat helper callback sink.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

pSink A pointer to the IMeetingChatHelperSink that receives the meeting chat helper callback.

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

◆ EditNewChatMessage()

virtual ZRCSDKError IMeetingChatHelper::EditNewChatMessage	(	const std::string &	messageID,
		const std::string &	text
	)

pure virtual

Edit new chat message.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

messageID	Message ID
text	The new message content.

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

◆ FetchChatMessages()

virtual ZRCSDKError IMeetingChatHelper::FetchChatMessages	(	int32_t	start,
		int32_t	count
	)

pure virtual

Fetch chat message.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

start	Fetch message start index.
count	Fetch message count. Suggest count 20.

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

◆ FetchNewChatEmojiDetail()

virtual ZRCSDKError IMeetingChatHelper::FetchNewChatEmojiDetail	(	const std::string &	messageID,
		const std::string &	emojiCode
	)

pure virtual

Fetch new chat emoji detail.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

messageID	Message ID
emojiCode	The emoji code.

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

◆ GetNewMeetingChatMessageList()

virtual ZRCSDKError IMeetingChatHelper::GetNewMeetingChatMessageList ( std::vector< NewMeetingChatThreadItem > & messages )

pure virtual

Query loaded new meeting chat message list.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

The messages are ordered by the thread's visibleTime which means the most recent changed message at bottom.

Parameters

[out] messages Current loaded new meeting chat messages.

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

◆ GetOldMeetingChatMessages()

virtual ZRCSDKError IMeetingChatHelper::GetOldMeetingChatMessages ( std::vector< MeetingChatMessage > & messages )

pure virtual

Query loaded old meeting chat message list.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Only include FetchChatMessages returned messages.

Parameters

[out] messages Current loaded old meeting chat messages, ordered by index.

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

◆ GetSelectedEmojisForReaction()

virtual ZRCSDKError IMeetingChatHelper::GetSelectedEmojisForReaction ( std::string & selectedEmojis )

pure virtual

Query allowed emojis to react to chat messages. Only needed when meeting chat only allows to react with selected emojis.

Since: 6.2.0

Zoom Rooms minimum version: 6.2.0

Parameters

[out] selectedEmojis The allowed emojis to react to chat messages, stored as a json style list.

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

◆ GetWebinarChattedAttendees()

virtual ZRCSDKError IMeetingChatHelper::GetWebinarChattedAttendees ( std::vector< MeetingParticipant > & chattedAttendees )

pure virtual

Query webinar chatted attendees, not include self.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Only include FetchChatMessages returned messages' involved attendees.

Parameters

[out] chattedAttendees Attendees that chatted in webinar. NOTE: use only userID and userName.

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

◆ IsAllowHyperlinks()

virtual ZRCSDKError IMeetingChatHelper::IsAllowHyperlinks ( bool & isAllowHyperlinks )

pure virtual

Query if allow hyper links.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

[out] isAllowHyperlinks TRUE indicates allow hyper links

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

◆ IsEditMessageEnabled()

virtual ZRCSDKError IMeetingChatHelper::IsEditMessageEnabled ( bool & isEditMessageEnabled )

pure virtual

Query if edit message enabled.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

[out] isEditMessageEnabled TRUE indicates edit message is enabled

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

◆ IsNewChatExperience()

virtual ZRCSDKError IMeetingChatHelper::IsNewChatExperience ( bool & isNewChat )

pure virtual

Query if new chat experience.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

[out] isNewChat TRUE indicates is new chat. Otherwise old chat.

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

◆ IsOnlySelectedEmojisEnabled()

virtual ZRCSDKError IMeetingChatHelper::IsOnlySelectedEmojisEnabled ( bool & isOnlySelectedEmojisEnabled )

pure virtual

Query if meeting chat only allows to react with selected emojis.

Since: 6.2.0

Zoom Rooms minimum version: 6.2.0

Parameters

[out] isOnlySelectedEmojisEnabled TRUE indicates only allow participants to react to chat messages with selected emojis. Otherwise all emojis are allowed.

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

◆ IsReactEmojiEnabled()

virtual ZRCSDKError IMeetingChatHelper::IsReactEmojiEnabled ( bool & isReactEmojiEnabled )

pure virtual

Query if react emoji enabled.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

[out] isReactEmojiEnabled TRUE indicates react emoji is enabled.

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

◆ IsReadyForLoadMessage()

virtual ZRCSDKError IMeetingChatHelper::IsReadyForLoadMessage ( bool & isReadyForLoadMessage )

pure virtual

Query if ready for load message.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

[out] isReadyForLoadMessage TRUE indicates is ready for load message.

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

◆ IsReplyChatDisabled()

virtual ZRCSDKError IMeetingChatHelper::IsReplyChatDisabled ( bool & isReplyChatDisabled )

pure virtual

Query if reply chat disabled.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

[out] isReplyChatDisabled TRUE indicates reply chat is disabled.

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

◆ IsRequiredConfirmCMCTip()

virtual ZRCSDKError IMeetingChatHelper::IsRequiredConfirmCMCTip ( bool & required )

pure virtual

Query if required to confirm CMC tip.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

If you are required to confirm cmc tip but haven't ConfirmCMCTip, calls to New chat APIs will fail.

Parameters

[out] required TRUE indicates is required to confirm.

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

◆ LoadCommentMessages()

virtual ZRCSDKError IMeetingChatHelper::LoadCommentMessages ( const std::string & threadID )

pure virtual

Load more history thread's comment messages. Start from the most history thread's comment message, max size 20 one call.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

threadID Specify the thread ID

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

◆ LoadThreadMessages()

virtual ZRCSDKError IMeetingChatHelper::LoadThreadMessages ( )

pure virtual

Load more history thread messages. Start from the most history message, max size 20 one call.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

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

◆ OpenChatPageOnZRC()

virtual ZRCSDKError IMeetingChatHelper::OpenChatPageOnZRC ( bool open )

pure virtual

Inform ZR that ZRC enters chat page.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

open	TRUE indicates enter chat page.

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

◆ ReactNewChatEmoji()

virtual ZRCSDKError IMeetingChatHelper::ReactNewChatEmoji	(	const std::string &	messageID,
		bool	add,
		const std::string &	emojiCode
	)

pure virtual

React new chat emoji.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

messageID	Message ID
add	TRUE indicates add emoji. Otherwise revoke emoji.
emojiCode	The emoji code.

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

◆ RegisterSink()

virtual ZRCSDKError IMeetingChatHelper::RegisterSink ( IMeetingChatHelperSink * pSink )

pure virtual

Register meeting chat helper callback sink.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

pSink A pointer to the IMeetingChatHelperSink that receives the meeting chat helper callback.

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

◆ SendChatMessage()

virtual ZRCSDKError IMeetingChatHelper::SendChatMessage	(	int32_t	receiverID,
		MeetingChatMSGSendToType	type,
		const std::string &	content
	)

pure virtual

Send chat message.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

receiverID	Receiver ID, used when type is MeetingChatMSGSendToTypeToIndividualCcPanelist or MeetingChatMSGSendToTypeToIndividual.
type	Send message to type, see MeetingChatMSGSendToType enum.
content	Send message content.

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

◆ SendNewChatMessage()

virtual ZRCSDKError IMeetingChatHelper::SendNewChatMessage	(	const std::string &	threadID,
		int32_t	receiverMeetingUserID,
		MeetingChatMSGSendToType	chatMSGType,
		const std::string &	text
	)

pure virtual

Send new chat message.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

threadID	Specify the thread ID if this is a comment. A comment's chatMSGType should be the same as thread's chatMSGType.
receiverMeetingUserID	Specify the receiver meeting user ID if chatMSGType is MeetingChatMSGSendToTypeToIndividual.
chatMSGType	Send to type, see MeetingChatMSGSendToType enum.
text	Send message content.

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

◆ SetChatPanelistPrivilege()

virtual ZRCSDKError IMeetingChatHelper::SetChatPanelistPrivilege ( MeetingChatPanelistPrivilegeType type )

pure virtual

Update Chat Panelist Privilege in webinar.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

type	The meeting chat panelist privilege type, such as MeetingChatPanelistPrivilegeType enum.

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

◆ SetChatPrivilege()

virtual ZRCSDKError IMeetingChatHelper::SetChatPrivilege ( MeetingChatPrivilegeType type )

pure virtual

Update chat privilege for participants in normal meeting and attendees in webinar.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

type	The meeting chat privilege type, such as MeetingChatPrivilegeType enum.

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

◆ ShowChatListOnZR()

virtual ZRCSDKError IMeetingChatHelper::ShowChatListOnZR ( bool show )

pure virtual

Show chat list on ZR.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

show	TRUE indicates show chat list on ZR.

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

◆ ShowChatNotificationOnZR()

virtual ZRCSDKError IMeetingChatHelper::ShowChatNotificationOnZR ( bool show )

pure virtual

Show chat notification on ZR.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

show	TRUE indicates show chat notification on ZR

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

◆ ~IMeetingChatHelper()

Member Function Documentation

◆ ConfirmCMCTip()

◆ DeleteChatMessage()

◆ DeleteNewChatMessage()

◆ DeregisterSink()

◆ EditNewChatMessage()

◆ FetchChatMessages()

◆ FetchNewChatEmojiDetail()

◆ GetNewMeetingChatMessageList()

◆ GetOldMeetingChatMessages()

◆ GetSelectedEmojisForReaction()

◆ GetWebinarChattedAttendees()

◆ IsAllowHyperlinks()

◆ IsEditMessageEnabled()

◆ IsNewChatExperience()

◆ IsOnlySelectedEmojisEnabled()

◆ IsReactEmojiEnabled()

◆ IsReadyForLoadMessage()

◆ IsReplyChatDisabled()

◆ IsRequiredConfirmCMCTip()

◆ LoadCommentMessages()

◆ LoadThreadMessages()

◆ OpenChatPageOnZRC()

◆ ReactNewChatEmoji()

◆ RegisterSink()

◆ SendChatMessage()

◆ SendNewChatMessage()

◆ SetChatPanelistPrivilege()

◆ SetChatPrivilege()

◆ ShowChatListOnZR()

◆ ShowChatNotificationOnZR()