ZoomSDKJoinMeetingHelper Class Reference

Helper interface for handling the process of joining a meeting, such as inputting password or display name. More...

#include <ZoomSDKMeetingActionController.h>

Inherits NSObject.

Instance Methods
(JoinMeetingReqInfoType)	- getReqInfoType
	Gets the type of registration information required to join the meeting.
(ZoomSDKError)	- inputPassword:
	Input the password to join meeting.
(ZoomSDKError)	- inputMeetingScreenName:
	Input the screen name to join meeting.
(ZoomSDKError)	- cancel
	Cancels to join meeting.
(ZoomSDKError)	- confirmPreview:videoOn:audioOn:
	Confirms the user's display name and audio and video settings before joining the meeting.

Protected Attributes
JoinMeetingReqInfoType	_reqInfoType

Detailed Description

Helper interface for handling the process of joining a meeting, such as inputting password or display name.

Definition at line 541 of file ZoomSDKMeetingActionController.h.

Method Documentation

cancel

- (ZoomSDKError) cancel

Cancels to join meeting.

Returns

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

References cancel.

Referenced by cancel.

confirmPreview:videoOn:audioOn:

- (ZoomSDKError) confirmPreview:		(NSString *_Nullable)	screenName
videoOn:		(BOOL)	videoOn
audioOn:		(BOOL)	audioOn

Confirms the user's display name and audio and video settings before joining the meeting.

Parameters

screenName	The user's display name. Can be null or empty if the display name has already been set.
videoOn	YES if video is on in meeting. NO otherwise.
audioOn	YES if audio is on in meeting. NO otherwise.

Returns

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

Note

Only for custom UI.

getReqInfoType

- (JoinMeetingReqInfoType) getReqInfoType

Gets the type of registration information required to join the meeting.

Returns

The registration information's type.

References getReqInfoType.

Referenced by getReqInfoType.

inputMeetingScreenName:

- (ZoomSDKError) inputMeetingScreenName:

(NSString *)

screenName

Input the screen name to join meeting.

Parameters

screenName

The meeting's username.

Returns

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

inputPassword:

- (ZoomSDKError) inputPassword:

(NSString *)

password

Input the password to join meeting.

Parameters

password

The meeting's password.

Returns

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

Field Documentation

_reqInfoType

- (JoinMeetingReqInfoType) _reqInfoType

protected

Definition at line 543 of file ZoomSDKMeetingActionController.h.