ZoomSDKAICompanionFeatureSwitchHandler Class Reference

Handler to respond to requests for turning AI Companion features on or off. More...

#include <ZoomSDKMeetingAICompanionController.h>

Inherits NSObject.

Instance Methods
(ZoomSDKError)	- agree:
	Agree to the request to turn the AI Companion features on or off.
(ZoomSDKError)	- decline
	Decline the request to turn the AI Companion features on or off.

Properties
unsigned int	requestUserID
	The user ID who requests the host to turn the AI Companion features on or off.
NSString *	requesterUserName
	Gets the requester's user name.
BOOL	isTurnOn
	Turn the AI Companion features on or off.

Detailed Description

Handler to respond to requests for turning AI Companion features on or off.

Definition at line 48 of file ZoomSDKMeetingAICompanionController.h.

Method Documentation

agree:

- (ZoomSDKError) agree:

(BOOL)

deleteAssets

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

Parameters

deleteAssets

YES to delete the meeting assets when turning off the AI Companion features, NO otherwise.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

decline

- (ZoomSDKError) decline

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

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

References decline.

Referenced by decline.

Property Documentation

isTurnOn

- (BOOL) isTurnOn

readnonatomicassign

Turn the AI Companion features on or off.

Definition at line 64 of file ZoomSDKMeetingAICompanionController.h.

requesterUserName

- (NSString*) requesterUserName

readnonatomiccopy

Gets the requester's user name.

Note

This value is always valid, even when requestUserID returns 0.

Definition at line 60 of file ZoomSDKMeetingAICompanionController.h.

requestUserID

- (unsigned int) requestUserID

readnonatomicassign

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

Note

This value may return 0 in some cross-context scenarios, such as when the host is in a breakout room, or when the requester is not in the host's local participant cache). In these cases, use requesterUserName to obtain the requester's display name.

Definition at line 55 of file ZoomSDKMeetingAICompanionController.h.