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

The share action interface. More...

#include <customized_share_render.h>

Inherits IShareActionBase.

Public Member Functions

virtual SDKError SetEvent (IShareActionEvent *pEvent)=0
 Set the share action callback event handler.
 
virtual SDKError Reposition (RECT rc, HWND hParentWnd=nullptr)=0
 Resize the share action in the specified area and reset the parent window.
 
virtual const unsigned int GetSharingID ()=0
 Get the sharing ID.
 
virtual const zchar_tGetSharingUserName ()=0
 Get the name of the sharing user.
 
virtual SDKError Subscribe ()=0
 Subscribe the sharing content.
 
virtual SDKError Unsubscribe ()=0
 Unsubscribe the sharing content.
 
virtual ~IShareAction ()
 
- Public Member Functions inherited from IShareActionBase
virtual SDKError Show ()=0
 Show the shared content received.
 
virtual SDKError Hide ()=0
 Hide the shared content received.
 
virtual HWND GetOwnerWnd ()=0
 Get the window handle of showing sharing content.
 
virtual ~IShareActionBase ()
 

Detailed Description

The share action interface.

Definition at line 144 of file customized_share_render.h.

Constructor & Destructor Documentation

◆ ~IShareAction()

virtual IShareAction::~IShareAction ( )
inlinevirtual

Definition at line 180 of file customized_share_render.h.

180{}

Member Function Documentation

◆ GetSharingID()

virtual const unsigned int IShareAction::GetSharingID ( )
pure virtual

Get the sharing ID.

Returns
If the function succeeds, the return value is the sharing ID. Otherwise the function fails, and the return value is ZERO(0).

◆ GetSharingUserName()

virtual const zchar_t * IShareAction::GetSharingUserName ( )
pure virtual

Get the name of the sharing user.

Returns
If the function succeeds, the return value is the name. Otherwise the function fails, and the return value is nullptr.

◆ Reposition()

virtual SDKError IShareAction::Reposition ( RECT rc,
HWND hParentWnd = nullptr )
pure virtual

Resize the share action in the specified area and reset the parent window.

Parameters
rcSpecify a new display area. The coordinate value of the structure is that of the parent window of share action.
hParentWndSpecify a new parent window HWND.
Returns
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise the function fails. To get extended error information, see SDKError enum.

◆ SetEvent()

virtual SDKError IShareAction::SetEvent ( IShareActionEvent * pEvent)
pure virtual

Set the share action callback event handler.

Parameters
pEventA pointer to the IShareActionEvent that receives the share render event.
Returns
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise the function fails. To get extended error information, see SDKError enum.

◆ Subscribe()

virtual SDKError IShareAction::Subscribe ( )
pure virtual

Subscribe the sharing content.

Returns
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise the function fails. To get extended error information, see SDKError enum.

◆ Unsubscribe()

virtual SDKError IShareAction::Unsubscribe ( )
pure virtual

Unsubscribe the sharing content.

Returns
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise the function fails. To get extended error information, see SDKError enum.