us.zoom.sdk.InMeetingDocsController Interface Reference

Docs Controller in ZOOM meeting. More...

Data Structures
interface	InMeetingDocsEvent
	Docs event callback. More...
enum	SDKDocsCreateOption
	Enumeration of document creation permission options. More...
enum	SDKDocsShareOption
	Enumeration of document sharing permission options. More...
enum	SDKDocsStatus
	Enumeration of document sharing status in a meeting. More...

Public Member Functions
MobileRTCSDKError	setEvent (InMeetingDocsEvent pEvent)
	Configure the meeting docs controller callback event handler.
MobileRTCSDKError	showDocsHomeView (FragmentActivity activity)
	Show the docs home view. This interface can only be used when MeetingSettingsHelper#isCustomizedMeetingUIEnabled() is true.
boolean	isSupportDocs ()
	Determine whether the current meeting supports the docs or not.
CannotShareReasonType	canStartShareDoc ()
	Determine whether the current user can start sharing docs or not.
boolean	canSetDocsOption ()
	Determine whether the current user can set docs option or not.
MobileRTCSDKError	setDocsShareOption (SDKDocsShareOption option)
	Set the setting option for who can share docs.
SDKDocsShareOption	getDocsShareOption ()
	Get the setting option for who can share docs.
MobileRTCSDKError	setDocsCreateOption (SDKDocsCreateOption option)
	Set the setting option for who can initiate new docs.
SDKDocsCreateOption	getDocsCreateOption ()
	Get the setting option for docs who can initiate new docs.
boolean	isOtherSharingDocs ()
	Query if other user is sharing docs.
boolean	isSharingDocsOut ()
	Query if the current user is sharing docs successfully.
List< ZoomSDKDocSharingSourceInfo >	getDocsSharingSourceInfoList (long userID)
	Get the list of docs sharing source info.
List< Long >	getViewableDocsSharingUserList ()
	Get the ID of users who are sharing docs.

Detailed Description

Docs Controller in ZOOM meeting.

Definition at line 10 of file InMeetingDocsController.java.

Member Function Documentation

canSetDocsOption()

boolean us.zoom.sdk.InMeetingDocsController.canSetDocsOption

(

)

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

Returns

true means the current user can set docs option, false means the user can't set docs option.

canStartShareDoc()

CannotShareReasonType us.zoom.sdk.InMeetingDocsController.canStartShareDoc

(

)

Determine whether the current user can start sharing docs or not.

Returns

The reason why no one can start sharing the doc.

getDocsCreateOption()

SDKDocsCreateOption us.zoom.sdk.InMeetingDocsController.getDocsCreateOption

(

)

Get the setting option for docs who can initiate new docs.

Returns

option seeSDKDocsCreateOption

getDocsShareOption()

SDKDocsShareOption us.zoom.sdk.InMeetingDocsController.getDocsShareOption

(

)

Get the setting option for who can share docs.

Returns

option

getDocsSharingSourceInfoList()

List< ZoomSDKDocSharingSourceInfo > us.zoom.sdk.InMeetingDocsController.getDocsSharingSourceInfoList

(

long

userID

)

Get the list of docs sharing source info.

Parameters

userID

The ID of the user who is sharing docs.

Returns

if the function succeeds, the return value is list, Otherwise, the return value is null.

getViewableDocsSharingUserList()

List< Long > us.zoom.sdk.InMeetingDocsController.getViewableDocsSharingUserList

(

)

Get the ID of users who are sharing docs.

Returns

A list of userID of all users who are sharing docs.

isOtherSharingDocs()

boolean us.zoom.sdk.InMeetingDocsController.isOtherSharingDocs

(

)

Query if other user is sharing docs.

Returns

TRUE means sharing, FALSE not.

isSharingDocsOut()

boolean us.zoom.sdk.InMeetingDocsController.isSharingDocsOut

(

)

Query if the current user is sharing docs successfully.

Returns

TRUE means sharing successfully, FALSE not.

isSupportDocs()

boolean us.zoom.sdk.InMeetingDocsController.isSupportDocs

(

)

Determine whether the current meeting supports the docs or not.

Returns

true means the current meeting supports the Docs, false means the Docs is not supported.

setDocsCreateOption()

MobileRTCSDKError us.zoom.sdk.InMeetingDocsController.setDocsCreateOption

(

SDKDocsCreateOption

option

)

Set the setting option for who can initiate new docs.

Parameters

option

Setting option for who can initiate new docs.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

setDocsShareOption()

MobileRTCSDKError us.zoom.sdk.InMeetingDocsController.setDocsShareOption

(

SDKDocsShareOption

option

)

Set the setting option for who can share docs.

Parameters

option

the setting for who can share docs SDKDocsShareOption

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

setEvent()

MobileRTCSDKError us.zoom.sdk.InMeetingDocsController.setEvent

(

InMeetingDocsEvent

pEvent

)

Configure the meeting docs controller callback event handler.

Parameters

pEvent

docs event callback.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

showDocsHomeView()

MobileRTCSDKError us.zoom.sdk.InMeetingDocsController.showDocsHomeView

(

FragmentActivity

activity

)

Show the docs home view. This interface can only be used when MeetingSettingsHelper#isCustomizedMeetingUIEnabled() is true.

Parameters

activity

the top resume activity.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.