Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKPhoneHelper.h
Go to the documentation of this file.
1
5
6#import <ZoomSDK/ZoomSDKErrors.h>
7NS_ASSUME_NONNULL_BEGIN
8
13@protocol ZoomSDKPhoneHelperDelegate <NSObject>
19- (void)onInviteCalloutUserStatus:(PhoneStatus)status FailedReason:(PhoneFailedReason)reason;
20
26- (void)onCallMeStatus:(PhoneStatus)status FailedReason:(PhoneFailedReason)reason;
27@end
28
29
34@interface ZoomSDKPhoneSupportCountryInfo : NSObject
39- (NSString*)getCountryID;
44- (NSString*)getCountryName;
49- (NSString*)getCountryCode;
50@end
51
52
57@interface ZoomSDKCallInPhoneNumInfo : NSObject
62- (NSString*) getID;
67- (NSString*) getCode;
72- (NSString*) getName;
77- (NSString*) getNumber;
82- (NSString*) getDisplayNumber;
88@end
89
90
95@interface ZoomSDKPhoneHelper : NSObject
96{
97 id<ZoomSDKPhoneHelperDelegate> _delegate;
99}
103@property(nonatomic, assign, nullable)id<ZoomSDKPhoneHelperDelegate> delegate;
109
115
121
129- (ZoomSDKError)inviteCalloutUser:(NSString*)userName PhoneNumber:(NSString*)number CountryCode:(NSString*)countryCode;
130
136
142
149- (ZoomSDKError)callMe:(NSString*)number CountryCode:(NSString*)countryCode;
150
156
162
168
173- (NSArray*_Nullable)getCallInNumberInfo;
174
175@end
176NS_ASSUME_NONNULL_END
PhoneStatus
Enumeration of phone call status.
ZoomSDKError
Enumeration of common errors of SDK.
CallInNumberType
Enumeration of the number types for calling to join the audio into a meeting.
PhoneFailedReason
Enumeration of the reasons for the telephone call’s failure.
Represents call-in phone number information.
NSString * getCode()
Gets the current call-in number’s country code.
NSString * getName()
Gets the current call-in number’s country name.
NSString * getDisplayNumber()
Gets the current call-in number’s display number.
CallInNumberType getType()
Gets the call-in number’s call type.
NSString * getNumber()
Gets the current call-in number’s telephone number.
NSString * getID()
Gets the current call-in number’s country ID.
Provides APIs to manage Zoom phone call-in and call-out features.
id< ZoomSDKPhoneHelperDelegate > _delegate
BOOL isSupportPhone()
Query if current meeting support telephony.
id< ZoomSDKPhoneHelperDelegate > delegate
Sets the delegate to receive phone call status updates.
ZoomSDKError cancelCalloutUser()
Cancels the invitation that is being called out by phone.
ZoomSDKError hangUp()
Cancels the current CALL ME action.
NSArray *_Nullable getCallInNumberInfo()
Gets the list of call-in numbers supported by the meeting.
NSArray * getSupportCountryInfo()
Gets the countries's list which support calling out.
unsigned int getCallInParticipantID()
Gets the participant's ID who joins the meeting by calling in.
PhoneStatus getCallMeStatus()
Gets the status of myself by CALL ME.
PhoneStatus getInviteCalloutUserStatus()
Gets the invited user's status by calling out.
BOOL isDialoutSupported()
Query if it is able to dial out in the current meeting.
Provides information of countries that support calling out.
NSString * getCountryID()
Gets the country's ID where a user can dial in.
NSString * getCountryCode()
Gets the country code.
NSString * getCountryName()
Gets the country name.