Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CreateCombineMsgParameters

Hierarchy

  • CreateCombineMsgParameters

Index

Properties

Methods

Properties

chatType

chatType: ChatType

The conversation type.

compatibleText

compatibleText: string

The compatible text of the combined message.

Optional deliverOnlineOnly

deliverOnlineOnly?: boolean

Whether the message is delivered only when the recipient(s) is/are online:

  • true: The message is delivered only when the recipient(s) is/are online. If the recipient is offline, the message is discarded.
  • (Default) false: The message is delivered when the recipient(s) is/are online. If the recipient(s) is/are offline, the message will not be delivered to them until they get online.

Optional ext

ext?: {}

The message extension.

Type declaration

  • [key: string]: any

Optional from

from?: string

The sender, which can only be the current user and can not be changed.

Optional isChatThread

isChatThread?: boolean

Whether the message is a threaded message.

messageList

messageList: (Message.TextMsgBody | Message.CmdMsgBody | Message.CustomMsgBody | Message.ImgMsgBody | Message.LocationMsgBody | Message.AudioMsgBody | Message.VideoMsgBody | Message.FileMsgBody | Message.CombineMsgBody)[]

The message list of the combined message.

Optional msgConfig

msgConfig?: { allowGroupAck?: boolean; languages?: string[] }

Whether read receipts are required during a group conversation.

Type declaration

  • Optional allowGroupAck?: boolean
  • Optional languages?: string[]

Optional priority

priority?: MessagePriority

Message priority.

Optional receiverList

receiverList?: string[]

The list of message recipients.

summary

summary: string

The summary list of the combined message.

title

title: string

The title of the combined message.

to

to: string

The recipient.

type

type: "combine"

The message type.

Methods

Optional onFileUploadComplete

  • onFileUploadComplete(data: { secret: string; url: string }): void

  • The callback of file upload completion.

    Parameters

    • data: { secret: string; url: string }
      • secret: string
      • url: string

    Returns void

Optional onFileUploadError

  • onFileUploadError(error: any): void

  • The callback of a file upload error.

    Parameters

    • error: any

    Returns void

Generated using TypeDoc