ZMVideoSDKInvitePhoneUserInfo Class Reference

Represents the information used when inviting a user to join the session via phone. More...

#include <ZMVideoSDKPhoneHelper.h>

Inherits NSObject.

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

Detailed Description

Represents the information used when inviting a user to join the session via phone.

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 ZMVideoSDKErrors_Invalid_Parameter.

Definition at line 73 of file ZMVideoSDKPhoneHelper.h.

Property Documentation

bGreeting

- (BOOL) bGreeting

readwritenonatomicassign

YES if joining the session, play a greeting prompt tone. NO Otherwise.

Definition at line 93 of file ZMVideoSDKPhoneHelper.h.

bPressOne

- (BOOL) bPressOne

readwritenonatomicassign

YES if need press number one to agree to join the session, NO otherwise.

Definition at line 89 of file ZMVideoSDKPhoneHelper.h.

countryCode

- (NSString*) countryCode

readwritenonatomiccopy

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

Definition at line 77 of file ZMVideoSDKPhoneHelper.h.

languageCode

- (NSString*) languageCode

readwritenonatomiccopy

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

Definition at line 98 of file ZMVideoSDKPhoneHelper.h.

name

- (NSString*) name

readwritenonatomiccopy

The specified's screen name user in the session.

Definition at line 85 of file ZMVideoSDKPhoneHelper.h.

phoneNumber

- (NSString*) phoneNumber

readwritenonatomiccopy

The phone number of specified user.

Definition at line 81 of file ZMVideoSDKPhoneHelper.h.

variantId

- (NSString*) variantId

readwritenonatomiccopy

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

Definition at line 102 of file ZMVideoSDKPhoneHelper.h.