Meeting Docs helper interface. More...

#include <meeting_docs_interface.h>

Public Member Functions
virtual	~IMeetingDocsController ()

virtual SDKError	SetEvent (IMeetingDocsCtrlEvent *pEvent)=0
	Configure the meeting docs controller callback event handler.

virtual bool	IsSupportDocs ()=0
	Determine whether the current meeting supports the docs or not.

virtual bool	CanStartShareDocs (CannotShareReasonType &reason)=0
	Determine whether the current user can start sharinge the doc or not.

virtual bool	CanSetDocsOption ()=0
	Determine whether the current user can set docs options or not.

virtual SDKError	SetDocsShareOption (SDKDocsShareOption option)=0
	Set the setting option for who can share docs.

virtual SDKError	GetDocsShareOption (SDKDocsShareOption &option)=0
	Get the setting option for who can share docs.

virtual SDKError	SetDocsCreateOption (SDKDocsCreateOption option)=0
	Set the option for who can initiate a new doc.

virtual SDKError	GetDocsCreateOption (SDKDocsCreateOption &option)=0
	Get the option for who can initiate a new doc.

virtual bool	IsOtherSharingDocs ()=0
	Query if other user is sharing docs.

virtual bool	IsSharingDocsOut ()=0
	Query if the current user is sharing docs successfully.

virtual SDKError	SetOwnerWindow (HWND hOwner)=0
	Set the docs web view and dashboard web view owner window.

virtual SDKError	ShowDocsDashboard (int x=-1, int y=-1)=0
	Show the docs dashboard web view window.

virtual SDKError	SetDocDashboardSize (int width=-1, int height=-1)=0
	Set the dashboard web view window size.

virtual SDKError	SetDocsViewPos (int x=-1, int y=-1)=0
	Set the docs web view window position.

virtual SDKError	SetDocsViewSize (int width=-1, int height=-1)=0
	Set the docs web view window size.

virtual SDKError	ShowDocsViewWindow (unsigned int sourceID)=0
	Show the docs web view window.

virtual SDKError	CloseDocsViewWindow ()=0
	Close the docs web view window.

virtual IList< IZoomSDKDocSharingSourceInfo * > *	GetDocsSharingSourceInfoList (unsigned int userID)=0
	Get the docs sharing source information list from the specified sharer.

virtual IList< unsigned int > *	GetViewableDocsSharingUserList ()=0
	Get the ID of users who are sharing docs.

Detailed Description

Meeting Docs helper interface.

Definition at line 111 of file meeting_docs_interface.h.

Constructor & Destructor Documentation

◆ ~IMeetingDocsController()

virtual IMeetingDocsController::~IMeetingDocsController ( )

inlinevirtual

Definition at line 114 of file meeting_docs_interface.h.

114{}

Member Function Documentation

◆ CanSetDocsOption()

virtual bool IMeetingDocsController::CanSetDocsOption ( )

pure virtual

Determine whether the current user can set docs options or not.

Returns: true means the current user can set docs options, false means the user can' not set docs options.

◆ CanStartShareDocs()

virtual bool IMeetingDocsController::CanStartShareDocs ( CannotShareReasonType & reason )

pure virtual

Determine whether the current user can start sharinge the doc or not.

Parameters

[out] reason The reason why no one can start sharing the doc. See CannotShareReasonType enum.

Returns: true indicates you can start sharing the doc.

◆ CloseDocsViewWindow()

virtual SDKError IMeetingDocsController::CloseDocsViewWindow ( )

pure virtual

Close the docs web view window.

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

Note: Valid only for custom user interface mode.

◆ GetDocsCreateOption()

virtual SDKError IMeetingDocsController::GetDocsCreateOption ( SDKDocsCreateOption & option )

pure virtual

Get the option for who can initiate a new doc.

Parameters

param [out] option Setting option for who can initiate a new doc, see SDKDocsCreateOption enum.

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

◆ GetDocsShareOption()

virtual SDKError IMeetingDocsController::GetDocsShareOption ( SDKDocsShareOption & option )

pure virtual

Get the setting option for who can share docs.

Parameters

[out] option Setting option for who can share docs, see SDKDocsShareOption enum.

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

◆ GetDocsSharingSourceInfoList()

virtual IList< IZoomSDKDocSharingSourceInfo * > * IMeetingDocsController::GetDocsSharingSourceInfoList ( unsigned int userID )

pure virtual

Get the docs sharing source information list from the specified sharer.

Parameters

userID The ID of the user who is sharing docs.

Returns: If the function succeeds, the return value is the viewable docs sharing information list. For more details, see IZoomSDKDocSharingSourceInfo class.

◆ GetViewableDocsSharingUserList()

virtual IList< unsigned int > * IMeetingDocsController::GetViewableDocsSharingUserList ( )

pure virtual

Get the ID of users who are sharing docs.

Returns: If the function succeeds, the return value is a list of user ID of all users who are sharing docs. If the function fails, the return value is nullptr.

◆ IsOtherSharingDocs()

virtual bool IMeetingDocsController::IsOtherSharingDocs ( )

pure virtual

Query if other user is sharing docs.

Returns: true means other user is sharing docs.

◆ IsSharingDocsOut()

virtual bool IMeetingDocsController::IsSharingDocsOut ( )

pure virtual

Query if the current user is sharing docs successfully.

Returns: True means sharing successfully.

◆ IsSupportDocs()

virtual bool IMeetingDocsController::IsSupportDocs ( )

pure virtual

Determine whether the current meeting supports the docs or not.

Returns: true indicates to support.

◆ SetDocDashboardSize()

virtual SDKError IMeetingDocsController::SetDocDashboardSize	(	int	width = -1,
		int	height = -1 )

pure virtual

Set the dashboard web view window size.

Parameters

height	Specify the height of the window.
width	Specify the width of the window.

Note: If height == -1 and width == -1, the window size will be default.

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

Note: Valid only for custom user interface mode.

◆ SetDocsCreateOption()

virtual SDKError IMeetingDocsController::SetDocsCreateOption ( SDKDocsCreateOption option )

pure virtual

Set the option for who can initiate a new doc.

Parameters

option Setting option for who can initiate a new doc, see SDKDocsCreateOption enum.

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

◆ SetDocsShareOption()

virtual SDKError IMeetingDocsController::SetDocsShareOption ( SDKDocsShareOption option )

pure virtual

Set the setting option for who can share docs.

Parameters

option The setting for who can share docs, see SDKDocsShareOption enum.

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

◆ SetDocsViewPos()

virtual SDKError IMeetingDocsController::SetDocsViewPos	(	int	x = -1,
		int	y = -1 )

pure virtual

Set the docs web view window position.

Parameters

x	Specifies the X-axis coordinate of the top-left corner of the docs web view window in the parent window.
y	Specifies the Y-axis coordinate of the top-left corner of the docs web view window in the parent window.

Note: If x == -1 and y = -1, the window position will be in the center of the screen where the owner window is located.; If you don't call this function, the window position will be in the center of the screen where the owner window is located.

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

Note: Valid only for custom user interface mode.

◆ SetDocsViewSize()

virtual SDKError IMeetingDocsController::SetDocsViewSize	(	int	width = -1,
		int	height = -1 )

pure virtual

Set the docs web view window size.

Parameters

height	Specify the height of the docs web view window.
width	Specify the width of the docs web view window.

Note: If height == -1 and width == -1, the window size will be default.; If you don't call this function, the window size will be default.

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

Note: Valid only for custom user interface mode.

◆ SetEvent()

virtual SDKError IMeetingDocsController::SetEvent ( IMeetingDocsCtrlEvent * pEvent )

pure virtual

Configure the meeting docs controller callback event handler.

Parameters

pEvent An object pointer to the IMeetingDocsCtrlEvent that receives the meeting docs callback event. For more details, see IMeetingDocsCtrlEvent.

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

Note: remarks The SDK use pEvent to transmit the callback event to the user's application. If the function is not called or fails, the user's application is unable to retrieve the callback event.

◆ SetOwnerWindow()

virtual SDKError IMeetingDocsController::SetOwnerWindow ( HWND hOwner )

pure virtual

Set the docs web view and dashboard web view owner window.

Parameters

hOwner Specify the owner window.

Note: Call this function before calling ShowDocsDashboard. Call this function when receiving the meeting status MEETING_STATUS_INMEETING.

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

Note: Valid only for user custom interface mode.

◆ ShowDocsDashboard()

virtual SDKError IMeetingDocsController::ShowDocsDashboard	(	int	x = -1,
		int	y = -1 )

pure virtual

Show the docs dashboard web view window.

Parameters

x	The horizontal coordinate value.
y	The vertical coordinate value.

Note: If x == -1 and y = -1, the window position will be in the center of the screen where the owner window is located.

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

Note: Valid only for custom user interface mode.

◆ ShowDocsViewWindow()

virtual SDKError IMeetingDocsController::ShowDocsViewWindow ( unsigned int sourceID )

pure virtual

Show the docs web view window.

Parameters

sourceID The share source ID that is sharing.

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

Note: Valid only for custom user interface mode.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IMeetingDocsController()

Member Function Documentation

◆ CanSetDocsOption()

◆ CanStartShareDocs()

◆ CloseDocsViewWindow()

◆ GetDocsCreateOption()

◆ GetDocsShareOption()

◆ GetDocsSharingSourceInfoList()

◆ GetViewableDocsSharingUserList()

◆ IsOtherSharingDocs()

◆ IsSharingDocsOut()

◆ IsSupportDocs()

◆ SetDocDashboardSize()

◆ SetDocsCreateOption()

◆ SetDocsShareOption()

◆ SetDocsViewPos()

◆ SetDocsViewSize()

◆ SetEvent()

◆ SetOwnerWindow()

◆ ShowDocsDashboard()

◆ ShowDocsViewWindow()