ComponentMessageBuilder class
Extended MessageBuilder with support for buttons
- Inheritance
-
- Object
- MessageBuilder
- ComponentMessageBuilder
Constructors
Properties
- allowedMentions ↔ AllowedMentions?
-
AllowedMentions object to control mentions in message
read / writeinherited
-
attachments
↔ List<
AttachmentMetadataBuilder> ? -
List of attachments to send with message
read / writeinherited
-
componentRows
↔ List<
ComponentRowBuilder> ? -
Set of buttons to attach to message. Message can only have 5 rows with 5 buttons each.
read / write
- content ↔ String
-
Returns current content of message
read / writeinherited
-
embeds
↔ List<
EmbedBuilder> ? -
Embed to include in message
read / writeinherited
-
files
↔ List<
AttachmentBuilder> ? -
List of files to send with message
read / writeinherited
- flags ↔ MessageFlagBuilder?
-
Flags to attach to message
read / writeinherited
- hashCode → int
-
The hash code for this object.
read-onlyinherited
- nonce ↔ String?
-
A nonce that can be used for optimistic message sending (up to 25 characters)
You will be able to identify that message when receiving it through gateway
read / writeinherited
- replyBuilder ↔ ReplyBuilder?
-
Allows to create message that replies to another message
read / writeinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
read-onlyinherited
- tts ↔ bool?
-
Set to true if message should be TTS
read / writeinherited
Methods
-
addAttachment(
AttachmentBuilder attachment) → void -
Add attachment
inherited
-
addBytesAttachment(
List< int> bytes, String name, {bool spoiler = false}) → void -
Add attachment from specified bytes
inherited
-
addComponentRow(
ComponentRowBuilder componentRowBuilder) → void - Allows to add
-
addEmbed(
FutureOr< void> builder(EmbedBuilder embed)) → FutureOr<void> -
Allows to add embed to message.
Warning: Completes future synchronously!
inherited
-
addFileAttachment(
File file, {String? name, bool spoiler = false}) → void -
Add attachment from specified file
inherited
-
addPathAttachment(
String path, {String? name, bool spoiler = false}) → void -
Add attachment at specified path
inherited
-
append(
Object text) → void -
Allows to append
inherited
-
appendBold(
Object text) → void -
Appends bold text to message
inherited
-
appendClearCharacter(
) → void -
Appends clear character. Can be used to skip first line in message body.
inherited
-
appendCode(
Object language, Object code) → void -
Appends code block to message
inherited
-
appendCodeSimple(
Object text) → void -
Appends simple code to message
inherited
-
appendItalics(
Object text) → void -
Appends italic text to message
inherited
-
appendMention(
Mentionable mentionable) → void -
Appends Mentionable object to message
inherited
-
appendNewLine(
) → void -
Appends empty line to message
inherited
-
appendSpoiler(
Object text) → void -
Appends spoiler to message
inherited
-
appendStrike(
Object text) → void -
Appends strikeout text to message
inherited
-
appendTimestamp(
DateTime dateTime, {TimeStampStyle style = TimeStampStyle.def}) → void -
Appends timestamp to message from
dateTimeinherited -
appendWithDecoration(
Object text, MessageDecoration decoration) → void -
Appends formatted text to message
inherited
-
build(
[AllowedMentions? defaultAllowedMentions]) → RawApiMap -
override
-
canBeUsedAsNewMessage(
) → bool -
Returns if this instance of message builder can be used when editing message
override
-
getMappedFiles(
) → Iterable< MultipartFile> -
inherited
-
hasFiles(
) → bool -
inherited
-
limitLength(
{int length = 2000, String? ellipsis = '...'}) → void -
Limits the length of the content of the builder to
length.inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
send(
ISend entity) → Future< IMessage> -
Sends message
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited