ZOOM SDK user information. More...

#include <ZoomSDKMeetingActionController.h>

Inherits NSObject.

Instance Methods
(BOOL)	- isMySelf
	Determine if the information corresponds to the current user.

(NSString *_Nullable)	- getUserName
	Get the username matched with the current user information.

(unsigned int)	- getUserID
	Get the user ID matched with the current user information.

(NSString *_Nullable)	- getAvatarPath
	Get the storage path of avatar.

(BOOL)	- isHost
	Determine whether the member corresponding with the current information is the host or not.

(BOOL)	- isVideoOn
	Determine the video status of the user specified by the current information.

(ZoomSDKAudioStatus)	- getAudioStatus
	Get the audio status of user.

(ZoomSDKAudioType)	- getAudioType
	Get the audio type of user.

(UserRole)	- getUserRole
	Get the type of role of the user specified by the current information.

(BOOL)	- isPurePhoneUser
	Determine whether the user corresponding to the current information joins the meeting by telephone or not.

(BOOL)	- isH323User
	Determine whether the user corresponding to the current information joins the meeting by h323 or not.

(BOOL)	- canBeCoHost
	Determine if it is able to change the specified user role as the co-host.

(ZoomSDKWebinarAttendeeStatus *_Nullable)	- GetWebinarAttendeeStatus
	Get the webinar status of the user specified by the current information.

(BOOL)	- isTalking
	Get the user is talking.

(NSString *_Nullable)	- getCustomerKey
	Get the customer Key matched with the current user information. The max length of customer Key is 35.

(BOOL)	- isInterpreter
	Determine if user is interpreter.

(BOOL)	- isSignLanguageInterpreter
	Determine whether the user specified by the current information is a sign language interpreter or not.

(NSString *_Nullable)	- getInterpreterActiveLanguage
	Get interpreter active language.

(BOOL)	- isRaisingHand
	Get the raising hand status.

(ZoomSDKRecordingStatus)	- getLocalRecordingStatus
	Get the local recording status.

(NSString *_Nullable)	- getPersistentId
	Get the user persistent ID matched with the current user information. This ID persists for the duration of the main meeting. Once the main meeting ends, the ID will be discarded.

(BOOL)	- isRawLiveStreaming
	Determine whether the user has started a raw live stream.

(BOOL)	- hasRawLiveStreamPrivilege
	Determine whether the user has raw live stream privilege.

(ZoomSDKEmojiFeedbackType)	- getEmojiFeedbackType
	Get the emoji feedback type of the user.

(BOOL)	- hasCamera
	Query if the participant has a camera.

(BOOL)	- isInWaitingRoom
	Query if the participant is in waiting room.

(BOOL)	- isInWebinarBackstage
	Determine whether the user specified by the current information is in the webinar backstage or not.

(BOOL)	- isClosedCaptionSender
	Query if the participant is closedCaption sender.

(BOOL)	- isProductionStudioUser
	Returns whether the user is production studio user.

(unsigned int)	- getProductionStudioParent
	Returns the ID of the parent user of this production user.

(BOOL)	- isBotUser
	Determine whether the user specified by the current information is bot user or not.

(NSString *_Nullable)	- getBotAppName
	Get the bot app name.

(BOOL)	- isVirtualNameTagEnabled
	Query if the participant enabled virtual name tag.

(nullable NSArray< ZoomSDKVirtualNameTag * > *)	- getVirtualNameTagArray
	Query the virtual name tag roster infomation.

(BOOL)	- isCompanionModeUser
	Determine whether the user specified by the current information in companion mode or not.

Protected Attributes
unsigned int	_userID

Detailed Description

ZOOM SDK user information.

Definition at line 250 of file ZoomSDKMeetingActionController.h.

Method Documentation

◆ canBeCoHost

- (BOOL) canBeCoHost

Determine if it is able to change the specified user role as the co-host.

Returns: If the specified user can be the co-host, the return value is YES. Otherwise failed.

◆ getAudioStatus

- (ZoomSDKAudioStatus) getAudioStatus

Get the audio status of user.

Returns: The audio status of user.

◆ getAudioType

- (ZoomSDKAudioType) getAudioType

Get the audio type of user.

Returns: The audio type of user.

◆ getAvatarPath

- (NSString *_Nullable) getAvatarPath

Get the storage path of avatar.

Returns: The path to store the head portrait.

◆ getBotAppName

- (NSString *_Nullable) getBotAppName

Get the bot app name.

Returns: If the function succeeds, the return value is the bot app name. Otherwise the function fails, the return value is nil.

◆ getCustomerKey

- (NSString *_Nullable) getCustomerKey

Get the customer Key matched with the current user information. The max length of customer Key is 35.

Returns: The user customer Key.

◆ getEmojiFeedbackType

- (ZoomSDKEmojiFeedbackType) getEmojiFeedbackType

Get the emoji feedback type of the user.

◆ getInterpreterActiveLanguage

- (NSString *_Nullable) getInterpreterActiveLanguage

Get interpreter active language.

Returns: Value of language id.

◆ getLocalRecordingStatus

- (ZoomSDKRecordingStatus) getLocalRecordingStatus

Get the local recording status.

Returns: The status of the local recording status.

◆ getPersistentId

- (NSString *_Nullable) getPersistentId

Get the user persistent ID matched with the current user information. This ID persists for the duration of the main meeting. Once the main meeting ends, the ID will be discarded.

Returns: If the function succeeds, the return value is the user persistent ID. Otherwise nil.

◆ getProductionStudioParent

- (unsigned int) getProductionStudioParent

Returns the ID of the parent user of this production user.

Returns: The userid of the parent user of this production user.

◆ getUserID

- (unsigned int) getUserID

Get the user ID matched with the current user information.

Returns: The user ID.

◆ getUserName

- (NSString *_Nullable) getUserName

Get the username matched with the current user information.

Returns: The username.

◆ getUserRole

- (UserRole) getUserRole

Get the type of role of the user specified by the current information.

Returns: The role of the user.

◆ getVirtualNameTagArray

- (nullable NSArray< ZoomSDKVirtualNameTag * > *) getVirtualNameTagArray

Query the virtual name tag roster infomation.

Returns: If the function succeeds, it returns the list of user's virtual name tag roster info. For more details, see ZoomSDKVirtualNameTag.

◆ GetWebinarAttendeeStatus

- (ZoomSDKWebinarAttendeeStatus *_Nullable) GetWebinarAttendeeStatus

Get the webinar status of the user specified by the current information.

Returns: The object of ZoomSDKWebinarAttendeeStatus.

◆ hasCamera

- (BOOL) hasCamera

Query if the participant has a camera.

Returns: YES means the user has a camera.

◆ hasRawLiveStreamPrivilege

- (BOOL) hasRawLiveStreamPrivilege

Determine whether the user has raw live stream privilege.

Returns: YES indicates that the specified user has raw live stream privilege, otherwise false.

◆ isBotUser

- (BOOL) isBotUser

Determine whether the user specified by the current information is bot user or not.

Returns: YES indicates that the specified user is bot user.

◆ isClosedCaptionSender

- (BOOL) isClosedCaptionSender

Query if the participant is closedCaption sender.

Returns: YES means the user is closedCaption sender.

◆ isCompanionModeUser

- (BOOL) isCompanionModeUser

Determine whether the user specified by the current information in companion mode or not.

Returns: YES indicates that the specified user in companion mode.

◆ isH323User

- (BOOL) isH323User

Determine whether the user corresponding to the current information joins the meeting by h323 or not.

Returns: YES indicates that the user joins the meeting by h323.

◆ isHost

- (BOOL) isHost

Determine whether the member corresponding with the current information is the host or not.

Returns: YES means host.

◆ isInterpreter

- (BOOL) isInterpreter

Determine if user is interpreter.

Returns: YES means that the user is interpreter.

◆ isInWaitingRoom

- (BOOL) isInWaitingRoom

Query if the participant is in waiting room.

Returns: YES means the user in waiting room.

◆ isInWebinarBackstage

- (BOOL) isInWebinarBackstage

Determine whether the user specified by the current information is in the webinar backstage or not.

Returns: YES indicates that the specified user is in the webinar backstage.

◆ isMySelf

- (BOOL) isMySelf

Determine if the information corresponds to the current user.

Returns: YES means that the information corresponds to the current user, otherwise not.

◆ isProductionStudioUser

- (BOOL) isProductionStudioUser

Returns whether the user is production studio user.

Returns: YES means the user is production studio user.

◆ isPurePhoneUser

- (BOOL) isPurePhoneUser

Determine whether the user corresponding to the current information joins the meeting by telephone or not.

Returns: YES indicates that the user joins the meeting by telephone.

◆ isRaisingHand

- (BOOL) isRaisingHand

Get the raising hand status.

Returns: YES means that the user is raising hand.

◆ isRawLiveStreaming

- (BOOL) isRawLiveStreaming

Determine whether the user has started a raw live stream.

Returns: YES indicates that the specified user has started a raw live stream, otherwise false.

◆ isSignLanguageInterpreter

- (BOOL) isSignLanguageInterpreter

Determine whether the user specified by the current information is a sign language interpreter or not.

Returns: YES means that the user is sign interpreter.

◆ isTalking

- (BOOL) isTalking

Get the user is talking.

Returns: YES means that the user is talking.

◆ isVideoOn

- (BOOL) isVideoOn

Determine the video status of the user specified by the current information.

Returns: YES means that the video is turned on.

◆ isVirtualNameTagEnabled

- (BOOL) isVirtualNameTagEnabled

Query if the participant enabled virtual name tag.

Returns: YES means enabled. Otherwise it isn't enabled.

Field Documentation

◆ _userID

- (unsigned int) _userID

protected

Definition at line 252 of file ZoomSDKMeetingActionController.h.

Instance Methods

Protected Attributes