Video SDK for MacOS API Reference
Loading...
Searching...
No Matches
ZMVideoSDKPhoneHelper.h
Go to the documentation of this file.
1
5
6
7#import <Foundation/Foundation.h>
8
9NS_ASSUME_NONNULL_BEGIN
14@interface ZMVideoSDKDialInNumberInfo : NSObject
18@property (nonatomic, copy, readonly) NSString* countryID;
22@property (nonatomic, copy, readonly) NSString* countryCode;
26@property (nonatomic, copy, readonly) NSString* countryName;
30@property (nonatomic, copy, readonly) NSString* number;
34@property (nonatomic, copy, readonly) NSString* displayNumber;
38@property (nonatomic, assign, readonly) ZMVideoSDKDialInNumType type;
42@property (nonatomic, assign, readonly) BOOL isDedicateID;
43@end
44
45
54@property (nonatomic, copy, readonly) NSString* countryID;
58@property (nonatomic, copy, readonly) NSString* countryName;
62@property (nonatomic, copy, readonly) NSString* countryCode;
63@end
64
65
73@interface ZMVideoSDKInvitePhoneUserInfo : NSObject
77@property (nonatomic, copy, nullable) NSString* countryCode;
81@property (nonatomic, copy, nullable) NSString* phoneNumber;
85@property (nonatomic, copy, nullable) NSString* name;
89@property (nonatomic, assign) BOOL bPressOne;
93@property (nonatomic, assign) BOOL bGreeting;
94
98@property (nonatomic, copy, nullable) NSString* languageCode;
102@property (nonatomic, copy, nullable) NSString* variantId;
103@end
104
113@property (nonatomic, copy, readonly) NSString* languageCode;
117@property (nonatomic, copy, readonly) NSString* languageName;
121@property (nonatomic, copy, readonly) NSString* variantId;
122@end
123
124
129@interface ZMVideoSDKPhoneHelper : NSObject
135
141
150- (ZMVideoSDKErrors)inviteByPhone:(NSString*)countryCode phoneNumber:(NSString*)phoneNumber name:(NSString*)name DEPRECATED_MSG_ATTRIBUTE("Use -invitePhoneUser: instead");
151
157- (ZMVideoSDKErrors)invitePhoneUser:(ZMVideoSDKInvitePhoneUserInfo *)inviteInfo;
163
169
175
183@end
184
185NS_ASSUME_NONNULL_END
ZMVideoSDKErrors
Enumerates all errors in the VideoSDK.
ZMPhoneStatus
Enumerates the statuses of a phone call.
ZMVideoSDKDialInNumType
Enumeration of the number types for calling to join the audio into a meeting.
Represents dial-in number information for a specific country.
NSString * countryCode
The current's country code information.
BOOL isDedicateID
Is the dial number an account dedicated number.
NSString * displayNumber
The display number.
ZMVideoSDKDialInNumType type
The type of dial in number.
NSString * countryID
The current's country ID information.
NSString * number
The country number.
NSString * countryName
The current's country name information.
Represents the information used when inviting a user to join the session via phone.
NSString * languageCode
Optional: The welcome message's language code, such as "en-US", "zh-CN".
NSString * phoneNumber
The phone number of specified user.
NSString * countryCode
The specified's country code user must be in the support list.
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 * name
The specified's screen name user in the session.
NSString * variantId
Optional: The welcome message's variant ID (e.g., "variant_001").
Provides methods for managing phone-related session features such as dial-in and phone invites.
NSArray< ZMVideoSDKPhoneSupportCountryInfo * > *_Nullable getSupportCountryInfo()
Gets the country information list where the session supports to join by telephone.
BOOL isSupportPhoneFeature()
Determines if the session supports join by phone or not.
ZMPhoneStatus getInviteByPhoneStatus()
Gets the phone invitation's status.
NSArray< ZMVideoSDKPhoneWelcomeMessageInfo * > *_Nullable getPhoneWelcomeMessageInfoList()
Gets the list of multilingual welcome message information.
ZMVideoSDKErrors cancelInviteByPhone()
Cancels the invitation that is being called out by phone.
NSArray< ZMVideoSDKDialInNumberInfo * > *_Nullable getSessionDialInNumbers()
Gets the dial in number list supported by session.
Contains information about a country where phone features are supported.
NSString * countryID
The current's country ID information.
NSString * countryName
The current's country name information.
NSString * countryCode
The current's country code information.
Represents phone welcome message information.
NSString * variantId
The current information's variant ID.
NSString * languageName
The current information's language name, such as "English (US)", "Chinese (China)".
NSString * languageCode
The current information's language code, such as "en-US", "zh-CN".