ZMVideoSDKChatHelper.h 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  1. #import <Foundation/Foundation.h>
  2. #import "ZMVideoSDKUserHelper.h"
  3. NS_ASSUME_NONNULL_BEGIN
  4. /**
  5. @brief Chat helper interface.
  6. */
  7. @interface ZMVideoSDKChatHelper : NSObject
  8. /**
  9. @brief Determine whether chat is disabled.
  10. @return YES if chat is disabled, otherwise NO.
  11. */
  12. -(BOOL)isChatDisabled;
  13. /**
  14. @brief Determine whether private chat is disabled.
  15. @return YES if private chat is disabled, otherwise NO.
  16. */
  17. -(BOOL)isPrivateChatDisabled;
  18. /**
  19. @brief Call this method to send a chat message to a specific user.
  20. @param user The receiver.
  21. @param msgContent The content of message.
  22. @return If the function succeeds, it will return ZMVideoSDKErrors_Success.
  23. */
  24. -(ZMVideoSDKErrors)sendChatToUser:(ZMVideoSDKUser*)user content:(NSString *)msgContent;
  25. /**
  26. @brief Call this method to send a chat message to all users.
  27. @param msgContent The content of message.
  28. @return If the function succeeds, it will return ZMVideoSDKErrors_Success.
  29. */
  30. -(ZMVideoSDKErrors)sendChatToAll:(NSString *)msgContent;
  31. /**
  32. @brief Determine if a specific message can be deleted.
  33. @param msgID The message Id.
  34. @return YES if the message can be deleted, otherwise NO.
  35. */
  36. -(BOOL)canChatMessageBeDeleted:(NSString *)msgID;
  37. /**
  38. @brief Call this method to delete a specific chat message from the Zoom server.
  39. @Note This does not delete the message in your user interface.
  40. @param msgID The message Id.
  41. @return If the function succeeds, it will return ZMVideoSDKErrors_Success, otherwise failed.
  42. */
  43. -(ZMVideoSDKErrors)deleteChatMessage:(NSString *)msgID;
  44. /**
  45. @brief Set participant chat privilege when in session. Only session host/manager can run the function.
  46. @param privilege The chat privilege of the participant.
  47. @return If the function succeeds, it will return ZMVideoSDKErrors_Success, otherwise failed.
  48. */
  49. -(ZMVideoSDKErrors)changeChatPrivilege:(ZMVideoSDKChatPrivilegeType)privilege;
  50. /**
  51. @brief Get participant chat privilege when in session.
  52. @return The result of participant chat priviledge.
  53. */
  54. -(ZMVideoSDKChatPrivilegeType)getChatPrivilege;
  55. @end
  56. NS_ASSUME_NONNULL_END