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

#include <meeting_chat_interface.h>

Public Member Functions
virtual IChatMsgInfoBuilder *	SetContent (const zchar_t *content)=0
	Sets chat message content.
virtual IChatMsgInfoBuilder *	SetReceiver (unsigned int receiver)=0
	Sets who will receive the chat message.
virtual IChatMsgInfoBuilder *	SetThreadId (const zchar_t *threadId)=0
	Sets the ID of the thread where the message will be posted.
virtual IChatMsgInfoBuilder *	SetMessageType (SDKChatMessageType type)=0
	Sets the chat message type.
virtual IChatMsgInfoBuilder *	SetQuotePosition (unsigned int positionStart, unsigned int positionEnd)=0
	Sets the chat message content quote style and position.
virtual IChatMsgInfoBuilder *	UnsetQuotePosition (unsigned int positionStart, unsigned int positionEnd)=0
	Clear the chat message content quote style.
virtual IChatMsgInfoBuilder *	SetInsertLink (InsertLinkAttrs insertLink, unsigned int positionStart, unsigned int positionEnd)=0
	Sets the chat message content insert link style.
virtual IChatMsgInfoBuilder *	UnsetInsertLink (unsigned int positionStart, unsigned int positionEnd)=0
	Clear the chat message content insert link style.
virtual IChatMsgInfoBuilder *	SetFontSize (FontSizeAttrs fontSize, unsigned int positionStart, unsigned int positionEnd)=0
	Sets the chat message content font size style.
virtual IChatMsgInfoBuilder *	UnsetFontSize (unsigned int positionStart, unsigned int positionEnd)=0
	Clear the chat message content font size style.
virtual IChatMsgInfoBuilder *	SetItalic (unsigned int positionStart, unsigned int positionEnd)=0
	Sets the chat message content italic style.
virtual IChatMsgInfoBuilder *	UnsetItalic (unsigned int positionStart, unsigned int positionEnd)=0
	Clear the chat message content italic style.
virtual IChatMsgInfoBuilder *	SetBold (unsigned int positionStart, unsigned int positionEnd)=0
	Sets the chat message content bold style.
virtual IChatMsgInfoBuilder *	UnsetBold (unsigned int positionStart, unsigned int positionEnd)=0
	Clear the chat message content italic style.
virtual IChatMsgInfoBuilder *	SetStrikethrough (unsigned int positionStart, unsigned int positionEnd)=0
	Sets the chat message content strikethrough style.
virtual IChatMsgInfoBuilder *	UnsetStrikethrough (unsigned int positionStart, unsigned int positionEnd)=0
	Clear the chat message content strikethrough style.
virtual IChatMsgInfoBuilder *	SetBulletedList (unsigned int positionStart, unsigned int positionEnd)=0
	Sets the chat message content bulleted list style.
virtual IChatMsgInfoBuilder *	UnsetBulletedList (unsigned int positionStart, unsigned int positionEnd)=0
	Clear the chat message content bulleted list style.
virtual IChatMsgInfoBuilder *	SetNumberedList (unsigned int positionStart, unsigned int positionEnd)=0
	Sets the chat message content numbered list style.
virtual IChatMsgInfoBuilder *	UnsetNumberedList (unsigned int positionStart, unsigned int positionEnd)=0
	Clear the chat message content numbered list style.
virtual IChatMsgInfoBuilder *	SetUnderline (unsigned int positionStart, unsigned int positionEnd)=0
	Sets the chat message content under line style.
virtual IChatMsgInfoBuilder *	UnsetUnderline (unsigned int positionStart, unsigned int positionEnd)=0
	Clear the chat message content under line style.
virtual IChatMsgInfoBuilder *	SetFontColor (FontColorAttrs color, unsigned int positionStart, unsigned int positionEnd)=0
	Sets the chat message content font color style.
virtual IChatMsgInfoBuilder *	UnsetFontColor (unsigned int positionStart, unsigned int positionEnd)=0
	Clear the chat message content font color style.
virtual IChatMsgInfoBuilder *	SetBackgroundColor (BackgroundColorAttrs color, unsigned int positionStart, unsigned int positionEnd)=0
	Sets the chat message content background color style.
virtual IChatMsgInfoBuilder *	UnsetBackgroundColor (unsigned int positionStart, unsigned int positionEnd)=0
	Clear the chat message content background color style.
virtual IChatMsgInfoBuilder *	IncreaseIndent (IndentAttrs indent, unsigned int positionStart, unsigned int positionEnd)=0
	Increase the chat message content indent style.
virtual IChatMsgInfoBuilder *	DecreaseIndent (IndentAttrs indent, unsigned int positionStart, unsigned int positionEnd)=0
	Decrease the chat message content indent style.
virtual IChatMsgInfoBuilder *	SetParagraph (ParagraphAttrs paragraph, unsigned int positionStart, unsigned int positionEnd)=0
	Sets the chat message content paragraph style.
virtual IChatMsgInfoBuilder *	UnsetParagraph (unsigned int positionStart, unsigned int positionEnd)=0
	Clear the chat message content paragraph style. Tips: if paragraph.strParagraph is one of Paragraph_H1, Paragraph_H2, Paragraph_H3, Bold and font size styles will be removed internally.
virtual IChatMsgInfoBuilder *	ClearStyles ()=0
	Clear all set styles.
virtual IChatMsgInfoBuilder *	Clear ()=0
	Clear all set properties.
virtual IChatMsgInfo *	Build ()=0
	build chat message entity.
virtual	~IChatMsgInfoBuilder ()

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 689 of file meeting_chat_interface.h.

Constructor & Destructor Documentation

◆ ~IChatMsgInfoBuilder()

virtual IChatMsgInfoBuilder::~IChatMsgInfoBuilder ( )

inlinevirtual

Definition at line 953 of file meeting_chat_interface.h.

953{}

Member Function Documentation

◆ Build()

virtual IChatMsgInfo * IChatMsgInfoBuilder::Build ( )

pure virtual

build chat message entity.

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

◆ Clear()

virtual IChatMsgInfoBuilder * IChatMsgInfoBuilder::Clear ( )

pure virtual

Clear all set properties.

◆ ClearStyles()

virtual IChatMsgInfoBuilder * IChatMsgInfoBuilder::ClearStyles ( )

pure virtual

Clear all set styles.

◆ DecreaseIndent()

virtual IChatMsgInfoBuilder * IChatMsgInfoBuilder::DecreaseIndent	(	IndentAttrs	indent,
		unsigned int	positionStart,
		unsigned int	positionEnd )

pure virtual

Decrease the chat message content indent style.

Parameters

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

Returns: Return value is a pointer of IChatMsgInfoBuilder with modifications for chain call.

◆ IncreaseIndent()

virtual IChatMsgInfoBuilder * IChatMsgInfoBuilder::IncreaseIndent	(	IndentAttrs	indent,
		unsigned int	positionStart,
		unsigned int	positionEnd )

pure virtual

Increase the chat message content indent style.

Parameters

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

Returns: Return value is a pointer of IChatMsgInfoBuilder with modifications for chain call.

◆ SetBackgroundColor()

virtual IChatMsgInfoBuilder * IChatMsgInfoBuilder::SetBackgroundColor	(	BackgroundColorAttrs	color,
		unsigned int	positionStart,
		unsigned int	positionEnd )

pure virtual

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: Return value is a pointer of IChatMsgInfoBuilder with modifications for chain call.

◆ SetBold()

virtual IChatMsgInfoBuilder * IChatMsgInfoBuilder::SetBold	(	unsigned int	positionStart,
		unsigned int	positionEnd )

pure virtual

Sets the chat message content bold style.

Parameters

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

Returns: Return value is a pointer of IChatMsgInfoBuilder with modifications for chain call.

◆ SetBulletedList()

virtual IChatMsgInfoBuilder * IChatMsgInfoBuilder::SetBulletedList	(	unsigned int	positionStart,
		unsigned int	positionEnd )

pure virtual

Sets the chat message content bulleted list style.

Parameters

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

Returns: Return value is a pointer of IChatMsgInfoBuilder with modifications for chain call.

◆ SetContent()

virtual IChatMsgInfoBuilder * IChatMsgInfoBuilder::SetContent ( const zchar_t * content )

pure virtual

Sets chat message content.

Parameters

content The chat message's content.

◆ SetFontColor()

virtual IChatMsgInfoBuilder * IChatMsgInfoBuilder::SetFontColor	(	FontColorAttrs	color,
		unsigned int	positionStart,
		unsigned int	positionEnd )

pure virtual

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: Return value is a pointer of IChatMsgInfoBuilder with modifications for chain call.

◆ SetFontSize()

virtual IChatMsgInfoBuilder * IChatMsgInfoBuilder::SetFontSize	(	FontSizeAttrs	fontSize,
		unsigned int	positionStart,
		unsigned int	positionEnd )

pure virtual

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: Return value is a pointer of IChatMsgInfoBuilder with modifications for chain call.

◆ SetInsertLink()

virtual IChatMsgInfoBuilder * IChatMsgInfoBuilder::SetInsertLink	(	InsertLinkAttrs	insertLink,
		unsigned int	positionStart,
		unsigned int	positionEnd )

pure virtual

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: Return value is a pointer of IChatMsgInfoBuilder with modifications for chain call.

◆ SetItalic()

virtual IChatMsgInfoBuilder * IChatMsgInfoBuilder::SetItalic	(	unsigned int	positionStart,
		unsigned int	positionEnd )

pure virtual

Sets the chat message content italic style.

Parameters

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

Returns: Return value is a pointer of IChatMsgInfoBuilder with modifications for chain call.

◆ SetMessageType()

virtual IChatMsgInfoBuilder * IChatMsgInfoBuilder::SetMessageType ( SDKChatMessageType type )

pure virtual

Sets the chat message type.

Parameters

type	The chat message's type.

◆ SetNumberedList()

virtual IChatMsgInfoBuilder * IChatMsgInfoBuilder::SetNumberedList	(	unsigned int	positionStart,
		unsigned int	positionEnd )

pure virtual

Sets the chat message content numbered list style.

Parameters

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

Returns: Return value is a pointer of IChatMsgInfoBuilder with modifications for chain call.

◆ SetParagraph()

virtual IChatMsgInfoBuilder * IChatMsgInfoBuilder::SetParagraph	(	ParagraphAttrs	paragraph,
		unsigned int	positionStart,
		unsigned int	positionEnd )

pure virtual

Sets the chat message content paragraph style.

Parameters

paragraph	The segment paragraph value. Tips: 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
positionStart	The segment start position.
positionEnd	The segment end position.

Returns: Return value is a pointer of IChatMsgInfoBuilder with modifications for chain call.

◆ SetQuotePosition()

virtual IChatMsgInfoBuilder * IChatMsgInfoBuilder::SetQuotePosition	(	unsigned int	positionStart,
		unsigned int	positionEnd )

pure virtual

Sets the chat message content quote style and position.

Parameters

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

◆ SetReceiver()

virtual IChatMsgInfoBuilder * IChatMsgInfoBuilder::SetReceiver ( unsigned int receiver )

pure virtual

Sets 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).

◆ SetStrikethrough()

virtual IChatMsgInfoBuilder * IChatMsgInfoBuilder::SetStrikethrough	(	unsigned int	positionStart,
		unsigned int	positionEnd )

pure virtual

Sets the chat message content strikethrough style.

Parameters

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

Returns: Return value is a pointer of IChatMsgInfoBuilder with modifications for chain call.

◆ SetThreadId()

virtual IChatMsgInfoBuilder * IChatMsgInfoBuilder::SetThreadId ( const zchar_t * threadId )

pure virtual

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

Parameters

threadId Specify the thread ID.

◆ SetUnderline()

virtual IChatMsgInfoBuilder * IChatMsgInfoBuilder::SetUnderline	(	unsigned int	positionStart,
		unsigned int	positionEnd )

pure virtual

Sets the chat message content under line style.

Parameters

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

Returns: Return value is a pointer of IChatMsgInfoBuilder with modifications for chain call.

◆ UnsetBackgroundColor()

virtual IChatMsgInfoBuilder * IChatMsgInfoBuilder::UnsetBackgroundColor	(	unsigned int	positionStart,
		unsigned int	positionEnd )

pure virtual

Clear the chat message content background color style.

Parameters

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

Returns: Return value is a pointer of IChatMsgInfoBuilder with modifications for chain call.

◆ UnsetBold()

virtual IChatMsgInfoBuilder * IChatMsgInfoBuilder::UnsetBold	(	unsigned int	positionStart,
		unsigned int	positionEnd )

pure virtual

Clear the chat message content italic style.

Parameters

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

Returns: Return value is a pointer of IChatMsgInfoBuilder with modifications for chain call.

◆ UnsetBulletedList()

virtual IChatMsgInfoBuilder * IChatMsgInfoBuilder::UnsetBulletedList	(	unsigned int	positionStart,
		unsigned int	positionEnd )

pure virtual

Clear the chat message content bulleted list style.

Parameters

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

Returns: Return value is a pointer of IChatMsgInfoBuilder with modifications for chain call.

◆ UnsetFontColor()

virtual IChatMsgInfoBuilder * IChatMsgInfoBuilder::UnsetFontColor	(	unsigned int	positionStart,
		unsigned int	positionEnd )

pure virtual

Clear the chat message content font color style.

Parameters

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

Returns: Return value is a pointer of IChatMsgInfoBuilder with modifications for chain call.

◆ UnsetFontSize()

virtual IChatMsgInfoBuilder * IChatMsgInfoBuilder::UnsetFontSize	(	unsigned int	positionStart,
		unsigned int	positionEnd )

pure virtual

Clear the chat message content font size style.

Parameters

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

Returns: Return value is a pointer of IChatMsgInfoBuilder with modifications for chain call.

◆ UnsetInsertLink()

virtual IChatMsgInfoBuilder * IChatMsgInfoBuilder::UnsetInsertLink	(	unsigned int	positionStart,
		unsigned int	positionEnd )

pure virtual

Clear the chat message content insert link style.

Parameters

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

Returns: Return value is a pointer of IChatMsgInfoBuilder with modifications for chain call.

◆ UnsetItalic()

virtual IChatMsgInfoBuilder * IChatMsgInfoBuilder::UnsetItalic	(	unsigned int	positionStart,
		unsigned int	positionEnd )

pure virtual

Clear the chat message content italic style.

Parameters

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

Returns: Return value is a pointer of IChatMsgInfoBuilder with modifications for chain call.

◆ UnsetNumberedList()

virtual IChatMsgInfoBuilder * IChatMsgInfoBuilder::UnsetNumberedList	(	unsigned int	positionStart,
		unsigned int	positionEnd )

pure virtual

Clear the chat message content numbered list style.

Parameters

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

Returns: Return value is a pointer of IChatMsgInfoBuilder with modifications for chain call.

◆ UnsetParagraph()

virtual IChatMsgInfoBuilder * IChatMsgInfoBuilder::UnsetParagraph	(	unsigned int	positionStart,
		unsigned int	positionEnd )

pure virtual

Clear the chat message content paragraph style. Tips: if paragraph.strParagraph is one of Paragraph_H1, Paragraph_H2, Paragraph_H3, Bold and font size styles will be removed internally.

Parameters

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

Returns: Return value is a pointer of IChatMsgInfoBuilder with modifications for chain call.

◆ UnsetQuotePosition()

virtual IChatMsgInfoBuilder * IChatMsgInfoBuilder::UnsetQuotePosition	(	unsigned int	positionStart,
		unsigned int	positionEnd )

pure virtual

Clear the chat message content quote style.

Parameters

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

Returns: Return value is a pointer of IChatMsgInfoBuilder with modifications for chain call.

◆ UnsetStrikethrough()

virtual IChatMsgInfoBuilder * IChatMsgInfoBuilder::UnsetStrikethrough	(	unsigned int	positionStart,
		unsigned int	positionEnd )

pure virtual

Clear the chat message content strikethrough style.

Parameters

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

Returns: Return value is a pointer of IChatMsgInfoBuilder with modifications for chain call.

◆ UnsetUnderline()

virtual IChatMsgInfoBuilder * IChatMsgInfoBuilder::UnsetUnderline	(	unsigned int	positionStart,
		unsigned int	positionEnd )

pure virtual

Clear the chat message content under line style.

Parameters

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

Returns: Return value is a pointer of IChatMsgInfoBuilder with modifications for chain call.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IChatMsgInfoBuilder()

Member Function Documentation

◆ Build()

◆ Clear()

◆ ClearStyles()

◆ DecreaseIndent()

◆ IncreaseIndent()

◆ SetBackgroundColor()

◆ SetBold()

◆ SetBulletedList()

◆ SetContent()

◆ SetFontColor()

◆ SetFontSize()

◆ SetInsertLink()

◆ SetItalic()

◆ SetMessageType()

◆ SetNumberedList()

◆ SetParagraph()

◆ SetQuotePosition()

◆ SetReceiver()

◆ SetStrikethrough()

◆ SetThreadId()

◆ SetUnderline()

◆ UnsetBackgroundColor()

◆ UnsetBold()

◆ UnsetBulletedList()

◆ UnsetFontColor()

◆ UnsetFontSize()

◆ UnsetInsertLink()

◆ UnsetItalic()

◆ UnsetNumberedList()

◆ UnsetParagraph()

◆ UnsetQuotePosition()

◆ UnsetStrikethrough()

◆ UnsetUnderline()