Zoom Rooms Controller SDK Reference 6.5.0
Loading...
Searching...
No Matches
Public Member Functions
IMeetingListHelper Class Referenceabstract

Meeting List helper interface. More...

#include <IMeetingListHelper.h>

Public Member Functions

virtual ~IMeetingListHelper ()
 
virtual ZRCSDKError RegisterSink (IMeetingListHelperSink *pSink)=0
 Register meeting list helper callback sink.
 
virtual ZRCSDKError DeregisterSink (IMeetingListHelperSink *pSink)=0
 Deregister meeting list helper callback sink.
 
virtual ZRCSDKError ListMeeting ()=0
 List all the meetings from current Zoom Room configured calendar.
 
virtual ZRCSDKError ScheduleCalendarEvent (ScheduleCalendarEventParam scheduleParam)=0
 Schedule a calendar event into current Zoom Room configured calendar.
 
virtual ZRCSDKError DeleteCalendarEvent (const MeetingItem &meetingItem)=0
 Delete the calendar event from current Zoom Room configured calendar.
 
virtual ZRCSDKError CheckInCalendarEvent (const MeetingItem &meetingItem)=0
 Check in the calendar event.
 
virtual ZRCSDKError CheckOutCalendarEvent (const MeetingItem &meetingItem)=0
 Check out the calendar event.
 
virtual ZRCSDKError ShowUpcomingMeetingAlert (const MeetingItem &meetingItem)=0
 Show current upcoming meeting alert.
 
virtual ZRCSDKError CloseUpcomingMeetingAlert ()=0
 Close current upcoming meeting alert.
 
virtual ZRCSDKError CloseAutoReleaseMeetingAlert ()=0
 Close auto release meeting alert.
 

Detailed Description

Meeting List helper interface.

Definition at line 99 of file IMeetingListHelper.h.

Constructor & Destructor Documentation

◆ ~IMeetingListHelper()

virtual IMeetingListHelper::~IMeetingListHelper ( )
inlinevirtual

Definition at line 102 of file IMeetingListHelper.h.

102{}

Member Function Documentation

◆ CheckInCalendarEvent()

virtual ZRCSDKError IMeetingListHelper::CheckInCalendarEvent ( const MeetingItem &  meetingItem)
pure virtual

Check in the calendar event.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
meetingItemThe assigned meeting item to be checked in.
Returns
If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ CheckOutCalendarEvent()

virtual ZRCSDKError IMeetingListHelper::CheckOutCalendarEvent ( const MeetingItem &  meetingItem)
pure virtual

Check out the calendar event.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
meetingItemThe assigned meeting item to be checked out.
Returns
If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ CloseAutoReleaseMeetingAlert()

virtual ZRCSDKError IMeetingListHelper::CloseAutoReleaseMeetingAlert ( )
pure virtual

Close auto release meeting alert.

Since
6.2.0
Zoom Rooms minimum version
6.1.5
Returns
If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ CloseUpcomingMeetingAlert()

virtual ZRCSDKError IMeetingListHelper::CloseUpcomingMeetingAlert ( )
pure virtual

Close current upcoming meeting alert.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Returns
If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ DeleteCalendarEvent()

virtual ZRCSDKError IMeetingListHelper::DeleteCalendarEvent ( const MeetingItem &  meetingItem)
pure virtual

Delete the calendar event from current Zoom Room configured calendar.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
meetingItemThe assigned meeting item to be deleted.
Returns
If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ DeregisterSink()

virtual ZRCSDKError IMeetingListHelper::DeregisterSink ( IMeetingListHelperSink *  pSink)
pure virtual

Deregister meeting list helper callback sink.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
pSinkA pointer to the IMeetingListHelperSink that receives the meeting list helper callback.
Returns
If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ ListMeeting()

virtual ZRCSDKError IMeetingListHelper::ListMeeting ( )
pure virtual

List all the meetings from current Zoom Room configured calendar.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Returns
If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ RegisterSink()

virtual ZRCSDKError IMeetingListHelper::RegisterSink ( IMeetingListHelperSink *  pSink)
pure virtual

Register meeting list helper callback sink.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
pSinkA pointer to the IMeetingListHelperSink that receives the meeting list helper callback.
Returns
If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ ScheduleCalendarEvent()

virtual ZRCSDKError IMeetingListHelper::ScheduleCalendarEvent ( ScheduleCalendarEventParam  scheduleParam)
pure virtual

Schedule a calendar event into current Zoom Room configured calendar.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
scheduleParamSchedule calendar event param, specify the event information.
Returns
If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ ShowUpcomingMeetingAlert()

virtual ZRCSDKError IMeetingListHelper::ShowUpcomingMeetingAlert ( const MeetingItem &  meetingItem)
pure virtual

Show current upcoming meeting alert.

Since
6.0.0
Zoom Rooms minimum version
6.0.0
Parameters
meetingItemSpecify the meeting item
Returns
If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.