Skip to content

Commit

Permalink
Implement IMessageChannel#DeleteMessageAsync (#996)
Browse files Browse the repository at this point in the history 
* Implement DeleteMessageAsync

* Refer to MessageHelper instead of duplicating call

* Fix refactor error
  • Loading branch information
@foxbot
Still Hsu authored and foxbot committed May 25, 2018
1 parent cee71ef commit bc6009e
Show file tree
Hide file tree
Showing 10 changed files with 48 additions and 2 deletions.
5 changes: 5 additions & 0 deletions src/Discord.Net.Core/Entities/Channels/IMessageChannel.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,11 @@ IAsyncEnumerable<IReadOnlyCollection<IMessage>> GetMessagesAsync(IMessage fromMe
/// <summary> Gets a collection of pinned messages in this channel. </summary>
Task<IReadOnlyCollection<IMessage>> GetPinnedMessagesAsync(RequestOptions options = null);

/// <summary> Deletes a message based on the message ID in this channel. </summary>
Task DeleteMessageAsync(ulong messageId, RequestOptions options = null);
/// <summary> Deletes a message based on the provided message in this channel. </summary>
Task DeleteMessageAsync(IMessage message, RequestOptions options = null);

/// <summary> Broadcasts the "user is typing" message to all users in this channel, lasting 10 seconds. </summary>
Task TriggerTypingAsync(RequestOptions options = null);
/// <summary> Continuously broadcasts the "user is typing" message to all users in this channel until the returned object is disposed. </summary>
Expand Down
4 changes: 4 additions & 0 deletions src/Discord.Net.Rest/Entities/Channels/ChannelHelper.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,10 @@ public static async Task<RestUserMessage> SendFileAsync(IMessageChannel channel,
return RestUserMessage.Create(client, channel, client.CurrentUser, model);
}

public static Task DeleteMessageAsync(IMessageChannel channel, ulong messageId, BaseDiscordClient client,
RequestOptions options)
=> MessageHelper.DeleteAsync(channel.Id, messageId, client, options);

public static async Task DeleteMessagesAsync(ITextChannel channel, BaseDiscordClient client,
IEnumerable<ulong> messageIds, RequestOptions options)
{
Expand Down
5 changes: 5 additions & 0 deletions src/Discord.Net.Rest/Entities/Channels/RestDMChannel.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,11 @@ public Task<RestUserMessage> SendFileAsync(string filePath, string text, bool is
public Task<RestUserMessage> SendFileAsync(Stream stream, string filename, string text, bool isTTS = false, Embed embed = null, RequestOptions options = null)
=> ChannelHelper.SendFileAsync(this, Discord, stream, filename, text, isTTS, embed, options);

public Task DeleteMessageAsync(ulong messageId, RequestOptions options = null)
=> ChannelHelper.DeleteMessageAsync(this, messageId, Discord, options);
public Task DeleteMessageAsync(IMessage message, RequestOptions options = null)
=> ChannelHelper.DeleteMessageAsync(this, message.Id, Discord, options);

public Task TriggerTypingAsync(RequestOptions options = null)
=> ChannelHelper.TriggerTypingAsync(this, Discord, options);
public IDisposable EnterTypingState(RequestOptions options = null)
Expand Down
5 changes: 5 additions & 0 deletions src/Discord.Net.Rest/Entities/Channels/RestGroupChannel.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,11 @@ public IAsyncEnumerable<IReadOnlyCollection<RestMessage>> GetMessagesAsync(IMess
public Task<IReadOnlyCollection<RestMessage>> GetPinnedMessagesAsync(RequestOptions options = null)
=> ChannelHelper.GetPinnedMessagesAsync(this, Discord, options);

public Task DeleteMessageAsync(ulong messageId, RequestOptions options = null)
=> ChannelHelper.DeleteMessageAsync(this, messageId, Discord, options);
public Task DeleteMessageAsync(IMessage message, RequestOptions options = null)
=> ChannelHelper.DeleteMessageAsync(this, message.Id, Discord, options);

public Task<RestUserMessage> SendMessageAsync(string text = null, bool isTTS = false, Embed embed = null, RequestOptions options = null)
=> ChannelHelper.SendMessageAsync(this, Discord, text, isTTS, embed, options);
#if FILESYSTEM
Expand Down
5 changes: 5 additions & 0 deletions src/Discord.Net.Rest/Entities/Channels/RestTextChannel.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,11 @@ public Task<RestUserMessage> SendFileAsync(string filePath, string text, bool is
public Task<RestUserMessage> SendFileAsync(Stream stream, string filename, string text, bool isTTS = false, Embed embed = null, RequestOptions options = null)
=> ChannelHelper.SendFileAsync(this, Discord, stream, filename, text, isTTS, embed, options);

public Task DeleteMessageAsync(ulong messageId, RequestOptions options = null)
=> ChannelHelper.DeleteMessageAsync(this, messageId, Discord, options);
public Task DeleteMessageAsync(IMessage message, RequestOptions options = null)
=> ChannelHelper.DeleteMessageAsync(this, message.Id, Discord, options);

public Task DeleteMessagesAsync(IEnumerable<IMessage> messages, RequestOptions options = null)
=> ChannelHelper.DeleteMessagesAsync(this, Discord, messages.Select(x => x.Id), options);
public Task DeleteMessagesAsync(IEnumerable<ulong> messageIds, RequestOptions options = null)
Expand Down
5 changes: 5 additions & 0 deletions src/Discord.Net.Rest/Entities/Channels/RpcVirtualMessageChannel.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,11 @@ public Task<RestUserMessage> SendFileAsync(string filePath, string text, bool is
public Task<RestUserMessage> SendFileAsync(Stream stream, string filename, string text, bool isTTS = false, Embed embed = null, RequestOptions options = null)
=> ChannelHelper.SendFileAsync(this, Discord, stream, filename, text, isTTS, embed, options);

public Task DeleteMessageAsync(ulong messageId, RequestOptions options = null)
=> ChannelHelper.DeleteMessageAsync(this, messageId, Discord, options);
public Task DeleteMessageAsync(IMessage message, RequestOptions options = null)
=> ChannelHelper.DeleteMessageAsync(this, message.Id, Discord, options);

public Task TriggerTypingAsync(RequestOptions options = null)
=> ChannelHelper.TriggerTypingAsync(this, Discord, options);
public IDisposable EnterTypingState(RequestOptions options = null)
Expand Down
6 changes: 4 additions & 2 deletions src/Discord.Net.Rest/Entities/Messages/MessageHelper.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,12 @@ public static async Task<Model> ModifyAsync(IMessage msg, BaseDiscordClient clie
};
return await client.ApiClient.ModifyMessageAsync(msg.Channel.Id, msg.Id, apiArgs, options).ConfigureAwait(false);
}
public static async Task DeleteAsync(IMessage msg, BaseDiscordClient client,
public static Task DeleteAsync(IMessage msg, BaseDiscordClient client, RequestOptions options)
=> DeleteAsync(msg.Channel.Id, msg.Id, client, options);
public static async Task DeleteAsync(ulong channelId, ulong msgId, BaseDiscordClient client,
RequestOptions options)
{
await client.ApiClient.DeleteMessageAsync(msg.Channel.Id, msg.Id, options).ConfigureAwait(false);
await client.ApiClient.DeleteMessageAsync(channelId, msgId, options).ConfigureAwait(false);
}

public static async Task AddReactionAsync(IMessage msg, IEmote emote, BaseDiscordClient client, RequestOptions options)
Expand Down
5 changes: 5 additions & 0 deletions src/Discord.Net.WebSocket/Entities/Channels/SocketDMChannel.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,11 @@ public Task<RestUserMessage> SendFileAsync(string filePath, string text, bool is
public Task<RestUserMessage> SendFileAsync(Stream stream, string filename, string text, bool isTTS = false, Embed embed = null, RequestOptions options = null)
=> ChannelHelper.SendFileAsync(this, Discord, stream, filename, text, isTTS, embed, options);

public Task DeleteMessageAsync(ulong messageId, RequestOptions options = null)
=> ChannelHelper.DeleteMessageAsync(this, messageId, Discord, options);
public Task DeleteMessageAsync(IMessage message, RequestOptions options = null)
=> ChannelHelper.DeleteMessageAsync(this, message.Id, Discord, options);

public Task TriggerTypingAsync(RequestOptions options = null)
=> ChannelHelper.TriggerTypingAsync(this, Discord, options);
public IDisposable EnterTypingState(RequestOptions options = null)
Expand Down
5 changes: 5 additions & 0 deletions src/Discord.Net.WebSocket/Entities/Channels/SocketGroupChannel.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,11 @@ public Task<RestUserMessage> SendFileAsync(string filePath, string text, bool is
public Task<RestUserMessage> SendFileAsync(Stream stream, string filename, string text, bool isTTS = false, Embed embed = null, RequestOptions options = null)
=> ChannelHelper.SendFileAsync(this, Discord, stream, filename, text, isTTS, embed, options);

public Task DeleteMessageAsync(ulong messageId, RequestOptions options = null)
=> ChannelHelper.DeleteMessageAsync(this, messageId, Discord, options);
public Task DeleteMessageAsync(IMessage message, RequestOptions options = null)
=> ChannelHelper.DeleteMessageAsync(this, message.Id, Discord, options);

public Task TriggerTypingAsync(RequestOptions options = null)
=> ChannelHelper.TriggerTypingAsync(this, Discord, options);
public IDisposable EnterTypingState(RequestOptions options = null)
Expand Down
5 changes: 5 additions & 0 deletions src/Discord.Net.WebSocket/Entities/Channels/SocketTextChannel.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,11 @@ public Task DeleteMessagesAsync(IEnumerable<IMessage> messages, RequestOptions o
public Task DeleteMessagesAsync(IEnumerable<ulong> messageIds, RequestOptions options = null)
=> ChannelHelper.DeleteMessagesAsync(this, Discord, messageIds, options);

public Task DeleteMessageAsync(ulong messageId, RequestOptions options = null)
=> ChannelHelper.DeleteMessageAsync(this, messageId, Discord, options);
public Task DeleteMessageAsync(IMessage message, RequestOptions options = null)
=> ChannelHelper.DeleteMessageAsync(this, message.Id, Discord, options);

public Task TriggerTypingAsync(RequestOptions options = null)
=> ChannelHelper.TriggerTypingAsync(this, Discord, options);
public IDisposable EnterTypingState(RequestOptions options = null)
Expand Down

1 comment on commit bc6009e

@RheaAyase
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wish I had seen this a few months ago. Please for the future reference, pass around objects, not IDs. It's nice to have those objects to be able to do stuff with them. Especially if you're adding similar implementation of something that already exists, with objects, and you remove them.

(Breaking change for my fork.)

Please sign in to comment.