Meeting SDK for iOS API Reference
Loading...
Searching...
No Matches
MobileRTCMeetingChatBuilder Class Reference

Chat message builder to create ChatMsgInfo objects. More...

#include <MobileRTCMeetingChat.h>

Inherits NSObject.

Instance Methods

(MobileRTCMeetingChatBuilder *_Nullable) - setContent:
 Set chat message content.
 
(MobileRTCMeetingChatBuilder *_Nullable) - setReceiver:
 Set who will receive the chat message.
 
(MobileRTCMeetingChatBuilder *_Nullable) - setThreadId:
 Set the ID of the thread where the message will be posted.
 
(MobileRTCMeetingChatBuilder *_Nullable) - setMessageType:
 Set the chat message type.
 
(MobileRTCMeetingChatBuilder *_Nullable) - setQuotePosition:end:
 Set the chat message content quote style.
 
(MobileRTCMeetingChatBuilder *_Nullable) - unsetQuotePosition:end:
 Clear the chat message content quote style.
 
(MobileRTCMeetingChatBuilder *_Nullable) - setItalic:end:
 Set the chat message content italic style.
 
(MobileRTCMeetingChatBuilder *_Nullable) - unsetItalic:end:
 Clear the chat message content italic style.
 
(MobileRTCMeetingChatBuilder *_Nullable) - setBold:end:
 Set the chat message content bold style.
 
(MobileRTCMeetingChatBuilder *_Nullable) - unsetBold:end:
 Clear the chat message content bold style.
 
(MobileRTCMeetingChatBuilder *_Nullable) - setStrikethrough:end:
 Set the chat message content strikethrough style.
 
(MobileRTCMeetingChatBuilder *_Nullable) - unsetStrikethrough:end:
 Clear the chat message content strikethrough style.
 
(MobileRTCMeetingChatBuilder *_Nullable) - setBulletedList:end:
 Set the chat message content bulletedList style.
 
(MobileRTCMeetingChatBuilder *_Nullable) - unsetBulletedList:end:
 Clear the chat message content bulletedList style.
 
(MobileRTCMeetingChatBuilder *_Nullable) - setNumberedList:end:
 Set the chat message content numberedList style.
 
(MobileRTCMeetingChatBuilder *_Nullable) - unsetNumberedList:end:
 Clear the chat message content numberedList style.
 
(MobileRTCMeetingChatBuilder *_Nullable) - setUnderline:end:
 Set the chat message content underline style.
 
(MobileRTCMeetingChatBuilder *_Nullable) - unsetUnderline:end:
 Clear the chat message content underline style.
 
(MobileRTCMeetingChatBuilder *_Nullable) - setFontSize:start:end:
 Set the chat message content font size style.
 
(MobileRTCMeetingChatBuilder *_Nullable) - unsetFontSize:end:
 Clear the chat message content font size style.
 
(MobileRTCMeetingChatBuilder *_Nullable) - setInsertLink:start:end:
 Set the chat message content insert link style.
 
(MobileRTCMeetingChatBuilder *_Nullable) - unsetInsertLink:end:
 Clear the chat message content insert link style.
 
(MobileRTCMeetingChatBuilder *_Nullable) - setBackgroundColor:start:end:
 Set the chat message content background color style.
 
(MobileRTCMeetingChatBuilder *_Nullable) - unsetBackgroundColor:end:
 Clear the chat message content background color style.
 
(MobileRTCMeetingChatBuilder *_Nullable) - setFontColor:start:end:
 Set the chat message content font color style.
 
(MobileRTCMeetingChatBuilder *_Nullable) - unsetFontColor:end:
 Clear the chat message content font color style.
 
(MobileRTCMeetingChatBuilder *_Nullable) - increaseIndent:start:end:
 Increase the chat message content indent style.
 
(MobileRTCMeetingChatBuilder *_Nullable) - decreaseIndent:start:end:
 Decrease the chat message content indent style.
 
(MobileRTCMeetingChatBuilder *_Nullable) - setParagraph:start:end:
 Set the chat message content paragraph style.
 
(MobileRTCMeetingChatBuilder *_Nullable) - unsetParagraph:end:
 Clear the chat message content paragraph style.
 
(MobileRTCMeetingChat *_Nullable) - build
 Build chat message entity.
 

Detailed Description

Chat message builder to create ChatMsgInfo objects.

Note
If there are duplicate styles, the final appearance is determined by the last applied setting.

Definition at line 129 of file MobileRTCMeetingChat.h.

Method Documentation

◆ build

- (MobileRTCMeetingChat *_Nullable) build

Build chat message entity.

Returns
If the function succeeds, the return value is the message detail information.

◆ decreaseIndent:start:end:

- (MobileRTCMeetingChatBuilder *_Nullable) decreaseIndent: (MobileRTCIndentAttrs *_Nullable) indent
start: (NSInteger) start
end: (NSInteger) end 

Decrease the chat message content indent style.

Parameters
startThe segment start position.
endThe segment end position.
Returns
Return the MobileRTCMeetingChatBuilder object with modify information.

◆ increaseIndent:start:end:

- (MobileRTCMeetingChatBuilder *_Nullable) increaseIndent: (MobileRTCIndentAttrs *_Nullable) indent
start: (NSInteger) start
end: (NSInteger) end 

Increase the chat message content indent style.

Parameters
startThe segment start position.
endThe segment end position.
Returns
Return the MobileRTCMeetingChatBuilder object with modify information.

◆ setBackgroundColor:start:end:

- (MobileRTCMeetingChatBuilder *_Nullable) setBackgroundColor: (MobileRTCBackgroundColorAttrs *_Nullable) color
start: (NSInteger) start
end: (NSInteger) end 

Set the chat message content background color style.

Parameters
startThe segment start position.
endThe segment end position.
Returns
Return the MobileRTCMeetingChatBuilder object with modify information.

◆ setBold:end:

- (MobileRTCMeetingChatBuilder *_Nullable) setBold: (NSInteger) start
end: (NSInteger) end 

Set the chat message content bold style.

Parameters
startThe segment start position.
endThe segment end position.
Returns
Return the MobileRTCMeetingChatBuilder object with modify information.

◆ setBulletedList:end:

- (MobileRTCMeetingChatBuilder *_Nullable) setBulletedList: (NSInteger) start
end: (NSInteger) end 

Set the chat message content bulletedList style.

Parameters
startThe segment start position.
endThe segment end position.
Returns
Return the MobileRTCMeetingChatBuilder object with modify information.

◆ setContent:

- (MobileRTCMeetingChatBuilder *_Nullable) setContent: (NSString *_Nullable) content

Set chat message content.

Parameters
contentThe chat message’s content.

◆ setFontColor:start:end:

- (MobileRTCMeetingChatBuilder *_Nullable) setFontColor: (MobileRTCFontColorAttrs *_Nullable) color
start: (NSInteger) start
end: (NSInteger) end 

Set the chat message content font color style.

Parameters
startThe segment start position.
endThe segment end position.
Returns
Return the MobileRTCMeetingChatBuilder object with modify information.

◆ setFontSize:start:end:

- (MobileRTCMeetingChatBuilder *_Nullable) setFontSize: (MobileRTCFontSizeAttrs *_Nullable) size
start: (NSInteger) start
end: (NSInteger) end 

Set the chat message content font size style.

Parameters
startThe segment start position.
endThe segment end position.
Returns
Return the MobileRTCMeetingChatBuilder object with modify information.

◆ setInsertLink:start:end:

- (MobileRTCMeetingChatBuilder *_Nullable) setInsertLink: (MobileRTCInsertLinkAttrs *_Nullable) link
start: (NSInteger) start
end: (NSInteger) end 

Set the chat message content insert link style.

Parameters
startThe segment start position.
endThe segment end position.
Returns
Return the MobileRTCMeetingChatBuilder object with modify information.

◆ setItalic:end:

- (MobileRTCMeetingChatBuilder *_Nullable) setItalic: (NSInteger) start
end: (NSInteger) end 

Set the chat message content italic style.

Parameters
startThe segment start position.
endThe segment end position.
Returns
Return the MobileRTCMeetingChatBuilder object with modify information.

◆ setMessageType:

- (MobileRTCMeetingChatBuilder *_Nullable) setMessageType: (MobileRTCChatMessageType) type

Set the chat message type.

Parameters
typeThe chat message’s type.

◆ setNumberedList:end:

- (MobileRTCMeetingChatBuilder *_Nullable) setNumberedList: (NSInteger) start
end: (NSInteger) end 

Set the chat message content numberedList style.

Parameters
startThe segment start position.
endThe segment end position.
Returns
Return the MobileRTCMeetingChatBuilder object with modify information.

◆ setParagraph:start:end:

- (MobileRTCMeetingChatBuilder *_Nullable) setParagraph: (MobileRTCParagraphAttrs *_Nullable) paragraph
start: (NSInteger) start
end: (NSInteger) end 

Set the chat message content paragraph style.

Parameters
startThe segment start position.
endThe segment end position.
Returns
Return the MobileRTCMeetingChatBuilder object with modify information.

◆ setQuotePosition:end:

- (MobileRTCMeetingChatBuilder *_Nullable) setQuotePosition: (NSInteger) start
end: (NSInteger) end 

Set the chat message content quote style.

Parameters
startThe segment start position.
endThe segment end position.
Returns
Return the MobileRTCMeetingChatBuilder object with modify information.

◆ setReceiver:

- (MobileRTCMeetingChatBuilder *_Nullable) setReceiver: (NSInteger) receiver

Set who will receive the chat message.

Parameters
receiverSpecify the user ID to receive the chat message. The message is sent to all participants when the value is zero (0).

◆ setStrikethrough:end:

- (MobileRTCMeetingChatBuilder *_Nullable) setStrikethrough: (NSInteger) start
end: (NSInteger) end 

Set the chat message content strikethrough style.

Parameters
startThe segment start position.
endThe segment end position.
Returns
Return the MobileRTCMeetingChatBuilder object with modify information.

◆ setThreadId:

- (MobileRTCMeetingChatBuilder *_Nullable) setThreadId: (NSString *_Nullable) threadId

Set the ID of the thread where the message will be posted.

Parameters
threadIdSpecify the thread ID.

◆ setUnderline:end:

- (MobileRTCMeetingChatBuilder *_Nullable) setUnderline: (NSInteger) start
end: (NSInteger) end 

Set the chat message content underline style.

Parameters
startThe segment start position.
endThe segment end position.
Returns
Return the MobileRTCMeetingChatBuilder object with modify information.

◆ unsetBackgroundColor:end:

- (MobileRTCMeetingChatBuilder *_Nullable) unsetBackgroundColor: (NSInteger) start
end: (NSInteger) end 

Clear the chat message content background color style.

Parameters
startThe segment start position.
endThe segment end position.
Returns
Return the MobileRTCMeetingChatBuilder object with modify information.

◆ unsetBold:end:

- (MobileRTCMeetingChatBuilder *_Nullable) unsetBold: (NSInteger) start
end: (NSInteger) end 

Clear the chat message content bold style.

Parameters
startThe segment start position.
endThe segment end position.
Returns
Return the MobileRTCMeetingChatBuilder object with modify information.

◆ unsetBulletedList:end:

- (MobileRTCMeetingChatBuilder *_Nullable) unsetBulletedList: (NSInteger) start
end: (NSInteger) end 

Clear the chat message content bulletedList style.

Parameters
startThe segment start position.
endThe segment end position.
Returns
Return the MobileRTCMeetingChatBuilder object with modify information.

◆ unsetFontColor:end:

- (MobileRTCMeetingChatBuilder *_Nullable) unsetFontColor: (NSInteger) start
end: (NSInteger) end 

Clear the chat message content font color style.

Parameters
startThe segment start position.
endThe segment end position.
Returns
Return the MobileRTCMeetingChatBuilder object with modify information.

◆ unsetFontSize:end:

- (MobileRTCMeetingChatBuilder *_Nullable) unsetFontSize: (NSInteger) start
end: (NSInteger) end 

Clear the chat message content font size style.

Parameters
startThe segment start position.
endThe segment end position.
Returns
Return the MobileRTCMeetingChatBuilder object with modify information.

◆ unsetInsertLink:end:

- (MobileRTCMeetingChatBuilder *_Nullable) unsetInsertLink: (NSInteger) start
end: (NSInteger) end 

Clear the chat message content insert link style.

Parameters
startThe segment start position.
endThe segment end position.
Returns
Return the MobileRTCMeetingChatBuilder object with modify information.

◆ unsetItalic:end:

- (MobileRTCMeetingChatBuilder *_Nullable) unsetItalic: (NSInteger) start
end: (NSInteger) end 

Clear the chat message content italic style.

Parameters
startThe segment start position.
endThe segment end position.
Returns
Return the MobileRTCMeetingChatBuilder object with modify information.

◆ unsetNumberedList:end:

- (MobileRTCMeetingChatBuilder *_Nullable) unsetNumberedList: (NSInteger) start
end: (NSInteger) end 

Clear the chat message content numberedList style.

Parameters
startThe segment start position.
endThe segment end position.
Returns
Return the MobileRTCMeetingChatBuilder object with modify information.

◆ unsetParagraph:end:

- (MobileRTCMeetingChatBuilder *_Nullable) unsetParagraph: (NSInteger) start
end: (NSInteger) end 

Clear the chat message content paragraph style.

Parameters
startThe segment start position.
endThe segment end position.
Returns
Return the MobileRTCMeetingChatBuilder object with modify information.

◆ unsetQuotePosition:end:

- (MobileRTCMeetingChatBuilder *_Nullable) unsetQuotePosition: (NSInteger) start
end: (NSInteger) end 

Clear the chat message content quote style.

Parameters
startThe segment start position.
endThe segment end position.
Returns
Return the MobileRTCMeetingChatBuilder object with modify information.

◆ unsetStrikethrough:end:

- (MobileRTCMeetingChatBuilder *_Nullable) unsetStrikethrough: (NSInteger) start
end: (NSInteger) end 

Clear the chat message content strikethrough style.

Parameters
startThe segment start position.
endThe segment end position.
Returns
Return the MobileRTCMeetingChatBuilder object with modify information.

◆ unsetUnderline:end:

- (MobileRTCMeetingChatBuilder *_Nullable) unsetUnderline: (NSInteger) start
end: (NSInteger) end 

Clear the chat message content underline style.

Parameters
startThe segment start position.
endThe segment end position.
Returns
Return the MobileRTCMeetingChatBuilder object with modify information.