Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKMeetingChatController.h
Go to the documentation of this file.
1//
2
3#import <Foundation/Foundation.h>
4#import <ZoomSDK/ZoomSDKErrors.h>
5
6@class ZoomSDKChatInfo;
7NS_ASSUME_NONNULL_BEGIN
8
9@interface ZoomSDKFileTransferInfo : NSObject
13@property(nonatomic, copy, readonly) NSString *messageId;
17@property(nonatomic, assign, readonly) ZoomSDKFileTransferStatus transferStatus;
21@property(nonatomic, assign, readonly) time_t timeStamp;
25@property(nonatomic, assign, readonly) BOOL isSendToAll;
29@property(nonatomic, assign, readonly) unsigned int fileSizeBytes;
33@property(nonatomic, copy, readonly) NSString *fileName;
37@property(nonatomic, assign, readonly) unsigned int completePercentage;
41@property(nonatomic, assign, readonly) unsigned int completeSize;
45@property(nonatomic, assign, readonly) unsigned int bitPerSecond;
46@end
47
48@interface ZoomSDKFileSender : NSObject
52@property(nonatomic, retain, readonly) ZoomSDKFileTransferInfo *transferInfo;
57@property(nonatomic, assign, readonly) unsigned int receiverUserId;
62- (ZoomSDKError)cancelSend;
63@end
64@interface ZoomSDKFileReceiver : NSObject
68@property(nonatomic, retain, readonly) ZoomSDKFileTransferInfo *transferInfo;
72@property(nonatomic, assign, readonly) unsigned int senderUserId;
78- (ZoomSDKError)startReceive:(NSString *)path;
83- (ZoomSDKError)cancelReceive;
84@end
85
86@interface ZoomSDKRichTextStyleOffset : NSObject
90@property(nonatomic,assign,readonly)unsigned int positionStart;
94@property(nonatomic,assign,readonly)unsigned int positionEnd;
99@property(nonatomic,copy,readonly)NSString* reserve;
100@end
101
102@interface ZoomSDKRichTextStyleItem : NSObject
106@property(nonatomic,assign,readonly)ZoomSDKRichTextStyle textStyle;
111- (NSArray<ZoomSDKRichTextStyleOffset *> *)getTextStyleOffsetList;
112@end
113
114@interface ZoomSDKChatMsgBoldAttrs : NSObject
118@property(nonatomic,assign)BOOL bBold;
119@end
120
121@interface ZoomSDKChatMsgItalicAttrs : NSObject
125@property(nonatomic,assign)BOOL bItalic;
126@end
127
132@property(nonatomic,assign)BOOL bStrikethrough;
133@end
134
139@property(nonatomic,assign)BOOL bBulletedList;
140@end
141
146@property(nonatomic,assign)BOOL bNumberedList;
147@end
148
149@interface ZoomSDKChatMsgUnderlineAttrs : NSObject
153@property(nonatomic,assign)BOOL bUnderline;
154@end
155
156@interface ZoomSDKChatMsgQuoteAttrs : NSObject
160@property(nonatomic,assign)BOOL bQuote;
161@end
162
163@interface ZoomSDKChatMsgInsertLinkAttrs : NSObject
167@property(nonatomic, copy, nullable)NSString* insertLinkUrl;
168@end
169
170#define FontSize_Small 8
171#define FontSize_Medium 10
172#define FontSize_Large 12
173
174@interface ZoomSDKChatMsgFontSizeAttrs : NSObject
178@property(nonatomic,assign)int fontSize;
179@end
180
192@interface ZoomSDKChatMsgFontColorAttrs : NSObject
196@property(nonatomic,assign)int red;
200@property(nonatomic,assign)int green;
204@property(nonatomic,assign)int blue;
205@end
206
223@property(nonatomic,assign)int red;
227@property(nonatomic,assign)int green;
231@property(nonatomic,assign)int blue;
232@end
233
234#define TextStyle_Paragraph_H1 @"Paragraph_H1"
235#define TextStyle_Paragraph_H2 @"Paragraph_H2"
236#define TextStyle_Paragraph_H3 @"Paragraph_H3"
237@interface ZoomSDKChatMsgParagraphAttrs : NSObject
241@property(nonatomic, copy, nullable)NSString* strParagraph;
242@end
243
244@interface ZoomSDKChatMsgIndentAttrs : NSObject
248@property(nonatomic,assign)int indent;
249@end
250
251@interface ZoomSDKChatMsgSegmentDetails : NSObject
255@property(nonatomic, copy, readonly, nullable)NSString* strContent;
259@property(nonatomic, retain, readonly, nullable)ZoomSDKChatMsgBoldAttrs* boldAttrs;
263@property(nonatomic, retain, readonly, nullable)ZoomSDKChatMsgItalicAttrs* italicAttrs;
267@property(nonatomic, retain, readonly, nullable)ZoomSDKChatMsgStrikethroughAttrs* strikethroughAttrs;
271@property(nonatomic, retain, readonly, nullable)ZoomSDKChatMsgBulletedListAttrs* bulletedListAttrs;
275@property(nonatomic, retain, readonly, nullable)ZoomSDKChatMsgNumberedListAttrs* numberedListAttrs;
279@property(nonatomic, retain, readonly, nullable)ZoomSDKChatMsgUnderlineAttrs* underlineAttrs;
283@property(nonatomic, retain, readonly, nullable)ZoomSDKChatMsgQuoteAttrs* quoteAttrs;
287@property(nonatomic, retain, readonly, nullable)ZoomSDKChatMsgInsertLinkAttrs* insertLinkAttrs;
291@property(nonatomic, retain, readonly, nullable)ZoomSDKChatMsgFontSizeAttrs* fontSizeAttrs;
295@property(nonatomic, retain, readonly, nullable)ZoomSDKChatMsgFontColorAttrs* fontColorAttrs;
299@property(nonatomic, retain, readonly, nullable)ZoomSDKChatMsgBackgroundColorAttrs* backgroundColorAttrs;
303@property(nonatomic, retain, readonly, nullable)ZoomSDKChatMsgParagraphAttrs* paragraphAttrs;
307@property(nonatomic, retain, readonly, nullable)ZoomSDKChatMsgIndentAttrs* indentAttrs;
308@end
309
310@interface ZoomSDKChatMsgInfoBuilder : NSObject
316- (ZoomSDKChatMsgInfoBuilder*)setContent:(NSString*)content;
322- (ZoomSDKChatMsgInfoBuilder*)setReceiver:(unsigned int)receiver;
328- (ZoomSDKChatMsgInfoBuilder*)setThreadId:(NSString*)threadId;
341- (ZoomSDKChatMsgInfoBuilder*)setQuotePosition:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
348- (ZoomSDKChatMsgInfoBuilder*)unsetQuotePosition:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
356- (ZoomSDKChatMsgInfoBuilder*)setInsertLink:(ZoomSDKChatMsgInsertLinkAttrs*)insertLink positionStart:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
363- (ZoomSDKChatMsgInfoBuilder*)unsetInsertLink:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
371- (ZoomSDKChatMsgInfoBuilder*)setFontSize:(ZoomSDKChatMsgFontSizeAttrs*)fontSize positionStart:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
378- (ZoomSDKChatMsgInfoBuilder*)unsetFontSize:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
385- (ZoomSDKChatMsgInfoBuilder*)setItalic:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
392- (ZoomSDKChatMsgInfoBuilder*)unsetItalic:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
399- (ZoomSDKChatMsgInfoBuilder*)setBold:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
406- (ZoomSDKChatMsgInfoBuilder*)unsetBold:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
413- (ZoomSDKChatMsgInfoBuilder*)setStrikethrough:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
420- (ZoomSDKChatMsgInfoBuilder*)unsetStrikethrough:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
427- (ZoomSDKChatMsgInfoBuilder*)setBulletedList:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
434- (ZoomSDKChatMsgInfoBuilder*)unsetBulletedList:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
441- (ZoomSDKChatMsgInfoBuilder*)setNumberedList:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
448- (ZoomSDKChatMsgInfoBuilder*)unsetNumberedList:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
455- (ZoomSDKChatMsgInfoBuilder*)setUnderline:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
462- (ZoomSDKChatMsgInfoBuilder*)unsetUnderline:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
470- (ZoomSDKChatMsgInfoBuilder*)setFontColor:(ZoomSDKChatMsgFontColorAttrs*)color positionStart:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
477- (ZoomSDKChatMsgInfoBuilder*)unsetFontColor:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
485- (ZoomSDKChatMsgInfoBuilder*)setBackgroundColor:(ZoomSDKChatMsgBackgroundColorAttrs*)color positionStart:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
492- (ZoomSDKChatMsgInfoBuilder*)unsetBackgroundColor:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
500- (ZoomSDKChatMsgInfoBuilder*)increaseIndent:(ZoomSDKChatMsgIndentAttrs*)indent positionStart:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
508- (ZoomSDKChatMsgInfoBuilder*)decreaseIndent:(ZoomSDKChatMsgIndentAttrs*)indent positionStart:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
520- (ZoomSDKChatMsgInfoBuilder*)setParagraph:(ZoomSDKChatMsgParagraphAttrs*)paragraph positionStart:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
528- (ZoomSDKChatMsgInfoBuilder*)unsetParagraph:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
529
534- (ZoomSDKChatInfo*)build;
535@end
536
537@protocol ZoomSDKMeetingChatControllerDelegate <NSObject>
542- (void)onChatMessageNotification:(ZoomSDKChatInfo*)chatInfo;
543
548- (void)onChatMessageEditNotification:(ZoomSDKChatInfo*)chatInfo;
549
554- (void)onFileSendStart:(ZoomSDKFileSender *)sender;
559- (void)onFileReceived:(ZoomSDKFileReceiver *)receiver;
564- (void)onFileTransferProgress:(ZoomSDKFileTransferInfo *)info;
565@end
566
567@interface ZoomSDKMeetingChatController : NSObject
568
569@property(nonatomic,assign,nullable) id<ZoomSDKMeetingChatControllerDelegate> delegate;
575- (ZoomSDKChatInfo*_Nullable)getChatMessageById:(NSString *)messageID;
576
582- (ZoomSDKError)sendChatMsgTo:(ZoomSDKChatInfo*)message;
583
588- (BOOL)isFileTransferEnabled;
589
597- (ZoomSDKError)transferFile:(NSString *)filePath toUser:(unsigned int)userId;
598
605- (ZoomSDKError)transferFileToAll:(NSString *)filePath;
606
611- (NSString *_Nullable)getTransferFileTypeAllowList;
612
617- (unsigned long long)getMaxTransferFileSizeBytes;
618@end
619
620NS_ASSUME_NONNULL_END
ZoomSDKRichTextStyle
Enumeration of the content font style type for chat message. For more information,...
ZoomSDKError
Enumeration of common errors of SDK.
ZoomSDKChatMessageType
Enumeration of the type for chat message.
ZoomSDKFileTransferStatus
Enumeration of the status of a file transfer.
ZOOM SDK chat information.
unsigned int completeSize
The size of the file transferred so far in bytes.
NSString * messageId
The message identify of transfer file.
unsigned int fileSizeBytes
The bytes of transfer file size.
BOOL isSendToAll
Is the file send to all user in meeting?
unsigned int bitPerSecond
The speed of the file transfer in bits per second.
unsigned int completePercentage
The ratio of the file transfer completed.
ZoomSDKFileTransferStatus transferStatus
The status of the file transfer.
time_t timeStamp
The time stamp of the file.
NSString * fileName
The file name of transfer file.