IAICompanionFeatureSwitchHandler Class Reference

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
	Gets the user ID who requests host to turn the AI Companion features on or off.
virtual const zchar_t *	GetRequestUserName ()=0
	Gets the requester's user name.
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 921 of file meeting_ai_companion_interface.h.

Constructor & Destructor Documentation

~IAICompanionFeatureSwitchHandler()

virtual IAICompanionFeatureSwitchHandler::~IAICompanionFeatureSwitchHandler ( )

inlinevirtual

Definition at line 924 of file meeting_ai_companion_interface.h.

{};

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

bDeleteAssets

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, this function returns an error.

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, this function returns an error.

GetRequestUserID()

virtual unsigned int IAICompanionFeatureSwitchHandler::GetRequestUserID ( )

pure virtual

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

Note

This value may return 0 in some cross-context scenarios (for example, when the host is in a breakout room, or when the requester is not in the host's local participant cache). In this case, use GetRequestUserName() to obtain the requester's display name.

Returns

The request user ID, or 0 if the requester is from the main meeting.

GetRequestUserName()

virtual const zchar_t * IAICompanionFeatureSwitchHandler::GetRequestUserName ( )

pure virtual

Gets the requester's user name.

Note

This value is always valid, even when GetRequestUserID() returns 0.

Returns

The user name of the requester.

IsTurnOn()

virtual bool IAICompanionFeatureSwitchHandler::IsTurnOn ( )

pure virtual

Turn the AI Companion features on or off.

Returns

true if turning on the AI Companion features. Otherwise, false.