Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKMeetingChatController.h
Go to the documentation of this file.
1
7#import <Foundation/Foundation.h>
8#import <ZoomSDK/ZoomSDKErrors.h>
9
10@class ZoomSDKChatInfo;
11NS_ASSUME_NONNULL_BEGIN
12
17@interface ZoomSDKFileTransferInfo : NSObject
21@property(nonatomic, copy, readonly) NSString *messageId;
25@property(nonatomic, assign, readonly) ZoomSDKFileTransferStatus transferStatus;
29@property(nonatomic, assign, readonly) time_t timeStamp;
33@property(nonatomic, assign, readonly) BOOL isSendToAll;
37@property(nonatomic, assign, readonly) unsigned int fileSizeBytes;
41@property(nonatomic, copy, readonly) NSString *fileName;
45@property(nonatomic, assign, readonly) unsigned int completePercentage;
49@property(nonatomic, assign, readonly) unsigned int completeSize;
53@property(nonatomic, assign, readonly) unsigned int bitPerSecond;
54@end
55
56
61@interface ZoomSDKFileSender : NSObject
65@property(nonatomic, retain, readonly) ZoomSDKFileTransferInfo *transferInfo;
70@property(nonatomic, assign, readonly) unsigned int receiverUserId;
75- (ZoomSDKError)cancelSend;
76@end
77
78
83@interface ZoomSDKFileReceiver : NSObject
87@property(nonatomic, retain, readonly) ZoomSDKFileTransferInfo *transferInfo;
91@property(nonatomic, assign, readonly) unsigned int senderUserId;
97- (ZoomSDKError)startReceive:(NSString *)path;
102- (ZoomSDKError)cancelReceive;
103@end
104
105
110@interface ZoomSDKRichTextStyleOffset : NSObject
114@property(nonatomic,assign,readonly)unsigned int positionStart;
118@property(nonatomic,assign,readonly)unsigned int positionEnd;
123@property(nonatomic,copy,readonly)NSString* reserve;
124@end
125
126
131@interface ZoomSDKRichTextStyleItem : NSObject
135@property(nonatomic,assign,readonly)ZoomSDKRichTextStyle textStyle;
140- (NSArray<ZoomSDKRichTextStyleOffset *> *)getTextStyleOffsetList;
141@end
142
143
148@interface ZoomSDKChatMsgBoldAttrs : NSObject
152@property(nonatomic,assign)BOOL bBold;
153@end
154
155
160@interface ZoomSDKChatMsgItalicAttrs : NSObject
164@property(nonatomic,assign)BOOL bItalic;
165@end
166
167
176@property(nonatomic,assign)BOOL bStrikethrough;
177@end
178
179
188@property(nonatomic,assign)BOOL bBulletedList;
189@end
190
191
200@property(nonatomic,assign)BOOL bNumberedList;
201@end
202
203
208@interface ZoomSDKChatMsgUnderlineAttrs : NSObject
212@property(nonatomic,assign)BOOL bUnderline;
213@end
214
215
220@interface ZoomSDKChatMsgQuoteAttrs : NSObject
224@property(nonatomic,assign)BOOL bQuote;
225@end
226
227
232@interface ZoomSDKChatMsgInsertLinkAttrs : NSObject
236@property(nonatomic, copy, nullable)NSString* insertLinkUrl;
237@end
238
239#define FontSize_Small 8
240#define FontSize_Medium 10
241#define FontSize_Large 12
242
247@interface ZoomSDKChatMsgFontSizeAttrs : NSObject
251@property(nonatomic,assign)int fontSize;
252@end
253
254
268@interface ZoomSDKChatMsgFontColorAttrs : NSObject
272@property(nonatomic,assign)int red;
276@property(nonatomic,assign)int green;
280@property(nonatomic,assign)int blue;
281@end
282
283
302@property(nonatomic,assign)int red;
306@property(nonatomic,assign)int green;
310@property(nonatomic,assign)int blue;
311@end
312
313#define TextStyle_Paragraph_H1 @"Paragraph_H1"
314#define TextStyle_Paragraph_H2 @"Paragraph_H2"
315#define TextStyle_Paragraph_H3 @"Paragraph_H3"
316
321@interface ZoomSDKChatMsgParagraphAttrs : NSObject
325@property(nonatomic, copy, nullable)NSString* strParagraph;
326@end
327
332@interface ZoomSDKChatMsgIndentAttrs : NSObject
336@property(nonatomic,assign)int indent;
337@end
338
339
344@interface ZoomSDKChatMsgSegmentDetails : NSObject
348@property(nonatomic, copy, readonly, nullable)NSString* strContent;
352@property(nonatomic, retain, readonly, nullable)ZoomSDKChatMsgBoldAttrs* boldAttrs;
356@property(nonatomic, retain, readonly, nullable)ZoomSDKChatMsgItalicAttrs* italicAttrs;
360@property(nonatomic, retain, readonly, nullable)ZoomSDKChatMsgStrikethroughAttrs* strikethroughAttrs;
364@property(nonatomic, retain, readonly, nullable)ZoomSDKChatMsgBulletedListAttrs* bulletedListAttrs;
368@property(nonatomic, retain, readonly, nullable)ZoomSDKChatMsgNumberedListAttrs* numberedListAttrs;
372@property(nonatomic, retain, readonly, nullable)ZoomSDKChatMsgUnderlineAttrs* underlineAttrs;
376@property(nonatomic, retain, readonly, nullable)ZoomSDKChatMsgQuoteAttrs* quoteAttrs;
380@property(nonatomic, retain, readonly, nullable)ZoomSDKChatMsgInsertLinkAttrs* insertLinkAttrs;
384@property(nonatomic, retain, readonly, nullable)ZoomSDKChatMsgFontSizeAttrs* fontSizeAttrs;
388@property(nonatomic, retain, readonly, nullable)ZoomSDKChatMsgFontColorAttrs* fontColorAttrs;
392@property(nonatomic, retain, readonly, nullable)ZoomSDKChatMsgBackgroundColorAttrs* backgroundColorAttrs;
396@property(nonatomic, retain, readonly, nullable)ZoomSDKChatMsgParagraphAttrs* paragraphAttrs;
400@property(nonatomic, retain, readonly, nullable)ZoomSDKChatMsgIndentAttrs* indentAttrs;
401@end
402
403
408@interface ZoomSDKChatMsgInfoBuilder : NSObject
414- (ZoomSDKChatMsgInfoBuilder*)setContent:(NSString*)content;
420- (ZoomSDKChatMsgInfoBuilder*)setReceiver:(unsigned int)receiver;
426- (ZoomSDKChatMsgInfoBuilder*)setThreadId:(NSString*)threadId;
439- (ZoomSDKChatMsgInfoBuilder*)setQuotePosition:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
446- (ZoomSDKChatMsgInfoBuilder*)unsetQuotePosition:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
454- (ZoomSDKChatMsgInfoBuilder*)setInsertLink:(ZoomSDKChatMsgInsertLinkAttrs*)insertLink positionStart:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
461- (ZoomSDKChatMsgInfoBuilder*)unsetInsertLink:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
469- (ZoomSDKChatMsgInfoBuilder*)setFontSize:(ZoomSDKChatMsgFontSizeAttrs*)fontSize positionStart:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
476- (ZoomSDKChatMsgInfoBuilder*)unsetFontSize:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
483- (ZoomSDKChatMsgInfoBuilder*)setItalic:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
490- (ZoomSDKChatMsgInfoBuilder*)unsetItalic:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
497- (ZoomSDKChatMsgInfoBuilder*)setBold:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
504- (ZoomSDKChatMsgInfoBuilder*)unsetBold:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
511- (ZoomSDKChatMsgInfoBuilder*)setStrikethrough:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
518- (ZoomSDKChatMsgInfoBuilder*)unsetStrikethrough:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
525- (ZoomSDKChatMsgInfoBuilder*)setBulletedList:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
532- (ZoomSDKChatMsgInfoBuilder*)unsetBulletedList:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
539- (ZoomSDKChatMsgInfoBuilder*)setNumberedList:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
546- (ZoomSDKChatMsgInfoBuilder*)unsetNumberedList:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
553- (ZoomSDKChatMsgInfoBuilder*)setUnderline:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
560- (ZoomSDKChatMsgInfoBuilder*)unsetUnderline:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
568- (ZoomSDKChatMsgInfoBuilder*)setFontColor:(ZoomSDKChatMsgFontColorAttrs*)color positionStart:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
575- (ZoomSDKChatMsgInfoBuilder*)unsetFontColor:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
583- (ZoomSDKChatMsgInfoBuilder*)setBackgroundColor:(ZoomSDKChatMsgBackgroundColorAttrs*)color positionStart:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
590- (ZoomSDKChatMsgInfoBuilder*)unsetBackgroundColor:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
598- (ZoomSDKChatMsgInfoBuilder*)increaseIndent:(ZoomSDKChatMsgIndentAttrs*)indent positionStart:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
606- (ZoomSDKChatMsgInfoBuilder*)decreaseIndent:(ZoomSDKChatMsgIndentAttrs*)indent positionStart:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
618- (ZoomSDKChatMsgInfoBuilder*)setParagraph:(ZoomSDKChatMsgParagraphAttrs*)paragraph positionStart:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
626- (ZoomSDKChatMsgInfoBuilder*)unsetParagraph:(unsigned int)positionStart positionEnd:(unsigned int)positionEnd;
627
632- (ZoomSDKChatInfo*)build;
633@end
634
635
640@protocol ZoomSDKMeetingChatControllerDelegate <NSObject>
645- (void)onChatMessageNotification:(ZoomSDKChatInfo*)chatInfo;
646
651- (void)onChatMessageEditNotification:(ZoomSDKChatInfo*)chatInfo;
652
657- (void)onFileSendStart:(ZoomSDKFileSender *)sender;
662- (void)onFileReceived:(ZoomSDKFileReceiver *)receiver;
667- (void)onFileTransferProgress:(ZoomSDKFileTransferInfo *)info;
668@end
669
670
675@interface ZoomSDKMeetingChatController : NSObject
679@property(nonatomic,assign,nullable) id<ZoomSDKMeetingChatControllerDelegate> delegate;
685- (ZoomSDKChatInfo*_Nullable)getChatMessageById:(NSString *)messageID;
686
692- (ZoomSDKError)sendChatMsgTo:(ZoomSDKChatInfo*)message;
693
698- (BOOL)isFileTransferEnabled;
699
707- (ZoomSDKError)transferFile:(NSString *)filePath toUser:(unsigned int)userId;
708
715- (ZoomSDKError)transferFileToAll:(NSString *)filePath;
716
721- (NSString *_Nullable)getTransferFileTypeAllowList;
722
727- (unsigned long long)getMaxTransferFileSizeBytes;
728@end
729
730NS_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.
Represents a chat message in the meeting.
Set background color attributes for a chat message segment. Currently supported background color comb...
Style attributes indicating text is bold.
Set bulleted list style attributes for a chat message segment.
Set font color attributes for a chat message segment. Currently supported font color combinations....
Set font size attributes for a chat message segment.
Set indent attributes for a chat message segment.
Used to build a ZoomSDK chat message with various content and styles.
Set italic style attributes for a chat message segment.
Set numbered list style attributes for a chat message segment.
Set paragraph style attributes for a chat message segment.
Set quote style attributes for a chat message segment.
Define detailed attributes for a chat message segment.
Set strikethrough style attributes for a chat message segment.
Set underline style attributes for a chat message segment.
Provides control over receiving a file in a Zoom meeting chat.
Provides control over file sending in a Zoom meeting chat.
Provides information about the status and progress of a file transfer during a Zoom meeting.
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.
Provide APIs to manage in-meeting chat messages and file transfers.
Represents a rich-text style and associated style ranges.
Describes the style range and additional metadata of a rich text segment.