Class ChatCombineMessageBody

The combined message body.

Hierarchy

  • _ChatFileMessageBody
    • ChatCombineMessageBody

Constructors

constructor

Properties

compatibleText? displayName fileSize fileStatus lastModifyOperatorId? lastModifyTime? localPath messageIdList? modifyCount? remotePath secret summary? title? type

Constructors

constructor

  • new ChatCombineMessageBody(params): ChatCombineMessageBody

  • Parameters

    • params: {
          compatibleText?: string;
          displayName?: string;
          fileSize?: number;
          fileStatus?: number;
          lastModifyOperatorId?: string;
          lastModifyTime?: number;
          localPath: string;
          messageIdList?: string[];
          modifyCount?: number;
          remotePath?: string;
          secret?: string;
          summary?: string;
          title?: string;
      }
      • OptionalcompatibleText?: string
      • OptionaldisplayName?: string
      • OptionalfileSize?: number
      • OptionalfileStatus?: number
      • OptionallastModifyOperatorId?: string
      • OptionallastModifyTime?: number
      • localPath: string
      • OptionalmessageIdList?: string[]
      • OptionalmodifyCount?: number
      • OptionalremotePath?: string
      • Optionalsecret?: string
      • Optionalsummary?: string
      • Optionaltitle?: string

    Returns ChatCombineMessageBody

Properties

OptionalcompatibleText

compatibleText?: string

The compatible text of the combined message.

displayName

displayName: string

The file name.

fileSize

fileSize: number

The size of the file in bytes.

fileStatus

fileStatus: ChatDownloadStatus

The download status of the attachment file. See ChatDownloadStatus.

OptionallastModifyOperatorId

lastModifyOperatorId?: string

The user ID of the operator that modified the message last time.

OptionallastModifyTime

lastModifyTime?: number

The UNIX timestamp of the last message modification, in milliseconds.

localPath

localPath: string = ''

The local path of the file.

OptionalmessageIdList

messageIdList?: string[]

The list of IDs of original messages in the combined message.

note This attribute is used only when you create a combined message.

OptionalmodifyCount

modifyCount?: number

The number of times a message is modified.

remotePath

remotePath: string

The path of the attachment file in the server.

secret

secret: string

The token to download the file attachment.

Optionalsummary

summary?: string

The summary of the combined message.

Optionaltitle

title?: string

The title of the combined message.

Readonlytype

type: ChatMessageType

The message type. See ChatMessageType.

Settings

Member Visibility

On This Page

Constructors
Properties