Pre-meeting service interface. More...

#include <premeeting_service_interface.h>

Public Member Functions
virtual IScheduleMeetingItem *	CreateScheduleMeetingItem ()=0
	Create an item to schedule meeting. More...

virtual void	DestoryScheduleMeetingItem (IScheduleMeetingItem *pMeeting)=0
	Destroy the item of scheduling meeting created via CreateScheduleMeetingItem(). More...

virtual IScheduleMeetingItem *	CreateEditMeetingItem (UINT64 meetingUniqueID)=0

virtual void	DestoryEditMeetingItem (IScheduleMeetingItem *pMeeting)=0
	Destroy the item of editing meeting created via CreateEditMeetingItem(). More...

virtual SDKError	SetEvent (IPreMeetingServiceEvent *pEvent)=0
	Set pre-meeting service event. More...

virtual SDKError	ScheduleMeeting (IScheduleMeetingItem *pItem)=0
	Schedule Meeting. More...

virtual SDKError	ScheduleMeeting (WndPosition &wndParam)=0
	Schedule Meeting. More...

virtual SDKError	EditMeeting (IScheduleMeetingItem *pItem)=0
	Edit Meeting. More...

virtual SDKError	EditMeeting (WndPosition &wndParam, UINT64 meetingUniqueID)=0
	Edit Meeting. More...

virtual SDKError	DeleteMeeting (UINT64 meetingUniqueID)=0
	Delete the specified scheduled meeting. More...

virtual SDKError	ListMeeting ()=0
	Get the list of current meetings. More...

virtual IMeetingItemInfo *	GetMeeingItem (UINT64 meetingUniqueID)=0
	Get a pointer to IMyMeeingItem. More...

Detailed Description

Pre-meeting service interface.

Member Function Documentation

◆ CreateEditMeetingItem()

virtual IScheduleMeetingItem* IPreMeetingService::CreateEditMeetingItem ( UINT64 meetingUniqueID )

pure virtual

Parameters

meetingUniqueID Specify the meeting ID.

Returns: If the function succeeds, the return value is the object pointer to IScheduleMeetingItem. Otherwise failed, returns NULL. Notice that if the specified meeting is a webinar, NULL will be returned. This interface doesn't support a webinar or a recurring one.

◆ CreateScheduleMeetingItem()

virtual IScheduleMeetingItem* IPreMeetingService::CreateScheduleMeetingItem ( )

pure virtual

Create an item to schedule meeting.

Returns: If the function succeeds, the return value is the object pointer to IScheduleMeetingItem. Otherwise failed, returns NULL.

◆ DeleteMeeting()

virtual SDKError IPreMeetingService::DeleteMeeting ( UINT64 meetingUniqueID )

pure virtual

Delete the specified scheduled meeting.

Parameters

meetingUniqueID Assign a meeting ID to delete meeting.

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

Remarks: Once the function is called successfully, the user will receive the callback event via IPreMeetingServiceEvent::onDeleteMeeting (). It is forbidden to delete personal meeting or webinar or a recurring one.

◆ DestoryEditMeetingItem()

virtual void IPreMeetingService::DestoryEditMeetingItem ( IScheduleMeetingItem * pMeeting )

pure virtual

Destroy the item of editing meeting created via CreateEditMeetingItem().

Parameters

pMeeting A pointer to the item created via CreateEditMeetingItem().

◆ DestoryScheduleMeetingItem()

virtual void IPreMeetingService::DestoryScheduleMeetingItem ( IScheduleMeetingItem * pMeeting )

pure virtual

Destroy the item of scheduling meeting created via CreateScheduleMeetingItem().

Parameters

pMeeting A pointer to the item created via CreateScheduleMeetingItem().

◆ EditMeeting() [1/2]

virtual SDKError IPreMeetingService::EditMeeting ( IScheduleMeetingItem * pItem )

pure virtual

Edit Meeting.

Parameters

pItem The object created via CreateEditMeetingItem.

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

Remarks: Once the function is called successfully, the user will receive the callback event via IPreMeetingServiceEvent::onScheduleOrEditMeeting (). Notice that if the specified meeting is a recurring one or a webinar, a SDKERR_INVALID_PARAMETER error will be returned. In these cases, edit the meeting via IPreMeetingService::EditMeeting(WndPosition& wndParam, UINT64 meetingUniqueID).

◆ EditMeeting() [2/2]

virtual SDKError IPreMeetingService::EditMeeting	(	WndPosition &	wndParam,
		UINT64	meetingUniqueID
	)

pure virtual

Edit Meeting.

Parameters

wndParam	Edit the meeting through the dialog window by setting its parameter. For more details, see WndPosition structure.
meetingUniqueID	Assign a meeting ID to schedule or edit related meeting.

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

Remarks: Once the function is called successfully, the user will receive the callback event via IPreMeetingServiceEvent::onScheduleOrEditMeeting (). The recurring meeting and webinar can only be edited via this function.

◆ GetMeeingItem()

virtual IMeetingItemInfo* IPreMeetingService::GetMeeingItem ( UINT64 meetingUniqueID )

pure virtual

Get a pointer to IMyMeeingItem.

Parameters

meetingUniqueID Specifies meeting ID to get the related object of the IMeetingItemInfo.

Returns: If the function succeeds, the return value is not NULL. Otherwise failed, returns NULL.

◆ ListMeeting()

virtual SDKError IPreMeetingService::ListMeeting ( )

pure virtual

Get the list of current meetings.

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

Remarks: Once the function is called successfully, the user will receive the callback event via IPreMeetingServiceEvent::onListMeeting ().

◆ ScheduleMeeting() [1/2]

virtual SDKError IPreMeetingService::ScheduleMeeting ( IScheduleMeetingItem * pItem )

pure virtual

Schedule Meeting.

Parameters

pItem The object created via CreateScheduleMeetingItem().

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

Remarks: Once the function is called successfully, the user will receive the callback event via IPreMeetingServiceEventreMeetingSer::onScheduleOrEditMeeting().

◆ ScheduleMeeting() [2/2]

virtual SDKError IPreMeetingService::ScheduleMeeting ( WndPosition & wndParam )

pure virtual

Schedule Meeting.

Parameters

wndParam Schedule a meeting in the dialog window box by setting its parameter. For more details, see WndPosition structure.

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

Remarks: Once the function is called successfully, the user will receive the callback event via IPreMeetingServiceEventreMeetingSer::onScheduleOrEditMeeting().

◆ SetEvent()

virtual SDKError IPreMeetingService::SetEvent ( IPreMeetingServiceEvent * pEvent )

pure virtual

Set pre-meeting service event.

Parameters

pEvent A pointer to the IPreMeetingServiceEvent which is used to receive pre-meeting service callback events. For more details, see IPreMeetingServiceEvent.

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

Remarks: The event is used by the SDK to pass the callback event to user's application. If the function is not called or failed, the user's application can not retrieve the callback event.

The documentation for this class was generated from the following file:

h/premeeting_service_interface.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ CreateEditMeetingItem()

◆ CreateScheduleMeetingItem()

◆ DeleteMeeting()

◆ DestoryEditMeetingItem()

◆ DestoryScheduleMeetingItem()

◆ EditMeeting() [1/2]

◆ EditMeeting() [2/2]

◆ GetMeeingItem()

◆ ListMeeting()

◆ ScheduleMeeting() [1/2]

◆ ScheduleMeeting() [2/2]

◆ SetEvent()