Zoom Direct Share Helper
- Description:
- Zoom Direct Share Helper
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
OnDirectShareStatusUpdate |
function | The callback event will be triggered if the status of direct sharing changes. |
Returns:
- Type
- ZoomDirectShareHelper
- Description:
- Zoom Direct Share Helper
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
OnDirectShareStatusUpdate |
function | The callback event will be triggered if the status of direct sharing changes. |
Returns:
- Type
- ZoomDirectShareHelper
Methods
(inner) CanStartDirectShare() → {Number}
- Description:
- Determine if it is able to start the direct sharing.
- Source:
Returns:
If it is enabled to start the direct sharing, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) CanStartDirectShare() → {Number}
- Description:
- Determine if it is able to start the direct sharing.
- Source:
Returns:
If it is enabled to start the direct sharing, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) Cancel() → {Number}
- Description:
- Delete the present direct sharing.
- Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) Cancel() → {Number}
- Description:
- Delete the present direct sharing.
- Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) IsDirectShareInProgress() → {Boolean}
- Description:
- Determine if direct sharing is in progress.
- Source:
Returns:
- Type
- Boolean
(inner) IsDirectShareInProgress() → {Boolean}
- Description:
- Determine if direct sharing is in progress.
- Source:
Returns:
- Type
- Boolean
(inner) SetDirectShareStatusUpdateCB(OnDirectShareStatusUpdate) → {Boolean}
- Description:
- Set on direct share status update callback function.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
OnDirectShareStatusUpdate |
function |
Returns:
- Type
- Boolean
(inner) SetDirectShareStatusUpdateCB(OnDirectShareStatusUpdate) → {Boolean}
- Description:
- Set on direct share status update callback function.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
OnDirectShareStatusUpdate |
function |
Returns:
- Type
- Boolean
(inner) StartDirectShare() → {Number}
- Description:
- Start direct sharing. This API can only be called by the logged in user.
- Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) StartDirectShare() → {Number}
- Description:
- Start direct sharing. This API can only be called by the logged in user.
- Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) StopDirectShare() → {Number}
- Description:
- Stop direct sharing. This API can only be called by the logged in user.
- Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) StopDirectShare() → {Number}
- Description:
- Stop direct sharing. This API can only be called by the logged in user.
- Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) TryWithMeetingNumber(meetingNumber) → {Number}
- Description:
- Try to match with the specified meeting number.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
meetingNumber |
Number | Specifies the meeting number. |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) TryWithMeetingNumber(meetingNumber) → {Number}
- Description:
- Try to match with the specified meeting number.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
meetingNumber |
Number | Specifies the meeting number. |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) TryWithPairingCode(pairingCode) → {Number}
- Description:
- Try to match with the pairing code.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
pairingCode |
String | Specifies the pairing code. |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) TryWithPairingCode(pairingCode) → {Number}
- Description:
- Try to match with the pairing code.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
pairingCode |
String | Specifies the pairing code. |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
Events
OnDirectShareStatusUpdate
- Description:
- The callback event will be triggered if the status of direct sharing changes.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
status |
String | Specifies the status of direct sharing. Defined in: DirectShareStatus |
OnDirectShareStatusUpdate
- Description:
- The callback event will be triggered if the status of direct sharing changes.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
status |
String | Specifies the status of direct sharing. Defined in: DirectShareStatus |