MessageDraftV2 object

MessageDraftV2 represents a message that has not been published yet.

Message draft versions

Version 2 provides a more generic way to work with user mentions, channel references, and links ("message elements"). Refer to Drafts (v2) and Drafts (v1).

Version 2

MessageDraftV2 has the following properties:

1class MessageDraftV2 {
2    channel: Channel,
3    value: string,
4    quotedMessage?: Message,
5    config: MessageDraftConfig,
6    files?: FileList | File[] | SendFileParameters["file"][];
7}

Parameter	Description
channel Type: Channel	The channel the draft message is being created on.
value Type: string	Message that includes mentions.
quotedMessage Type: Message or undefined	Object added to a draft message when you quote another message.
config Type: MessageDraftConfig	Configuration of the message containing mentions - what is the user source (channel members or app's keyset users), whether the typing indicator is enabled, and what is the maximum number of user names mentioned in one message (the default value is 10 and max is 100).
files Type: FileList or File[] or SendFileParameters["file"][], or undefined	One or multiple files attached to the draft text message. They can take the form of a read-only files property of the HTML <input /> element (when a user has selected one or more files from their device), or through a drag-and-drop operation (FileList). Alternatively, that can be an array of file objects (File[]) or PubNub-specific `SendFileParameters["file"][].

The MessageDraftConfig type takes the following parameters:

1type MessageDraftConfig = {
2    userSuggestionSource: "channel" | "global";
3    isTypingIndicatorTriggered: boolean;
4    userLimit: number;
5    channelLimit: number;
6};

Message draft configuration

Methods

Available methods:

• addChangeListener()
• removeChangeListener()
• addQuote()
• removeQuote()
• addMention()
• removeMention()
• insertText()
• removeText()
• insertSuggestedMention()
• send()
• update()

Version 1

MessageDraft has the following properties:

1class MessageDraft {
2    value: string,
3    quotedMessage?: Message,
4    config: MessageDraftConfig,
5    files?: FileList | File[] | FileInput[]
6}

Parameter	Description
value Type: string	Message that includes mentions.
quotedMessage Type: Message or undefined	Object added to a draft message when you quote another message.
config Type: MessageDraftConfig	Configuration of the message containing mentions - what is the user source (channel members or app's keyset users), whether the typing indicator is enabled, and what is the maximum number of user names mentioned in one message (the default value is 10 and max is 100).
files Type: FileList, File[], FileInput[], or undefined	One or multiple files attached to the draft text message. They can take the form of a read-only files property of the HTML <input /> element (when a user has selected one or more files from their device), or through a drag-and-drop operation (FileList). Alternatively, that can be an array of file objects (File[]) or PubNub-specific FileInput (FileInput[]).

The MessageDraftConfig type takes the following parameters:

1type MessageDraftConfig = {
2    userSuggestionSource: "channel" | "global";
3    isTypingIndicatorTriggered: boolean;
4    userLimit: number
5}
6import MessageDraftConfig

Message draft configuration

Methods

Available methods:

• addLinkedText()
• addMentionedUser()
• addReferencedChannel()
• addQuote()
• getHighlightedMention()
• getMessagePreview()
• onChange()
• removeLinkedText()
• removeMentionedUser()
• removeReferencedChannel()
• removeQuote()
• send()

Use case

MessageDraftV2 methods enable users to prepare draft messages with:

• Links
• User mentions with @
• Channel references with #