Builds a ZoomSDK chat message with various content and styles. More...

#include <ZoomSDKMeetingChatController.h>

Inherits NSObject.

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

(ZoomSDKChatMsgInfoBuilder *)	- setReceiver:
	Sets who receives the chat message.

(ZoomSDKChatMsgInfoBuilder *)	- setThreadId:
	Sets the thread's ID where the message is posted.

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

(ZoomSDKChatMsgInfoBuilder *)	- setQuotePosition:positionEnd:
	Sets the chat message content quote style and position.

(ZoomSDKChatMsgInfoBuilder *)	- unsetQuotePosition:positionEnd:
	Clears the chat message content quote style.

(ZoomSDKChatMsgInfoBuilder *)	- setInsertLink:positionStart:positionEnd:
	Sets the chat message content insert link style.

(ZoomSDKChatMsgInfoBuilder *)	- unsetInsertLink:positionEnd:
	Clears the chat message content insert link style.

(ZoomSDKChatMsgInfoBuilder *)	- setFontSize:positionStart:positionEnd:
	Sets the chat message content font size style.

(ZoomSDKChatMsgInfoBuilder *)	- unsetFontSize:positionEnd:
	Clears the chat message content font size style.

(ZoomSDKChatMsgInfoBuilder *)	- setItalic:positionEnd:
	Sets the chat message content italic style.

(ZoomSDKChatMsgInfoBuilder *)	- unsetItalic:positionEnd:
	Clears the chat message content italic style.

(ZoomSDKChatMsgInfoBuilder *)	- setBold:positionEnd:
	Sets the chat message content bold style.

(ZoomSDKChatMsgInfoBuilder *)	- unsetBold:positionEnd:
	Clears the chat message content bold style.

(ZoomSDKChatMsgInfoBuilder *)	- setStrikethrough:positionEnd:
	Sets the chat message content strikethrough style.

(ZoomSDKChatMsgInfoBuilder *)	- unsetStrikethrough:positionEnd:
	Clears the chat message content strikethrough style.

(ZoomSDKChatMsgInfoBuilder *)	- setBulletedList:positionEnd:
	Sets the chat message content bulleted list style.

(ZoomSDKChatMsgInfoBuilder *)	- unsetBulletedList:positionEnd:
	Clears the chat message content bulleted list style.

(ZoomSDKChatMsgInfoBuilder *)	- setNumberedList:positionEnd:
	Sets the chat message content numbered list style.

(ZoomSDKChatMsgInfoBuilder *)	- unsetNumberedList:positionEnd:
	Unset the chat message content numbered list style.

(ZoomSDKChatMsgInfoBuilder *)	- setUnderline:positionEnd:
	Sets the chat message content under line style.

(ZoomSDKChatMsgInfoBuilder *)	- unsetUnderline:positionEnd:
	Clears the chat message content under line style.

(ZoomSDKChatMsgInfoBuilder *)	- setFontColor:positionStart:positionEnd:
	Sets the chat message content font color style.

(ZoomSDKChatMsgInfoBuilder *)	- unsetFontColor:positionEnd:
	Clears the chat message content font color style.

(ZoomSDKChatMsgInfoBuilder *)	- setBackgroundColor:positionStart:positionEnd:
	Sets the chat message content background color style.

(ZoomSDKChatMsgInfoBuilder *)	- unsetBackgroundColor:positionEnd:
	Clears the chat message content background color style.

(ZoomSDKChatMsgInfoBuilder *)	- increaseIndent:positionStart:positionEnd:
	Increase the chat message content indent style.

(ZoomSDKChatMsgInfoBuilder *)	- decreaseIndent:positionStart:positionEnd:
	Decrease the chat message content indent style.

(ZoomSDKChatMsgInfoBuilder *)	- setParagraph:positionStart:positionEnd:
	Sets the chat message content paragraph style.

(ZoomSDKChatMsgInfoBuilder *)	- unsetParagraph:positionEnd:
	Clears the chat message content paragraph style.

(ZoomSDKChatInfo *)	- build
	Build chat message entity.

Detailed Description

Builds a ZoomSDK chat message with various content and styles.

Definition at line 408 of file ZoomSDKMeetingChatController.h.

Method Documentation

◆ build

- (ZoomSDKChatInfo *) build

Build chat message entity.

Returns: If the function succeeds, it returns message detail info. Otherwise, this function fails and returns nil.

◆ decreaseIndent:positionStart:positionEnd:

- (ZoomSDKChatMsgInfoBuilder *) decreaseIndent:	(ZoomSDKChatMsgIndentAttrs *)	indent
positionStart:	(unsigned int)	positionStart
positionEnd:	(unsigned int)	positionEnd

Decrease the chat message content indent style.

Parameters

indent	The segment indent value.
positionStart	The segment start position.
positionEnd	The segment end position.

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

◆ increaseIndent:positionStart:positionEnd:

- (ZoomSDKChatMsgInfoBuilder *) increaseIndent:	(ZoomSDKChatMsgIndentAttrs *)	indent
positionStart:	(unsigned int)	positionStart
positionEnd:	(unsigned int)	positionEnd

Increase the chat message content indent style.

Parameters

indent	The segment indent value.
positionStart	The segment start position.
positionEnd	The segment end position.

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

◆ setBackgroundColor:positionStart:positionEnd:

- (ZoomSDKChatMsgInfoBuilder *) setBackgroundColor:	(ZoomSDKChatMsgBackgroundColorAttrs *)	color
positionStart:	(unsigned int)	positionStart
positionEnd:	(unsigned int)	positionEnd

Sets the chat message content background color style.

Parameters

color	The segment color value.
positionStart	The segment start position.
positionEnd	The segment end position.

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

◆ setBold:positionEnd:

- (ZoomSDKChatMsgInfoBuilder *) setBold:		(unsigned int)	positionStart
positionEnd:		(unsigned int)	positionEnd

Sets the chat message content bold style.

Parameters

positionStart	The segment start position.
positionEnd	The segment end position.

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

◆ setBulletedList:positionEnd:

- (ZoomSDKChatMsgInfoBuilder *) setBulletedList:		(unsigned int)	positionStart
positionEnd:		(unsigned int)	positionEnd

Sets the chat message content bulleted list style.

Parameters

positionStart	The segment start position.
positionEnd	The segment end position.

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

◆ setContent:

- (ZoomSDKChatMsgInfoBuilder *) setContent: (NSString *) content

Sets chat message content.

Parameters

content The chat message’s content.

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

◆ setFontColor:positionStart:positionEnd:

- (ZoomSDKChatMsgInfoBuilder *) setFontColor:	(ZoomSDKChatMsgFontColorAttrs *)	color
positionStart:	(unsigned int)	positionStart
positionEnd:	(unsigned int)	positionEnd

Sets the chat message content font color style.

Parameters

color	The segment color value.
positionStart	The segment start position.
positionEnd	The segment end position.

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

◆ setFontSize:positionStart:positionEnd:

- (ZoomSDKChatMsgInfoBuilder *) setFontSize:	(ZoomSDKChatMsgFontSizeAttrs *)	fontSize
positionStart:	(unsigned int)	positionStart
positionEnd:	(unsigned int)	positionEnd

Sets the chat message content font size style.

Parameters

fontSize	The segment font size.
positionStart	The segment start position.
positionEnd	The segment end position.

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

◆ setInsertLink:positionStart:positionEnd:

- (ZoomSDKChatMsgInfoBuilder *) setInsertLink:	(ZoomSDKChatMsgInsertLinkAttrs *)	insertLink
positionStart:	(unsigned int)	positionStart
positionEnd:	(unsigned int)	positionEnd

Sets the chat message content insert link style.

Parameters

insertLink	The segment link url.
positionStart	The segment start position.
positionEnd	The segment end position.

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

◆ setItalic:positionEnd:

- (ZoomSDKChatMsgInfoBuilder *) setItalic:		(unsigned int)	positionStart
positionEnd:		(unsigned int)	positionEnd

Sets the chat message content italic style.

Parameters

positionStart	The segment start position.
positionEnd	The segment end position.

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

◆ setMessageType:

- (ZoomSDKChatMsgInfoBuilder *) setMessageType: (ZoomSDKChatMessageType) type

Sets the chat message type.

Parameters

type	The chat message’s type.

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

◆ setNumberedList:positionEnd:

- (ZoomSDKChatMsgInfoBuilder *) setNumberedList:		(unsigned int)	positionStart
positionEnd:		(unsigned int)	positionEnd

Sets the chat message content numbered list style.

Parameters

positionStart	The segment start position.
positionEnd	The segment end position.

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

◆ setParagraph:positionStart:positionEnd:

- (ZoomSDKChatMsgInfoBuilder *) setParagraph:	(ZoomSDKChatMsgParagraphAttrs *)	paragraph
positionStart:	(unsigned int)	positionStart
positionEnd:	(unsigned int)	positionEnd

Sets the chat message content paragraph style.

Parameters

paragraph	The segment paragraph value.
positionStart	The segment start position.
positionEnd	The segment end position.

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

Note: if paragraph.strParagraph is one of the three contents, bold and font size styles will be added internally. Paragraph_H1 with bold and FontSize_Large Paragraph_H2 with bold and FontSize_Medium Paragraph_H3 with bold and FontSize_Small

◆ setQuotePosition:positionEnd:

- (ZoomSDKChatMsgInfoBuilder *) setQuotePosition:		(unsigned int)	positionStart
positionEnd:		(unsigned int)	positionEnd

Sets the chat message content quote style and position.

Parameters

positionStart	The segment start position.
positionEnd	The segment end position.

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

◆ setReceiver:

- (ZoomSDKChatMsgInfoBuilder *) setReceiver: (unsigned int) receiver

Sets who receives the chat message.

Parameters

receiver Specify 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 object ZoomSDKChatMsgInfoBuilder. Otherwise, this function fails and returns nil.

◆ setStrikethrough:positionEnd:

- (ZoomSDKChatMsgInfoBuilder *) setStrikethrough:		(unsigned int)	positionStart
positionEnd:		(unsigned int)	positionEnd

Sets the chat message content strikethrough style.

Parameters

positionStart	The segment start position.
positionEnd	The segment end position.

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

◆ setThreadId:

- (ZoomSDKChatMsgInfoBuilder *) setThreadId: (NSString *) threadId

Sets the thread's ID where the message is posted.

Parameters

threadId Specify the thread ID.

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

◆ setUnderline:positionEnd:

- (ZoomSDKChatMsgInfoBuilder *) setUnderline:		(unsigned int)	positionStart
positionEnd:		(unsigned int)	positionEnd

Sets the chat message content under line style.

Parameters

positionStart	The segment start position.
positionEnd	The segment end position.

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

◆ unsetBackgroundColor:positionEnd:

- (ZoomSDKChatMsgInfoBuilder *) unsetBackgroundColor:		(unsigned int)	positionStart
positionEnd:		(unsigned int)	positionEnd

Clears the chat message content background color style.

Parameters

positionStart	The segment start position.
positionEnd	The segment end position.

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

◆ unsetBold:positionEnd:

- (ZoomSDKChatMsgInfoBuilder *) unsetBold:		(unsigned int)	positionStart
positionEnd:		(unsigned int)	positionEnd

Clears the chat message content bold style.

Parameters

positionStart	The segment start position.
positionEnd	The segment end position.

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

◆ unsetBulletedList:positionEnd:

- (ZoomSDKChatMsgInfoBuilder *) unsetBulletedList:		(unsigned int)	positionStart
positionEnd:		(unsigned int)	positionEnd

Clears the chat message content bulleted list style.

Parameters

positionStart	The segment start position.
positionEnd	The segment end position.

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

◆ unsetFontColor:positionEnd:

- (ZoomSDKChatMsgInfoBuilder *) unsetFontColor:		(unsigned int)	positionStart
positionEnd:		(unsigned int)	positionEnd

Clears the chat message content font color style.

Parameters

positionStart	The segment start position.
positionEnd	The segment end position.

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

◆ unsetFontSize:positionEnd:

- (ZoomSDKChatMsgInfoBuilder *) unsetFontSize:		(unsigned int)	positionStart
positionEnd:		(unsigned int)	positionEnd

Clears the chat message content font size style.

Parameters

positionStart	The segment start position.
positionEnd	The segment end position.

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

◆ unsetInsertLink:positionEnd:

- (ZoomSDKChatMsgInfoBuilder *) unsetInsertLink:		(unsigned int)	positionStart
positionEnd:		(unsigned int)	positionEnd

Clears the chat message content insert link style.

Parameters

positionStart	The segment start position.
positionEnd	The segment end position.

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

◆ unsetItalic:positionEnd:

- (ZoomSDKChatMsgInfoBuilder *) unsetItalic:		(unsigned int)	positionStart
positionEnd:		(unsigned int)	positionEnd

Clears the chat message content italic style.

Parameters

positionStart	The segment start position.
positionEnd	The segment end position.

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

◆ unsetNumberedList:positionEnd:

- (ZoomSDKChatMsgInfoBuilder *) unsetNumberedList:		(unsigned int)	positionStart
positionEnd:		(unsigned int)	positionEnd

Unset the chat message content numbered list style.

Parameters

positionStart	The segment start position.
positionEnd	The segment end position.

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

◆ unsetParagraph:positionEnd:

- (ZoomSDKChatMsgInfoBuilder *) unsetParagraph:		(unsigned int)	positionStart
positionEnd:		(unsigned int)	positionEnd

Clears the chat message content paragraph style.

Parameters

positionStart	The segment start position.
positionEnd	The segment end position.

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

Note: if paragraph.strParagraph is one of Paragraph_H1, Paragraph_H2, Paragraph_H3. bold and font size styles will be removed internally.

◆ unsetQuotePosition:positionEnd:

- (ZoomSDKChatMsgInfoBuilder *) unsetQuotePosition:		(unsigned int)	positionStart
positionEnd:		(unsigned int)	positionEnd

Clears the chat message content quote style.

Parameters

positionStart	The segment start position.
positionEnd	The segment end position.

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

◆ unsetStrikethrough:positionEnd:

- (ZoomSDKChatMsgInfoBuilder *) unsetStrikethrough:		(unsigned int)	positionStart
positionEnd:		(unsigned int)	positionEnd

Clears the chat message content strikethrough style.

Parameters

positionStart	The segment start position.
positionEnd	The segment end position.

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

◆ unsetUnderline:positionEnd:

- (ZoomSDKChatMsgInfoBuilder *) unsetUnderline:		(unsigned int)	positionStart
positionEnd:		(unsigned int)	positionEnd

Clears the chat message content under line style.

Parameters

positionStart	The segment start position.
positionEnd	The segment end position.

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

Instance Methods

Detailed Description

Method Documentation

◆ build

◆ decreaseIndent:positionStart:positionEnd:

◆ increaseIndent:positionStart:positionEnd:

◆ setBackgroundColor:positionStart:positionEnd:

◆ setBold:positionEnd:

◆ setBulletedList:positionEnd:

◆ setContent:

◆ setFontColor:positionStart:positionEnd:

◆ setFontSize:positionStart:positionEnd:

◆ setInsertLink:positionStart:positionEnd:

◆ setItalic:positionEnd:

◆ setMessageType:

◆ setNumberedList:positionEnd:

◆ setParagraph:positionStart:positionEnd:

◆ setQuotePosition:positionEnd:

◆ setReceiver:

◆ setStrikethrough:positionEnd:

◆ setThreadId:

◆ setUnderline:positionEnd:

◆ unsetBackgroundColor:positionEnd:

◆ unsetBold:positionEnd:

◆ unsetBulletedList:positionEnd:

◆ unsetFontColor:positionEnd:

◆ unsetFontSize:positionEnd:

◆ unsetInsertLink:positionEnd:

◆ unsetItalic:positionEnd:

◆ unsetNumberedList:positionEnd:

◆ unsetParagraph:positionEnd:

◆ unsetQuotePosition:positionEnd:

◆ unsetStrikethrough:positionEnd:

◆ unsetUnderline:positionEnd: