Meeting Chat helper event callback. More...

#include <IMeetingChatHelper.h>

Public Member Functions
virtual	~IMeetingChatHelperSink ()

virtual void	OnChatDisplaySettingsNotification (bool isShowChatNotificationOnZR, bool isShowChatListOnZR)=0
	Chat display settings notification.

virtual void	OnMeetingChatPrivilegeNotification (const MeetingChatPrivilege &chatPrivilege)=0
	Meeting chat privilege notification.

virtual void	OnChatMessageResponse (int32_t result, int32_t action)=0
	Chat message response.

virtual void	OnMeetingChatMessagesNotification (const std::vector< MeetingChatMessage > &messages)=0
	Meeting chat messages notification.

virtual void	OnUpdateCMCInfo (bool isCMCForBackendEnabled, bool isTeamChatEnabled)=0
	CMC info update notification.

virtual void	OnUpdateCMCTip (bool needConfirm, const std::string &title, const std::string &message)=0
	CMC tip info update notification.

virtual void	OnIsReadyForLoadMessageChanged ()=0
	Ready to load message changes notification.

virtual void	OnThreadReceived (const NewMeetingChatMessage &thread)=0
	Thread received notification.

virtual void	OnCommentReceived (const NewMeetingChatMessage &comment, const NewMeetingChatMessage &updatedThread)=0
	Comment received notification.

virtual void	OnThreadSent (const NewMeetingChatMessage &thread)=0
	Thread sent notification.

virtual void	OnCommentSent (const NewMeetingChatMessage &comment, const NewMeetingChatMessage &updatedThread)=0
	Comment sent notification.

virtual void	OnThreadDeleted (const NewMeetingChatMessage &thread)=0
	Thread deleted notification.

virtual void	OnCommentDeleted (const NewMeetingChatMessage &comment, const NewMeetingChatMessage &updatedThread)=0
	Comment deleted notification.

virtual void	OnMessagesUpdated (const std::vector< NewMeetingChatMessage > &messages)=0
	Messages updated notification.

virtual void	OnEmojiUpdated (const std::vector< NewMeetingChatMessage > &messages)=0
	Emoji updated notification.

virtual void	OnMessageLoaded (const ChatMessageSyncFilter &filter, bool result, const std::vector< NewMeetingChatMessage > &messages, bool hasMoreHistory, bool hasMoreRecent)=0
	Message loaded notification.

virtual void	OnEmojiDetail (const std::string &messageID, const std::string &emojiCode, bool isFirstPage, bool isLastPage, const std::vector< ChatEmojiComment > &emojiSenders)=0
	Emoji updated notification.

virtual void	OnSendMessageFailed ()=0
	Send message failed notification.

Detailed Description

Meeting Chat helper event callback.

Definition at line 244 of file IMeetingChatHelper.h.

Constructor & Destructor Documentation

◆ ~IMeetingChatHelperSink()

virtual IMeetingChatHelperSink::~IMeetingChatHelperSink ( )

inlinevirtual

Definition at line 247 of file IMeetingChatHelper.h.

247{}

Member Function Documentation

◆ OnChatDisplaySettingsNotification()

virtual void IMeetingChatHelperSink::OnChatDisplaySettingsNotification	(	bool	isShowChatNotificationOnZR,
		bool	isShowChatListOnZR
	)

pure virtual

Chat display settings notification.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

isShowChatNotificationOnZR	TRUE indicates show chat notification on ZR. Otherwise not.
isShowChatListOnZR	TRUE indicates show chat list on ZR. Otherwise not.

◆ OnChatMessageResponse()

virtual void IMeetingChatHelperSink::OnChatMessageResponse	(	int32_t	result,
		int32_t	action
	)

pure virtual

Chat message response.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

result	[0] success. Otherwise failed.
action	[0] Fetch, [1] Delete, [2] Send.

◆ OnCommentDeleted()

virtual void IMeetingChatHelperSink::OnCommentDeleted	(	const NewMeetingChatMessage &	comment,
		const NewMeetingChatMessage &	updatedThread
	)

pure virtual

Comment deleted notification.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

comment	Deleted comment message.
updatedThread	Comment update triggers its thread update.

◆ OnCommentReceived()

virtual void IMeetingChatHelperSink::OnCommentReceived	(	const NewMeetingChatMessage &	comment,
		const NewMeetingChatMessage &	updatedThread
	)

pure virtual

Comment received notification.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

comment	Comment message.
updatedThread	Comment update triggers its thread update.

◆ OnCommentSent()

virtual void IMeetingChatHelperSink::OnCommentSent	(	const NewMeetingChatMessage &	comment,
		const NewMeetingChatMessage &	updatedThread
	)

pure virtual

Comment sent notification.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

comment	Sent comment message
updatedThread	Comment update triggers its thread update.

◆ OnEmojiDetail()

virtual void IMeetingChatHelperSink::OnEmojiDetail	(	const std::string &	messageID,
		const std::string &	emojiCode,
		bool	isFirstPage,
		bool	isLastPage,
		const std::vector< ChatEmojiComment > &	emojiSenders
	)

pure virtual

Emoji updated notification.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

messageID	Messages ID.
emojiCode	Emoji code.
isFirstPage	TRUE indicates is the first page.
isLastPage	TRUE indicates is the last page.
emojiSenders	Emoji senders' info.

◆ OnEmojiUpdated()

virtual void IMeetingChatHelperSink::OnEmojiUpdated ( const std::vector< NewMeetingChatMessage > & messages )

pure virtual

Emoji updated notification.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

messages Messages list.

◆ OnIsReadyForLoadMessageChanged()

virtual void IMeetingChatHelperSink::OnIsReadyForLoadMessageChanged ( )

pure virtual

Ready to load message changes notification.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

◆ OnMeetingChatMessagesNotification()

virtual void IMeetingChatHelperSink::OnMeetingChatMessagesNotification ( const std::vector< MeetingChatMessage > & messages )

pure virtual

Meeting chat messages notification.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

messages Meeting chat messages.

◆ OnMeetingChatPrivilegeNotification()

virtual void IMeetingChatHelperSink::OnMeetingChatPrivilegeNotification ( const MeetingChatPrivilege & chatPrivilege )

pure virtual

Meeting chat privilege notification.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

chatPrivilege Meeting chat privilege info.

◆ OnMessageLoaded()

virtual void IMeetingChatHelperSink::OnMessageLoaded	(	const ChatMessageSyncFilter &	filter,
		bool	result,
		const std::vector< NewMeetingChatMessage > &	messages,
		bool	hasMoreHistory,
		bool	hasMoreRecent
	)

pure virtual

Message loaded notification.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

filter	Message sync filter.
result	TRUE indicates success.
messages	Loaded messages.
hasMoreHistory	TRUE indicates has more history messages.
hasMoreRecent	TRUE indicates has more recent messages.

◆ OnMessagesUpdated()

virtual void IMeetingChatHelperSink::OnMessagesUpdated ( const std::vector< NewMeetingChatMessage > & messages )

pure virtual

Messages updated notification.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

messages Messages list.

◆ OnSendMessageFailed()

virtual void IMeetingChatHelperSink::OnSendMessageFailed ( )

pure virtual

Send message failed notification.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

◆ OnThreadDeleted()

virtual void IMeetingChatHelperSink::OnThreadDeleted ( const NewMeetingChatMessage & thread )

pure virtual

Thread deleted notification.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

thread Deleted thread message.

◆ OnThreadReceived()

virtual void IMeetingChatHelperSink::OnThreadReceived ( const NewMeetingChatMessage & thread )

pure virtual

Thread received notification.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

thread Thread message.

◆ OnThreadSent()

virtual void IMeetingChatHelperSink::OnThreadSent ( const NewMeetingChatMessage & thread )

pure virtual

Thread sent notification.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

thread Sent thread message.

◆ OnUpdateCMCInfo()

virtual void IMeetingChatHelperSink::OnUpdateCMCInfo	(	bool	isCMCForBackendEnabled,
		bool	isTeamChatEnabled
	)

pure virtual

CMC info update notification.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

isCMCForBackendEnabled	TRUE indicates CMC for backend enabled.
isTeamChatEnabled	TRUE indicates team chat enabled.

◆ OnUpdateCMCTip()

virtual void IMeetingChatHelperSink::OnUpdateCMCTip	(	bool	needConfirm,
		const std::string &	title,
		const std::string &	message
	)

pure virtual

CMC tip info update notification.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

PRIVACY NOTE: Every first time in a meeting, you should always check the CMC tip before send chat. You cannot send chat if CMC tip is required but not confirmed.

Parameters

needConfirm	TRUE indicates need to confirm CMC tip.
title	Suggest title for the CMC tip.
message	Suggest message for the CMC tip.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IMeetingChatHelperSink()

Member Function Documentation

◆ OnChatDisplaySettingsNotification()

◆ OnChatMessageResponse()

◆ OnCommentDeleted()

◆ OnCommentReceived()

◆ OnCommentSent()

◆ OnEmojiDetail()

◆ OnEmojiUpdated()

◆ OnIsReadyForLoadMessageChanged()

◆ OnMeetingChatMessagesNotification()

◆ OnMeetingChatPrivilegeNotification()

◆ OnMessageLoaded()

◆ OnMessagesUpdated()

◆ OnSendMessageFailed()

◆ OnThreadDeleted()

◆ OnThreadReceived()

◆ OnThreadSent()

◆ OnUpdateCMCInfo()

◆ OnUpdateCMCTip()