ZMVideoSDKPhoneHelper.h 2.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889
  1. #import <Foundation/Foundation.h>
  2. NS_ASSUME_NONNULL_BEGIN
  3. @interface ZMVideoSDKDialInNumberInfo : NSObject
  4. /**
  5. @brief The country ID of the current information.
  6. */
  7. @property (nonatomic, copy, readonly) NSString* countryID;
  8. /**
  9. @brief The country code of the current information.
  10. */
  11. @property (nonatomic, copy, readonly) NSString* countryCode;
  12. /**
  13. @brief The country name of the current information.
  14. */
  15. @property (nonatomic, copy, readonly) NSString* countryName;
  16. /**
  17. @brief The country number.
  18. */
  19. @property (nonatomic, copy, readonly) NSString* number;
  20. /**
  21. @brief The display number.
  22. */
  23. @property (nonatomic, copy, readonly) NSString* displayNumber;
  24. /**
  25. @brief The type of dial in number.
  26. */
  27. @property (nonatomic, assign, readonly) ZMVideoSDKDialInNumType type;
  28. @end
  29. @interface ZMVideoSDKPhoneSupportCountryInfo : NSObject
  30. /**
  31. @brief The country ID of the current information.
  32. */
  33. @property (nonatomic, copy, readonly) NSString* countryID;
  34. /**
  35. @brief The country name of the current information.
  36. */
  37. @property (nonatomic, copy, readonly) NSString* countryName;
  38. /**
  39. @brief The country code of the current information.
  40. */
  41. @property (nonatomic, copy, readonly) NSString* countryCode;
  42. @end
  43. @interface ZMVideoSDKPhoneHelper : NSObject
  44. /**
  45. @brief Determine if the session supports join by phone or not.
  46. @return YES indicates join by phone is supported, otherwise NO.
  47. */
  48. - (BOOL)isSupportPhoneFeature;
  49. /**
  50. @brief Get the list of the country information where the session supports to join by telephone.
  51. @return If the function succeeds, the return value is the array of the country information, otherwise returns nil.
  52. */
  53. - (NSArray<ZMVideoSDKPhoneSupportCountryInfo*>*)getSupportCountryInfo;
  54. /**
  55. @brief Invite the specified user to join the session by phone.
  56. @param countryCode The country code of the specified user must be in the support list.
  57. @param phoneNumber The phone number of specified user.
  58. @param name The screen name of the specified user in the session.
  59. @return If the function succeeds, the return value is ZMVideoSDKErrors_Success, otherwise not.
  60. */
  61. - (ZMVideoSDKErrors)inviteByPhone:(NSString*)countryCode phoneNumber:(NSString*)phoneNumber name:(NSString*)name;
  62. /**
  63. @brief Cancel the invitation that is being called out by phone.
  64. @return If the function succeeds, the return value is ZMVideoSDKErrors_Success, otherwise not.
  65. */
  66. - (ZMVideoSDKErrors)cancelInviteByPhone;
  67. /**
  68. @brief Get the status of the invitation by phone.
  69. @return If the function succeeds, the method returns the ZMPhoneStatus of the invitation by phone. To get extended error information, see {@link ZMPhoneStatus}.
  70. */
  71. - (ZMPhoneStatus)getInviteByPhoneStatus;
  72. /**
  73. @brief Get the list of dial in numbers supported by session.
  74. @return If the function succeeds, the return value is the list of the call-in numbers. Otherwise failed. For more details, see {@link ZMVideoSDKDialInNumberInfo}.
  75. */
  76. - (NSArray<ZMVideoSDKDialInNumberInfo *>*)getSessionDialInNumbers;
  77. @end
  78. NS_ASSUME_NONNULL_END