Discord.Addons.CommandCache 2.0.0

Discord.Addons.CommandCache

A Discord.Net addon to autodelete command responses when the command message is deleted.

Usage

The built in CommandCacheService stores message IDs, and is thread safe. It should fit most use cases, but you can create your own implementation using ICommandCache.

Adding the service

Either add it manually:

var services = new ServiceCollection();
services.AddSingleton(new CommandCacheService(_client));

Or use the extension method:

var services = new ServiceCollection();
_client = new DiscordSocketClient().UseCommandCache(services, 500, Log);

You can also have an instance with no size limit by passing CommandCacheService.UNLIMITED as capacity.

Using the cache in a module

In order to use the command cache in a module, you must add it to the module through Discord.Net's dependency injection. While this can be done manually, an easier method is to have your module derive from CommandCacheModuleBase<TCommandCache, TCacheKey, TCacheValue, TCommandContext>. This works with any implementation of ICommandCache<TKey, TValue>.

Because that's a quite verbose class name, this package also provides CommandCacheModuleBase<TCommandContext> which uses the default CommandCacheService.

You can then access the cache through the module's Cache property. Responding to commands through ReplyAsync will automatically add the messages to the cache.

Adding values to the cache outside modules

There are two ways to add a message to the cache without the ModuleBase extension. The first is by using the Add method:

var responseMessage = await textChannel.SendMessageAsync("This is a command response");
cache.Add(commandMessageId, responseMessage.Id);

The second is by using the SendCachedMessageAsync extension method:

await textChannel.SendCachedMessageAsync(cache, commandMessageId, "This is a command response");

This method only works with the default CommandCacheService and does not support adding multiple messages at once.

Disposing of the cache

The built in CommandCacheService uses a System.Threading.Timer internally, so you should call the Dispose method in your shutdown logic. An example method is provided in the example bot.

Example

Refer to the example bot for proper usage of the command cache.