MessageFlags class
Flags that can be applied to a Message.
External references:
- Discord API Reference: https://discord.com/developers/docs/resources/channel#message-object-message-flags
- Inheritance
-
- Object
- IterableBase<
Flag< MessageFlags> > - Flags<
MessageFlags> - MessageFlags
- Available Extensions
Constructors
- MessageFlags(int value)
-
Create a new MessageFlags.
const
Properties
- didFailToMentionSomeRolesInThread → bool
-
Whether this set of flags has the failedToMentionSomeRolesInThread flag set.
no setter
-
first
→ Flag<
MessageFlags> -
The first element.
no setterinherited
- hasAThread → bool
-
Whether this set of flags has the hasThread flag set.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- isACrosspost → bool
-
Whether this set of flags has the isCrosspost flag set.
no setter
- isAVoiceMessage → bool
-
Whether this set of flags has the isVoiceMessage flag set.
no setter
- isEmpty → bool
-
Whether this collection has no elements.
no setterinherited
- isEphemeral → bool
-
Whether this set of flags has the ephemeral flag set.
no setter
- isLoading → bool
-
Whether this set of flags has the loading flag set.
no setter
- isNotEmpty → bool
-
Whether this collection has at least one element.
no setterinherited
- isUrgent → bool
-
Whether this set of flags has the urgent flag set.
no setter
-
iterator
→ Iterator<
Flag< MessageFlags> > -
A new
Iterator
that allows iterating the elements of thisIterable
.no setterinherited -
last
→ Flag<
MessageFlags> -
The last element.
no setterinherited
- length → int
-
The number of elements in this Iterable.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
single
→ Flag<
MessageFlags> -
Checks that this iterable has only one element, and returns that element.
no setterinherited
- sourceMessageWasDeleted → bool
-
Whether this set of flags has the sourceMessageDeleted flag set.
no setter
- suppressesEmbeds → bool
-
Whether this set of flags has the suppressEmbeds flag set.
no setter
- suppressesNotifications → bool
-
Whether this set of flags has the suppressNotifications flag set.
no setter
- value → int
-
The integer value encoding the flags as a bitfield.
finalinherited
- wasCrossposted → bool
-
Whether this set of flags has the crossposted flag set.
no setter
Methods
-
any(
bool test(Flag< MessageFlags> element)) → bool -
Checks whether any element of this iterable satisfies
test
.inherited -
cast<
R> () → Iterable< R> -
A view of this iterable as an iterable of
R
instances.inherited -
contains(
Object? element) → bool -
Whether the collection contains an element equal to
element
.inherited -
defaultToString(
) → String -
Same as toString, but only called when dart:mirrors is not available.
inherited
-
elementAt(
int index) → Flag< MessageFlags> -
Returns the
index
th element.inherited -
every(
bool test(Flag< MessageFlags> element)) → bool -
Checks whether every element of this iterable satisfies
test
.inherited -
expand<
T> (Iterable< T> toElements(Flag<MessageFlags> element)) → Iterable<T> -
Expands each element of this Iterable into zero or more elements.
inherited
-
firstWhere(
bool test(Flag< MessageFlags> element), {Flag<MessageFlags> orElse()?}) → Flag<MessageFlags> -
The first element that satisfies the given predicate
test
.inherited -
fold<
T> (T initialValue, T combine(T previousValue, Flag< MessageFlags> element)) → T -
Reduces a collection to a single value by iteratively combining each
element of the collection with an existing value
inherited
-
followedBy(
Iterable< Flag< other) → Iterable<MessageFlags> >Flag< MessageFlags> > -
Creates the lazy concatenation of this iterable and
other
.inherited -
forEach(
void action(Flag< MessageFlags> element)) → void -
Invokes
action
on each element of this iterable in iteration order.inherited -
has(
Flag< MessageFlags> flag) → bool -
Returns
true
if this Flags has theflag
enabled,false
otherwise.inherited -
join(
[String separator = ""]) → String -
Converts each element to a String and concatenates the strings.
inherited
-
lastWhere(
bool test(Flag< MessageFlags> element), {Flag<MessageFlags> orElse()?}) → Flag<MessageFlags> -
The last element that satisfies the given predicate
test
.inherited -
map<
T> (T toElement(Flag< MessageFlags> e)) → Iterable<T> -
The current elements of this iterable modified by
toElement
.inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
reduce(
Flag< MessageFlags> combine(Flag<MessageFlags> value, Flag<MessageFlags> element)) → Flag<MessageFlags> -
Reduces a collection to a single value by iteratively combining elements
of the collection using the provided function.
inherited
-
singleWhere(
bool test(Flag< MessageFlags> element), {Flag<MessageFlags> orElse()?}) → Flag<MessageFlags> -
The single element that satisfies
test
.inherited -
skip(
int count) → Iterable< Flag< MessageFlags> > -
Creates an Iterable that provides all but the first
count
elements.inherited -
skipWhile(
bool test(Flag< MessageFlags> value)) → Iterable<Flag< MessageFlags> > -
Creates an
Iterable
that skips leading elements whiletest
is satisfied.inherited -
take(
int count) → Iterable< Flag< MessageFlags> > -
Creates a lazy iterable of the
count
first elements of this iterable.inherited -
takeWhile(
bool test(Flag< MessageFlags> value)) → Iterable<Flag< MessageFlags> > -
Creates a lazy iterable of the leading elements satisfying
test
.inherited -
toList(
{bool growable = true}) → List< Flag< MessageFlags> > -
Creates a List containing the elements of this Iterable.
inherited
-
toSet(
) → Set< Flag< MessageFlags> > -
Creates a Set containing the same elements as this iterable.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
where(
bool test(Flag< MessageFlags> element)) → Iterable<Flag< MessageFlags> > -
Creates a new lazy Iterable with all elements that satisfy the
predicate
test
.inherited -
whereType<
T> () → Iterable< T> -
Creates a new lazy Iterable with all elements that have type
T
.inherited
Operators
-
operator &(
Flags< MessageFlags> other) → Flags<MessageFlags> -
Return a set of flags that has all the flags set in both
this
andother
.inherited -
operator ==(
Object other) → bool -
The equality operator.
inherited
-
operator ^(
Flags< MessageFlags> other) → Flags<MessageFlags> -
Return a set of flags that has all the flags set in
this
or inother
but not in both.inherited -
operator |(
Flags< MessageFlags> other) → Flags<MessageFlags> -
Return a set of flags that has all the flags set in either
this
orother
.inherited -
operator ~(
) → Flags< MessageFlags> -
Returns the opposite of this set of flags.
inherited
Constants
-
crossposted
→ const Flag<
MessageFlags> - This message has been published to subscribed channels (via Channel Following).
-
ephemeral
→ const Flag<
MessageFlags> - This message is only visible to the user who invoked the Interaction.
-
failedToMentionSomeRolesInThread
→ const Flag<
MessageFlags> - This message failed to mention some roles and add their members to the thread.
-
hasThread
→ const Flag<
MessageFlags> - This message has an associated thread, with the same id as the message.
-
isCrosspost
→ const Flag<
MessageFlags> - This message originated from a message in another channel (via Channel Following).
-
isVoiceMessage
→ const Flag<
MessageFlags> - This message is a voice message.
-
loading
→ const Flag<
MessageFlags> - This message is an Interaction Response and the bot is "thinking".
-
sourceMessageDeleted
→ const Flag<
MessageFlags> - The source message for this crosspost has been deleted (via Channel Following).
-
suppressEmbeds
→ const Flag<
MessageFlags> - Do not include any embeds when serializing this message.
-
suppressNotifications
→ const Flag<
MessageFlags> - This message will not trigger push and desktop notifications.
-
urgent
→ const Flag<
MessageFlags> - This message came from the urgent message system.