MessageListParams

MessageListParams

Parameter class for building message list. Used in baseChannel.getMessagesByTimestamp and baseChannel.getMessagesByMessageId

Constructor

new MessageListParams()

Members

(nullable) customType :string

Deprecated:
  • since version v3.0.142, please use customTypes instead
Default Value:
  • null
Type:
  • string

(nullable) customTypes :Array.<string>

Default Value:
  • []
Type:
  • Array.<string>

includeMetaArray :boolean

Default Value:
  • false
Type:
  • boolean

includeParentMessageInfo :boolean

Default Value:
  • null
Type:
  • boolean

includeParentMessageText :boolean

Deprecated:
  • since version v3.0.159, please use includeParentMessageInfo instead
Default Value:
  • null
Type:
  • boolean

includePollDetails :boolean

Default Value:
  • false
Type:
  • boolean

includeReaction :boolean

Deprecated:
  • since version v3.0.125, please use includeReactions instead
Default Value:
  • null
Type:
  • boolean

includeReactions :boolean

Default Value:
  • null
Type:
  • boolean

includeReplies :boolean

Deprecated:
  • since version v3.0.159, please use replyType instead
Default Value:
  • null
Type:
  • boolean

includeThreadInfo :boolean

Default Value:
  • false
Type:
  • boolean

isInclusive :boolean

Default Value:
  • false
Type:
  • boolean

(nullable) messageType :string

Default Value:
  • null
See:
Type:
  • string

nextResultSize :number

Default Value:
  • 0
Type:
  • number

prevResultSize :number

Default Value:
  • 0
Type:
  • number

(nullable) replyType :string

Default Value:
  • null
Type:
  • string

reverse :boolean

Default Value:
  • false
Type:
  • boolean

senderUserIds :Array.<string>

Default Value:
  • []
Type:
  • Array.<string>

showSubchannelMessagesOnly :boolean

Default Value:
  • false
Type:
  • boolean

Methods

belongsTo(params) → {boolean}

Parameters:
Name Type Description
params module:model/params/userMessageParams~UserMessageParams | module:model/params/fileMessageParams~FileMessageParams
Returns:
Type
boolean