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

Process after the user receives the requirement from the host to give the remote support privilege. More...

#include <meeting_remote_support_interface.h>

Public Member Functions

virtual ~IRemoteSupportRequestHandler ()
 
virtual unsigned int GetRequesterId ()=0
 Get the user ID who requested privilege.
 
virtual const zchar_tGetRequesterName ()=0
 Get the user name who requested privileges.
 
virtual RemoteSupportType GetRemoteSupportType ()=0
 Get the remote support type.
 
virtual SDKError SetRemoteSupportApplicationView (void *view)=0
 Set the specified application.
 
virtual SDKError Grant ()=0
 Allows the user to remote support and finally self-destroy.
 
virtual SDKError Deny ()=0
 Denies the user to remote support and finally self-destroy.
 

Detailed Description

Process after the user receives the requirement from the host to give the remote support privilege.

Definition at line 36 of file meeting_remote_support_interface.h.

Constructor & Destructor Documentation

◆ ~IRemoteSupportRequestHandler()

virtual IRemoteSupportRequestHandler::~IRemoteSupportRequestHandler ( )
inlinevirtual

Definition at line 39 of file meeting_remote_support_interface.h.

39{};

Member Function Documentation

◆ Deny()

virtual SDKError IRemoteSupportRequestHandler::Deny ( )
pure virtual

Denies the user to remote support and finally self-destroy.

◆ GetRemoteSupportType()

virtual RemoteSupportType IRemoteSupportRequestHandler::GetRemoteSupportType ( )
pure virtual

Get the remote support type.

Returns
If the function succeeds, the return value is the RemoteSupportType.

◆ GetRequesterId()

virtual unsigned int IRemoteSupportRequestHandler::GetRequesterId ( )
pure virtual

Get the user ID who requested privilege.

Returns
If the function succeeds, the return value is the user ID. Otherwise, this returns 0.

◆ GetRequesterName()

virtual const zchar_t * IRemoteSupportRequestHandler::GetRequesterName ( )
pure virtual

Get the user name who requested privileges.

Returns
If the function succeeds, the return value is the user name.

◆ Grant()

virtual SDKError IRemoteSupportRequestHandler::Grant ( )
pure virtual

Allows the user to remote support and finally self-destroy.

◆ SetRemoteSupportApplicationView()

virtual SDKError IRemoteSupportRequestHandler::SetRemoteSupportApplicationView ( void * view)
pure virtual

Set the specified application.

Parameters
viewSpecify the window handle of the application to be remote support. If the view can't be shared, the return value is the SDKERR_INVALID_PARAMETER error code.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.
Remarks
Set the application view only when RemoteSupportType is Remote_Support_Application.