Zoom Meeting AI Companion
- Description:
- Zoom Meeting AI Companion
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onAICompanionFeatureTurnOffByParticipant |
function | Callback when the auto start AI Companion feature is turned off by a participant before the host join. Only the host or cohost can receive this callback. |
onAICompanionFeatureSwitchRequested |
function | Callback when host receives the request to turn the AI Companion features on or off. |
onAICompanionFeatureSwitchRequestResponse |
function | Callback when the host handles the request to turn the AI Companion features on or off. |
onAICompanionFeatureCanNotBeTurnedOff |
function | Callback when the started AI Companion feature can't be turned off. |
onSmartSummaryStateNotSupported |
function | Callback notify the meting does not support smart summary. |
onSmartSummaryStateSupportedButDisabled |
function | Callback notify the meeting support smart summary but smart summary feature is disabled. |
onSmartSummaryStateEnabledButNotStarted |
function | Callback notify the meeting smart summary is not started. |
onSmartSummaryStateStarted |
function | Callback notify the meeting smart summary is started. |
onFailedToStartSmartSummary |
function | Callback notify failed to start the smart summary. |
onSmartSummaryEnableRequestReceived |
function | Callback notify receive request to enable smart summary. |
onSmartSummaryStartRequestReceived |
function | Callback notify receive request to start smart summary. |
onSmartSummaryEnableActionCallback |
function | Callback notify receive request to start smart summary. |
onQueryStateNotSupported |
function | Callback event that the meeting does not support query. |
onQueryStateSupportedButDisabled |
function | Callback event that the meeting supports query but query feature is disabled. |
onQueryStateEnabledButNotStarted |
function | Callback event that the query is not started. |
onQueryStateStarted |
function | Callback event that the query is started. |
onQuerySettingChanged |
function | Callback event that the query setting is changed. |
onFailedToStartQuery |
function | Callback event that the query failed to start. |
onReceiveRequestToEnableQuery |
function | Callback event that receiving request to enable query. |
onReceiveRequestToStartQuery |
function | Callback event that receiving request to start query. |
onReceiveQueryAnswer |
function | Callback event that receiving query answer. |
onQueryEnableActionCallback |
function | Callback event that receiving query enable action callback. |
onSendQueryPrivilegeChanged |
function | Callback event that getting or losing send query question privilege. |
onFailedToRequestSendQuery |
function | Callback event that failed to request send query. |
onReceiveRequestToSendQuery |
function | Callback event that receiving request to send query. |
Returns:
- Type
- ZoomMeetingAICompanion
- Description:
- Zoom Meeting AI Companion
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onAICompanionFeatureTurnOffByParticipant |
function | Callback when the auto start AI Companion feature is turned off by a participant before the host join. Only the host or cohost can receive this callback. |
onAICompanionFeatureSwitchRequested |
function | Callback when host receives the request to turn the AI Companion features on or off. |
onAICompanionFeatureSwitchRequestResponse |
function | Callback when the host handles the request to turn the AI Companion features on or off. |
onAICompanionFeatureCanNotBeTurnedOff |
function | Callback when the started AI Companion feature can't be turned off. |
onSmartSummaryStateNotSupported |
function | Callback notify the meting does not support smart summary. |
onSmartSummaryStateSupportedButDisabled |
function | Callback notify the meeting support smart summary but smart summary feature is disabled. |
onSmartSummaryStateEnabledButNotStarted |
function | Callback notify the meeting smart summary is not started. |
onSmartSummaryStateStarted |
function | Callback notify the meeting smart summary is started. |
onFailedToStartSmartSummary |
function | Callback notify failed to start the smart summary. |
onSmartSummaryEnableRequestReceived |
function | Callback notify receive request to enable smart summary. |
onSmartSummaryStartRequestReceived |
function | Callback notify receive request to start smart summary. |
onSmartSummaryEnableActionCallback |
function | Callback notify receive request to start smart summary. |
onQueryStateNotSupported |
function | Callback event that the meeting does not support query. |
onQueryStateSupportedButDisabled |
function | Callback event that the meeting supports query but query feature is disabled. |
onQueryStateEnabledButNotStarted |
function | Callback event that the query is not started. |
onQueryStateStarted |
function | Callback event that the query is started. |
onQuerySettingChanged |
function | Callback event that the query setting is changed. |
onFailedToStartQuery |
function | Callback event that the query failed to start. |
onReceiveRequestToEnableQuery |
function | Callback event that receiving request to enable query. |
onReceiveRequestToStartQuery |
function | Callback event that receiving request to start query. |
onReceiveQueryAnswer |
function | Callback event that receiving query answer. |
onQueryEnableActionCallback |
function | Callback event that receiving query enable action callback. |
onSendQueryPrivilegeChanged |
function | Callback event that getting or losing send query question privilege. |
onFailedToRequestSendQuery |
function | Callback event that failed to request send query. |
onReceiveRequestToSendQuery |
function | Callback event that receiving request to send query. |
Returns:
- Type
- ZoomMeetingAICompanion
Methods
(inner) AICompanionQueryFeedback(feedbackType) → {Number}
- Description:
- Send feedback of query answer.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
feedbackType |
Number | The feedback type. For more details, see MeetingAICompanionQueryFeedbackType |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) AICompanionQueryFeedback(feedbackType) → {Number}
- Description:
- Send feedback of query answer.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
feedbackType |
Number | The feedback type. For more details, see MeetingAICompanionQueryFeedbackType |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) Agree(deleteAssets) → {Number}
- Description:
- Agree the request to turn the AI companion features on or off.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
deleteAssets |
Boolean | Specify whether delete the meeting assets when turning off the AI Companion features. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) Agree(deleteAssets) → {Number}
- Description:
- Agree the request to turn the AI companion features on or off.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
deleteAssets |
Boolean | Specify whether delete the meeting assets when turning off the AI Companion features. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) AgreeTurnOff() → {Number}
- Description:
- Agree the auto AI Companion feature turn off status. Keep the AI Companion feature off.
- 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) AgreeTurnOff() → {Number}
- Description:
- Agree the auto AI Companion feature turn off status. Keep the AI Companion feature off.
- 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) ApproveSendQuery() → {Number}
- Description:
- Approve the request.
- 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) ApproveSendQuery() → {Number}
- Description:
- Approve the request.
- 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) ApproveStartQuery() → {Number}
- Description:
- Approve request.
- 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) ApproveStartQuery() → {Number}
- Description:
- Approve request.
- 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) ApproveStartSmartSummary() → {Number}
- Description:
- Approve request.
- 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) ApproveStartSmartSummary() → {Number}
- Description:
- Approve request.
- 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) CanChangeQuerySetting() → {Object}
- Description:
- Change query setting.
- Source:
Returns:
bCan True means that it can change the setting. Otherwise it can't change the setting.
- Type
- Object
(inner) CanChangeQuerySetting() → {Object}
- Description:
- Change query setting.
- Source:
Returns:
bCan True means that it can change the setting. Otherwise it can't change the setting.
- Type
- Object
(inner) CanRequestTurnOnAllAICompanions() → {Boolean}
- Description:
- Determine whether the current user can request host to turn on all AI Companion features if they are enabled for the current meeting.
- Source:
Returns:
True indicates the user can request host to turn on the AI Companion features.
- Type
- Boolean
(inner) CanRequestTurnOnAllAICompanions() → {Boolean}
- Description:
- Determine whether the current user can request host to turn on all AI Companion features if they are enabled for the current meeting.
- Source:
Returns:
True indicates the user can request host to turn on the AI Companion features.
- Type
- Boolean
(inner) CanRequestTurnoffAllAICompanions() → {Boolean}
- Description:
- Determine whether the current user can request host to turn off all started AI Companion features.
- Source:
Returns:
True indicates the user can request host to turn off all started AI Companion features.
- Type
- Boolean
(inner) CanRequestTurnoffAllAICompanions() → {Boolean}
- Description:
- Determine whether the current user can request host to turn off all started AI Companion features.
- Source:
Returns:
True indicates the user can request host to turn off all started AI Companion features.
- Type
- Boolean
(inner) CanSendQuery() → {Boolean}
- Description:
- Determine if can send query question.
- Source:
Returns:
true means can, otherwise not.
- Type
- Boolean
(inner) CanSendQuery() → {Boolean}
- Description:
- Determine if can send query question.
- Source:
Returns:
true means can, otherwise not.
- Type
- Boolean
(inner) CanTurnOffAllAICompanions() → {Boolean}
- Description:
- Determine whether the current user can turn off the AI Companion features.
- Source:
Returns:
True indicates the user can turn off the AI Companion features.
- Type
- Boolean
(inner) CanTurnOffAllAICompanions() → {Boolean}
- Description:
- Determine whether the current user can turn off the AI Companion features.
- Source:
Returns:
True indicates the user can turn off the AI Companion features.
- Type
- Boolean
(inner) CanTurnOnAllAICompanions() → {Boolean}
- Description:
- Determine whether the current user can turn on the AI Companion features.
- Source:
Returns:
True indicates the user can turn on the AI Companion features.
- Type
- Boolean
(inner) CanTurnOnAllAICompanions() → {Boolean}
- Description:
- Determine whether the current user can turn on the AI Companion features.
- Source:
Returns:
True indicates the user can turn on the AI Companion features.
- Type
- Boolean
(inner) CancelEnableQueryAction() → {Number}
- Description:
- Cancel enable query. The object will be deleted after this interface call.
- 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) CancelEnableQueryAction() → {Number}
- Description:
- Cancel enable query. The object will be deleted after this interface call.
- 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) CancelEnableSmartSummaryAction() → {Number}
- Description:
- Cancel enabling smart summary.
- 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) CancelEnableSmartSummaryAction() → {Number}
- Description:
- Cancel enabling smart summary.
- 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) ChangeQuerySettings(setting) → {Number}
- Description:
- Change query setting.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
setting |
Number | The query setting, For more details, see MeetingAICompanionQuerySettingOptions |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) ChangeQuerySettings(setting) → {Number}
- Description:
- Change query setting.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
setting |
Number | The query setting, For more details, see MeetingAICompanionQuerySettingOptions |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) ConfirmEnableQueryAction() → {Number}
- Description:
- Confirm enable query. The object will be deleted after this interface call.
- 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) ConfirmEnableQueryAction() → {Number}
- Description:
- Confirm enable query. The object will be deleted after this interface call.
- 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) ConfirmEnableSmartSummaryAction() → {Number}
- Description:
- Confirm enabling smart summary.
- 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) ConfirmEnableSmartSummaryAction() → {Number}
- Description:
- Confirm enabling smart summary.
- 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) ContinueApproveEnableQuery() → {Number}
- Description:
- Continue approve action.
- 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) ContinueApproveEnableQuery() → {Number}
- Description:
- Continue approve action.
- 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) ContinueApproveEnableSmartSummary() → {Number}
- Description:
- Continue approve action.
- 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) ContinueApproveEnableSmartSummary() → {Number}
- Description:
- Continue approve action.
- 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) Decline() → {Number}
- Description:
- Decline the request to turn the AI companion features on or off.
- 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) Decline() → {Number}
- Description:
- Decline the request to turn the AI companion features on or off.
- 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) DeclineSendQuery(bDeclineAll) → {Number}
- Description:
- Decline the request.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bDeclineAll |
Boolean | true means decline all request. |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) DeclineSendQuery(bDeclineAll) → {Number}
- Description:
- Decline the request.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bDeclineAll |
Boolean | true means decline all request. |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) DeclineStartQuery() → {Number}
- Description:
- Decline request.
- 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) DeclineStartQuery() → {Number}
- Description:
- Decline request.
- 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) DeclineStartSmartSummary() → {Number}
- Description:
- ConfirmEnableSmartSummaryAction request.
- 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) DeclineStartSmartSummary() → {Number}
- Description:
- ConfirmEnableSmartSummaryAction request.
- 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) EnableQuery() → {Number}
- Description:
- Enable meeting query.
- 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) EnableQuery() → {Number}
- Description:
- Enable meeting query.
- 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) EnableSmartSummary() → {Number}
- Description:
- Enable smart summary.
- 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) EnableSmartSummary() → {Number}
- Description:
- Enable smart summary.
- 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) GetAICompanionQueryLegalNoticesExplained() → {String}
- Description:
- Get the AI Companion query legal notices explained.
- Source:
Returns:
If the function succeeds, it will return the AI Companion query legal notices explained. Otherwise the function fails.
- Type
- String
(inner) GetAICompanionQueryLegalNoticesExplained() → {String}
- Description:
- Get the AI Companion query legal notices explained.
- Source:
Returns:
If the function succeeds, it will return the AI Companion query legal notices explained. Otherwise the function fails.
- Type
- String
(inner) GetAICompanionQueryLegalNoticesPrompt() → {String}
- Description:
- Get the AI Companion query legal notices prompt.
- Source:
Returns:
If the function succeeds, it will return the AI Companion query legal notices prompt. Otherwise the function fails.
- Type
- String
(inner) GetAICompanionQueryLegalNoticesPrompt() → {String}
- Description:
- Get the AI Companion query legal notices prompt.
- Source:
Returns:
If the function succeeds, it will return the AI Companion query legal notices prompt. Otherwise the function fails.
- Type
- String
(inner) GetAICompanionQueryPrivacyLegalNoticesPrompt() → {String}
- Description:
- Get the AI Companion query privacy legal notices prompt.
- Source:
Returns:
If the function succeeds, it will return the AI Companion query privacy legal notices prompt. Otherwise the function fails.
- Type
- String
(inner) GetAICompanionQueryPrivacyLegalNoticesPrompt() → {String}
- Description:
- Get the AI Companion query privacy legal notices prompt.
- Source:
Returns:
If the function succeeds, it will return the AI Companion query privacy legal notices prompt. Otherwise the function fails.
- Type
- String
(inner) GetAssetsDeletedFeatureList() → {Array}
- Description:
- Get the list of features that the assets are deleted when the feature is turned off by participant.
- Source:
Returns:
- Type
- Array
(inner) GetAssetsDeletedFeatureList() → {Array}
- Description:
- Get the list of features that the assets are deleted when the feature is turned off by participant.
- Source:
Returns:
- Type
- Array
(inner) GetDefaultQueryQuestions() → {Array}
- Description:
- Get default query questions.
- Source:
Returns:
If the function succeeds, it returns the array of questions. Otherwise the function fails.
- Type
- Array
(inner) GetDefaultQueryQuestions() → {Array}
- Description:
- Get default query questions.
- Source:
Returns:
If the function succeeds, it returns the array of questions. Otherwise the function fails.
- Type
- Array
(inner) GetEnableQueryActionTipString() → {String}
- Description:
- Get the tip string.
- Source:
Returns:
- Type
- String
(inner) GetEnableQueryActionTipString() → {String}
- Description:
- Get the tip string.
- Source:
Returns:
- Type
- String
(inner) GetEnableQueryActionTipTitle() → {String}
- Description:
- Get the title of the tip.
- Source:
Returns:
- Type
- String
(inner) GetEnableQueryActionTipTitle() → {String}
- Description:
- Get the title of the tip.
- Source:
Returns:
- Type
- String
(inner) GetEnableSmartSummaryActionTipString() → {String}
- Description:
- Get the string of tip.
- Source:
Returns:
The string of tip.
- Type
- String
(inner) GetEnableSmartSummaryActionTipString() → {String}
- Description:
- Get the string of tip.
- Source:
Returns:
The string of tip.
- Type
- String
(inner) GetEnableSmartSummaryActionTipTitle() → {String}
- Description:
- Get the title of tip.
- Source:
Returns:
The title of tip.
- Type
- String
(inner) GetEnableSmartSummaryActionTipTitle() → {String}
- Description:
- Get the title of tip.
- Source:
Returns:
The title of tip.
- Type
- String
(inner) GetFeatureList() → {Array}
- Description:
- Get the list of features that the participant turns off.
- Source:
Returns:
- Type
- Array
(inner) GetFeatureList() → {Array}
- Description:
- Get the list of features that the participant turns off.
- Source:
Returns:
- Type
- Array
(inner) GetRequestUserID() → {Number}
- Description:
- Get the user ID who requests host to turn the AI Companion features on or off.
- Source:
Returns:
the request user ID.
- Type
- Number
(inner) GetRequestUserID() → {Number}
- Description:
- Get the user ID who requests host to turn the AI Companion features on or off.
- Source:
Returns:
the request user ID.
- Type
- Number
(inner) GetSelectedQuerySetting() → {Number}
- Description:
- Get the selected query setting.
- Source:
Returns:
If the function succeeds, it will return the selected query setting. Otherwise not.
- Type
- Number
(inner) GetSelectedQuerySetting() → {Number}
- Description:
- Get the selected query setting.
- Source:
Returns:
If the function succeeds, it will return the selected query setting. Otherwise not.
- Type
- Number
(inner) GetSenderEnableQueryUserID() → {Number}
- Description:
- Get the user ID of the requester.
- Source:
Returns:
The user ID of the requester.
- Type
- Number
(inner) GetSenderEnableQueryUserID() → {Number}
- Description:
- Get the user ID of the requester.
- Source:
Returns:
The user ID of the requester.
- Type
- Number
(inner) GetSenderEnableSmartSummaryUserID() → {Number}
- Description:
- Get the user ID of the requester.
- Source:
Returns:
The user ID of the requester.
- Type
- Number
(inner) GetSenderEnableSmartSummaryUserID() → {Number}
- Description:
- Get the user ID of the requester.
- Source:
Returns:
The user ID of the requester.
- Type
- Number
(inner) GetSenderQueryUserID() → {Number}
- Description:
- Get the requester's user ID.
- Source:
Returns:
the requester's user ID.
- Type
- Number
(inner) GetSenderQueryUserID() → {Number}
- Description:
- Get the requester's user ID.
- Source:
Returns:
the requester's user ID.
- Type
- Number
(inner) GetSenderStartQueryUserID() → {Number}
- Description:
- Get the user ID of the requester.
- Source:
Returns:
The user ID of the requester.
- Type
- Number
(inner) GetSenderStartQueryUserID() → {Number}
- Description:
- Get the user ID of the requester.
- Source:
Returns:
The user ID of the requester.
- Type
- Number
(inner) GetSenderStartSmartSummaryUserID() → {Number}
- Description:
- Get the user ID of the requester.
- Source:
Returns:
The user ID of the requester.
- Type
- Number
(inner) GetSenderStartSmartSummaryUserID() → {Number}
- Description:
- Get the user ID of the requester.
- Source:
Returns:
The user ID of the requester.
- Type
- Number
(inner) IsAICompanionQueryLegalNoticeAvailable() → {Object}
- Description:
- Determine whether the legal notice for the AI Companion query is available.
- Source:
Returns:
bAvailable True indicates the legal notice for the AI Companion query is available. Otherwise the legal notice is not available.
- Type
- Object
(inner) IsAICompanionQueryLegalNoticeAvailable() → {Object}
- Description:
- Determine whether the legal notice for the AI Companion query is available.
- Source:
Returns:
bAvailable True indicates the legal notice for the AI Companion query is available. Otherwise the legal notice is not available.
- Type
- Object
(inner) IsAICompanionQueryPrivacyLegalNoticeAvailable() → {Object}
- Description:
- Determine whether the legal notice for the AI Companion query privacy is available.
- Source:
Returns:
bAvailable True indicates the legal notice for the AI Companion query privacy is available. Otherwise the legal notice is not available.
- Type
- Object
(inner) IsAICompanionQueryPrivacyLegalNoticeAvailable() → {Object}
- Description:
- Determine whether the legal notice for the AI Companion query privacy is available.
- Source:
Returns:
bAvailable True indicates the legal notice for the AI Companion query privacy is available. Otherwise the legal notice is not available.
- Type
- Object
(inner) IsForRequestEnableQuery() → {Boolean}
- Description:
- Determine if this handler for request enable query.
- Source:
Returns:
True means this handler is for request enable query. Otherwise it returns false means this handler is for enable query directly.
- Type
- Boolean
(inner) IsForRequestEnableQuery() → {Boolean}
- Description:
- Determine if this handler for request enable query.
- Source:
Returns:
True means this handler is for request enable query. Otherwise it returns false means this handler is for enable query directly.
- Type
- Boolean
(inner) IsForRequestEnableSmartSummary() → {Boolean}
- Description:
- Determine if this handler is requesting enable smart summary.
- Source:
Returns:
True means this handler is for requesting enable smart summary. Otherwise not.
- Type
- Boolean
(inner) IsForRequestEnableSmartSummary() → {Boolean}
- Description:
- Determine if this handler is requesting enable smart summary.
- Source:
Returns:
True means this handler is for requesting enable smart summary. Otherwise not.
- Type
- Boolean
(inner) IsForRequestStartMeetingQuery() → {Boolean}
- Description:
- Determine if this handler for request start query.
- Source:
Returns:
True means this handler is for request start query. Otherwise it returns false means this handler is for start query directly.
- Type
- Boolean
(inner) IsForRequestStartMeetingQuery() → {Boolean}
- Description:
- Determine if this handler for request start query.
- Source:
Returns:
True means this handler is for request start query. Otherwise it returns false means this handler is for start query directly.
- Type
- Boolean
(inner) IsForRequestStartSmartSummary() → {Boolean}
- Description:
- Determine if this handler is for requesting to start the smart summary.
- Source:
Returns:
True means this handler is requesting to start the smart summary. Otherwise not.
- Type
- Boolean
(inner) IsForRequestStartSmartSummary() → {Boolean}
- Description:
- Determine if this handler is for requesting to start the smart summary.
- Source:
Returns:
True means this handler is requesting to start the smart summary. Otherwise not.
- Type
- Boolean
(inner) IsTurnOn() → {Boolean}
- Description:
- Turn the AI Companion features on or off.
- Source:
Returns:
true means turn on the AI Companion features, false means turn off the AI Companion features.
- Type
- Boolean
(inner) IsTurnOn() → {Boolean}
- Description:
- Turn the AI Companion features on or off.
- Source:
Returns:
true means turn on the AI Companion features, false means turn off the AI Companion features.
- Type
- Boolean
(inner) IsTurnOnAllAICompanionsSupported() → {Boolean}
- Description:
- Determine whether the current meeting supports turning on the AI Companion features.
- Source:
Returns:
True indicates to support.
- Type
- Boolean
(inner) IsTurnOnAllAICompanionsSupported() → {Boolean}
- Description:
- Determine whether the current meeting supports turning on the AI Companion features.
- Source:
Returns:
True indicates to support.
- Type
- Boolean
(inner) IsTurnoffAllAICompanionsSupported() → {Boolean}
- Description:
- Determine whether the current meeting supports turning off the AI Companion features.
- Source:
Returns:
True indicates to support.
- Type
- Boolean
(inner) IsTurnoffAllAICompanionsSupported() → {Boolean}
- Description:
- Determine whether the current meeting supports turning off the AI Companion features.
- Source:
Returns:
True indicates to support.
- Type
- Boolean
(inner) RequestSendQueryPrivilege() → {Number}
- Description:
- Request send query privilege.
- 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) RequestSendQueryPrivilege() → {Number}
- Description:
- Request send query privilege.
- 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) RequestTurnOnAllAICompanions() → {Number}
- Description:
- request host to turn on all AI Companion features if they are enabled for the current meeting.
- 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) RequestTurnOnAllAICompanions() → {Number}
- Description:
- request host to turn on all AI Companion features if they are enabled for the current meeting.
- 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) RequestTurnoffAllAICompanions() → {Number}
- Description:
- request host to turn off all started AI Companion features.
- 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) RequestTurnoffAllAICompanions() → {Number}
- Description:
- request host to turn off all started AI Companion features.
- 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) SendQueryQuestion(question) → {Number}
- Description:
- Send query question.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
question |
String | The query question. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) SendQueryQuestion(question) → {Number}
- Description:
- Send query question.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
question |
String | The query question. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) SetOnAICompanionFeatureCanNotBeTurnedOffCB(onAICompanionFeatureCanNotBeTurnedOff) → {Boolean}
- Description:
- Set notification user need to go to web to enable the smart summary feature callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onAICompanionFeatureCanNotBeTurnedOff |
function |
Returns:
- Type
- Boolean
(inner) SetOnAICompanionFeatureCanNotBeTurnedOffCB(onAICompanionFeatureCanNotBeTurnedOff) → {Boolean}
- Description:
- Set notification user need to go to web to enable the smart summary feature callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onAICompanionFeatureCanNotBeTurnedOff |
function |
Returns:
- Type
- Boolean
(inner) SetOnAICompanionFeatureSwitchRequestResponseCB(onAICompanionFeatureSwitchRequestResponse) → {Boolean}
- Description:
- Set host handle the smart summary request callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onAICompanionFeatureSwitchRequestResponse |
function |
Returns:
- Type
- Boolean
(inner) SetOnAICompanionFeatureSwitchRequestResponseCB(onAICompanionFeatureSwitchRequestResponse) → {Boolean}
- Description:
- Set host handle the smart summary request callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onAICompanionFeatureSwitchRequestResponse |
function |
Returns:
- Type
- Boolean
(inner) SetOnAICompanionFeatureSwitchRequestedCB(onAICompanionFeatureSwitchRequested) → {Boolean}
- Description:
- Set notification user requests host to start smart summary callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onAICompanionFeatureSwitchRequested |
function |
Returns:
- Type
- Boolean
(inner) SetOnAICompanionFeatureSwitchRequestedCB(onAICompanionFeatureSwitchRequested) → {Boolean}
- Description:
- Set notification user requests host to start smart summary callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onAICompanionFeatureSwitchRequested |
function |
Returns:
- Type
- Boolean
(inner) SetOnAICompanionFeatureTurnOffByParticipantCB(onAICompanionFeatureTurnOffByParticipant) → {Boolean}
- Description:
- Set callback when the auto start AI Companion feature is turned off by a participant before the host join.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onAICompanionFeatureTurnOffByParticipant |
function |
Returns:
- Type
- Boolean
(inner) SetOnAICompanionFeatureTurnOffByParticipantCB(onAICompanionFeatureTurnOffByParticipant) → {Boolean}
- Description:
- Set callback when the auto start AI Companion feature is turned off by a participant before the host join.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onAICompanionFeatureTurnOffByParticipant |
function |
Returns:
- Type
- Boolean
(inner) SetOnFailedToRequestSendQueryCB(onFailedToRequestSendQuery) → {Boolean}
- Description:
- Set callback event event that failed to request send query.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onFailedToRequestSendQuery |
function |
Returns:
- Type
- Boolean
(inner) SetOnFailedToRequestSendQueryCB(onFailedToRequestSendQuery) → {Boolean}
- Description:
- Set callback event event that failed to request send query.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onFailedToRequestSendQuery |
function |
Returns:
- Type
- Boolean
(inner) SetOnFailedToStartQueryCB(onFailedToStartQuery) → {Boolean}
- Description:
- Set callback event that the query failed to start.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onFailedToStartQuery |
function |
Returns:
- Type
- Boolean
(inner) SetOnFailedToStartQueryCB(onFailedToStartQuery) → {Boolean}
- Description:
- Set callback event that the query failed to start.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onFailedToStartQuery |
function |
Returns:
- Type
- Boolean
(inner) SetOnFailedToStartSmartSummaryCB(onFailedToStartSmartSummary) → {Boolean}
- Description:
- Set notify the meeting smart summary is started callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onFailedToStartSmartSummary |
function |
Returns:
- Type
- Boolean
(inner) SetOnFailedToStartSmartSummaryCB(onFailedToStartSmartSummary) → {Boolean}
- Description:
- Set notify the meeting smart summary is started callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onFailedToStartSmartSummary |
function |
Returns:
- Type
- Boolean
(inner) SetOnQueryEnableActionCallback(onQueryEnableActionCallback) → {Boolean}
- Description:
- Set callback event that receiving query enable action callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onQueryEnableActionCallback |
function |
Returns:
- Type
- Boolean
(inner) SetOnQueryEnableActionCallback(onQueryEnableActionCallback) → {Boolean}
- Description:
- Set callback event that receiving query enable action callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onQueryEnableActionCallback |
function |
Returns:
- Type
- Boolean
(inner) SetOnQuerySettingChangedCB(onQuerySettingChanged) → {Boolean}
- Description:
- Set callback event that the query setting is changed.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onQuerySettingChanged |
function |
Returns:
- Type
- Boolean
(inner) SetOnQuerySettingChangedCB(onQuerySettingChanged) → {Boolean}
- Description:
- Set callback event that the query setting is changed.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onQuerySettingChanged |
function |
Returns:
- Type
- Boolean
(inner) SetOnQueryStateEnabledButNotStartedCB(onQueryStateEnabledButNotStarted) → {Boolean}
- Description:
- Set callback event that the query is not started.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onQueryStateEnabledButNotStarted |
function |
Returns:
- Type
- Boolean
(inner) SetOnQueryStateEnabledButNotStartedCB(onQueryStateEnabledButNotStarted) → {Boolean}
- Description:
- Set callback event that the query is not started.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onQueryStateEnabledButNotStarted |
function |
Returns:
- Type
- Boolean
(inner) SetOnQueryStateNotSupportedCB(onQueryStateNotSupported) → {Boolean}
- Description:
- Set callback event that the meeting does not support query.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onQueryStateNotSupported |
function |
Returns:
- Type
- Boolean
(inner) SetOnQueryStateNotSupportedCB(onQueryStateNotSupported) → {Boolean}
- Description:
- Set callback event that the meeting does not support query.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onQueryStateNotSupported |
function |
Returns:
- Type
- Boolean
(inner) SetOnQueryStateStartedCB(onQueryStateStarted) → {Boolean}
- Description:
- Set callback event that the query is started.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onQueryStateStarted |
function |
Returns:
- Type
- Boolean
(inner) SetOnQueryStateStartedCB(onQueryStateStarted) → {Boolean}
- Description:
- Set callback event that the query is started.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onQueryStateStarted |
function |
Returns:
- Type
- Boolean
(inner) SetOnQueryStateSupportedButDisabledCB(onQueryStateSupportedButDisabled) → {Boolean}
- Description:
- Set callback event that the meeting supports query but query feature is disabled.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onQueryStateSupportedButDisabled |
function |
Returns:
- Type
- Boolean
(inner) SetOnQueryStateSupportedButDisabledCB(onQueryStateSupportedButDisabled) → {Boolean}
- Description:
- Set callback event that the meeting supports query but query feature is disabled.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onQueryStateSupportedButDisabled |
function |
Returns:
- Type
- Boolean
(inner) SetOnReceiveQueryAnswerCB(onReceiveQueryAnswer) → {Boolean}
- Description:
- Set callback event that receiving query answer.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onReceiveQueryAnswer |
function |
Returns:
- Type
- Boolean
(inner) SetOnReceiveQueryAnswerCB(onReceiveQueryAnswer) → {Boolean}
- Description:
- Set callback event that receiving query answer.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onReceiveQueryAnswer |
function |
Returns:
- Type
- Boolean
(inner) SetOnReceiveRequestToEnableQueryCB(onReceiveRequestToEnableQuery) → {Boolean}
- Description:
- Set callback event that receiving request to enable query.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onReceiveRequestToEnableQuery |
function |
Returns:
- Type
- Boolean
(inner) SetOnReceiveRequestToEnableQueryCB(onReceiveRequestToEnableQuery) → {Boolean}
- Description:
- Set callback event that receiving request to enable query.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onReceiveRequestToEnableQuery |
function |
Returns:
- Type
- Boolean
(inner) SetOnReceiveRequestToSendQueryCB(onReceiveRequestToSendQuery) → {Boolean}
- Description:
- Set callback event that receiving request to send query.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onReceiveRequestToSendQuery |
function |
Returns:
- Type
- Boolean
(inner) SetOnReceiveRequestToSendQueryCB(onReceiveRequestToSendQuery) → {Boolean}
- Description:
- Set callback event that receiving request to send query.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onReceiveRequestToSendQuery |
function |
Returns:
- Type
- Boolean
(inner) SetOnReceiveRequestToStartQueryCB(onReceiveRequestToStartQuery) → {Boolean}
- Description:
- Set callback event that receiving request to start query.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onReceiveRequestToStartQuery |
function |
Returns:
- Type
- Boolean
(inner) SetOnReceiveRequestToStartQueryCB(onReceiveRequestToStartQuery) → {Boolean}
- Description:
- Set callback event that receiving request to start query.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onReceiveRequestToStartQuery |
function |
Returns:
- Type
- Boolean
(inner) SetOnSendQueryPrivilegeChangedCB(onSendQueryPrivilegeChanged) → {Boolean}
- Description:
- Set callback event that getting or losing send query question privilege.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onSendQueryPrivilegeChanged |
function |
Returns:
- Type
- Boolean
(inner) SetOnSendQueryPrivilegeChangedCB(onSendQueryPrivilegeChanged) → {Boolean}
- Description:
- Set callback event that getting or losing send query question privilege.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onSendQueryPrivilegeChanged |
function |
Returns:
- Type
- Boolean
(inner) SetOnSmartSummaryEnableActionCallbackCB(onSmartSummaryEnableActionCallback) → {Boolean}
- Description:
- Set notify receive request to start smart summary.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onSmartSummaryEnableActionCallback |
function |
Returns:
- Type
- Boolean
(inner) SetOnSmartSummaryEnableActionCallbackCB(onSmartSummaryEnableActionCallback) → {Boolean}
- Description:
- Set notify receive request to start smart summary.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onSmartSummaryEnableActionCallback |
function |
Returns:
- Type
- Boolean
(inner) SetOnSmartSummaryEnableRequestReceivedCB(onSmartSummaryEnableRequestReceived) → {Boolean}
- Description:
- Set notify receive request to enable smart summary callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onSmartSummaryEnableRequestReceived |
function |
Returns:
- Type
- Boolean
(inner) SetOnSmartSummaryEnableRequestReceivedCB(onSmartSummaryEnableRequestReceived) → {Boolean}
- Description:
- Set notify receive request to enable smart summary callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onSmartSummaryEnableRequestReceived |
function |
Returns:
- Type
- Boolean
(inner) SetOnSmartSummaryStartRequestReceivedCB(onSmartSummaryStartRequestReceived) → {Boolean}
- Description:
- Set notify receive request to start smart summary.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onSmartSummaryStartRequestReceived |
function |
Returns:
- Type
- Boolean
(inner) SetOnSmartSummaryStartRequestReceivedCB(onSmartSummaryStartRequestReceived) → {Boolean}
- Description:
- Set notify receive request to start smart summary.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onSmartSummaryStartRequestReceived |
function |
Returns:
- Type
- Boolean
(inner) SetOnSmartSummaryStateEnabledButNotStartedCB(onSmartSummaryStateEnabledButNotStarted) → {Boolean}
- Description:
- Set notify the meeting smart summary is not started callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onSmartSummaryStateEnabledButNotStarted |
function |
Returns:
- Type
- Boolean
(inner) SetOnSmartSummaryStateEnabledButNotStartedCB(onSmartSummaryStateEnabledButNotStarted) → {Boolean}
- Description:
- Set notify the meeting smart summary is not started callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onSmartSummaryStateEnabledButNotStarted |
function |
Returns:
- Type
- Boolean
(inner) SetOnSmartSummaryStateNotSupportedCB(onSmartSummaryStateNotSupported) → {Boolean}
- Description:
- Set notify the meting does not support smart summary callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onSmartSummaryStateNotSupported |
function |
Returns:
- Type
- Boolean
(inner) SetOnSmartSummaryStateNotSupportedCB(onSmartSummaryStateNotSupported) → {Boolean}
- Description:
- Set notify the meting does not support smart summary callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onSmartSummaryStateNotSupported |
function |
Returns:
- Type
- Boolean
(inner) SetOnSmartSummaryStateStartedCB(onSmartSummaryStateStarted) → {Boolean}
- Description:
- Set notify the meeting smart summary is started callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onSmartSummaryStateStarted |
function |
Returns:
- Type
- Boolean
(inner) SetOnSmartSummaryStateStartedCB(onSmartSummaryStateStarted) → {Boolean}
- Description:
- Set notify the meeting smart summary is started callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onSmartSummaryStateStarted |
function |
Returns:
- Type
- Boolean
(inner) SetOnSmartSummaryStateSupportedButDisabledCB(onSmartSummaryStateSupportedButDisabled) → {Boolean}
- Description:
- Set notify the meeting support smart summary but smart summary feature is disabled.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onSmartSummaryStateSupportedButDisabled |
function |
Returns:
- Type
- Boolean
(inner) SetOnSmartSummaryStateSupportedButDisabledCB(onSmartSummaryStateSupportedButDisabled) → {Boolean}
- Description:
- Set notify the meeting support smart summary but smart summary feature is disabled.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onSmartSummaryStateSupportedButDisabled |
function |
Returns:
- Type
- Boolean
(inner) StartMeetingQuery() → {Number}
- Description:
- Start meeting query.
- 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) StartMeetingQuery() → {Number}
- Description:
- Start meeting query.
- 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) StartSmartSummary() → {Number}
- Description:
- Start smart summary.
- 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) StartSmartSummary() → {Number}
- Description:
- Start smart summary.
- 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) StopMeetingQuery() → {Number}
- Description:
- Stop meeting query.
- 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) StopMeetingQuery() → {Number}
- Description:
- Stop meeting query.
- 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) StopSmartSummary() → {Number}
- Description:
- Stop smart summary.
- 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) StopSmartSummary() → {Number}
- Description:
- Stop smart summary.
- 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) TurnOffAllAICompanions(deleteAssets) → {Number}
- Description:
- Turn off the AI Companion features.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
deleteAssets |
Boolean | Specify whether delete the meeting assets when turn off the AI Companion features. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) TurnOffAllAICompanions(deleteAssets) → {Number}
- Description:
- Turn off the AI Companion features.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
deleteAssets |
Boolean | Specify whether delete the meeting assets when turn off the AI Companion features. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) TurnOnAgain() → {Number}
- Description:
- Turn on the auto AI Companion feature which was stopped by the participant before the host or cohost joined meeting.
- 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) TurnOnAgain() → {Number}
- Description:
- Turn on the auto AI Companion feature which was stopped by the participant before the host or cohost joined meeting.
- 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) TurnOnAllAICompanions() → {Number}
- Description:
- Turn on the AI Companion features.
- 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) TurnOnAllAICompanions() → {Number}
- Description:
- Turn on the AI Companion features.
- Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
Events
onAICompanionFeatureCanNotBeTurnedOff
- Description:
- Callback when the started AI Companion feature can't be turned off.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
features |
Array | Specify the AI Companion features that can't be turned off. |
onAICompanionFeatureCanNotBeTurnedOff
- Description:
- Callback when the started AI Companion feature can't be turned off.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
features |
Array | Specify the AI Companion features that can't be turned off. |
onAICompanionFeatureSwitchRequestResponse
- Description:
- Callback when the host handles the request to turn the AI Companion features on or off.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bTimeout |
Boolean | Specify the host not handle the request until timeout. |
bAgree |
Boolean | Specify the host agrees to the request to turn the AI companion features on or off. |
bTurnOn |
Boolean | Specify the host respond the request of turn on or off. |
onAICompanionFeatureSwitchRequestResponse
- Description:
- Callback when the host handles the request to turn the AI Companion features on or off.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bTimeout |
Boolean | Specify the host not handle the request until timeout. |
bAgree |
Boolean | Specify the host agrees to the request to turn the AI companion features on or off. |
bTurnOn |
Boolean | Specify the host respond the request of turn on or off. |
onAICompanionFeatureSwitchRequested
- Description:
- Callback when host receives the request to turn the AI Companion features on or off.
- Source:
onAICompanionFeatureSwitchRequested
- Description:
- Callback when host receives the request to turn the AI Companion features on or off.
- Source:
onAICompanionFeatureTurnOffByParticipant
- Description:
- Callback when the auto start AI Companion feature is turned off by a participant before the host join. Only the host or cohost can receive this callback.
- Source:
onAICompanionFeatureTurnOffByParticipant
- Description:
- Callback when the auto start AI Companion feature is turned off by a participant before the host join. Only the host or cohost can receive this callback.
- Source:
onFailedToRequestSendQuery
- Description:
- Callback event that failed to request send query.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bTimeout |
Boolean | true means is timeout. Otherwise means the user declines the request. |
onFailedToRequestSendQuery
- Description:
- Callback event that failed to request send query.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bTimeout |
Boolean | true means is timeout. Otherwise means the user declines the request. |
onFailedToStartQuery
- Description:
- Callback event that the query failed to start.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bTimeout |
Boolean | true means is timeout. Otherwise not. |
onFailedToStartQuery
- Description:
- Callback event that the query failed to start.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bTimeout |
Boolean | true means is timeout. Otherwise not. |
onFailedToStartSmartSummary
- Description:
- Callback notify failed to start the smart summary.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bTimeout |
Boolean | bTimeout True means timeout. Otherwise no timeout. May be declined by host or cohost. |
onFailedToStartSmartSummary
- Description:
- Callback notify failed to start the smart summary.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bTimeout |
Boolean | bTimeout True means timeout. Otherwise no timeout. May be declined by host or cohost. |
onQueryEnableActionCallback
- Description:
- Callback event that receiving query enable action callback.
- Source:
onQueryEnableActionCallback
- Description:
- Callback event that receiving query enable action callback.
- Source:
onQuerySettingChanged
- Description:
- Callback event that the query setting is changed.
- Source:
onQuerySettingChanged
- Description:
- Callback event that the query setting is changed.
- Source:
onQueryStateEnabledButNotStarted
- Description:
- Callback event that the query is not started.
- Source:
onQueryStateEnabledButNotStarted
- Description:
- Callback event that the query is not started.
- Source:
onQueryStateNotSupported
- Description:
- Callback event that the meeting does not support query.
- Source:
onQueryStateNotSupported
- Description:
- Callback event that the meeting does not support query.
- Source:
onQueryStateStarted
- Description:
- Callback event that the query is started.
- Source:
onQueryStateStarted
- Description:
- Callback event that the query is started.
- Source:
onQueryStateSupportedButDisabled
- Description:
- Callback event that the meeting supports query but query feature is disabled.
- Source:
onQueryStateSupportedButDisabled
- Description:
- Callback event that the meeting supports query but query feature is disabled.
- Source:
onReceiveQueryAnswer
- Description:
- Callback event that receiving query answer.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
queryItem |
Object |
onReceiveQueryAnswer
- Description:
- Callback event that receiving query answer.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
queryItem |
Object |
onReceiveRequestToEnableQuery
- Description:
- Callback event that receiving request to enable query.
- Source:
onReceiveRequestToEnableQuery
- Description:
- Callback event that receiving request to enable query.
- Source:
onReceiveRequestToSendQuery
- Description:
- Callback event that receiving request to send query.
- Source:
onReceiveRequestToSendQuery
- Description:
- Callback event that receiving request to send query.
- Source:
onReceiveRequestToStartQuery
- Description:
- Callback event that receiving request to start query.
- Source:
onReceiveRequestToStartQuery
- Description:
- Callback event that receiving request to start query.
- Source:
onSendQueryPrivilegeChanged
- Description:
- Callback event that getting or losing send query question privilege.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
canSendQuery |
Boolean | true means can send. Otherwise not. |
onSendQueryPrivilegeChanged
- Description:
- Callback event that getting or losing send query question privilege.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
canSendQuery |
Boolean | true means can send. Otherwise not. |
onSmartSummaryEnableActionCallback
- Description:
- Callback notify receive request to start smart summary.
- Source:
onSmartSummaryEnableActionCallback
- Description:
- Callback notify receive request to start smart summary.
- Source:
onSmartSummaryEnableRequestReceived
- Description:
- Callback notify receive request to enable smart summary.
- Source:
onSmartSummaryEnableRequestReceived
- Description:
- Callback notify receive request to enable smart summary.
- Source:
onSmartSummaryStartRequestReceived
- Description:
- Callback notify receive request to start smart summary.
- Source:
onSmartSummaryStartRequestReceived
- Description:
- Callback notify receive request to start smart summary.
- Source:
onSmartSummaryStateEnabledButNotStarted
- Description:
- Callback notify the meeting smart summary is not started.
- Source:
onSmartSummaryStateEnabledButNotStarted
- Description:
- Callback notify the meeting smart summary is not started.
- Source:
onSmartSummaryStateNotSupported
- Description:
- Callback notify the meting does not support smart summary.
- Source:
onSmartSummaryStateNotSupported
- Description:
- Callback notify the meting does not support smart summary.
- Source:
onSmartSummaryStateStarted
- Description:
- Callback notify the meeting smart summary is started.
- Source:
onSmartSummaryStateStarted
- Description:
- Callback notify the meeting smart summary is started.
- Source:
onSmartSummaryStateSupportedButDisabled
- Description:
- Callback notify the meeting support smart summary but smart summary feature is disabled.
- Source:
onSmartSummaryStateSupportedButDisabled
- Description:
- Callback notify the meeting support smart summary but smart summary feature is disabled.
- Source: