A chat message builder to create ChatMsgInfo objects. More...

#include <MobileRTCMeetingChat.h>

Inherits NSObject.

Instance Methods
(MobileRTCMeetingChatBuilder *_Nullable)	- setContent:
	Sets chat message content.

(MobileRTCMeetingChatBuilder *_Nullable)	- setReceiver:
	Sets who will receive the chat message.

(MobileRTCMeetingChatBuilder *_Nullable)	- setThreadId:
	Sets the ID of the thread where the message will be posted.

(MobileRTCMeetingChatBuilder *_Nullable)	- setMessageType:
	Sets the chat message type.

(MobileRTCMeetingChatBuilder *_Nullable)	- setQuotePosition:end:
	Sets the chat message content quote style.

(MobileRTCMeetingChatBuilder *_Nullable)	- unsetQuotePosition:end:
	Clears the chat message content quote style.

(MobileRTCMeetingChatBuilder *_Nullable)	- setItalic:end:
	Sets the chat message content italic style.

(MobileRTCMeetingChatBuilder *_Nullable)	- unsetItalic:end:
	Clears the chat message content italic style.

(MobileRTCMeetingChatBuilder *_Nullable)	- setBold:end:
	Sets the chat message content bold style.

(MobileRTCMeetingChatBuilder *_Nullable)	- unsetBold:end:
	Clears the chat message content bold style.

(MobileRTCMeetingChatBuilder *_Nullable)	- setStrikethrough:end:
	Sets the chat message content strikethrough style.

(MobileRTCMeetingChatBuilder *_Nullable)	- unsetStrikethrough:end:
	Clears the chat message content strikethrough style.

(MobileRTCMeetingChatBuilder *_Nullable)	- setBulletedList:end:
	Sets the chat message content bulleted list style.

(MobileRTCMeetingChatBuilder *_Nullable)	- unsetBulletedList:end:
	Clears the chat message content bulleted list style.

(MobileRTCMeetingChatBuilder *_Nullable)	- setNumberedList:end:
	Sets the chat message content numbered list style.

(MobileRTCMeetingChatBuilder *_Nullable)	- unsetNumberedList:end:
	Clears the chat message content numbered list style.

(MobileRTCMeetingChatBuilder *_Nullable)	- setUnderline:end:
	Sets the chat message content underline style.

(MobileRTCMeetingChatBuilder *_Nullable)	- unsetUnderline:end:
	Clears the chat message content underline style.

(MobileRTCMeetingChatBuilder *_Nullable)	- setFontSize:start:end:
	Sets the chat message content font size style.

(MobileRTCMeetingChatBuilder *_Nullable)	- unsetFontSize:end:
	Clears the chat message content font size style.

(MobileRTCMeetingChatBuilder *_Nullable)	- setInsertLink:start:end:
	Sets the chat message content insert link style.

(MobileRTCMeetingChatBuilder *_Nullable)	- unsetInsertLink:end:
	Clears the chat message content insert link style.

(MobileRTCMeetingChatBuilder *_Nullable)	- setBackgroundColor:start:end:
	Sets the chat message content background color style.

(MobileRTCMeetingChatBuilder *_Nullable)	- unsetBackgroundColor:end:
	Clears the chat message content background color style.

(MobileRTCMeetingChatBuilder *_Nullable)	- setFontColor:start:end:
	Sets the chat message content font color style.

(MobileRTCMeetingChatBuilder *_Nullable)	- unsetFontColor:end:
	Clears the chat message content font color style.

(MobileRTCMeetingChatBuilder *_Nullable)	- increaseIndent:start:end:
	Increases the chat message content indent style.

(MobileRTCMeetingChatBuilder *_Nullable)	- decreaseIndent:start:end:
	Decreases the chat message content indent style.

(MobileRTCMeetingChatBuilder *_Nullable)	- setParagraph:start:end:
	Sets the chat message content paragraph style.

(MobileRTCMeetingChatBuilder *_Nullable)	- unsetParagraph:end:
	Clears the chat message content paragraph style.

(MobileRTCMeetingChat *_Nullable)	- build
	Builds chat message entity.

Detailed Description

A 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 136 of file MobileRTCMeetingChat.h.

Method Documentation

◆ build

- (MobileRTCMeetingChat *_Nullable) build

Builds chat message entity.

Returns: If the function succeeds, it returns a MobileRTCMeetingChat object. Otherwise, this function fails and returns nil.

◆ decreaseIndent:start:end:

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

Decreases the chat message content indent style.

Parameters

indent	The indent attributes.
start	The segment start position.
end	The segment end position.

Returns: If the function succeeds, it returns a MobileRTCMeetingChatBuilder object. Otherwise, this function fails and returns nil.

◆ increaseIndent:start:end:

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

Increases the chat message content indent style.

Parameters

indent	The indent attributes.
start	The segment start position.
end	The segment end position.

Returns: If the function succeeds, it returns a MobileRTCMeetingChatBuilder object. Otherwise, this function fails and returns nil.

◆ setBackgroundColor:start:end:

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

Sets the chat message content background color style.

Parameters

color	The background color attributes.
start	The segment start position.
end	The segment end position.

Returns: If the function succeeds, it returns a MobileRTCMeetingChatBuilder object. Otherwise, this function fails and returns nil.

◆ setBold:end:

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

Sets the chat message content bold style.

Parameters

start	The segment start position.
end	The segment end position.

Returns: If the function succeeds, it returns a MobileRTCMeetingChatBuilder object. Otherwise, this function fails and returns nil.

◆ setBulletedList:end:

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

Sets the chat message content bulleted list style.

Parameters

start	The segment start position.
end	The segment end position.

Returns: If the function succeeds, it returns a MobileRTCMeetingChatBuilder object. Otherwise, this function fails and returns nil.

◆ setContent:

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

Sets chat message content.

Parameters

content The chat message's content.

Returns: If the function succeeds, it returns a MobileRTCMeetingChatBuilder object. Otherwise, this function fails and returns nil.

◆ setFontColor:start:end:

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

Sets the chat message content font color style.

Parameters

color	The font color attributes.
start	The segment start position.
end	The segment end position.

Returns: If the function succeeds, it returns a MobileRTCMeetingChatBuilder object. Otherwise, this function fails and returns nil.

◆ setFontSize:start:end:

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

Sets the chat message content font size style.

Parameters

size	The font size attributes.
start	The segment start position.
end	The segment end position.

Returns: If the function succeeds, it returns a MobileRTCMeetingChatBuilder object. Otherwise, this function fails and returns nil.

◆ setInsertLink:start:end:

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

Sets the chat message content insert link style.

Parameters

link	The insert link attributes.
start	The segment start position.
end	The segment end position.

Returns: If the function succeeds, it returns a MobileRTCMeetingChatBuilder object. Otherwise, this function fails and returns nil.

◆ setItalic:end:

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

Sets the chat message content italic style.

Parameters

start	The segment start position.
end	The segment end position.

Returns: If the function succeeds, it returns a MobileRTCMeetingChatBuilder object. Otherwise, this function fails and returns nil.

◆ setMessageType:

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

Sets the chat message type.

Parameters

type	The chat message's type.

Returns: If the function succeeds, it returns a MobileRTCMeetingChatBuilder object. Otherwise, this function fails and returns nil.

◆ setNumberedList:end:

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

Sets the chat message content numbered list style.

Parameters

start	The segment start position.
end	The segment end position.

Returns: If the function succeeds, it returns a MobileRTCMeetingChatBuilder object. Otherwise, this function fails and returns nil.

◆ setParagraph:start:end:

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

Sets the chat message content paragraph style.

Parameters

paragraph	The paragraph attributes.
start	The segment start position.
end	The segment end position.

Returns: If the function succeeds, it returns a MobileRTCMeetingChatBuilder object. Otherwise, this function fails and returns nil.

◆ setQuotePosition:end:

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

Sets the chat message content quote style.

Parameters

start	The segment start position.
end	The segment end position.

Returns: If the function succeeds, it returns a MobileRTCMeetingChatBuilder object. Otherwise, this function fails and returns nil.

◆ setReceiver:

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

Sets who will receive the chat message.

Parameters

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

Returns: If the function succeeds, it returns a MobileRTCMeetingChatBuilder object. Otherwise, this function fails and returns nil.

◆ setStrikethrough:end:

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

Sets the chat message content strikethrough style.

Parameters

start	The segment start position.
end	The segment end position.

Returns: If the function succeeds, it returns a MobileRTCMeetingChatBuilder object. Otherwise, this function fails and returns nil.

◆ setThreadId:

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

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

Parameters

threadId The thread ID.

Returns: If the function succeeds, it returns a MobileRTCMeetingChatBuilder object. Otherwise, this function fails and returns nil.

◆ setUnderline:end:

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

Sets the chat message content underline style.

Parameters

start	The segment start position.
end	The segment end position.

Returns: If the function succeeds, it returns a MobileRTCMeetingChatBuilder object. Otherwise, this function fails and returns nil.

◆ unsetBackgroundColor:end:

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

Clears the chat message content background color style.

Parameters

start	The segment start position.
end	The segment end position.

Returns: If the function succeeds, it returns a MobileRTCMeetingChatBuilder object. Otherwise, this function fails and returns nil.

◆ unsetBold:end:

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

Clears the chat message content bold style.

Parameters

start	The segment start position.
end	The segment end position.

Returns: If the function succeeds, it returns a MobileRTCMeetingChatBuilder object. Otherwise, this function fails and returns nil.

◆ unsetBulletedList:end:

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

Clears the chat message content bulleted list style.

Parameters

start	The segment start position.
end	The segment end position.

Returns: If the function succeeds, it returns a MobileRTCMeetingChatBuilder object. Otherwise, this function fails and returns nil.

◆ unsetFontColor:end:

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

Clears the chat message content font color style.

Parameters

start	The segment start position.
end	The segment end position.

Returns: If the function succeeds, it returns a MobileRTCMeetingChatBuilder object. Otherwise, this function fails and returns nil.

◆ unsetFontSize:end:

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

Clears the chat message content font size style.

Parameters

start	The segment start position.
end	The segment end position.

Returns: If the function succeeds, it returns a MobileRTCMeetingChatBuilder object. Otherwise, this function fails and returns nil.

◆ unsetInsertLink:end:

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

Clears the chat message content insert link style.

Parameters

start	The segment start position.
end	The segment end position.

Returns: If the function succeeds, it returns a MobileRTCMeetingChatBuilder object. Otherwise, this function fails and returns nil.

◆ unsetItalic:end:

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

Clears the chat message content italic style.

Parameters

start	The segment start position.
end	The segment end position.

Returns: If the function succeeds, it returns a MobileRTCMeetingChatBuilder object. Otherwise, this function fails and returns nil.

◆ unsetNumberedList:end:

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

Clears the chat message content numbered list style.

Parameters

start	The segment start position.
end	The segment end position.

Returns: If the function succeeds, it returns a MobileRTCMeetingChatBuilder object. Otherwise, this function fails and returns nil.

◆ unsetParagraph:end:

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

Clears the chat message content paragraph style.

Parameters

start	The segment start position.
end	The segment end position.

Returns: If the function succeeds, it returns a MobileRTCMeetingChatBuilder object. Otherwise, this function fails and returns nil.

◆ unsetQuotePosition:end:

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

Clears the chat message content quote style.

Parameters

start	The segment start position.
end	The segment end position.

Returns: If the function succeeds, it returns a MobileRTCMeetingChatBuilder object. Otherwise, this function fails and returns nil.

◆ unsetStrikethrough:end:

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

Clears the chat message content strikethrough style.

Parameters

start	The segment start position.
end	The segment end position.

Returns: If the function succeeds, it returns a MobileRTCMeetingChatBuilder object. Otherwise, this function fails and returns nil.

◆ unsetUnderline:end:

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

Clears the chat message content underline style.

Parameters

start	The segment start position.
end	The segment end position.

Returns: If the function succeeds, it returns a MobileRTCMeetingChatBuilder object. Otherwise, this function fails and returns nil.

Instance Methods

Detailed Description

Method Documentation

◆ build

◆ decreaseIndent:start:end:

◆ increaseIndent:start:end:

◆ setBackgroundColor:start:end:

◆ setBold:end:

◆ setBulletedList:end:

◆ setContent:

◆ setFontColor:start:end:

◆ setFontSize:start:end:

◆ setInsertLink:start:end:

◆ setItalic:end:

◆ setMessageType:

◆ setNumberedList:end:

◆ setParagraph:start:end:

◆ setQuotePosition:end:

◆ setReceiver:

◆ setStrikethrough:end:

◆ setThreadId:

◆ setUnderline:end:

◆ unsetBackgroundColor:end:

◆ unsetBold:end:

◆ unsetBulletedList:end:

◆ unsetFontColor:end:

◆ unsetFontSize:end:

◆ unsetInsertLink:end:

◆ unsetItalic:end:

◆ unsetNumberedList:end:

◆ unsetParagraph:end:

◆ unsetQuotePosition:end:

◆ unsetStrikethrough:end:

◆ unsetUnderline:end: