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

The handler to handle a user request to turn the AI Companion features on or off. More...

#include <meeting_ai_companion_interface.h>

Public Member Functions

virtual ~IAICompanionFeatureSwitchHandler ()
 
virtual unsigned int GetRequestUserID ()=0
 Get the user ID who requests host to turn the AI Companion features on or off.
 
virtual bool IsTurnOn ()=0
 Turn the AI Companion features on or off.
 
virtual SDKError Agree (bool bDeleteAssets)=0
 Agree the request to turn the AI companion features on or off.
 
virtual SDKError Decline ()=0
 Decline the request to turn the AI companion features on or off.
 

Detailed Description

The handler to handle a user request to turn the AI Companion features on or off.

Definition at line 664 of file meeting_ai_companion_interface.h.

Constructor & Destructor Documentation

◆ ~IAICompanionFeatureSwitchHandler()

virtual IAICompanionFeatureSwitchHandler::~IAICompanionFeatureSwitchHandler ( )
inlinevirtual

Definition at line 667 of file meeting_ai_companion_interface.h.

667{};

Member Function Documentation

◆ Agree()

virtual SDKError IAICompanionFeatureSwitchHandler::Agree ( bool bDeleteAssets)
pure virtual

Agree the request to turn the AI companion features on or off.

Parameters
bDeleteAssetsSpecify whether delete the meeting assets when turning off the AI Companion features.
Returns
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise the function fails. To get extended error information, see SDKError enum.

◆ Decline()

virtual SDKError IAICompanionFeatureSwitchHandler::Decline ( )
pure virtual

Decline the request to turn the AI companion features on or off.

Returns
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise the function fails. To get extended error information, see SDKError enum.

◆ GetRequestUserID()

virtual unsigned int IAICompanionFeatureSwitchHandler::GetRequestUserID ( )
pure virtual

Get the user ID who requests host to turn the AI Companion features on or off.

Returns
the request user ID.

◆ IsTurnOn()

virtual bool IAICompanionFeatureSwitchHandler::IsTurnOn ( )
pure virtual

Turn the AI Companion features on or off.

Returns
true means turn on the AI Companion features, false means turn off the AI Companion features.