Meeting SDK for Linux API Reference
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
IMeetingAICompanionQueryHelper Class Referenceabstract

Meeting AI companion query helper interface. More...

#include <meeting_ai_companion_interface.h>

Public Member Functions

virtual ~IMeetingAICompanionQueryHelper ()
 
virtual void SetEvent (IMeetingAICompanionQueryHelperEvent *event)=0
 Set the AI companion query callback event handler.
 
virtual SDKError CanChangeQuerySetting (bool &bCan)=0
 Determine whether the current user can change query setting.
 
virtual SDKError ChangeQuerySettings (MeetingAICompanionQuerySettingOptions setting)=0
 Change query setting.
 
virtual MeetingAICompanionQuerySettingOptions GetSelectedQuerySetting ()=0
 Get the selected query setting.
 
virtual SDKError IsAICompanionQueryLegalNoticeAvailable (bool &bAvailable)=0
 Determine whether the legal notice for the AI Companion query is available.
 
virtual const zchar_tGetAICompanionQueryLegalNoticesPrompt ()=0
 Get the AI Companion query legal notices prompt.
 
virtual const zchar_tGetAICompanionQueryLegalNoticesExplained ()=0
 Get the AI Companion query legal notices explained.
 
virtual SDKError IsAICompanionQueryPrivacyLegalNoticeAvailable (bool &bAvailable)=0
 Determine whether the legal notice for the AI Companion query privacy is available.
 
virtual const zchar_tGetAICompanionQueryPrivacyLegalNoticesPrompt ()=0
 Get the AI Companion query privacy legal notices prompt.
 

Detailed Description

Meeting AI companion query helper interface.

Definition at line 594 of file meeting_ai_companion_interface.h.

Constructor & Destructor Documentation

◆ ~IMeetingAICompanionQueryHelper()

virtual IMeetingAICompanionQueryHelper::~IMeetingAICompanionQueryHelper ( )
inlinevirtual

Definition at line 597 of file meeting_ai_companion_interface.h.

597{}

Member Function Documentation

◆ CanChangeQuerySetting()

virtual SDKError IMeetingAICompanionQueryHelper::CanChangeQuerySetting ( bool & bCan)
pure virtual

Determine whether the current user can change query setting.

Parameters
bCanTrue means that it can change the setting. Otherwise it can't change the setting.
Returns
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise the function fails. To get extended error information, see SDKError enum.

◆ ChangeQuerySettings()

virtual SDKError IMeetingAICompanionQueryHelper::ChangeQuerySettings ( MeetingAICompanionQuerySettingOptions setting)
pure virtual

Change query setting.

Parameters
settingThe query setting. For more details, see MeetingAICompanionQuerySettingOptions.
Returns
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise the function fails. To get extended error information, see SDKError enum.

◆ GetAICompanionQueryLegalNoticesExplained()

virtual const zchar_t * IMeetingAICompanionQueryHelper::GetAICompanionQueryLegalNoticesExplained ( )
pure virtual

Get the AI Companion query legal notices explained.

Returns
If the function succeeds, it will return the AI Companion query legal notices explained. Otherwise the function fails and returns nullptr.

◆ GetAICompanionQueryLegalNoticesPrompt()

virtual const zchar_t * IMeetingAICompanionQueryHelper::GetAICompanionQueryLegalNoticesPrompt ( )
pure virtual

Get the AI Companion query legal notices prompt.

Returns
If the function succeeds, it will return the AI Companion query legal notices prompt. Otherwise the function fails and returns nullptr.

◆ GetAICompanionQueryPrivacyLegalNoticesPrompt()

virtual const zchar_t * IMeetingAICompanionQueryHelper::GetAICompanionQueryPrivacyLegalNoticesPrompt ( )
pure virtual

Get the AI Companion query privacy legal notices prompt.

Returns
If the function succeeds, it will return the AI Companion query privacy legal notices prompt. Otherwise the function fails and returns nullptr.

◆ GetSelectedQuerySetting()

virtual MeetingAICompanionQuerySettingOptions IMeetingAICompanionQueryHelper::GetSelectedQuerySetting ( )
pure virtual

Get the selected query setting.

Returns
If the function succeeds, it will return the selected query setting. Otherwise not.

◆ IsAICompanionQueryLegalNoticeAvailable()

virtual SDKError IMeetingAICompanionQueryHelper::IsAICompanionQueryLegalNoticeAvailable ( bool & bAvailable)
pure virtual

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

Parameters
bAvailableTrue indicates the legal notice for the AI Companion query is available. Otherwise the legal notice is not available.
Returns
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise the function fails. To get extended error information, see SDKError enum.

◆ IsAICompanionQueryPrivacyLegalNoticeAvailable()

virtual SDKError IMeetingAICompanionQueryHelper::IsAICompanionQueryPrivacyLegalNoticeAvailable ( bool & bAvailable)
pure virtual

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

Parameters
bAvailableTrue indicates the legal notice for the AI Companion query privacy is available. Otherwise the legal notice is not available.
Returns
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise the function fails. To get extended error information, see SDKError enum.

◆ SetEvent()

virtual void IMeetingAICompanionQueryHelper::SetEvent ( IMeetingAICompanionQueryHelperEvent * event)
pure virtual

Set the AI companion query callback event handler.

Parameters
eventA pointer to the IMeetingAICompanionQueryHelperEvent that receives the AI companion query event.