ZoomSDKAICompanionQueryHelper.h File Reference

Go to the source code of this file.

Data Structures
class	ZoomSDKAICompanionQueryItem
class	ZoomSDKEnableQueryHandler
class	ZoomSDKStartQueryHandler
class	ZoomSDKApproveEnableQueryHandler
class	ZoomSDKApproveStartQueryHandler
class	ZoomSDKApproveSendQueryHandler
class	ZoomSDKSendQueryHandler
class	ZoomSDKEnableQueryActionHandler
protocol	<ZoomSDKAICompanionQueryHelperDelegate>
class	ZoomSDKAICompanionQueryHelper

Enumerations
enum	ZoomSDKAICompanionQueryFeedbackType { ZoomSDKAICompanionQueryFeedbackType_None = 0 , ZoomSDKAICompanionQueryFeedbackType_Good , ZoomSDKAICompanionQueryFeedbackType_Bad }
	Enumeration of the types of feedback for AI Companion query responses. More...
enum	ZoomSDKAICompanionQueryRequestError {   ZoomSDKAICompanionQueryRequestError_OK = 0 , ZoomSDKAICompanionQueryRequestError_InvalidParam , ZoomSDKAICompanionQueryRequestError_SendFailed , ZoomSDKAICompanionQueryRequestError_WebUnAvailable ,   ZoomSDKAICompanionQueryRequestError_PermissionVerifyFailed , ZoomSDKAICompanionQueryRequestError_QueryRateLimitError , ZoomSDKAICompanionQueryRequestError_Timeout , ZoomSDKAICompanionQueryRequestError_Unknown = 100 }
	Enumeration of the error types for AI Companion query requests. More...
enum	ZoomSDKAICompanionQuerySettingOptions {   ZoomSDKAICompanionQuerySettingOptions_None = 0 , ZoomSDKAICompanionQuerySettingOptions_WhenQueryStarted , ZoomSDKAICompanionQuerySettingOptions_WhenParticipantsJoin , ZoomSDKAICompanionQuerySettingOptions_OnlyHost ,   ZoomSDKAICompanionQuerySettingOptions_ParticipantsAndInviteesInOurOrganization , ZoomSDKAICompanionQuerySettingOptions_WhenParticipantsAndOrganizationJoin , ZoomSDKAICompanionQuerySettingOptions_HostAndPanelists = 10 , ZoomSDKAICompanionQuerySettingOptions_HostAndPanelistsInOurOrganization }
	Enumeration of configuration options for who in the meeting can interact with AI Companion by asking questions about the meeting. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0057749. More...

Enumeration Type Documentation

ZoomSDKAICompanionQueryFeedbackType

enum ZoomSDKAICompanionQueryFeedbackType

Enumeration of the types of feedback for AI Companion query responses.

Enumerator
ZoomSDKAICompanionQueryFeedbackType_None	For initialization.
ZoomSDKAICompanionQueryFeedbackType_Good	Indicates the feedback is positive, the query response was good.
ZoomSDKAICompanionQueryFeedbackType_Bad	Indicates the feedback is negative, the query response was bad.

Definition at line 7 of file ZoomSDKAICompanionQueryHelper.h.

             {
    ZoomSDKAICompanionQueryFeedbackType_None = 0,
    ZoomSDKAICompanionQueryFeedbackType_Good,
    ZoomSDKAICompanionQueryFeedbackType_Bad
}ZoomSDKAICompanionQueryFeedbackType;

ZoomSDKAICompanionQueryRequestError

enum ZoomSDKAICompanionQueryRequestError

Enumeration of the error types for AI Companion query requests.

Enumerator
ZoomSDKAICompanionQueryRequestError_OK	The request was successful, no error.
ZoomSDKAICompanionQueryRequestError_InvalidParam	Invalid parameter provided in the query request.
ZoomSDKAICompanionQueryRequestError_SendFailed	The request failed to be sent.
ZoomSDKAICompanionQueryRequestError_WebUnAvailable	The web service is unavailable.
ZoomSDKAICompanionQueryRequestError_PermissionVerifyFailed	Permission verification failed for the query request.
ZoomSDKAICompanionQueryRequestError_QueryRateLimitError	The query request exceeded the rate limit.
ZoomSDKAICompanionQueryRequestError_Timeout	The query request timed out.
ZoomSDKAICompanionQueryRequestError_Unknown	An unknown error occurred.

Definition at line 19 of file ZoomSDKAICompanionQueryHelper.h.

             {
    ZoomSDKAICompanionQueryRequestError_OK = 0,
    ZoomSDKAICompanionQueryRequestError_InvalidParam,
    ZoomSDKAICompanionQueryRequestError_SendFailed,
    ZoomSDKAICompanionQueryRequestError_WebUnAvailable,
    ZoomSDKAICompanionQueryRequestError_PermissionVerifyFailed,
    ZoomSDKAICompanionQueryRequestError_QueryRateLimitError,
    ZoomSDKAICompanionQueryRequestError_Timeout,
    ZoomSDKAICompanionQueryRequestError_Unknown = 100
}ZoomSDKAICompanionQueryRequestError;

ZoomSDKAICompanionQuerySettingOptions

enum ZoomSDKAICompanionQuerySettingOptions

Enumeration of configuration options for who in the meeting can interact with AI Companion by asking questions about the meeting. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0057749.

Enumerator
ZoomSDKAICompanionQuerySettingOptions_None	For initialization.
ZoomSDKAICompanionQuerySettingOptions_WhenQueryStarted	Allows all participants and attendee to ask questions about all discussions since AI Companion was active.
ZoomSDKAICompanionQuerySettingOptions_WhenParticipantsJoin	Allows all participants to ask questions about the discussion since they joined the current meeting.
ZoomSDKAICompanionQuerySettingOptions_OnlyHost	Allows only the host, alternative host, and users with host privileges assigned before the meeting start time to ask questions about all discussions since AI Companion is active.
ZoomSDKAICompanionQuerySettingOptions_ParticipantsAndInviteesInOurOrganization	Allows only participants and invitees from your organization to ask questions about all discussions since AI Companion is active.
ZoomSDKAICompanionQuerySettingOptions_WhenParticipantsAndOrganizationJoin	Allows only participants from your organization to ask questions about the discussion since they joined the current meeting.
ZoomSDKAICompanionQuerySettingOptions_HostAndPanelists	Hosts and all panelists can ask questions, and answers are based on the meeting's start time until now.
ZoomSDKAICompanionQuerySettingOptions_HostAndPanelistsInOurOrganization	Hosts and any panelists in our organization can ask questions, and answers are based on the meeting's start time until now.

Definition at line 43 of file ZoomSDKAICompanionQueryHelper.h.

             {
    ZoomSDKAICompanionQuerySettingOptions_None = 0,
    ZoomSDKAICompanionQuerySettingOptions_WhenQueryStarted,
    ZoomSDKAICompanionQuerySettingOptions_WhenParticipantsJoin,
    ZoomSDKAICompanionQuerySettingOptions_OnlyHost,
    ZoomSDKAICompanionQuerySettingOptions_ParticipantsAndInviteesInOurOrganization,
    ZoomSDKAICompanionQuerySettingOptions_WhenParticipantsAndOrganizationJoin,
    ZoomSDKAICompanionQuerySettingOptions_HostAndPanelists = 10,
    ZoomSDKAICompanionQuerySettingOptions_HostAndPanelistsInOurOrganization
}ZoomSDKAICompanionQuerySettingOptions;