diff --git a/src/Discord.Net.Webhook/DiscordWebhookClient.cs b/src/Discord.Net.Webhook/DiscordWebhookClient.cs index 0bbb73eae..24656b104 100644 --- a/src/Discord.Net.Webhook/DiscordWebhookClient.cs +++ b/src/Discord.Net.Webhook/DiscordWebhookClient.cs @@ -85,30 +85,93 @@ namespace Discord.Webhook } private static API.DiscordRestApiClient CreateApiClient(DiscordRestConfig config) => new API.DiscordRestApiClient(config.RestClientProvider, DiscordRestConfig.UserAgent); - /// Sends a message to the channel for this webhook. - /// Returns the ID of the created message. + + /// + /// Sends a message to the channel for this webhook. + /// + /// The message to be sent. + /// Determines whether the message should be read aloud by Discord or not. + /// The s to be sent. + /// The username the webhook will display on this message. + /// The url to the avatar the webhook will display on this message. + /// The options to be used when sending the request. + /// + /// Returns the ID of the created message. + /// public Task SendMessageAsync(string text = null, bool isTTS = false, IEnumerable embeds = null, string username = null, string avatarUrl = null, RequestOptions options = null) => WebhookClientHelper.SendMessageAsync(this, text, isTTS, embeds, username, avatarUrl, options); - /// Sends a message to the channel for this webhook with an attachment. - /// Returns the ID of the created message. + /// + /// Sends a message to the channel for this webhook with an attachment. + /// + /// The file path of the file. + /// The message to be sent. + /// Determines whether the message should be read aloud by Discord or not. + /// The s to be sent. + /// The username the webhook will display on this message. + /// The url to the avatar the webhook will display on this message. + /// Whether the message attachment should be hidden as a spoiler. + /// The options to be used when sending the request. + /// + /// Returns the ID of the created message. + /// public Task SendFileAsync(string filePath, string text, bool isTTS = false, IEnumerable embeds = null, string username = null, string avatarUrl = null, RequestOptions options = null, bool isSpoiler = false) => WebhookClientHelper.SendFileAsync(this, filePath, text, isTTS, embeds, username, avatarUrl, options, isSpoiler); - /// Sends a message to the channel for this webhook with an attachment. - /// Returns the ID of the created message. + + /// + /// Sends a message to the channel for this webhook with an attachment. + /// + /// The stream of the file to be sent. + /// The name of the file to be sent. + /// The message to be sent. + /// Determines whether the message should be read aloud by Discord or not. + /// The s to be sent. + /// The username the webhook will display on this message. + /// The url to the avatar the webhook will display on this message. + /// Whether the message attachment should be hidden as a spoiler. + /// The options to be used when sending the request. + /// + /// Returns the ID of the created message. + /// public Task SendFileAsync(Stream stream, string filename, string text, bool isTTS = false, IEnumerable embeds = null, string username = null, string avatarUrl = null, RequestOptions options = null, bool isSpoiler = false) => WebhookClientHelper.SendFileAsync(this, stream, filename, text, isTTS, embeds, username, avatarUrl, options, isSpoiler); - /// Sends a message to the channel for this webhook with multiple attachments. - /// Returns the ID of the created message. + /// + /// Sends a message to the channel for this webhook with multiple attachments. + /// + /// The of file paths of the files. + /// The message to be sent. + /// Determines whether the message should be read aloud by Discord or not. + /// The s to be sent. + /// The username the webhook will display on this message. + /// The url to the avatar the webhook will display on this message. + /// Whether the message attachment should be hidden as a spoiler. + /// The options to be used when sending the request. + /// + /// Returns the ID of the created message. + /// public Task SendFileAsync(IEnumerable filePaths, string text, bool isTTS = false, IEnumerable embeds = null, string username = null, string avatarUrl = null, RequestOptions options = null, bool isSpoiler = false) => WebhookClientHelper.SendFileAsync(this, filePaths, text, isTTS, embeds, username, avatarUrl, options, isSpoiler); - /// Sends a message to the channel for this webhook with multiple attachments. - /// Returns the ID of the created message. + + /// + /// Sends a message to the channel for this webhook with multiple attachments. + /// + /// The of + /// that are the filename and stream for each file. + /// The message to be sent. + /// Determines whether the message should be read aloud by Discord or not. + /// The s to be sent. + /// The username the webhook will display on this message. + /// The url to the avatar the webhook will display on this message. + /// Whether the message attachment should be hidden as a spoiler. + /// The options to be used when sending the request. + /// + /// Returns the ID of the created message. + /// public Task SendFileAsync(IEnumerable> streams, string text, bool isTTS = false, IEnumerable embeds = null, string username = null, string avatarUrl = null, RequestOptions options = null, bool isSpoiler = false) => WebhookClientHelper.SendFileAsync(this, streams, text, isTTS, embeds, username, avatarUrl, options, isSpoiler);