Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
Instance Methods | Protected Attributes
ZoomSDKUserInfo Class Reference

Provides detailed information about a user in a meeting. More...

#include <ZoomSDKMeetingActionController.h>

Inherits NSObject.

Instance Methods

(BOOL) - isMySelf
 Determines if the information corresponds to the current user.
 
(NSString *_Nullable) - getUserName
 Gets the username matched with the current user information.
 
(unsigned int) - getUserID
 Gets the user ID matched with the current user information.
 
(NSString *_Nullable) - getAvatarPath
 Gets the storage path of avatar.
 
(BOOL) - isHost
 Determines whether the member corresponding with the current information is the host or not.
 
(BOOL) - isVideoOn
 Determines the user's video status specified by the current information.
 
(ZoomSDKAudioStatus) - getAudioStatus
 Gets the audio status of user.
 
(ZoomSDKAudioType) - getAudioType
 Gets the audio type of user.
 
(UserRole) - getUserRole
 Gets the user's type of role specified by the current information.
 
(BOOL) - isPurePhoneUser
 Determines whether the user corresponding to the current information joins the meeting by telephone or not.
 
(BOOL) - isH323User
 Determines whether the user corresponding to the current information joins the meeting by h323 or not.
 
(BOOL) - canBeCoHost
 Determines if it is able to change the specified user role as the co-host.
 
(BOOL) - canBeCoOwner
 Query if the user can be assigned as co-owner in meeting. Co-owner can be grant privilege to manage some assets after the meeting.
 
(ZoomSDKWebinarAttendeeStatus *_Nullable) - GetWebinarAttendeeStatus
 Gets the user's webinar status specified by the current information.
 
(BOOL) - isTalking
 Gets the user is talking.
 
(NSString *_Nullable) - getCustomerKey
 Gets the customer Key matched with the current user information. The max length of customer Key is 35.
 
(BOOL) - isInterpreter
 Determines if user is interpreter.
 
(BOOL) - isSignLanguageInterpreter
 Determines whether the user specified by the current information is a sign language interpreter or not.
 
(NSString *_Nullable) - getInterpreterActiveLanguage
 Gets interpreter active language.
 
(BOOL) - isRaisingHand
 Gets the raising hand status.
 
(ZoomSDKRecordingStatus) - getLocalRecordingStatus
 Gets the local recording status.
 
(NSString *_Nullable) - getPersistentId
 Gets the user persistent ID matched with the current user information. This ID persists for the main meeting's duration. Once the main meeting ends, the ID is discarded.
 
(BOOL) - isRawLiveStreaming
 Determines whether the user has started a raw live stream.
 
(BOOL) - hasRawLiveStreamPrivilege
 Determines whether the user has raw live stream privilege.
 
(ZoomSDKEmojiFeedbackType) - getEmojiFeedbackType
 Gets the user's emoji feedback type.
 
(BOOL) - hasCamera
 Query if the participant has a camera.
 
(BOOL) - isInWaitingRoom
 Query if the participant is in waiting room.
 
(BOOL) - isInWebinarBackstage
 Determines 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 parent user ID of this production user.
 
(BOOL) - isBotUser
 Determines whether the user specified by the current information is bot user or not.
 
(NSString *_Nullable) - getBotAppName
 Gets 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
 Determines whether the user specified by the current information in companion mode or not.
 
(NSArray< ZoomSDKGrantCoOwnerAssetsInfo * > *_Nullable) - getGrantCoOwnerAssetsInfo
 Query the granted assets info when assign a co-owner.
 
(BOOL) - isAudioOnlyUser
 Determines whether the specified user is an audio only user.
 

Protected Attributes

unsigned int _userID
 

Detailed Description

Provides detailed information about a user in a meeting.

Definition at line 302 of file ZoomSDKMeetingActionController.h.

Method Documentation

◆ canBeCoHost

- (BOOL) canBeCoHost

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

Returns
If the specified user can be the co-host, it returns YES. Otherwise, NO.

◆ canBeCoOwner

- (BOOL) canBeCoOwner

Query if the user can be assigned as co-owner in meeting. Co-owner can be grant privilege to manage some assets after the meeting.

Returns
YES if that the user can be assigned as co-owner. Otherwise, NO.

◆ getAudioStatus

- (ZoomSDKAudioStatus) getAudioStatus

Gets the audio status of user.

Returns
The audio status of user.

◆ getAudioType

- (ZoomSDKAudioType) getAudioType

Gets the audio type of user.

Returns
The audio type of user.

◆ getAvatarPath

- (NSString *_Nullable) getAvatarPath

Gets the storage path of avatar.

Returns
If the function succeeds, it returns the path to store the head portrait. Otherwise, this function fails and returns nil.

◆ getBotAppName

- (NSString *_Nullable) getBotAppName

Gets the bot app name.

Returns
If the function succeeds, it returns the bot app name. Otherwise, this function fails and returns nil.

◆ getCustomerKey

- (NSString *_Nullable) getCustomerKey

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

Returns
If the function succeeds, it returns the user customer Key. Otherwise, this function fails and returns nil.

◆ getEmojiFeedbackType

- (ZoomSDKEmojiFeedbackType) getEmojiFeedbackType

Gets the user's emoji feedback type.

Returns
The emoji feedback type.

◆ getGrantCoOwnerAssetsInfo

- (NSArray< ZoomSDKGrantCoOwnerAssetsInfo * > *_Nullable) getGrantCoOwnerAssetsInfo

Query the granted assets info when assign a co-owner.

Returns
If the function succeeds, it returns the list of user's grant assets info. Otherwise, this function fails and returns nil.
Note
If not granted any assets privilege, the web's default configuration will be queried. If has granted assets privilege, the result after granting will be queried.

◆ getInterpreterActiveLanguage

- (NSString *_Nullable) getInterpreterActiveLanguage

Gets interpreter active language.

Returns
If the function succeeds, it returns the language ID. Otherwise, this function fails and returns nil.

◆ getLocalRecordingStatus

- (ZoomSDKRecordingStatus) getLocalRecordingStatus

Gets the local recording status.

Returns
The local's status recording status.

◆ getPersistentId

- (NSString *_Nullable) getPersistentId

Gets the user persistent ID matched with the current user information. This ID persists for the main meeting's duration. Once the main meeting ends, the ID is discarded.

Returns
If the function succeeds, it returns the user persistent ID. Otherwise, this function fails and returns nil.

◆ getProductionStudioParent

- (unsigned int) getProductionStudioParent

Returns the parent user ID of this production user.

Returns
The parent user's ID.

◆ getUserID

- (unsigned int) getUserID

Gets the user ID matched with the current user information.

Returns
The user ID.

◆ getUserName

- (NSString *_Nullable) getUserName

Gets the username matched with the current user information.

Returns
If the function succeeds, it returns the username. Otherwise, this function fails and returns nil.

◆ getUserRole

- (UserRole) getUserRole

Gets the user's type of role specified by the current information.

Returns
The user's role.

◆ 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. Otherwise, this function fails and returns nil.

◆ GetWebinarAttendeeStatus

- (ZoomSDKWebinarAttendeeStatus *_Nullable) GetWebinarAttendeeStatus

Gets the user's webinar status specified by the current information.

Returns
If the function succeeds, it returns the object of ZoomSDKWebinarAttendeeStatus. Otherwise, this function fails and returns nil.

◆ hasCamera

- (BOOL) hasCamera

Query if the participant has a camera.

Returns
YES if the user has a camera. Otherwise, NO.

◆ hasRawLiveStreamPrivilege

- (BOOL) hasRawLiveStreamPrivilege

Determines whether the user has raw live stream privilege.

Returns
YES if the specified user has raw live stream privilege. Otherwise, NO.

◆ isAudioOnlyUser

- (BOOL) isAudioOnlyUser

Determines whether the specified user is an audio only user.

Returns
YES if the specified user is an audio only user. Otherwise, NO.

◆ isBotUser

- (BOOL) isBotUser

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

Returns
YES if the specified user is bot user. Otherwise, NO.

◆ isClosedCaptionSender

- (BOOL) isClosedCaptionSender

Query if the participant is closedCaption sender.

Returns
YES if the user is closedCaption sender. Otherwise, NO.

◆ isCompanionModeUser

- (BOOL) isCompanionModeUser

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

Returns
YES if the specified user in companion mode. Otherwise, NO.

◆ isH323User

- (BOOL) isH323User

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

Returns
YES if the user joins the meeting by h323. Otherwise, NO.

◆ isHost

- (BOOL) isHost

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

Returns
YES if host. Otherwise, NO.

◆ isInterpreter

- (BOOL) isInterpreter

Determines if user is interpreter.

Returns
YES if the user is interpreter. Otherwise, NO.

◆ isInWaitingRoom

- (BOOL) isInWaitingRoom

Query if the participant is in waiting room.

Returns
YES if the user in waiting room. Otherwise, NO.

◆ isInWebinarBackstage

- (BOOL) isInWebinarBackstage

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

Returns
YES if the specified user is in the webinar backstage. Otherwise, NO.

◆ isMySelf

- (BOOL) isMySelf

Determines if the information corresponds to the current user.

Returns
YES if the information corresponds to the current user. Otherwise, NO.

◆ isProductionStudioUser

- (BOOL) isProductionStudioUser

Returns whether the user is production studio user.

Returns
YES if the user is production studio user. Otherwise, NO.

◆ isPurePhoneUser

- (BOOL) isPurePhoneUser

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

Returns
YES if the user joins the meeting by telephone. Otherwise, NO.

◆ isRaisingHand

- (BOOL) isRaisingHand

Gets the raising hand status.

Returns
YES if the user is raising hand. Otherwise, NO.

◆ isRawLiveStreaming

- (BOOL) isRawLiveStreaming

Determines whether the user has started a raw live stream.

Returns
YES if the specified user has started a raw live stream. Otherwise, NO.

◆ isSignLanguageInterpreter

- (BOOL) isSignLanguageInterpreter

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

Returns
YES if the user is sign interpreter. Otherwise, NO.

◆ isTalking

- (BOOL) isTalking

Gets the user is talking.

Returns
YES if the user is talking. Otherwise, NO.

◆ isVideoOn

- (BOOL) isVideoOn

Determines the user's video status specified by the current information.

Returns
YES if the video is turned on. Otherwise, NO.

◆ isVirtualNameTagEnabled

- (BOOL) isVirtualNameTagEnabled

Query if the participant enabled virtual name tag.

Returns
YES if enabled. Otherwise, NO.

Field Documentation

◆ _userID

- (unsigned int) _userID
protected

Definition at line 304 of file ZoomSDKMeetingActionController.h.