Meeting SDK for iOS API Reference
Loading...
Searching...
No Matches
MobileRTCMeetingChat.h
Go to the documentation of this file.
1//
2// MobileRTCMeetingChat.h
3// MobileRTC
4//
5// Created by Zoom Communications on 2017/9/15.
6// Copyright © Zoom Communications, Inc. All rights reserved.
7//
8
9#import <Foundation/Foundation.h>
10#import <MobileRTC/MobileRTCConstants.h>
11
16@interface MobileRTCFileTransferInfo : NSObject
20@property(nonatomic, copy, nullable) NSString *messageId;
24@property(nonatomic, assign) MobileRTCFileTransferStatus transStatus;
28@property(nonatomic, strong, nullable) NSDate *timeStamp;
32@property(nonatomic, assign) BOOL isSendToAll;
36@property(nonatomic, assign) NSUInteger fileSize;
40@property(nonatomic, copy, nullable) NSString *fileName;
44@property(nonatomic, assign) NSUInteger completePercentage;
48@property(nonatomic, assign) NSUInteger completeSize;
52@property(nonatomic, assign) NSUInteger bitPerSecond;
53@end
54
55
60@interface MobileRTCFileSender : NSObject
64@property(nonatomic, strong, nullable) MobileRTCFileTransferInfo *transferInfo;
65
70- (NSInteger)getReceiverUserId;
71
76- (MobileRTCSDKError)cancelSend;
77@end
78
83@interface MobileRTCFileReceiver : NSObject
87@property(nonatomic, strong, nullable) MobileRTCFileTransferInfo *transferInfo;
88
93- (NSInteger)getSenderUserId;
94
99- (MobileRTCSDKError)cancelReceive;
100
106- (MobileRTCSDKError)startReceive:(NSString * _Nullable)path;
107@end
108
109
111@class MobileRTCBoldAttrs;
129@interface MobileRTCMeetingChatBuilder : NSObject
134- (MobileRTCMeetingChatBuilder * _Nullable)setContent:(NSString * _Nullable)content;
139- (MobileRTCMeetingChatBuilder * _Nullable)setReceiver:(NSInteger)receiver;
144- (MobileRTCMeetingChatBuilder * _Nullable)setThreadId:(NSString * _Nullable)threadId;
149- (MobileRTCMeetingChatBuilder * _Nullable)setMessageType:(MobileRTCChatMessageType)type;
150
157- (MobileRTCMeetingChatBuilder * _Nullable)setQuotePosition:(NSInteger)start end:(NSInteger)end;
164- (MobileRTCMeetingChatBuilder * _Nullable)unsetQuotePosition:(NSInteger)start end:(NSInteger)end;
165
172- (MobileRTCMeetingChatBuilder * _Nullable)setItalic:(NSInteger)start end:(NSInteger)end;
179- (MobileRTCMeetingChatBuilder * _Nullable)unsetItalic:(NSInteger)start end:(NSInteger)end;
180
187- (MobileRTCMeetingChatBuilder * _Nullable)setBold:(NSInteger)start end:(NSInteger)end;
194- (MobileRTCMeetingChatBuilder * _Nullable)unsetBold:(NSInteger)start end:(NSInteger)end;
195
202- (MobileRTCMeetingChatBuilder * _Nullable)setStrikethrough:(NSInteger)start end:(NSInteger)end;
209- (MobileRTCMeetingChatBuilder * _Nullable)unsetStrikethrough:(NSInteger)start end:(NSInteger)end;
210
217- (MobileRTCMeetingChatBuilder * _Nullable)setBulletedList:(NSInteger)start end:(NSInteger)end;
224- (MobileRTCMeetingChatBuilder * _Nullable)unsetBulletedList:(NSInteger)start end:(NSInteger)end;
225
232- (MobileRTCMeetingChatBuilder * _Nullable)setNumberedList:(NSInteger)start end:(NSInteger)end;
239- (MobileRTCMeetingChatBuilder * _Nullable)unsetNumberedList:(NSInteger)start end:(NSInteger)end;
240
247- (MobileRTCMeetingChatBuilder * _Nullable)setUnderline:(NSInteger)start end:(NSInteger)end;
254- (MobileRTCMeetingChatBuilder * _Nullable)unsetUnderline:(NSInteger)start end:(NSInteger)end;
255
262- (MobileRTCMeetingChatBuilder * _Nullable)setFontSize:(MobileRTCFontSizeAttrs * _Nullable)size start:(NSInteger)start end:(NSInteger)end;
269- (MobileRTCMeetingChatBuilder * _Nullable)unsetFontSize:(NSInteger)start end:(NSInteger)end;
270
277- (MobileRTCMeetingChatBuilder * _Nullable)setInsertLink:(MobileRTCInsertLinkAttrs * _Nullable)link start:(NSInteger)start end:(NSInteger)end;
284- (MobileRTCMeetingChatBuilder * _Nullable)unsetInsertLink:(NSInteger)start end:(NSInteger)end;
285
292- (MobileRTCMeetingChatBuilder * _Nullable)setBackgroundColor:(MobileRTCBackgroundColorAttrs * _Nullable)color start:(NSInteger)start end:(NSInteger)end;
299- (MobileRTCMeetingChatBuilder * _Nullable)unsetBackgroundColor:(NSInteger)start end:(NSInteger)end;
300
307- (MobileRTCMeetingChatBuilder * _Nullable)setFontColor:(MobileRTCFontColorAttrs * _Nullable)color start:(NSInteger)start end:(NSInteger)end;
314- (MobileRTCMeetingChatBuilder * _Nullable)unsetFontColor:(NSInteger)start end:(NSInteger)end;
315
322- (MobileRTCMeetingChatBuilder * _Nullable)increaseIndent:(MobileRTCIndentAttrs * _Nullable)indent start:(NSInteger)start end:(NSInteger)end;
329- (MobileRTCMeetingChatBuilder * _Nullable)decreaseIndent:(MobileRTCIndentAttrs * _Nullable)indent start:(NSInteger)start end:(NSInteger)end;
330
337- (MobileRTCMeetingChatBuilder * _Nullable)setParagraph:(MobileRTCParagraphAttrs * _Nullable)paragraph start:(NSInteger)start end:(NSInteger)end;
344- (MobileRTCMeetingChatBuilder * _Nullable)unsetParagraph:(NSInteger)start end:(NSInteger)end;
345
350- (MobileRTCMeetingChat * _Nullable)build;
351
352@end
353
358__attribute__((deprecated("This class is deprecated, use MobileRTCSegmentDetails instead")))
363@interface MobileRTCRichTextStyleOffset : NSObject
367@property (nonatomic, assign) NSInteger positionStart;
371@property (nonatomic, assign) NSInteger positionEnd;
377@property (nonatomic, copy) NSString * _Nullable reserve;
378@end
379
384__attribute__((deprecated("This class is deprecated, use MobileRTCSegmentDetails instead")))
389@interface MobileRTCRichTextStyleItem : NSObject
393@property (nonatomic, assign) MobileRTCRichTextStyle textStyle;
397@property (nonatomic, copy) NSArray <MobileRTCRichTextStyleOffset *>* _Nullable textStyleOffsetList;
398@end
399
400
401#pragma mark - new chat -
406@interface MobileRTCSegmentDetails : NSObject
410@property (nonatomic, copy) NSString * _Nullable content;
411
415@property (nonatomic, strong) MobileRTCBoldAttrs * _Nullable boldAttrs;
419@property (nonatomic, strong) MobileRTCItalicAttrs * _Nullable italicAttrs;
423@property (nonatomic, strong) MobileRTCStrikethroughAttrs * _Nullable strikethroughAttrs;
427@property (nonatomic, strong) MobileRTCBulletedListAttrs * _Nullable bulletedListAttrs;
431@property (nonatomic, strong) MobileRTCNumberedListAttrs * _Nullable numberedListAttrs;
435@property (nonatomic, strong) MobileRTCUnderlineAttrs * _Nullable underlineAttrs;
439@property (nonatomic, strong) MobileRTCQuoteAttrs * _Nullable quoteAttrs;
443@property (nonatomic, strong) MobileRTCInsertLinkAttrs * _Nullable insertLinkAttrs;
447@property (nonatomic, strong) MobileRTCFontSizeAttrs * _Nullable fontSizeAttrs;
451@property (nonatomic, strong) MobileRTCFontColorAttrs * _Nullable fontColorAttrs;
455@property (nonatomic, strong) MobileRTCBackgroundColorAttrs * _Nullable backgroundColorAttrs;
459@property (nonatomic, strong) MobileRTCParagraphAttrs * _Nullable paragraphAttrs;
463@property (nonatomic, strong) MobileRTCIndentAttrs * _Nullable indentAttrs;
464@end
465
470@interface MobileRTCBoldAttrs : NSObject
474@property (nonatomic, assign) BOOL bBold;
475@end
476
481@interface MobileRTCItalicAttrs : NSObject
485@property (nonatomic, assign) BOOL bItalic;
486@end
487
492@interface MobileRTCStrikethroughAttrs : NSObject
496@property (nonatomic, assign) BOOL bStrikethrough;
497@end
498
503@interface MobileRTCBulletedListAttrs : NSObject
507@property (nonatomic, assign) BOOL bBulletedList;
508@end
509
514@interface MobileRTCNumberedListAttrs : NSObject
518@property (nonatomic, assign) BOOL bNumberedList;
519@end
520
525@interface MobileRTCUnderlineAttrs : NSObject
529@property (nonatomic, assign) BOOL bUnderline;
530@end
531
536@interface MobileRTCQuoteAttrs : NSObject
540@property (nonatomic, assign) BOOL bQuote;
541@end
542
547@interface MobileRTCInsertLinkAttrs : NSObject
551@property (nonatomic, copy) NSString * _Nullable insertLinkUrl;
552@end
553
557#define FontSize_Small 8
558#define FontSize_Medium 10
559#define FontSize_Large 12
564@interface MobileRTCFontSizeAttrs : NSObject
568@property (nonatomic, assign) NSInteger fontSize;
569@end
570
571
584#define kRichTextColor(r,g,b) [UIColor colorWithRed:r/255. green:g/255. blue:b/255. alpha:1.]
589@interface MobileRTCFontColorAttrs : NSObject
593@property (nonatomic, strong) UIColor * _Nullable color;
594@end
595
596
611@interface MobileRTCBackgroundColorAttrs : NSObject
615@property (nonatomic, strong) UIColor * _Nullable color;
616@end
617
622#define TextStyle_Paragraph_H1 @"Paragraph_H1"
623#define TextStyle_Paragraph_H2 @"Paragraph_H2"
624#define TextStyle_Paragraph_H3 @"Paragraph_H3"
625
630@interface MobileRTCParagraphAttrs : NSObject
634@property (nonatomic, copy) NSString * _Nullable strParagraph;
635@end
636
641@interface MobileRTCIndentAttrs : NSObject
645@property (nonatomic, assign) NSInteger indent;
646@end
647
648
654@interface MobileRTCMeetingChat : NSObject
658@property (nonatomic, copy) NSString * _Nullable chatId;
662@property (nonatomic, copy) NSString * _Nullable senderId;
666@property (nonatomic, copy) NSString * _Nullable senderName;
670@property (nonatomic, copy) NSString * _Nullable receiverId;
674@property (nonatomic, copy) NSString * _Nullable receiverName;
678@property (nonatomic, copy) NSString * _Nullable content;
682@property (nonatomic, retain) NSDate *_Nullable date;
683
687@property (nonatomic, assign) MobileRTCChatMessageType chatMessageType;
688
692@property (nonatomic, assign) BOOL isMyself;
696@property (nonatomic, assign) BOOL isPrivate;
700@property (nonatomic, assign) BOOL isChatToAll;
704@property (nonatomic, assign) BOOL isChatToAllPanelist;
708@property (nonatomic, assign) BOOL isChatToWaitingroom;
712@property (nonatomic, assign) BOOL isComment;
716@property (nonatomic, assign) BOOL isThread;
721@property (nonatomic, copy) NSArray <MobileRTCRichTextStyleItem *>* _Nullable textStyleItemList DEPRECATED_MSG_ATTRIBUTE("Use segmentDetails instead");
722
727@property (nonatomic, copy) NSArray <MobileRTCSegmentDetails *>* _Nullable segmentDetails;
731@property (nonatomic, copy) NSString * _Nullable threadID;
732@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.