Meeting Service event callback. More...

#include <IMeetingService.h>

Public Member Functions
virtual	~IMeetingServiceSink ()

virtual void	OnStartMeetingResult (int32_t result)=0
	Start meeting response callback.

virtual void	OnStartPmiResult (int32_t result, const std::string &meetingNumber, MeetingType meetingType)=0
	Start PMI meeting response callback, PMI meeting includes instant meeting, pstn callout, room system call.

virtual void	OnStartPmiNotification (bool success)=0
	Start PMI meeting notification callback.

virtual void	OnUpdateMeetingStatus (MeetingStatus meetingStatus)=0
	Meeting status changed callback.

virtual void	OnConfReadyNotification ()=0
	Notification of meeting is ready.

virtual void	OnUpdateMeetingInfoNotification (const MeetingInfo &meetingInfo)=0
	Update meeting info notification.

virtual void	OnExitMeetingNotification (int32_t result, ExitMeetingReason reason)=0
	Exit meeting event callback.

virtual void	OnMeetingErrorNotification (const MeetingErrorInfo &errorInfo)=0
	Meeting occurs error notification.

virtual void	OnMeetingEndedNotification (const MeetingErrorInfo &errorInfo)=0
	Meeting has been ended notification.

virtual void	OnReceiveMeetingInviteNotification (const MeetingInvitationInfo &invitation)=0
	Receive meeting invite notification.

virtual void	OnAnswerMeetingInviteResponse (int32_t result, const MeetingInvitationInfo &invitation, bool accepted)=0
	Answer meeting invite response.

virtual void	OnTreatedMeetingInviteNotification (const MeetingInvitationInfo &invitation, bool accepted)=0
	Treated meeting invite notification.

virtual void	OnStartMeetingWithHostKeyResult (int32_t result)=0
	Start meeting with host key result.

virtual void	OnUpdateDataCenterRegionNotification (const DataCenterRegion &dcRegion)=0
	Data center region info notification.

virtual void	OnUpdateE2ESecurityCode (const E2ESecurityCode &code)=0
	End-to-end security code update.

virtual void	OnBandwidthLimitNotification (const BandwidthLimitInfo &info)=0
	Bandwidth limit notification.

virtual void	OnSendMeetingInviteEmailNotification (int32_t result)=0
	Send meeting invite email result notification.

virtual void	OnSetRoomTempDisplayNameNotification (bool isShow)=0
	Set room temp display name notification.

virtual void	OnMeetingNeedsPasswordNotification (bool showPasswordDialog, bool wrongAndRetry, const ConfDeviceLockStatus &lockStatus)=0
	Meeting need password notification.

virtual void	OnConfDeviceLockStatusNotification (const ConfDeviceLockStatus &status)=0
	Device lock status from joining meeting notification.

virtual void	OnJBHWaitingHostNotification (bool showWaitForHostDialog, WaitingHostReason reason)=0
	Join before host notification.

virtual void	OnE2eeMeetingStatusNotification (const E2eeMeetingStatus &e2eeMeetingStatus)=0
	E2EE Meeting Info notification.

virtual void	OnMeshInfoNotification (const MeshInfoNotification &meshInfo)=0
	Mesh Info notification.

virtual void	OnMeetingWillStopAutomatically ()=0
	Meeting will automatically stop after 10 minutes.

virtual void	OnExtendMeetingResult (int32_t extendMins)=0
	Extend meeting result.

virtual void	OnConfirmPersonalLink (const std::string &personalLink)=0
	Callback to confirm personal link for joining meeting.

Detailed Description

Meeting Service event callback.

Definition at line 133 of file IMeetingService.h.

Constructor & Destructor Documentation

◆ ~IMeetingServiceSink()

virtual IMeetingServiceSink::~IMeetingServiceSink ( )

inlinevirtual

Definition at line 136 of file IMeetingService.h.

136{}

Member Function Documentation

◆ OnAnswerMeetingInviteResponse()

virtual void IMeetingServiceSink::OnAnswerMeetingInviteResponse	(	int32_t	result,
		const MeetingInvitationInfo &	invitation,
		bool	accepted
	)

pure virtual

Answer meeting invite response.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

result	[0] success.
invitation	Meeting invitation info.
accepted	TRUE indicates meeting invite has been accepted.

◆ OnBandwidthLimitNotification()

virtual void IMeetingServiceSink::OnBandwidthLimitNotification ( const BandwidthLimitInfo & info )

pure virtual

Bandwidth limit notification.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

info	Bandwidth limit info.

◆ OnConfDeviceLockStatusNotification()

virtual void IMeetingServiceSink::OnConfDeviceLockStatusNotification ( const ConfDeviceLockStatus & status )

pure virtual

Device lock status from joining meeting notification.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

status Device lock status from joining meeting.

◆ OnConfirmPersonalLink()

virtual void IMeetingServiceSink::OnConfirmPersonalLink ( const std::string & personalLink )

pure virtual

Callback to confirm personal link for joining meeting.

Since: 6.7.0

Zoom Rooms minimum version: 6.7.0

This notification is triggered when need to confirm which personal link to use for joining the meeting.

After receiving this callback, use one of the following methods:

JoinMeetingWithPersonalLink() to confirm joining with the personal link
JoinMeetingWithMeetingNumber() to join using meeting number instead
CancelConfirmPersonalLink() to cancel the confirmation flow

Personal link resolution behavior:

If personal link name exists only in current account (not globally): joins meeting directly, no callback.
If personal link name exists only globally (not in current account): personalLink is empty.
If personal link name exists in both current account and globally: personalLink is the complete personal link in current account.

Parameters

personalLink The personal link to confirm.

◆ OnConfReadyNotification()

virtual void IMeetingServiceSink::OnConfReadyNotification ( )

pure virtual

Notification of meeting is ready.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

◆ OnE2eeMeetingStatusNotification()

virtual void IMeetingServiceSink::OnE2eeMeetingStatusNotification ( const E2eeMeetingStatus & e2eeMeetingStatus )

pure virtual

E2EE Meeting Info notification.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

e2eeMeetingStatus e2ee meeting status.

◆ OnExitMeetingNotification()

virtual void IMeetingServiceSink::OnExitMeetingNotification	(	int32_t	result,
		ExitMeetingReason	reason
	)

pure virtual

Exit meeting event callback.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

result	Exit meeting result, [0] for success.
reason	Exit meeting reason, see ExitMeetingReason enum.

◆ OnExtendMeetingResult()

virtual void IMeetingServiceSink::OnExtendMeetingResult ( int32_t extendMins )

pure virtual

Extend meeting result.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

extendMins Minutes extended for the meeting

◆ OnJBHWaitingHostNotification()

virtual void IMeetingServiceSink::OnJBHWaitingHostNotification	(	bool	showWaitForHostDialog,
		WaitingHostReason	reason
	)

pure virtual

Join before host notification.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

showWaitForHostDialog	TRUE indicates to need wait for host while joining before host.
reason	Waiting host reason, see WaitingHostReason enum.

◆ OnMeetingEndedNotification()

virtual void IMeetingServiceSink::OnMeetingEndedNotification ( const MeetingErrorInfo & errorInfo )

pure virtual

Meeting has been ended notification.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

errorInfo Meeting error info.

◆ OnMeetingErrorNotification()

virtual void IMeetingServiceSink::OnMeetingErrorNotification ( const MeetingErrorInfo & errorInfo )

pure virtual

Meeting occurs error notification.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

errorInfo Meeting error info.

◆ OnMeetingNeedsPasswordNotification()

virtual void IMeetingServiceSink::OnMeetingNeedsPasswordNotification	(	bool	showPasswordDialog,
		bool	wrongAndRetry,
		const ConfDeviceLockStatus &	lockStatus
	)

pure virtual

Meeting need password notification.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

showPasswordDialog	TRUE indicates meeting needs password.
wrongAndRetry	TRUE indicates last input password is wrong.
lockStatus	Conf device lock status.

◆ OnMeetingWillStopAutomatically()

virtual void IMeetingServiceSink::OnMeetingWillStopAutomatically ( )

pure virtual

Meeting will automatically stop after 10 minutes.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

◆ OnMeshInfoNotification()

virtual void IMeetingServiceSink::OnMeshInfoNotification ( const MeshInfoNotification & meshInfo )

pure virtual

Mesh Info notification.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

meshInfo mesh information.

◆ OnReceiveMeetingInviteNotification()

virtual void IMeetingServiceSink::OnReceiveMeetingInviteNotification ( const MeetingInvitationInfo & invitation )

pure virtual

Receive meeting invite notification.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

invitation Meeting invitation info.

◆ OnSendMeetingInviteEmailNotification()

virtual void IMeetingServiceSink::OnSendMeetingInviteEmailNotification ( int32_t result )

pure virtual

Send meeting invite email result notification.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

result [0] Success. Otherwise Fail.

◆ OnSetRoomTempDisplayNameNotification()

virtual void IMeetingServiceSink::OnSetRoomTempDisplayNameNotification ( bool isShow )

pure virtual

Set room temp display name notification.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

isShow TRUE indicates set room temp display name is showing on ZR.

◆ OnStartMeetingResult()

virtual void IMeetingServiceSink::OnStartMeetingResult ( int32_t result )

pure virtual

Start meeting response callback.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

result Result of start meeting request.

◆ OnStartMeetingWithHostKeyResult()

virtual void IMeetingServiceSink::OnStartMeetingWithHostKeyResult ( int32_t result )

pure virtual

Start meeting with host key result.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

result [0] success.

◆ OnStartPmiNotification()

virtual void IMeetingServiceSink::OnStartPmiNotification ( bool success )

pure virtual

Start PMI meeting notification callback.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

success TRUE indicates start PMI successfully.

◆ OnStartPmiResult()

virtual void IMeetingServiceSink::OnStartPmiResult	(	int32_t	result,
		const std::string &	meetingNumber,
		MeetingType	meetingType
	)

pure virtual

Start PMI meeting response callback, PMI meeting includes instant meeting, pstn callout, room system call.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

result	Result of start PMI meeting request.
meetingNumber	Meeting number of start PMI meeting request.
meetingType	Meeting type of start PMI meeting request, see MeetingType enum.

◆ OnTreatedMeetingInviteNotification()

virtual void IMeetingServiceSink::OnTreatedMeetingInviteNotification	(	const MeetingInvitationInfo &	invitation,
		bool	accepted
	)

pure virtual

Treated meeting invite notification.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

invitation	Meeting invitation info.
accepted	TRUE indicates meeting invite has been accepted.

◆ OnUpdateDataCenterRegionNotification()

virtual void IMeetingServiceSink::OnUpdateDataCenterRegionNotification ( const DataCenterRegion & dcRegion )

pure virtual

Data center region info notification.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

dcRegion The data center region info.

◆ OnUpdateE2ESecurityCode()

virtual void IMeetingServiceSink::OnUpdateE2ESecurityCode ( const E2ESecurityCode & code )

pure virtual

End-to-end security code update.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

code	The E2E security code. If same with host's code means you are end-to-end encrypted with host.

◆ OnUpdateMeetingInfoNotification()

virtual void IMeetingServiceSink::OnUpdateMeetingInfoNotification ( const MeetingInfo & meetingInfo )

pure virtual

Update meeting info notification.

Since: 6.1.0

Zoom Rooms minimum version: 6.0.0

Parameters

meetingInfo The updated meeting info.

◆ OnUpdateMeetingStatus()

virtual void IMeetingServiceSink::OnUpdateMeetingStatus ( MeetingStatus meetingStatus )

pure virtual

Meeting status changed callback.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

meetingStatus Meeting status, see MeetingStatus enum.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IMeetingServiceSink()

Member Function Documentation

◆ OnAnswerMeetingInviteResponse()

◆ OnBandwidthLimitNotification()

◆ OnConfDeviceLockStatusNotification()

◆ OnConfirmPersonalLink()

◆ OnConfReadyNotification()

◆ OnE2eeMeetingStatusNotification()

◆ OnExitMeetingNotification()

◆ OnExtendMeetingResult()

◆ OnJBHWaitingHostNotification()

◆ OnMeetingEndedNotification()

◆ OnMeetingErrorNotification()

◆ OnMeetingNeedsPasswordNotification()

◆ OnMeetingWillStopAutomatically()

◆ OnMeshInfoNotification()

◆ OnReceiveMeetingInviteNotification()

◆ OnSendMeetingInviteEmailNotification()

◆ OnSetRoomTempDisplayNameNotification()

◆ OnStartMeetingResult()

◆ OnStartMeetingWithHostKeyResult()

◆ OnStartPmiNotification()

◆ OnStartPmiResult()

◆ OnTreatedMeetingInviteNotification()

◆ OnUpdateDataCenterRegionNotification()

◆ OnUpdateE2ESecurityCode()

◆ OnUpdateMeetingInfoNotification()

◆ OnUpdateMeetingStatus()