Zoom Meeting Docs
- Description:
- Zoom Meeting Docs
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onDocsSharingSourceInfoChanged |
function | Callback for document status change. Notifies when document sharing starts/stops. All meeting participants receive this event. |
ondocspermissionchanged |
function | Callback event of docs share setting type changed. |
Returns:
- Type
- ZoomMeetingDocs
- Description:
- Zoom Meeting Docs
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onDocsSharingSourceInfoChanged |
function | Callback for document status change. Notifies when document sharing starts/stops. All meeting participants receive this event. |
ondocspermissionchanged |
function | Callback event of docs share setting type changed. |
Returns:
- Type
- ZoomMeetingDocs
Methods
(inner) CanSetDocsOption() → {Boolean}
- Description:
- Determine whether the current user can set docs options or not.
- Source:
Returns:
True means the current user can set docs options, false means the user can' not set docs options.
- Type
- Boolean
(inner) CanSetDocsOption() → {Boolean}
- Description:
- Determine whether the current user can set docs options or not.
- Source:
Returns:
True means the current user can set docs options, false means the user can' not set docs options.
- Type
- Boolean
(inner) CanStartShareDocs() → {Boolean}
- Description:
- Determine whether the current user can start sharinge the doc or not.
- Source:
Returns:
True indicates you can start sharing the doc.
- Type
- Boolean
(inner) CanStartShareDocs() → {Boolean}
- Description:
- Determine whether the current user can start sharinge the doc or not.
- Source:
Returns:
True indicates you can start sharing the doc.
- Type
- Boolean
(inner) CloseDocsViewWindow() → {Number}
- Description:
- Close the docs web view window.
- Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) CloseDocsViewWindow() → {Number}
- Description:
- Close the docs web view window.
- Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) GetDocsCreateOption() → {Number}
- Description:
- Get the option for who can initiate a new doc.
- Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) GetDocsCreateOption() → {Number}
- Description:
- Get the option for who can initiate a new doc.
- Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) GetDocsShareOption() → {Number}
- Description:
- Get the setting option for who can share docs.
- Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) GetDocsShareOption() → {Number}
- Description:
- Get the setting option for who can share docs.
- Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) GetDocsSharingSourceInfoList(userID) → {Number}
- Description:
- Get the docs sharing source information list from the specified sharer.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
userID |
Number | The ID of the user who is sharing docs. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) GetDocsSharingSourceInfoList(userID) → {Number}
- Description:
- Get the docs sharing source information list from the specified sharer.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
userID |
Number | The ID of the user who is sharing docs. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) GetViewableDocsSharingUserList() → {Number}
- Description:
- Get the ID of users who are sharing docs.
- Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) GetViewableDocsSharingUserList() → {Number}
- Description:
- Get the ID of users who are sharing docs.
- Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) IsOtherSharingDocs() → {Boolean}
- Description:
- Query if other user is sharing docs.
- Source:
Returns:
True means sharing.
- Type
- Boolean
(inner) IsOtherSharingDocs() → {Boolean}
- Description:
- Query if other user is sharing docs.
- Source:
Returns:
True means sharing.
- Type
- Boolean
(inner) IsSharingDocsOut() → {Boolean}
- Description:
- Query if the current user is sharing docs successfully.
- Source:
Returns:
True means sharing successfully.
- Type
- Boolean
(inner) IsSharingDocsOut() → {Boolean}
- Description:
- Query if the current user is sharing docs successfully.
- Source:
Returns:
True means sharing successfully.
- Type
- Boolean
(inner) IsSupportDocs() → {Boolean}
- Description:
- Determine whether the current meeting supports the docs or not.
- Source:
Returns:
True indicates to support.
- Type
- Boolean
(inner) IsSupportDocs() → {Boolean}
- Description:
- Determine whether the current meeting supports the docs or not.
- Source:
Returns:
True indicates to support.
- Type
- Boolean
(inner) SetDocDashboardSize(width, height) → {Number}
- Description:
- Set the dashboard web view window size.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
width |
Number | Specify the width of the window. |
height |
Number | Specify the height of the window. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) SetDocDashboardSize(width, height) → {Number}
- Description:
- Set the dashboard web view window size.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
width |
Number | Specify the width of the window. |
height |
Number | Specify the height of the window. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) SetDocsCreateOption(option) → {Number}
- Description:
- Set the option for who can initiate a new doc.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
option |
Number | Setting option for who can initiate a new doc, see \link SDKDocsCreateOption \endlink enum. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) SetDocsCreateOption(option) → {Number}
- Description:
- Set the option for who can initiate a new doc.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
option |
Number | Setting option for who can initiate a new doc, see \link SDKDocsCreateOption \endlink enum. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) SetDocsShareOption() → {Number}
- Description:
- Set the setting option for who can share docs.
- Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) SetDocsShareOption() → {Number}
- Description:
- Set the setting option for who can share docs.
- Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) SetDocsViewPos(x, y) → {Number}
- Description:
- Set the docs web view window position.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
x |
Number | Specifies the X-axis coordinate of the top-left corner of the docs web view window in the parent window. |
y |
Number | Specifies the Y-axis coordinate of the top-left corner of the docs web view window in the parent window. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) SetDocsViewPos(x, y) → {Number}
- Description:
- Set the docs web view window position.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
x |
Number | Specifies the X-axis coordinate of the top-left corner of the docs web view window in the parent window. |
y |
Number | Specifies the Y-axis coordinate of the top-left corner of the docs web view window in the parent window. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) SetDocsViewSize(height, width) → {Number}
- Description:
- Set the docs web view window size.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
height |
Number | Specify the height of the docs web view window. |
width |
Number | Specify the width of the docs web view window. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) SetDocsViewSize(height, width) → {Number}
- Description:
- Set the docs web view window size.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
height |
Number | Specify the height of the docs web view window. |
width |
Number | Specify the width of the docs web view window. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) SetOnDocsPermissionChangedCB(onDocsPermissionChanged) → {Boolean}
- Description:
- Set callback event of docs share setting type changed.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onDocsPermissionChanged |
function |
Returns:
- Type
- Boolean
(inner) SetOnDocsPermissionChangedCB(onDocsPermissionChanged) → {Boolean}
- Description:
- Set callback event of docs share setting type changed.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onDocsPermissionChanged |
function |
Returns:
- Type
- Boolean
(inner) SetOnDocsSharingSourceInfoChangedCB(onDocsSharingSourceInfoChanged) → {Boolean}
- Description:
- Set document status change callback. Notifies when document sharing starts/stops. All meeting participants receive this event.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onDocsSharingSourceInfoChanged |
function |
Returns:
- Type
- Boolean
(inner) SetOnDocsSharingSourceInfoChangedCB(onDocsSharingSourceInfoChanged) → {Boolean}
- Description:
- Set document status change callback. Notifies when document sharing starts/stops. All meeting participants receive this event.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onDocsSharingSourceInfoChanged |
function |
Returns:
- Type
- Boolean
(inner) SetOwnerWindow(windowID) → {Number}
- Description:
- Set the docs web view and dashboard web view owner window. only for windows
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
windowID |
String | Specify the owner window. Call this function before calling ShowDocsDashboardView. Call this function when receiving the meeting status MEETING_STATUS_INMEETING. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) SetOwnerWindow(windowID) → {Number}
- Description:
- Set the docs web view and dashboard web view owner window. only for windows
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
windowID |
String | Specify the owner window. Call this function before calling ShowDocsDashboardView. Call this function when receiving the meeting status MEETING_STATUS_INMEETING. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) ShowDocsDashboard(x, y) → {Number}
- Description:
- Show the docs dashboard web view window.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
x |
Number | The original point to display docs web view window. Default is 0. only for mac |
y |
Number | The original point to display docs web view window. Default is 0. only for mac |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) ShowDocsDashboard(x, y) → {Number}
- Description:
- Show the docs dashboard web view window.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
x |
Number | The original point to display docs web view window. Default is 0. only for mac |
y |
Number | The original point to display docs web view window. Default is 0. only for mac |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) ShowDocsViewWindow(sourceID) → {Number}
- Description:
- Show the docs web view window.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
sourceID |
Number | The share source ID that is sharing. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) ShowDocsViewWindow(sourceID) → {Number}
- Description:
- Show the docs web view window.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
sourceID |
Number | The share source ID that is sharing. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
Events
onDocsPermissionChanged
- Description:
- Callback event of docs share setting type changed.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
createOption |
Number | Docs who can create new docs type. For more details, see \link SDKDocsCreateOption \endlink enum. |
option |
Number | Docs who can share type. For more details, see \link SDKDocsShareOption \endlink enum. |
onDocsPermissionChanged
- Description:
- Callback event of docs share setting type changed.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
createOption |
Number | Docs who can create new docs type. For more details, see \link SDKDocsCreateOption \endlink enum. |
option |
Number | Docs who can share type. For more details, see \link SDKDocsShareOption \endlink enum. |
onDocsSharingSourceInfoChanged
- Description:
- Callback for document status change. Notifies when document sharing starts/stops. All meeting participants receive this event.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
info |
Object |
onDocsSharingSourceInfoChanged
- Description:
- Callback for document status change. Notifies when document sharing starts/stops. All meeting participants receive this event.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
info |
Object |