Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKAICompanionQueryHelper Class Reference

Helper class to manage AI Companion meeting query features and related legal notices. More...

#include <ZoomSDKAICompanionQueryHelper.h>

Inherits NSObject.

Instance Methods

(ZoomSDKAICompanionQuerySettingOptions- getSelectedQuerySetting
 Gets the selected query setting.
(BOOL) - canChangeQuerySetting
 Determines whether the current user can change query setting.
(ZoomSDKError- changeQuerySettings:
 Change query setting.
(BOOL) - isAICompanionQueryLegalNoticeAvailable
 Determines whether the legal notice for the AI Companion query is available.
(NSString *) - getAICompanionQueryLegalNoticesPrompt
 Gets the AI Companion query legal notices prompt.
(NSString *) - getAICompanionQueryLegalNoticesExplained
 Gets the AI Companion query legal notices explained.
(BOOL) - isAICompanionQueryPrivacyLegalNoticeAvailable
 Determines whether the legal notice for the AI Companion query privacy is available.
(NSString *) - getAICompanionQueryPrivacyLegalNoticesPrompt
 Gets the AI Companion query privacy legal notices prompt.

Properties

id< ZoomSDKAICompanionQueryHelperDelegatedelegate
 Delegate to receive AI Companion query events.

Detailed Description

Helper class to manage AI Companion meeting query features and related legal notices.

Definition at line 372 of file ZoomSDKAICompanionQueryHelper.h.

Method Documentation

◆ canChangeQuerySetting

- (BOOL) canChangeQuerySetting

Determines whether the current user can change query setting.

Returns
YES if it can change the setting. Otherwise, NO.

References canChangeQuerySetting.

Referenced by canChangeQuerySetting.

◆ changeQuerySettings:

- (ZoomSDKError) changeQuerySettings: (ZoomSDKAICompanionQuerySettingOptions) setting

Change query setting.

Parameters
settingThe new query setting to apply.
Returns
If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ getAICompanionQueryLegalNoticesExplained

- (NSString *) getAICompanionQueryLegalNoticesExplained

Gets the AI Companion query legal notices explained.

Returns
If the function succeeds, it returns the AI Companion query legal notices explained. Otherwise, this function fails and returns nil.

References getAICompanionQueryLegalNoticesExplained.

Referenced by getAICompanionQueryLegalNoticesExplained.

◆ getAICompanionQueryLegalNoticesPrompt

- (NSString *) getAICompanionQueryLegalNoticesPrompt

Gets the AI Companion query legal notices prompt.

Returns
If the function succeeds, it returns the AI Companion query legal notices prompt. Otherwise, this function fails and returns nil.

References getAICompanionQueryLegalNoticesPrompt.

Referenced by getAICompanionQueryLegalNoticesPrompt.

◆ getAICompanionQueryPrivacyLegalNoticesPrompt

- (NSString *) getAICompanionQueryPrivacyLegalNoticesPrompt

Gets the AI Companion query privacy legal notices prompt.

Returns
If the function succeeds, it returns the AI Companion query privacy legal notices prompt. Otherwise, this function fails and returns nil.

References getAICompanionQueryPrivacyLegalNoticesPrompt.

Referenced by getAICompanionQueryPrivacyLegalNoticesPrompt.

◆ getSelectedQuerySetting

- (ZoomSDKAICompanionQuerySettingOptions) getSelectedQuerySetting

Gets the selected query setting.

Returns
If the function succeeds, it returns the selected query setting. Otherwise, this function returns an error.

References getSelectedQuerySetting.

Referenced by getSelectedQuerySetting.

◆ isAICompanionQueryLegalNoticeAvailable

- (BOOL) isAICompanionQueryLegalNoticeAvailable

Determines whether the legal notice for the AI Companion query is available.

Returns
YES if the legal notice for the AI Companion query is available. Otherwise the legal notice is not available.

References isAICompanionQueryLegalNoticeAvailable.

Referenced by isAICompanionQueryLegalNoticeAvailable.

◆ isAICompanionQueryPrivacyLegalNoticeAvailable

- (BOOL) isAICompanionQueryPrivacyLegalNoticeAvailable

Determines whether the legal notice for the AI Companion query privacy is available.

Returns
YES if the legal notice for the AI Companion query privacy is available. Otherwise the legal notice is not available.

References isAICompanionQueryPrivacyLegalNoticeAvailable.

Referenced by isAICompanionQueryPrivacyLegalNoticeAvailable.

Property Documentation

◆ delegate

- (id<ZoomSDKAICompanionQueryHelperDelegate>) delegate
readwritenonatomicassign

Delegate to receive AI Companion query events.

Definition at line 377 of file ZoomSDKAICompanionQueryHelper.h.