Meeting SDK for iOS API Reference
Loading...
Searching...
No Matches
MobileRTCMeetingChat.h
Go to the documentation of this file.
1
6#import <Foundation/Foundation.h>
7#import <MobileRTC/MobileRTCConstants.h>
8
13@interface MobileRTCFileTransferInfo : NSObject
14
18@property(nonatomic, copy, nullable) NSString *messageId;
19
23@property(nonatomic, assign) MobileRTCFileTransferStatus transStatus;
24
28@property(nonatomic, strong, nullable) NSDate *timeStamp;
29
33@property(nonatomic, assign) BOOL isSendToAll;
34
38@property(nonatomic, assign) NSUInteger fileSize;
39
43@property(nonatomic, copy, nullable) NSString *fileName;
44
48@property(nonatomic, assign) NSUInteger completePercentage;
49
53@property(nonatomic, assign) NSUInteger completeSize;
54
58@property(nonatomic, assign) NSUInteger bitPerSecond;
59@end
60
65@interface MobileRTCFileSender : NSObject
66
70@property(nonatomic, strong, nullable) MobileRTCFileTransferInfo *transferInfo;
71
76- (NSInteger)getReceiverUserId;
77
82- (MobileRTCSDKError)cancelSend;
83@end
84
89@interface MobileRTCFileReceiver : NSObject
90
94@property(nonatomic, strong, nullable) MobileRTCFileTransferInfo *transferInfo;
95
100- (NSInteger)getSenderUserId;
101
106- (MobileRTCSDKError)cancelReceive;
107
113- (MobileRTCSDKError)startReceive:(NSString * _Nullable)path;
114@end
115
116
118@class MobileRTCBoldAttrs;
136@interface MobileRTCMeetingChatBuilder : NSObject
137
143- (MobileRTCMeetingChatBuilder * _Nullable)setContent:(NSString * _Nullable)content;
144
150- (MobileRTCMeetingChatBuilder * _Nullable)setReceiver:(NSInteger)receiver;
151
157- (MobileRTCMeetingChatBuilder * _Nullable)setThreadId:(NSString * _Nullable)threadId;
158
164- (MobileRTCMeetingChatBuilder * _Nullable)setMessageType:(MobileRTCChatMessageType)type;
165
172- (MobileRTCMeetingChatBuilder * _Nullable)setQuotePosition:(NSInteger)start end:(NSInteger)end;
173
180- (MobileRTCMeetingChatBuilder * _Nullable)unsetQuotePosition:(NSInteger)start end:(NSInteger)end;
181
188- (MobileRTCMeetingChatBuilder * _Nullable)setItalic:(NSInteger)start end:(NSInteger)end;
189
196- (MobileRTCMeetingChatBuilder * _Nullable)unsetItalic:(NSInteger)start end:(NSInteger)end;
197
204- (MobileRTCMeetingChatBuilder * _Nullable)setBold:(NSInteger)start end:(NSInteger)end;
205
212- (MobileRTCMeetingChatBuilder * _Nullable)unsetBold:(NSInteger)start end:(NSInteger)end;
213
220- (MobileRTCMeetingChatBuilder * _Nullable)setStrikethrough:(NSInteger)start end:(NSInteger)end;
221
228- (MobileRTCMeetingChatBuilder * _Nullable)unsetStrikethrough:(NSInteger)start end:(NSInteger)end;
229
236- (MobileRTCMeetingChatBuilder * _Nullable)setBulletedList:(NSInteger)start end:(NSInteger)end;
237
244- (MobileRTCMeetingChatBuilder * _Nullable)unsetBulletedList:(NSInteger)start end:(NSInteger)end;
245
252- (MobileRTCMeetingChatBuilder * _Nullable)setNumberedList:(NSInteger)start end:(NSInteger)end;
253
260- (MobileRTCMeetingChatBuilder * _Nullable)unsetNumberedList:(NSInteger)start end:(NSInteger)end;
261
268- (MobileRTCMeetingChatBuilder * _Nullable)setUnderline:(NSInteger)start end:(NSInteger)end;
269
276- (MobileRTCMeetingChatBuilder * _Nullable)unsetUnderline:(NSInteger)start end:(NSInteger)end;
277
285- (MobileRTCMeetingChatBuilder * _Nullable)setFontSize:(MobileRTCFontSizeAttrs * _Nullable)size start:(NSInteger)start end:(NSInteger)end;
286
293- (MobileRTCMeetingChatBuilder * _Nullable)unsetFontSize:(NSInteger)start end:(NSInteger)end;
294
302- (MobileRTCMeetingChatBuilder * _Nullable)setInsertLink:(MobileRTCInsertLinkAttrs * _Nullable)link start:(NSInteger)start end:(NSInteger)end;
303
310- (MobileRTCMeetingChatBuilder * _Nullable)unsetInsertLink:(NSInteger)start end:(NSInteger)end;
311
319- (MobileRTCMeetingChatBuilder * _Nullable)setBackgroundColor:(MobileRTCBackgroundColorAttrs * _Nullable)color start:(NSInteger)start end:(NSInteger)end;
320
327- (MobileRTCMeetingChatBuilder * _Nullable)unsetBackgroundColor:(NSInteger)start end:(NSInteger)end;
328
336- (MobileRTCMeetingChatBuilder * _Nullable)setFontColor:(MobileRTCFontColorAttrs * _Nullable)color start:(NSInteger)start end:(NSInteger)end;
337
344- (MobileRTCMeetingChatBuilder * _Nullable)unsetFontColor:(NSInteger)start end:(NSInteger)end;
345
353- (MobileRTCMeetingChatBuilder * _Nullable)increaseIndent:(MobileRTCIndentAttrs * _Nullable)indent start:(NSInteger)start end:(NSInteger)end;
354
362- (MobileRTCMeetingChatBuilder * _Nullable)decreaseIndent:(MobileRTCIndentAttrs * _Nullable)indent start:(NSInteger)start end:(NSInteger)end;
363
371- (MobileRTCMeetingChatBuilder * _Nullable)setParagraph:(MobileRTCParagraphAttrs * _Nullable)paragraph start:(NSInteger)start end:(NSInteger)end;
372
379- (MobileRTCMeetingChatBuilder * _Nullable)unsetParagraph:(NSInteger)start end:(NSInteger)end;
380
385- (MobileRTCMeetingChat * _Nullable)build;
386
387@end
388
393__attribute__((deprecated("This class is deprecated, use MobileRTCSegmentDetails instead")))
398@interface MobileRTCRichTextStyleOffset : NSObject
399
403@property (nonatomic, assign) NSInteger positionStart;
404
408@property (nonatomic, assign) NSInteger positionEnd;
409
415@property (nonatomic, copy) NSString * _Nullable reserve;
416@end
417
422__attribute__((deprecated("This class is deprecated, use MobileRTCSegmentDetails instead")))
427@interface MobileRTCRichTextStyleItem : NSObject
428
432@property (nonatomic, assign) MobileRTCRichTextStyle textStyle;
433
437@property (nonatomic, copy) NSArray <MobileRTCRichTextStyleOffset *>* _Nullable textStyleOffsetList;
438@end
439
440#pragma mark - new chat -
445@interface MobileRTCSegmentDetails : NSObject
446
450@property (nonatomic, copy) NSString * _Nullable content;
451
455@property (nonatomic, strong) MobileRTCBoldAttrs * _Nullable boldAttrs;
456
460@property (nonatomic, strong) MobileRTCItalicAttrs * _Nullable italicAttrs;
461
465@property (nonatomic, strong) MobileRTCStrikethroughAttrs * _Nullable strikethroughAttrs;
466
470@property (nonatomic, strong) MobileRTCBulletedListAttrs * _Nullable bulletedListAttrs;
471
475@property (nonatomic, strong) MobileRTCNumberedListAttrs * _Nullable numberedListAttrs;
476
480@property (nonatomic, strong) MobileRTCUnderlineAttrs * _Nullable underlineAttrs;
481
485@property (nonatomic, strong) MobileRTCQuoteAttrs * _Nullable quoteAttrs;
489@property (nonatomic, strong) MobileRTCInsertLinkAttrs * _Nullable insertLinkAttrs;
490
494@property (nonatomic, strong) MobileRTCFontSizeAttrs * _Nullable fontSizeAttrs;
495
499@property (nonatomic, strong) MobileRTCFontColorAttrs * _Nullable fontColorAttrs;
500
504@property (nonatomic, strong) MobileRTCBackgroundColorAttrs * _Nullable backgroundColorAttrs;
505
509@property (nonatomic, strong) MobileRTCParagraphAttrs * _Nullable paragraphAttrs;
510
514@property (nonatomic, strong) MobileRTCIndentAttrs * _Nullable indentAttrs;
515@end
516
521@interface MobileRTCBoldAttrs : NSObject
522
526@property (nonatomic, assign) BOOL bBold;
527@end
528
533@interface MobileRTCItalicAttrs : NSObject
534
538@property (nonatomic, assign) BOOL bItalic;
539@end
540
545@interface MobileRTCStrikethroughAttrs : NSObject
546
550@property (nonatomic, assign) BOOL bStrikethrough;
551@end
552
557@interface MobileRTCBulletedListAttrs : NSObject
558
562@property (nonatomic, assign) BOOL bBulletedList;
563@end
564
569@interface MobileRTCNumberedListAttrs : NSObject
570
574@property (nonatomic, assign) BOOL bNumberedList;
575@end
576
581@interface MobileRTCUnderlineAttrs : NSObject
582
586@property (nonatomic, assign) BOOL bUnderline;
587@end
588
593@interface MobileRTCQuoteAttrs : NSObject
594
598@property (nonatomic, assign) BOOL bQuote;
599@end
600
605@interface MobileRTCInsertLinkAttrs : NSObject
606
610@property (nonatomic, copy) NSString * _Nullable insertLinkUrl;
611@end
612
616#define FontSize_Small 8
617#define FontSize_Medium 10
618#define FontSize_Large 12
619
624@interface MobileRTCFontSizeAttrs : NSObject
625
629@property (nonatomic, assign) NSInteger fontSize;
630@end
631
644#define kRichTextColor(r,g,b) [UIColor colorWithRed:r/255. green:g/255. blue:b/255. alpha:1.]
645
650@interface MobileRTCFontColorAttrs : NSObject
651
655@property (nonatomic, strong) UIColor * _Nullable color;
656@end
657
672@interface MobileRTCBackgroundColorAttrs : NSObject
673
677@property (nonatomic, strong) UIColor * _Nullable color;
678@end
679
684#define TextStyle_Paragraph_H1 @"Paragraph_H1"
685#define TextStyle_Paragraph_H2 @"Paragraph_H2"
686#define TextStyle_Paragraph_H3 @"Paragraph_H3"
687
692@interface MobileRTCParagraphAttrs : NSObject
693
697@property (nonatomic, copy) NSString * _Nullable strParagraph;
698@end
699
704@interface MobileRTCIndentAttrs : NSObject
705
709@property (nonatomic, assign) NSInteger indent;
710@end
711
717@interface MobileRTCMeetingChat : NSObject
718
722@property (nonatomic, copy) NSString * _Nullable chatId;
723
727@property (nonatomic, copy) NSString * _Nullable senderId;
728
732@property (nonatomic, copy) NSString * _Nullable senderName;
733
737@property (nonatomic, copy) NSString * _Nullable receiverId;
738
742@property (nonatomic, copy) NSString * _Nullable receiverName;
743
747@property (nonatomic, copy) NSString * _Nullable content;
748
752@property (nonatomic, retain) NSDate *_Nullable date;
753
757@property (nonatomic, assign) MobileRTCChatMessageType chatMessageType;
758
762@property (nonatomic, assign) BOOL isMyself;
763
767@property (nonatomic, assign) BOOL isPrivate;
768
772@property (nonatomic, assign) BOOL isChatToAll;
773
777@property (nonatomic, assign) BOOL isChatToAllPanelist;
778
782@property (nonatomic, assign) BOOL isChatToWaitingroom;
783
787@property (nonatomic, assign) BOOL isComment;
788
792@property (nonatomic, assign) BOOL isThread;
793
798@property (nonatomic, copy) NSArray <MobileRTCRichTextStyleItem *>* _Nullable textStyleItemList DEPRECATED_MSG_ATTRIBUTE("Use segmentDetails instead");
799
804@property (nonatomic, copy) NSArray <MobileRTCSegmentDetails *>* _Nullable segmentDetails;
808@property (nonatomic, copy) NSString * _Nullable threadID;
809@end
MobileRTCRichTextStyle
Enumeration of the content font style type for chat message. For more information,...
MobileRTCChatMessageType
Enumeration of chat types.
MobileRTCSDKError
Enumeration of the SDK error.
MobileRTCFileTransferStatus
Enumeration of the status of the file transfer.
@interface MobileRTCRichTextStyleItem NSArray< MobileRTCRichTextStyleOffset * > *_Nullable textStyleOffsetList
Gets the rich text type of a portion of the current message.
NSString *_Nullable reserve
Gets a certain rich-text style's supplementary information.
@interface MobileRTCRichTextStyleOffset NSInteger positionEnd
Gets a certain rich-text style's start position.
For rich text solution, the specified text style information.
For rich text solution, the specified rich text offset information.
A class that contains background color attributes.
A class that contains bold attributes.
A class that contains bulleted list attributes.
A class for file receiver.
A class for file sender.
A class that provides information about the status and progress of a file transfer during a Zoom meet...
NSUInteger bitPerSecond
The speed of the file transfer in bits per second.
BOOL isSendToAll
Indicates whether the file is sent to all users in the meeting.
NSString * fileName
The file name of the transfer file.
NSUInteger completeSize
The size of the file transferred so far in bytes.
MobileRTCFileTransferStatus transStatus
The status of the file transfer.
NSDate * timeStamp
The timestamp of the file.
NSUInteger completePercentage
The ratio of the file transfer completed.
NSUInteger fileSize
The bytes of transfer file size.
NSString * messageId
The message ID of the transfer file.
A class that sets font color attributes for a chat message segment.
A class that sets font size attributes for a chat message segment.
A class that contains indent attributes.
A class that contains italic attributes.
A chat message builder to create ChatMsgInfo objects.
A class that retrieves meeting chat data.
A class that contains numbered list attributes.
A class that contains paragraph attributes.
A class that contains quote attributes.
A class that contains information of rich text with style attributes in a chat message content....
A class that contains strikethrough attributes.
A class that contains underline attributes.