Plugin SDK for macOS Swift API Reference
Swift API documentation for PluginSDK
Loading...
Searching...
No Matches
ZoomToolSuiteAPI.Meeting.Participants

Declaration

class Participants

ObjC Types and Enums Used by This Swift API

Members

allowParticipantsToChat(isAllow:completion:meetingType:)

static func allowParticipantsToChat(isAllow: Bool, completion: @escaping (ZoomToolSuiteBaseResult) -> Void, meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

allow participants to chat

  • Parameters:
  • isAllow : Whether to allow participants to chat
  • completionHandler: completion handler
  • meetingType: meeting type
  • Returns: whether the API call is successful

allowParticipantsToRename(isAllow:completion:meetingType:)

static func allowParticipantsToRename(isAllow: Bool, completion: @escaping (ZoomToolSuiteBaseResult) -> Void, meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

allow participants to rename

  • Parameters:
  • isAllow : Whether to allow participants to rename
  • completionHandler: completion handler
  • meetingType: meeting type
  • Returns: whether the API call is successful

allowParticipantsToRequestLocalRecording(isAllow:completion:meetingType:)

static func allowParticipantsToRequestLocalRecording(isAllow: Bool, completion: @escaping (ZoomToolSuiteBaseResult) -> Void, meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

allow participants to local recording

  • Parameters:
  • isAllow : Whether to allow participants to local recording
  • completionHandler: completion handler
  • meetingType: meeting type
  • Returns: whether the API call is successful

allowParticipantsToShare(isAllow:completion:meetingType:)

static func allowParticipantsToShare(isAllow: Bool, completion: @escaping (ZoomToolSuiteBaseResult) -> Void, meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

allow participants to share

  • Parameters:
  • isAllow : Whether to allow participants to share
  • completionHandler: completion handler
  • meetingType: meeting type
  • Returns: whether the API call is successful

allowParticipantsToShareWhiteBoard(isAllow:completion:meetingType:)

static func allowParticipantsToShareWhiteBoard(isAllow: Bool, completion: @escaping (ZoomToolSuiteBaseResult) -> Void, meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

allow participants to share whiteBoard

  • Parameters:
  • isAllow : Whether to allow participants to share whiteBoard
  • completionHandler: completion handler
  • meetingType: meeting type
  • Returns: whether the API call is successful

allowParticipantsToStartVideo(isAllow:completion:meetingType:)

static func allowParticipantsToStartVideo(isAllow: Bool, completion: @escaping (ZoomToolSuiteBaseResult) -> Void, meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

allow participants to start video

  • Parameters:
  • isAllow : Whether to allow participants to start video
  • completionHandler: completion handler
  • meetingType: meeting type
  • Returns: whether the API call is successful

allowParticipantsToUnmuteSelf(isAllow:completion:meetingType:)

static func allowParticipantsToUnmuteSelf(isAllow: Bool, completion: @escaping (ZoomToolSuiteBaseResult) -> Void, meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

allow participants to unmute self

  • Parameters:
  • isAllow : Whether to allow participants to unmute self
  • completionHandler: completion handler
  • meetingType: meeting type
  • Returns: whether the API call is successful

assignCoHost(userID:completion:meetingType:)

static func assignCoHost(userID: UInt, completion: @escaping (ZoomToolSuiteBaseResult) -> Void, meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

assign co-host

  • Parameters:
  • userID: user ID
  • completionHandler: completion handler
  • meetingType: meeting type
  • Returns: whether the API call is successful

enableAutoAllowLocalRecordingRequestFeature(enable:completion:meetingType:)

static func enableAutoAllowLocalRecordingRequestFeature(enable: Bool, completion: @escaping (ZoomToolSuiteBaseResult) -> Void, meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

enable auto allow local recording request

  • Parameters:
  • enable: enable or not
  • completionHandler: completion handler
  • meetingType: meeting type
  • Returns: whether the API call is successful

getMySelf(_:)

static func getMySelf(_ meetingType: ZoomToolSuiteMeetingInstance = .default) -> ZoomToolSuiteUser

get self info

  • Parameter meetingType: meetingType
  • Returns: user Info

getUserByUserID(iUserID:meetingType:)

static func getUserByUserID(iUserID: UInt32, meetingType: ZoomToolSuiteMeetingInstance = .default) -> ZoomToolSuiteUser

get user info with userid

  • Parameters:
  • iUserID: userid
  • meetingType: meetingType
  • Returns: user Info

getUserRoleByUserID(userID:completion:meetingType:)

static func getUserRoleByUserID(userID: UInt, completion: @escaping (ZoomToolSuiteGetUserRoleByUserIDResult) -> Void, meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

get user role

  • Parameters:
  • userID: user ID
  • completionHandler: completion handler
  • meetingType: meeting type
  • Returns: whether the API call is successful

inviteUserToMeeting(userEmail:completion:meetingType:)

static func inviteUserToMeeting(userEmail: String, completion: @escaping (ZoomToolSuiteBaseResult) -> Void, meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

Whether to allow participants to chat

  • Parameters:
  • completionHandler: completion handler
  • meetingType: meeting type
  • Returns: whether the API call is successful

isAutoAllowLocalRecordingRequestFeatureOn(completion:meetingType:)

static func isAutoAllowLocalRecordingRequestFeatureOn(completion: @escaping (ZoomToolSuiteBoolValueResult) -> Void, meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

get auto allow local recording request status

  • Parameters:
  • completionHandler: completion handler
  • meetingType: meeting type
  • Returns: whether the API call is successful

isParticipantsChatAllowed(completion:meetingType:)

static func isParticipantsChatAllowed(completion: @escaping (ZoomToolSuiteBoolValueResult) -> Void, meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

Whether to allow participants to chat

  • Parameters:
  • completionHandler: completion handler
  • meetingType: meeting type
  • Returns: whether the API call is successful

isParticipantsRenameAllowed(completion:meetingType:)

static func isParticipantsRenameAllowed(completion: @escaping (ZoomToolSuiteBoolValueResult) -> Void, meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

Whether to allow participants to rename

  • Parameters:
  • completionHandler: completion handler
  • meetingType: meeting type
  • Returns: whether the API call is successful

isParticipantsRequestLocalRecordingAllowed(completion:meetingType:)

static func isParticipantsRequestLocalRecordingAllowed(completion: @escaping (ZoomToolSuiteBoolValueResult) -> Void, meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

Whether to allow participants to local recording

  • Parameters:
  • completionHandler: completion handler
  • meetingType: meeting type
  • Returns: whether the API call is successful

isParticipantsShareAllowed(completion:meetingType:)

static func isParticipantsShareAllowed(completion: @escaping (ZoomToolSuiteBoolValueResult) -> Void, meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

Whether to allow participants to share

  • Parameters:
  • completionHandler: completion handler
  • meetingType: meeting type
  • Returns: whether the API call is successful

isParticipantsShareWhiteBoardAllowed(completion:meetingType:)

static func isParticipantsShareWhiteBoardAllowed(completion: @escaping (ZoomToolSuiteBoolValueResult) -> Void, meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

Whether to allow participants to share whiteBoard

  • Parameters:
  • completionHandler: completion handler
  • meetingType: meeting type
  • Returns: whether the API call is successful

isParticipantsStartVideoAllowed(completion:meetingType:)

static func isParticipantsStartVideoAllowed(completion: @escaping (ZoomToolSuiteBoolValueResult) -> Void, meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

Whether to allow participants to start video

  • Parameters:
  • completionHandler: completion handler
  • meetingType: meeting type
  • Returns: whether the API call is successful

isParticipantsUnmuteSelfAllowed(completion:meetingType:)

static func isParticipantsUnmuteSelfAllowed(completion: @escaping (ZoomToolSuiteBoolValueResult) -> Void, meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

Whether to allow participants to unmute self

  • Parameters:
  • completionHandler: completion handler
  • meetingType: meeting type
  • Returns: whether the API call is successful

makeHost(userID:completion:meetingType:)

static func makeHost(userID: UInt, completion: @escaping (ZoomToolSuiteBaseResult) -> Void, meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

make host

  • Parameters:
  • userID: user ID
  • completionHandler: completion handler
  • meetingType: meeting type
  • Returns: whether the API call is successful

reclaimHost(completion:meetingType:)

static func reclaimHost(completion: @escaping (ZoomToolSuiteBaseResult) -> Void, meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

reclaim host

  • Parameters:
  • completionHandler: completion handler
  • meetingType: meeting type
  • Returns: whether the API call is successful

revokeCoHost(userID:completion:meetingType:)

static func revokeCoHost(userID: UInt, completion: @escaping (ZoomToolSuiteBaseResult) -> Void, meetingType: ZoomToolSuiteMeetingInstance = .default) -> Bool

revoke co-host

  • Parameters:
  • userID: user ID
  • completionHandler: completion handler
  • meetingType: meeting type
  • Returns: whether the API call is successful