Meeting SDK for Windows API Reference
Loading...
Searching...
No Matches
meeting_docs_interface.h
Go to the documentation of this file.
1
2#ifndef _MEETING_DOCS_INTERFACE_H_
3#define _MEETING_DOCS_INTERFACE_H_
4#include "zoom_sdk_def.h"
5
7
19
34
49
54{
55public:
60 virtual SDKDocsStatus GetStatus() = 0;
61
66 virtual const zchar_t* GetDocTitle() = 0;
67
72 virtual unsigned int GetShareSourceID() = 0;
73
78 virtual unsigned int GetUserID() = 0;
79
81};
82
87{
88public:
90
97
104 virtual void onDocsPermissionChanged(SDKDocsCreateOption createOption, SDKDocsShareOption option) = 0;
105
106};
107
112{
113public:
115
123
128 virtual bool IsSupportDocs() = 0;
129
135 virtual bool CanStartShareDocs(CannotShareReasonType& reason) = 0;
136
141 virtual bool CanSetDocsOption() = 0;
142
149
156
163
170
175 virtual bool IsOtherSharingDocs() = 0;
176
181 virtual bool IsSharingDocsOut() = 0;
182
190 virtual SDKError SetOwnerWindow(HWND hOwner) = 0;
191
200 virtual SDKError ShowDocsDashboard(int x = -1, int y = -1) = 0;
201
210 virtual SDKError SetDocDashboardSize(int width = -1, int height = -1) = 0;
211
221 virtual SDKError SetDocsViewPos(int x = -1, int y = -1) = 0;
222
232 virtual SDKError SetDocsViewSize(int width = -1, int height = -1) = 0;
233
240 virtual SDKError ShowDocsViewWindow(unsigned int sourceID) = 0;
241
248
255
261};
262
264#endif
Meeting Docs helper interface.
virtual SDKError GetDocsCreateOption(SDKDocsCreateOption &option)=0
Get the option for who can initiate a new doc.
virtual IList< unsigned int > * GetViewableDocsSharingUserList()=0
Get the ID of users who are sharing docs.
virtual SDKError SetDocsShareOption(SDKDocsShareOption option)=0
Set the setting option for who can share docs.
virtual SDKError ShowDocsDashboard(int x=-1, int y=-1)=0
Show the docs dashboard web view window.
virtual SDKError SetOwnerWindow(HWND hOwner)=0
Set the docs web view and dashboard web view owner window.
virtual bool IsSupportDocs()=0
Determine whether the current meeting supports the docs or not.
virtual SDKError GetDocsShareOption(SDKDocsShareOption &option)=0
Get the setting option for who can share docs.
virtual SDKError CloseDocsViewWindow()=0
Close the docs web view window.
virtual SDKError SetDocsCreateOption(SDKDocsCreateOption option)=0
Set the option for who can initiate a new doc.
virtual SDKError SetDocDashboardSize(int width=-1, int height=-1)=0
Set the dashboard web view window size.
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 IList< IZoomSDKDocSharingSourceInfo * > * GetDocsSharingSourceInfoList(unsigned int userID)=0
Get the docs sharing source information list from the specified sharer.
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 bool CanSetDocsOption()=0
Determine whether the current user can set docs options or not.
virtual bool CanStartShareDocs(CannotShareReasonType &reason)=0
Determine whether the current user can start sharinge the doc or not.
virtual SDKError SetEvent(IMeetingDocsCtrlEvent *pEvent)=0
Configure the meeting docs controller callback event handler.
virtual SDKError ShowDocsViewWindow(unsigned int sourceID)=0
Show the docs web view window.
Docs controller callback event.
virtual void onDocsPermissionChanged(SDKDocsCreateOption createOption, SDKDocsShareOption option)=0
Callback for document sharing permission changes Triggered when document creation/sharing permissions...
virtual void onDocsSharingSourceInfoChanged(IZoomSDKDocSharingSourceInfo *pInfo)=0
Callback for document status change Notifies when document sharing starts/stops. All meeting particip...
Share source info of Zoom docs.
virtual SDKDocsStatus GetStatus()=0
Get the status of Zoom docs sharing.
virtual const zchar_t * GetDocTitle()=0
Get the title of the sharing Zoom docs.
virtual unsigned int GetShareSourceID()=0
Get the share source id of the sharing Zoom docs.
virtual unsigned int GetUserID()=0
Get the user id who is sharing Zoom docs.
SDKDocsShareOption
Docs share option.
@ SDKDocsShareOption_None
@ SDKDocsShareOption_AllGrabShare
@ SDKDocsShareOption_HostGrabShare
@ SDKDocsShareOption_HostShare
SDKDocsStatus
Docs share status.
@ SDKDocsStatus_Start
@ SDKDocsStatus_None
@ SDKDocsStatus_Stop
SDKDocsCreateOption
Docs create option.
@ SDKDocsCreateOption_All
@ SDKDocsCreateOption_None
@ SDKDocsCreateOption_AccountUsers
@ SDKDocsCreateOption_HostOnly
ZOOM windows SDK Common Definition File.
CannotShareReasonType
Enumeration of reasons why sharing is not allowed.
#define END_ZOOM_SDK_NAMESPACE
wchar_t zchar_t
#define BEGIN_ZOOM_SDK_NAMESPACE
SDKError
Enumeration of common errors of SDK.