Meeting SDK for Windows API Reference
Loading...
Searching...
No Matches
INotificationServiceHelper Class Referenceabstract

#include <notification_service_interface.h>

Public Member Functions

virtual ~INotificationServiceHelper ()
 
virtual IPresenceHelperGetPresenceHelper ()=0
 Get the Presence helper.
 
virtual SDKError SetEvent (INotificationServiceEvent *pEvent)=0
 Set the controller event of notification service.
 
virtual bool IsTransferMeetingEnabled ()=0
 brief Determine whether the transfer meeting feature is enabled.
 
virtual bool IsPresenceFeatureEnabled ()=0
 brief Determine whether the presence feature is enabled.
 
virtual SDKError TransferMeeting (int nIndex)=0
 Try to transfer meeting to current device.
 
virtual SDKError TransferMeeting (TransferMeetingMode mode, const zchar_t *meetingId)=0
 Try to transfer meeting to current device or join meeting with companion mode.
 

Detailed Description

Definition at line 89 of file notification_service_interface.h.

Constructor & Destructor Documentation

◆ ~INotificationServiceHelper()

virtual INotificationServiceHelper::~INotificationServiceHelper ( )
inlinevirtual

Definition at line 92 of file notification_service_interface.h.

92{}

Member Function Documentation

◆ GetPresenceHelper()

virtual IPresenceHelper * INotificationServiceHelper::GetPresenceHelper ( )
pure virtual

Get the Presence helper.

Returns
If the function succeeds, the return value is a pointer to IPresenceHelper. Otherwise the function fails and returns nullptr.

◆ IsPresenceFeatureEnabled()

virtual bool INotificationServiceHelper::IsPresenceFeatureEnabled ( )
pure virtual

brief Determine whether the presence feature is enabled.

◆ IsTransferMeetingEnabled()

virtual bool INotificationServiceHelper::IsTransferMeetingEnabled ( )
pure virtual

brief Determine whether the transfer meeting feature is enabled.

◆ SetEvent()

virtual SDKError INotificationServiceHelper::SetEvent ( INotificationServiceEvent * pEvent)
pure virtual

Set the controller event of notification service.

◆ TransferMeeting() [1/2]

virtual SDKError INotificationServiceHelper::TransferMeeting ( int nIndex)
pure virtual

Try to transfer meeting to current device.

Parameters
nIndexSpecifies the index of meeting list.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.
Deprecated
This interface is marked as deprecated.

◆ TransferMeeting() [2/2]

virtual SDKError INotificationServiceHelper::TransferMeeting ( TransferMeetingMode mode,
const zchar_t * meetingId )
pure virtual

Try to transfer meeting to current device or join meeting with companion mode.

Parameters
TransferMeetingModeSpecifies the transfer meeting mode. If the mode is TransferMeetingMode_Companion, you will join meeting as a companion,Otherwise will transfer meeting to current device.
meetingIdSpecifies the meeting list's meeting ID.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.