Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

addr: string

The address.

buildingName: string

The building name.

chatType: ChatType

The session type.

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.
ext?: {}

The message extension.

Type declaration

  • [key: string]: any
from?: string

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

group?: string
deprecated

Whether the session type is group (3.0).

id: string

The message ID.

isChatThread?: boolean

Whether the message is a thread message.

lat: number

The latitude.

lng: number

The longitude.

msgConfig?: { allowGroupAck: boolean }

Whether read receipts are required during a group session.

Type declaration

  • allowGroupAck: boolean
priority?: MessagePriority

Message priority.

receiverList?: string[]

The list of message recipients.

roomType?: boolean
deprecated

Whether the session type is chat room (3.0).

time: number

Time.

to: string

The recipient.

type: "loc"

The message type.

Methods

  • fail(): void
  • The callback for a message sending failure.

    Returns void

Generated using TypeDoc