Zoom Meeting Docs
- Description:
- Zoom Meeting Docs
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onDocsSharingSourceInfoChanged |
function | Callback for document status change. |
onDocsPermissionChanged |
function | Callback for document sharing permission changes. |
Returns:
- Type
- ZoomMeetingDocs
- Description:
- Zoom Meeting Docs
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onDocsSharingSourceInfoChanged |
function | Callback for document status change. |
onDocsPermissionChanged |
function | Callback for document sharing permission changes. |
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 cannot 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 cannot set docs options.
- Type
- Boolean
(inner) CanStartShareDocs() → {Boolean}
- Description:
- Determine whether the current user can start sharing 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 sharing 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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 the viewable docs sharing information list.
- 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 the viewable docs sharing information list.
- 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 a list of user ID of all users who are sharing docs. If the function fails, the return value is null.
- 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 a list of user ID of all users who are sharing docs. If the function fails, the return value is null.
- Type
- Number
(inner) IsOtherSharingDocs() → {Boolean}
- Description:
- Query if other user is sharing docs.
- Source:
Returns:
true means other user is sharing docs.
- Type
- Boolean
(inner) IsOtherSharingDocs() → {Boolean}
- Description:
- Query if other user is sharing docs.
- Source:
Returns:
true means other user is sharing docs.
- 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.
- 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.
- 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. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- 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. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) SetDocsShareOption(option) → {Number}
- Description:
- Set the setting option for who can share docs.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
option |
Number | The setting for who can share docs. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) SetDocsShareOption(option) → {Number}
- Description:
- Set the setting option for who can share docs.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
option |
Number | The setting for who can share docs. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- 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.
- 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.
- Type
- Number
(inner) SetDocsViewSize(width, height) → {Number}
- Description:
- Set the docs web view window size.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
width |
Number | Specify the width of the docs web view window. |
height |
Number | Specify the height of the docs web view window. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) SetDocsViewSize(width, height) → {Number}
- Description:
- Set the docs web view window size.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
width |
Number | Specify the width of the docs web view window. |
height |
Number | Specify the height of the docs web view window. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) SetOnDocsPermissionChangedCB(onDocsPermissionChanged) → {Boolean}
- Description:
- Set onDocsPermissionChanged callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onDocsPermissionChanged |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetOnDocsPermissionChangedCB(onDocsPermissionChanged) → {Boolean}
- Description:
- Set onDocsPermissionChanged callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onDocsPermissionChanged |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetOnDocsSharingSourceInfoChangedCB(onDocsSharingSourceInfoChanged) → {Boolean}
- Description:
- Set onDocsSharingSourceInfoChanged callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onDocsSharingSourceInfoChanged |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetOnDocsSharingSourceInfoChangedCB(onDocsSharingSourceInfoChanged) → {Boolean}
- Description:
- Set onDocsSharingSourceInfoChanged callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onDocsSharingSourceInfoChanged |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetOwnerWindow(windowID) → {Number}
- Description:
- Set the docs web view and dashboard web view owner window.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
windowID |
String | Specify the owner window. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) SetOwnerWindow(windowID) → {Number}
- Description:
- Set the docs web view and dashboard web view owner window.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
windowID |
String | Specify the owner window. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) ShowDocsDashboard(x, y) → {Number}
- Description:
- Show the docs dashboard web view window.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
x |
Number | The horizontal coordinate value. |
y |
Number | The vertical coordinate value. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) ShowDocsDashboard(x, y) → {Number}
- Description:
- Show the docs dashboard web view window.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
x |
Number | The horizontal coordinate value. |
y |
Number | The vertical coordinate value. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- 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.
- 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.
- Type
- Number
Events
onDocsPermissionChanged
- Description:
- Callback for document sharing permission changes.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
createOption |
Number | Specifies who can create new documents. |
option |
Number | Specifies who can share documents. |
onDocsPermissionChanged
- Description:
- Callback for document sharing permission changes.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
createOption |
Number | Specifies who can create new documents. |
option |
Number | Specifies who can share documents. |
onDocsSharingSourceInfoChanged
- Description:
- Callback for document status change.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
info |
Object | Document sharing source information with the following properties: - status: Value defined in SDKDocsStatus enum - docTitle: The title of the sharing Zoom docs - shareSourceID: The share source id of the sharing Zoom docs - userID: The user id who is sharing Zoom docs |
onDocsSharingSourceInfoChanged
- Description:
- Callback for document status change.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
info |
Object | Document sharing source information with the following properties: - status: Value defined in SDKDocsStatus enum - docTitle: The title of the sharing Zoom docs - shareSourceID: The share source id of the sharing Zoom docs - userID: The user id who is sharing Zoom docs |