Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CmdMsgBody

Hierarchy

  • CmdMsgBody

Index

Properties

Methods

Properties

action

action: string

The command.

chatType

chatType: ChatType

The session type.

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 group

group?: string
deprecated

Whether the session type is chat room.

id

id: string

The message ID.

Optional isChatThread

isChatThread?: boolean

Whether the message is a thread message.

Optional msgConfig

msgConfig?: { allowGroupAck: boolean }

Whether read receipts are required during a group session.

Type declaration

  • allowGroupAck: boolean

Optional priority

priority?: MessagePriority

Message priority.

Optional receiverList

receiverList?: string[]

The list of message recipients.

Optional roomType

roomType?: boolean
deprecated

Whether the session type is chat room.

time

time: number

Time.

to

to: string

The recipient.

type

type: "cmd"

The message type.

Methods

Optional fail

  • fail(): void

  • The callback for a message sending failure.

    Returns void

Optional success

Generated using TypeDoc