Used to build a ZoomSDK chat message with various content and styles. More...

#include <ZoomSDKMeetingChatController.h>

Inherits NSObject.

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

(ZoomSDKChatMsgInfoBuilder *)	- setReceiver:
	Set who will receive the chat message.

(ZoomSDKChatMsgInfoBuilder *)	- setThreadId:
	Set the ID of the thread where the message will be posted.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

(ZoomSDKChatMsgInfoBuilder *)	- unsetBackgroundColor:positionEnd:
	Clear 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:
	Set the chat message content paragraph style.

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

(ZoomSDKChatInfo *)	- build
	Build chat message entity.

Detailed Description

Used to build 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, the return value is message detail info.

◆ 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 will return object ZoomSDKChatMessageBuilder.

◆ 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 will return object ZoomSDKChatMessageBuilder.

◆ setBackgroundColor:positionStart:positionEnd:

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

Set 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 will return object ZoomSDKChatMessageBuilder.

◆ setBold:positionEnd:

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

Set the chat message content bold style.

Parameters

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

Returns: If the function succeeds, it will return object ZoomSDKChatMsgInfoBuilder.

◆ setBulletedList:positionEnd:

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

Set the chat message content bulleted list style.

Parameters

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

Returns: If the function succeeds, it will return object ZoomSDKChatMsgInfoBuilder.

◆ setContent:

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

Set chat message content.

Parameters

content The chat message’s content.

Returns: If the function succeeds, it will return object ZoomSDKChatMsgInfoBuilder.

◆ setFontColor:positionStart:positionEnd:

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

Set 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 will return object ZoomSDKChatMessageBuilder.

◆ setFontSize:positionStart:positionEnd:

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

Set 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 will return object ZoomSDKChatMsgInfoBuilder.

◆ setInsertLink:positionStart:positionEnd:

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

Set 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 will return object ZoomSDKChatMsgInfoBuilder.

◆ setItalic:positionEnd:

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

Set the chat message content italic style.

Parameters

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

Returns: If the function succeeds, it will return object ZoomSDKChatMsgInfoBuilder.

◆ setMessageType:

- (ZoomSDKChatMsgInfoBuilder *) setMessageType: (ZoomSDKChatMessageType) type

Set the chat message type.

Parameters

type	The chat message’s type.

Returns: If the function succeeds, it will return object ZoomSDKChatMsgInfoBuilder.

◆ setNumberedList:positionEnd:

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

Set the chat message content numbered list style.

Parameters

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

Returns: If the function succeeds, it will return object ZoomSDKChatMsgInfoBuilder.

◆ setParagraph:positionStart:positionEnd:

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

Set 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 will return object ZoomSDKChatMessageBuilder.

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

Set 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 will return object ZoomSDKChatMsgInfoBuilder.

◆ setReceiver:

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

Set who will receive 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 will return object ZoomSDKChatMsgInfoBuilder.

◆ setStrikethrough:positionEnd:

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

Set the chat message content strikethrough style.

Parameters

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

Returns: If the function succeeds, it will return object ZoomSDKChatMsgInfoBuilder.

◆ setThreadId:

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

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

Parameters

threadId Specify the thread ID.

Returns: If the function succeeds, it will return object ZoomSDKChatMsgInfoBuilder.

◆ setUnderline:positionEnd:

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

Set the chat message content under line style.

Parameters

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

Returns: If the function succeeds, it will return object ZoomSDKChatMsgInfoBuilder.

◆ unsetBackgroundColor:positionEnd:

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

Clear the chat message content background color style.

Parameters

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

Returns: If the function succeeds, it will return object ZoomSDKChatMessageBuilder.

◆ unsetBold:positionEnd:

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

Clear the chat message content bold style.

Parameters

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

Returns: If the function succeeds, it will return object ZoomSDKChatMsgInfoBuilder.

◆ unsetBulletedList:positionEnd:

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

Clear the chat message content bulleted list style.

Parameters

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

Returns: If the function succeeds, it will return object ZoomSDKChatMsgInfoBuilder.

◆ unsetFontColor:positionEnd:

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

Clear the chat message content font color style.

Parameters

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

Returns: If the function succeeds, it will return object ZoomSDKChatMessageBuilder.

◆ unsetFontSize:positionEnd:

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

Clear the chat message content font size style.

Parameters

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

Returns: If the function succeeds, it will return object ZoomSDKChatMsgInfoBuilder.

◆ unsetInsertLink:positionEnd:

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

Clear the chat message content insert link style.

Parameters

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

Returns: If the function succeeds, it will return object ZoomSDKChatMsgInfoBuilder.

◆ unsetItalic:positionEnd:

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

Clear the chat message content italic style.

Parameters

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

Returns: If the function succeeds, it will return object ZoomSDKChatMsgInfoBuilder.

◆ 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 will return object ZoomSDKChatMsgInfoBuilder.

◆ unsetParagraph:positionEnd:

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

Clear the chat message content paragraph style.

Parameters

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

Returns: If the function succeeds, it will return object ZoomSDKChatMessageBuilder.

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

Clear the chat message content quote style.

Parameters

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

Returns: If the function succeeds, it will return object ZoomSDKChatMsgInfoBuilder.

◆ unsetStrikethrough:positionEnd:

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

Clear the chat message content strikethrough style.

Parameters

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

Returns: If the function succeeds, it will return object ZoomSDKChatMsgInfoBuilder.

◆ unsetUnderline:positionEnd:

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

Clear the chat message content under line style.

Parameters

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

Returns: If the function succeeds, it will return object ZoomSDKChatMsgInfoBuilder.

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: