IWebhook class abstract

Webhooks are a low-effort way to post messages to channels in Discord. They do not require a bot user or authentication to use.

Implemented types

Constructors

IWebhook()

Properties

avatarHash → String?
Webhooks avatar hash
no setter
bot → bool
True if bot or webhook
no setterinherited
channel → ICacheableTextChannel<ITextGuildChannel>?
The webhook's channel, if this is accessed using a normal client and the client has that channel in it's cache.
no setter
client → INyxx
Reference to NyxxWebsocket object
no setter
createdAt → DateTime
Gets creation timestamp included in Snowflake
no setterinherited
defaultAvatarId → int
Default webhook avatar id
no setter
discriminator → int
User Discriminator. -1 if webhook
no setterinherited
formattedDiscriminator → String
Formatted discriminator with leading zeros if needed
no setterinherited
guild → Cacheable<Snowflake, IGuild>?
The webhook's guild, if this is accessed using a normal client and the client has that guild in it's cache.
no setter
hashCode → int
The hash code for this object.
no setterinherited
id → Snowflake
ID of entity as Snowflake
finalinherited
isInteractionWebhook → bool
Whether this IMessageAuthor is a webhook received by an interaction.
no setterinherited
name → String?
The webhook's name.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tag → String
User tag: l7ssha#6712
no setterinherited
token → String
The webhook's token. Defaults to empty string
no setter
type → WebhookType?
Webhook type
no setter
user → IUser?
The user, if this is accessed using a normal client.
no setter
username → String
User name
no setterinherited

Methods

avatarUrl({String format = 'webp', int? size, bool animated = true}) → String
The user's avatar, represented as URL. In case if user does not have avatar, default discord avatar will be returned; format, size and animated will no longer affectng this URL. If animated is set as true, if available, the url will be a gif, otherwise the format.
override
delete({String? auditReason}) → Future<void>
Deletes the webhook.
edit({String? name, SnowflakeEntity? channel, AttachmentBuilder? avatarAttachment, String? auditReason}) → Future<IWebhook>
Edits the webhook.
execute(MessageBuilder builder, {bool wait = true, Snowflake? threadId, String? threadName, String? avatarUrl, String? username}) → Future<IMessage?>
Executes webhook.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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