MessageRetrievalParams class Null safety
An object consists a set of parameters to retrieve information from a message.
- Inheritance
-
- Object
- BaseMessageFetchParams
- MessageRetrievalParams
- Annotations
Constructors
- MessageRetrievalParams({required ChannelType channelType, required String channelUrl, required int messageId})
Properties
- channelType ↔ ChannelType
-
Specifies a type of the channel.
read / write
- channelUrl ↔ String
-
Specifies the URL of a channel to retrieve a message.
read / write
- hashCode → int
-
The hash code for this object.
read-onlyinherited
- includeMetaArray ↔ bool
-
Determines whether the metaarray of the message is included in the results.
read / writeoverride
- includeParentMessageInfo ↔ bool
-
Determines wheter to include parent message info in the results
read / writeoverride
- 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 amessage
. If it isFileMessage
, the value is thename
of the uploaded file. default value is falseread / writeoverride - includeReactions ↔ bool
-
Determine to retrieve reactions or not. default is
false
read / writeoverride - includeReplies ↔ bool?
-
Determines whether to include the reactions to the messages in the results.
default value is false
read / writeoverride
- 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
read / writeoverride
- messageId ↔ int
-
Specifies the unique ID of a message to retrieve.
read / write
- replyToChannel ↔ bool
-
Determines wheter to include option to reply to channel
read / write
- replyType ↔ ReplyType?
-
Determines message's reply type
read / writeinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
read-onlyinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent 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