ZoomVideoSDKInvitePhoneUserInfo Class Reference

Information for inviting phone users. More...

#include <ZoomVideoSDKPhoneHelper.h>

Inherits NSObject.

Properties
NSString *_Nullable	countryCode
	The country code of the specified user must be in the support list.
NSString *_Nullable	phoneNumber
	The phone number of specified user.
NSString *_Nullable	name
	The screen name of the specified user in the session.
BOOL	bPressOne
	Determines whether the user needs to press number one to agree to join the session.
BOOL	bGreeting
	Determines whether to play a greeting prompt tone when joining the session.
NSString *_Nullable	languageCode
	Optional: The welcome message's language code, such as "en-US", "zh-CN".
NSString *_Nullable	variantId
	Optional: The welcome message's variant ID (e.g., "variant_001").

Detailed Description

Information for inviting phone users.

Note

languageCode and variantId must be used together (both provided or both nil). Use getPhoneWelcomeMessageInfoList to retrieve the list of valid language codes and variant IDs. If provided with an invalid value, invitePhoneUser: returns Errors_Session_Invalid_Param.

Definition at line 72 of file ZoomVideoSDKPhoneHelper.h.

Property Documentation

bGreeting

- (BOOL) bGreeting

readwritenonatomicassign

Determines whether to play a greeting prompt tone when joining the session.

Definition at line 96 of file ZoomVideoSDKPhoneHelper.h.

bPressOne

- (BOOL) bPressOne

readwritenonatomicassign

Determines whether the user needs to press number one to agree to join the session.

Definition at line 91 of file ZoomVideoSDKPhoneHelper.h.

countryCode

- (NSString* _Nullable) countryCode

readwritenonatomiccopy

The country code of the specified user must be in the support list.

Definition at line 76 of file ZoomVideoSDKPhoneHelper.h.

languageCode

- (NSString* _Nullable) languageCode

readwritenonatomiccopy

Optional: The welcome message's language code, such as "en-US", "zh-CN".

Definition at line 101 of file ZoomVideoSDKPhoneHelper.h.

name

- (NSString* _Nullable) name

readwritenonatomiccopy

The screen name of the specified user in the session.

Definition at line 86 of file ZoomVideoSDKPhoneHelper.h.

phoneNumber

- (NSString* _Nullable) phoneNumber

readwritenonatomiccopy

The phone number of specified user.

Definition at line 81 of file ZoomVideoSDKPhoneHelper.h.

variantId

- (NSString* _Nullable) variantId

readwritenonatomiccopy

Optional: The welcome message's variant ID (e.g., "variant_001").

Definition at line 106 of file ZoomVideoSDKPhoneHelper.h.