Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKChatMsgInfoBuilder Class Reference

#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

Definition at line 310 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
indentThe segment indent value.
positionStartThe segment start position.
positionEndThe segment end position.
Returns
If the function succeeds, it will return object which ZoomSDKChatMessageBuilder.

◆ increaseIndent:positionStart:positionEnd:

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

Increase the chat message content indent style.

Parameters
indentThe segment indent value.
positionStartThe segment start position.
positionEndThe segment end position.
Returns
If the function succeeds, it will return object which 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
colorThe segment color value.
positionStartThe segment start position.
positionEndThe segment end position.
Returns
If the function succeeds, it will return object which ZoomSDKChatMessageBuilder.

◆ setBold:positionEnd:

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

Set the chat message content bold style.

Parameters
positionStartThe segment start position.
positionEndThe segment end position.
Returns
If the function succeeds, it will return object which ZoomSDKChatMessageBuilder.

◆ setBulletedList:positionEnd:

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

Set the chat message content bulleted list style.

Parameters
positionStartThe segment start position.
positionEndThe segment end position.
Returns
If the function succeeds, it will return object which ZoomSDKChatMessageBuilder.

◆ setContent:

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

Set chat message content.

Parameters
contentThe chat message’s content.
Returns
If the function succeeds, it will return object which ZoomSDKChatMessageBuilder.

◆ setFontColor:positionStart:positionEnd:

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

Set the chat message content font color style.

Parameters
colorThe segment color value.
positionStartThe segment start position.
positionEndThe segment end position.
Returns
If the function succeeds, it will return object which 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
fontSizeThe segment font size.
positionStartThe segment start position.
positionEndThe segment end position.
Returns
If the function succeeds, it will return object which ZoomSDKChatMessageBuilder.

◆ setInsertLink:positionStart:positionEnd:

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

Set the chat message content insert link style.

Parameters
insertLinkThe segment link url.
positionStartThe segment start position.
positionEndThe segment end position.
Returns
If the function succeeds, it will return object which ZoomSDKChatMessageBuilder.

◆ setItalic:positionEnd:

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

Set the chat message content italic style.

Parameters
positionStartThe segment start position.
positionEndThe segment end position.
Returns
If the function succeeds, it will return object which ZoomSDKChatMessageBuilder.

◆ setMessageType:

- (ZoomSDKChatMsgInfoBuilder *) setMessageType: (ZoomSDKChatMessageType) type

Set the chat message type.

Parameters
typeThe chat message’s type.
Returns
If the function succeeds, it will return object which ZoomSDKChatMessageBuilder.

◆ setNumberedList:positionEnd:

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

Set the chat message content numbered list style.

Parameters
positionStartThe segment start position.
positionEndThe segment end position.
Returns
If the function succeeds, it will return object which ZoomSDKChatMessageBuilder.

◆ setParagraph:positionStart:positionEnd:

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

Set the chat message content paragraph style.

Parameters
paragraphThe segment paragraph value.
positionStartThe segment start position.
positionEndThe segment end position.
Returns
If the function succeeds, it will return object which 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
positionStartThe segment start position.
positionEndThe segment end position.
Returns
If the function succeeds, it will return object which ZoomSDKChatMessageBuilder.

◆ setReceiver:

- (ZoomSDKChatMsgInfoBuilder *) setReceiver: (unsigned int) 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).
Returns
If the function succeeds, it will return object which ZoomSDKChatMessageBuilder.

◆ setStrikethrough:positionEnd:

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

Set the chat message content strikethrough style.

Parameters
positionStartThe segment start position.
positionEndThe segment end position.
Returns
If the function succeeds, it will return object which ZoomSDKChatMessageBuilder.

◆ setThreadId:

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

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

Parameters
threadIdSpecify the thread ID.
Returns
If the function succeeds, it will return object which ZoomSDKChatMessageBuilder.

◆ setUnderline:positionEnd:

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

Set the chat message content under line style.

Parameters
positionStartThe segment start position.
positionEndThe segment end position.
Returns
If the function succeeds, it will return object which ZoomSDKChatMessageBuilder.

◆ unsetBackgroundColor:positionEnd:

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

Clear the chat message content background color style.

Parameters
positionStartThe segment start position.
positionEndThe segment end position.
Returns
If the function succeeds, it will return object which ZoomSDKChatMessageBuilder.

◆ unsetBold:positionEnd:

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

Clear the chat message content bold style.

Parameters
positionStartThe segment start position.
positionEndThe segment end position.
Returns
If the function succeeds, it will return object which ZoomSDKChatMessageBuilder.

◆ unsetBulletedList:positionEnd:

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

Clear the chat message content bulleted list style.

Parameters
positionStartThe segment start position.
positionEndThe segment end position.
Returns
If the function succeeds, it will return object which ZoomSDKChatMessageBuilder.

◆ unsetFontColor:positionEnd:

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

Clear the chat message content font color style.

Parameters
positionStartThe segment start position.
positionEndThe segment end position.
Returns
If the function succeeds, it will return object which ZoomSDKChatMessageBuilder.

◆ unsetFontSize:positionEnd:

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

Clear the chat message content font size style.

Parameters
positionStartThe segment start position.
positionEndThe segment end position.
Returns
If the function succeeds, it will return object which ZoomSDKChatMessageBuilder.

◆ unsetInsertLink:positionEnd:

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

Clear the chat message content insert link style.

Parameters
positionStartThe segment start position.
positionEndThe segment end position.
Returns
If the function succeeds, it will return object which ZoomSDKChatMessageBuilder.

◆ unsetItalic:positionEnd:

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

Clear the chat message content italic style.

Parameters
positionStartThe segment start position.
positionEndThe segment end position.
Returns
If the function succeeds, it will return object which ZoomSDKChatMessageBuilder.

◆ unsetNumberedList:positionEnd:

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

Unset the chat message content numbered list style.

Parameters
positionStartThe segment start position.
positionEndThe segment end position.
Returns
If the function succeeds, it will return object which ZoomSDKChatMessageBuilder.

◆ unsetParagraph:positionEnd:

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

Clear the chat message content paragraph style.

Parameters
positionStartThe segment start position.
positionEndThe segment end position.
Returns
If the function succeeds, it will return object which 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
positionStartThe segment start position.
positionEndThe segment end position.
Returns
If the function succeeds, it will return object which ZoomSDKChatMessageBuilder.

◆ unsetStrikethrough:positionEnd:

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

Clear the chat message content strikethrough style.

Parameters
positionStartThe segment start position.
positionEndThe segment end position.
Returns
If the function succeeds, it will return object which ZoomSDKChatMessageBuilder.

◆ unsetUnderline:positionEnd:

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

Clear the chat message content under line style.

Parameters
positionStartThe segment start position.
positionEndThe segment end position.
Returns
If the function succeeds, it will return object which ZoomSDKChatMessageBuilder.