ICloudWhiteboardHelper Class Reference

Cloud whiteboard helper interface. More...

#include <ICloudWhiteboardHelper.h>

Public Member Functions
virtual	~ICloudWhiteboardHelper ()
virtual ZRCSDKError	RegisterSink (ICloudWhiteboardHelperSink *pSink)=0
	Register cloud whiteboard helper callback sink.
virtual ZRCSDKError	DeregisterSink (ICloudWhiteboardHelperSink *pSink)=0
	Deregister cloud whiteboard callback sink.
virtual ZRCSDKError	RequestCloudWhiteboardAction (CloudWhiteboardAction action)=0
	Request cloud whiteboard action.
virtual ZRCSDKError	ConfirmCloudWhiteboardUserChoice (CloudWhiteboardUserChoiceType choice, CloudWhiteboardWebWbState webWbState)=0
	Confirm cloud whiteboard user choice, respond to ZR cloud whiteboard warning.
virtual ZRCSDKError	ChangeWhiteboardSharePrivilege (WhiteboardSharePrivilegeType type)=0
	Change whiteboard share privilege type.
virtual ZRCSDKError	ChangeWhiteboardInitiatePrivilege (WhiteboardInitiatePrivilegeType type)=0
	Change whiteboard initiate privilege type.

Detailed Description

Cloud whiteboard helper interface.

Definition at line 127 of file ICloudWhiteboardHelper.h.

Constructor & Destructor Documentation

~ICloudWhiteboardHelper()

virtual ICloudWhiteboardHelper::~ICloudWhiteboardHelper ( )

inlinevirtual

Definition at line 130 of file ICloudWhiteboardHelper.h.

{}

Member Function Documentation

ChangeWhiteboardInitiatePrivilege()

virtual ZRCSDKError ICloudWhiteboardHelper::ChangeWhiteboardInitiatePrivilege ( WhiteboardInitiatePrivilegeType  type )

pure virtual

Change whiteboard initiate privilege type.

Since

6.1.0

Zoom Rooms minimum version

6.1.0

Parameters

type	Specify the whiteboard initiate privilege type.

Returns

If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

ChangeWhiteboardSharePrivilege()

virtual ZRCSDKError ICloudWhiteboardHelper::ChangeWhiteboardSharePrivilege ( WhiteboardSharePrivilegeType  type )

pure virtual

Change whiteboard share privilege type.

Since

6.1.0

Zoom Rooms minimum version

6.1.0

Parameters

type	Specify the whiteboard share privilege type.

Returns

If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

ConfirmCloudWhiteboardUserChoice()

virtual ZRCSDKError ICloudWhiteboardHelper::ConfirmCloudWhiteboardUserChoice ( CloudWhiteboardUserChoiceType  choice, CloudWhiteboardWebWbState  webWbState  )

pure virtual

Confirm cloud whiteboard user choice, respond to ZR cloud whiteboard warning.

Since

6.1.0

Zoom Rooms minimum version

6.1.0

Parameters

choice	Specify the confirm choice, see CloudWhiteboardUserChoiceType enum.
webWbState	Specify the current webWbState, see CloudWhiteboardWebWbState enum.

Returns

If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

DeregisterSink()

virtual ZRCSDKError ICloudWhiteboardHelper::DeregisterSink ( ICloudWhiteboardHelperSink *  pSink )

pure virtual

Deregister cloud whiteboard callback sink.

Since

6.1.0

Zoom Rooms minimum version

6.1.0

Parameters

pSink

A pointer to the ICloudWhiteboardHelperSink that receives the cloud whiteboard helper callback.

Returns

If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

RegisterSink()

virtual ZRCSDKError ICloudWhiteboardHelper::RegisterSink ( ICloudWhiteboardHelperSink *  pSink )

pure virtual

Register cloud whiteboard helper callback sink.

Since

6.1.0

Zoom Rooms minimum version

6.1.0

Parameters

pSink

A pointer to the ICloudWhiteboardHelperSink that receives the cloud whiteboard helper callback.

Returns

If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

RequestCloudWhiteboardAction()

virtual ZRCSDKError ICloudWhiteboardHelper::RequestCloudWhiteboardAction ( CloudWhiteboardAction  action )

pure virtual

Request cloud whiteboard action.

Since

6.1.0

Zoom Rooms minimum version

6.1.0

Parameters

action

Specify the action, see CloudWhiteboardAction enum.

Returns

If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.