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
17@property(nonatomic, copy, nullable) NSString *messageId;
21@property(nonatomic, assign) MobileRTCFileTransferStatus transStatus;
25@property(nonatomic, strong, nullable) NSDate *timeStamp;
29@property(nonatomic, assign) BOOL isSendToAll;
33@property(nonatomic, assign) NSUInteger fileSize;
37@property(nonatomic, copy, nullable) NSString *fileName;
41@property(nonatomic, assign) NSUInteger completePercentage;
45@property(nonatomic, assign) NSUInteger completeSize;
49@property(nonatomic, assign) NSUInteger bitPerSecond;
50@end
51
52
57@interface MobileRTCFileSender : NSObject
61@property(nonatomic, strong, nullable) MobileRTCFileTransferInfo *transferInfo;
62
67- (NSInteger)getReceiverUserId;
68
73- (MobileRTCSDKError)cancelSend;
74@end
75
80@interface MobileRTCFileReceiver : NSObject
84@property(nonatomic, strong, nullable) MobileRTCFileTransferInfo *transferInfo;
85
90- (NSInteger)getSenderUserId;
91
96- (MobileRTCSDKError)cancelReceive;
97
103- (MobileRTCSDKError)startReceive:(NSString * _Nullable)path;
104@end
105
106
108@class MobileRTCBoldAttrs;
126@interface MobileRTCMeetingChatBuilder : NSObject
132- (MobileRTCMeetingChatBuilder * _Nullable)setContent:(NSString * _Nullable)content;
138- (MobileRTCMeetingChatBuilder * _Nullable)setReceiver:(NSInteger)receiver;
144- (MobileRTCMeetingChatBuilder * _Nullable)setThreadId:(NSString * _Nullable)threadId;
150- (MobileRTCMeetingChatBuilder * _Nullable)setMessageType:(MobileRTCChatMessageType)type;
151
158- (MobileRTCMeetingChatBuilder * _Nullable)setQuotePosition:(NSInteger)start end:(NSInteger)end;
165- (MobileRTCMeetingChatBuilder * _Nullable)unsetQuotePosition:(NSInteger)start end:(NSInteger)end;
166
173- (MobileRTCMeetingChatBuilder * _Nullable)setItalic:(NSInteger)start end:(NSInteger)end;
180- (MobileRTCMeetingChatBuilder * _Nullable)unsetItalic:(NSInteger)start end:(NSInteger)end;
181
188- (MobileRTCMeetingChatBuilder * _Nullable)setBold:(NSInteger)start end:(NSInteger)end;
195- (MobileRTCMeetingChatBuilder * _Nullable)unsetBold:(NSInteger)start end:(NSInteger)end;
196
203- (MobileRTCMeetingChatBuilder * _Nullable)setStrikethrough:(NSInteger)start end:(NSInteger)end;
210- (MobileRTCMeetingChatBuilder * _Nullable)unsetStrikethrough:(NSInteger)start end:(NSInteger)end;
211
218- (MobileRTCMeetingChatBuilder * _Nullable)setBulletedList:(NSInteger)start end:(NSInteger)end;
225- (MobileRTCMeetingChatBuilder * _Nullable)unsetBulletedList:(NSInteger)start end:(NSInteger)end;
226
233- (MobileRTCMeetingChatBuilder * _Nullable)setNumberedList:(NSInteger)start end:(NSInteger)end;
240- (MobileRTCMeetingChatBuilder * _Nullable)unsetNumberedList:(NSInteger)start end:(NSInteger)end;
241
248- (MobileRTCMeetingChatBuilder * _Nullable)setUnderline:(NSInteger)start end:(NSInteger)end;
255- (MobileRTCMeetingChatBuilder * _Nullable)unsetUnderline:(NSInteger)start end:(NSInteger)end;
256
263- (MobileRTCMeetingChatBuilder * _Nullable)setFontSize:(MobileRTCFontSizeAttrs * _Nullable)size start:(NSInteger)start end:(NSInteger)end;
270- (MobileRTCMeetingChatBuilder * _Nullable)unsetFontSize:(NSInteger)start end:(NSInteger)end;
271
278- (MobileRTCMeetingChatBuilder * _Nullable)setInsertLink:(MobileRTCInsertLinkAttrs * _Nullable)link start:(NSInteger)start end:(NSInteger)end;
285- (MobileRTCMeetingChatBuilder * _Nullable)unsetInsertLink:(NSInteger)start end:(NSInteger)end;
286
293- (MobileRTCMeetingChatBuilder * _Nullable)setBackgroundColor:(MobileRTCBackgroundColorAttrs * _Nullable)color start:(NSInteger)start end:(NSInteger)end;
300- (MobileRTCMeetingChatBuilder * _Nullable)unsetBackgroundColor:(NSInteger)start end:(NSInteger)end;
301
308- (MobileRTCMeetingChatBuilder * _Nullable)setFontColor:(MobileRTCFontColorAttrs * _Nullable)color start:(NSInteger)start end:(NSInteger)end;
315- (MobileRTCMeetingChatBuilder * _Nullable)unsetFontColor:(NSInteger)start end:(NSInteger)end;
316
323- (MobileRTCMeetingChatBuilder * _Nullable)increaseIndent:(MobileRTCIndentAttrs * _Nullable)indent start:(NSInteger)start end:(NSInteger)end;
330- (MobileRTCMeetingChatBuilder * _Nullable)decreaseIndent:(MobileRTCIndentAttrs * _Nullable)indent start:(NSInteger)start end:(NSInteger)end;
331
338- (MobileRTCMeetingChatBuilder * _Nullable)setParagraph:(MobileRTCParagraphAttrs * _Nullable)paragraph start:(NSInteger)start end:(NSInteger)end;
345- (MobileRTCMeetingChatBuilder * _Nullable)unsetParagraph:(NSInteger)start end:(NSInteger)end;
346
351- (MobileRTCMeetingChat * _Nullable)build;
352
353@end
354
359__attribute__((deprecated("This class is deprecated, use MobileRTCSegmentDetails instead")))
364@interface MobileRTCRichTextStyleOffset : NSObject
368@property (nonatomic, assign) NSInteger positionStart;
372@property (nonatomic, assign) NSInteger positionEnd;
378@property (nonatomic, copy) NSString * _Nullable reserve;
379@end
380
385__attribute__((deprecated("This class is deprecated, use MobileRTCSegmentDetails instead")))
390@interface MobileRTCRichTextStyleItem : NSObject
394@property (nonatomic, assign) MobileRTCRichTextStyle textStyle;
398@property (nonatomic, copy) NSArray <MobileRTCRichTextStyleOffset *>* _Nullable textStyleOffsetList;
399@end
400
401
402#pragma mark - new chat -
407@interface MobileRTCSegmentDetails : NSObject
411@property (nonatomic, copy) NSString * _Nullable content;
412
416@property (nonatomic, strong) MobileRTCBoldAttrs * _Nullable boldAttrs;
420@property (nonatomic, strong) MobileRTCItalicAttrs * _Nullable italicAttrs;
424@property (nonatomic, strong) MobileRTCStrikethroughAttrs * _Nullable strikethroughAttrs;
428@property (nonatomic, strong) MobileRTCBulletedListAttrs * _Nullable bulletedListAttrs;
432@property (nonatomic, strong) MobileRTCNumberedListAttrs * _Nullable numberedListAttrs;
436@property (nonatomic, strong) MobileRTCUnderlineAttrs * _Nullable underlineAttrs;
440@property (nonatomic, strong) MobileRTCQuoteAttrs * _Nullable quoteAttrs;
444@property (nonatomic, strong) MobileRTCInsertLinkAttrs * _Nullable insertLinkAttrs;
448@property (nonatomic, strong) MobileRTCFontSizeAttrs * _Nullable fontSizeAttrs;
452@property (nonatomic, strong) MobileRTCFontColorAttrs * _Nullable fontColorAttrs;
456@property (nonatomic, strong) MobileRTCBackgroundColorAttrs * _Nullable backgroundColorAttrs;
460@property (nonatomic, strong) MobileRTCParagraphAttrs * _Nullable paragraphAttrs;
464@property (nonatomic, strong) MobileRTCIndentAttrs * _Nullable indentAttrs;
465@end
466
471@interface MobileRTCBoldAttrs : NSObject
475@property (nonatomic, assign) BOOL bBold;
476@end
477
482@interface MobileRTCItalicAttrs : NSObject
486@property (nonatomic, assign) BOOL bItalic;
487@end
488
493@interface MobileRTCStrikethroughAttrs : NSObject
497@property (nonatomic, assign) BOOL bStrikethrough;
498@end
499
504@interface MobileRTCBulletedListAttrs : NSObject
508@property (nonatomic, assign) BOOL bBulletedList;
509@end
510
515@interface MobileRTCNumberedListAttrs : NSObject
519@property (nonatomic, assign) BOOL bNumberedList;
520@end
521
526@interface MobileRTCUnderlineAttrs : NSObject
530@property (nonatomic, assign) BOOL bUnderline;
531@end
532
537@interface MobileRTCQuoteAttrs : NSObject
541@property (nonatomic, assign) BOOL bQuote;
542@end
543
548@interface MobileRTCInsertLinkAttrs : NSObject
552@property (nonatomic, copy) NSString * _Nullable insertLinkUrl;
553@end
554
558#define FontSize_Small 8
559#define FontSize_Medium 10
560#define FontSize_Large 12
565@interface MobileRTCFontSizeAttrs : NSObject
569@property (nonatomic, assign) NSInteger fontSize;
570@end
571
572
585#define kRichTextColor(r,g,b) [UIColor colorWithRed:r/255. green:g/255. blue:b/255. alpha:1.]
590@interface MobileRTCFontColorAttrs : NSObject
594@property (nonatomic, strong) UIColor * _Nullable color;
595@end
596
597
612@interface MobileRTCBackgroundColorAttrs : NSObject
616@property (nonatomic, strong) UIColor * _Nullable color;
617@end
618
623#define TextStyle_Paragraph_H1 @"Paragraph_H1"
624#define TextStyle_Paragraph_H2 @"Paragraph_H2"
625#define TextStyle_Paragraph_H3 @"Paragraph_H3"
626
631@interface MobileRTCParagraphAttrs : NSObject
635@property (nonatomic, copy) NSString * _Nullable strParagraph;
636@end
637
642@interface MobileRTCIndentAttrs : NSObject
646@property (nonatomic, assign) NSInteger indent;
647@end
648
649
655@interface MobileRTCMeetingChat : NSObject
659@property (nonatomic, copy) NSString * _Nullable chatId;
663@property (nonatomic, copy) NSString * _Nullable senderId;
667@property (nonatomic, copy) NSString * _Nullable senderName;
671@property (nonatomic, copy) NSString * _Nullable receiverId;
675@property (nonatomic, copy) NSString * _Nullable receiverName;
679@property (nonatomic, copy) NSString * _Nullable content;
683@property (nonatomic, retain) NSDate *_Nullable date;
684
688@property (nonatomic, assign) MobileRTCChatMessageType chatMessageType;
689
693@property (nonatomic, assign) BOOL isMyself;
697@property (nonatomic, assign) BOOL isPrivate;
701@property (nonatomic, assign) BOOL isChatToAll;
705@property (nonatomic, assign) BOOL isChatToAllPanelist;
709@property (nonatomic, assign) BOOL isChatToWaitingroom;
713@property (nonatomic, assign) BOOL isComment;
717@property (nonatomic, assign) BOOL isThread;
722@property (nonatomic, copy) NSArray <MobileRTCRichTextStyleItem *>* _Nullable textStyleItemList DEPRECATED_MSG_ATTRIBUTE("Use segmentDetails instead");
723
728@property (nonatomic, copy) NSArray <MobileRTCSegmentDetails *>* _Nullable segmentDetails;
732@property (nonatomic, copy) NSString * _Nullable threadID;
733@end
MobileRTCRichTextStyle
Enumeration of the content font style type for chat message. For more information,...
MobileRTCChatMessageType
Enumeration of chat types.
MobileRTCSDKError
Enumeration of SDK error.
MobileRTCFileTransferStatus
Enumeration of the status of a file transfer.
@interface MobileRTCRichTextStyleItem NSArray< MobileRTCRichTextStyleOffset * > *_Nullable textStyleOffsetList
Get the rich text type of a portion of the current message.
NSString *_Nullable reserve
Get a certain rich-text style’s supplementary information.
@interface MobileRTCRichTextStyleOffset NSInteger positionEnd
Get a certain rich-text style’s start position.
For rich text solution, the specify text styple information.
For rich text solution, the specify rich text offset information.
Background color attributes.
BulletedList attributes.
Interface for file receiver.
Interface for file sender.
Provides information about the status and progress of a file transfer during a Zoom meeting.
NSUInteger bitPerSecond
The speed of the file transfer in bits per second.
BOOL isSendToAll
Is the file send to all user in meeting?
NSString * fileName
The file name of 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 time stamp of the file.
NSUInteger completePercentage
The ratio of the file transfer completed.
NSUInteger fileSize
The bytes of transfer file size.
NSString * messageId
The message identify of transfer file.
Set font color attributes for a chat message segment.
Set font size attributes for a chat message segment.
Chat message builder to create ChatMsgInfo objects.
Retrieve the meeting chat data.
NumberedList attributes.
Information of rich text with style attributes in a chat message content. Here are more detailed stru...
Strikethrough attributes.