MessageRetrievalParams class

An object consists a set of parameters to retrieve information from a message.

Inheritance
Annotations
  • @JsonSerializable()

Constructors

MessageRetrievalParams({required ChannelType channelType, required String channelUrl, required int messageId})

Properties

channelType ↔ ChannelType
Specifies a type of the channel.
getter/setter pair
channelUrl ↔ String
Specifies the URL of a channel to retrieve a message.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
includeMetaArray ↔ bool
Determines whether the metaarray of the message is included in the results.
getter/setter pairoverride
includeParentMessageInfo ↔ bool
Determines wheter to include parent message info in the results
getter/setter pairoverride
includeParentMessageText ↔ bool?
Determines whether to include the parent message text in the results when the messages are replies in a thread. If the type of the parent message is UserMessage the value is a message. If it is FileMessage, the value is the name of the uploaded file. default value is false
getter/setter pairoverride
includeReactions ↔ bool
Determine to retrieve reactions or not. default is false
getter/setter pairoverride
includeReplies ↔ bool?
Determines whether to include the reactions to the messages in the results. default value is false
getter/setter pairoverride
includeThreadInfo ↔ bool
Determines whether to include the thread information of the messages in the results when the results contain root messages. default value is false
getter/setter pairoverride
messageId ↔ int
Specifies the unique ID of a message to retrieve.
getter/setter pair
replyToChannel ↔ bool
Determines wheter to include option to reply to channel
getter/setter pair
replyType ↔ ReplyType?
Determines message's reply type
getter/setter pairinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
override
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited