Noi/RegexBot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add missing documentation and initialization

Browse source
This commit is contained in:
Noikoio 2018-12-05 12:47:25 -08:00
parent 47cc8425b2
commit de8660d913
4 changed files with 38 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
Kerobot/Kerobot.cs
View file

@ -58,6 +58,7 @@ namespace Kerobot
svcList.Add(_svcLogging);
_svcGuildState = new Services.GuildState.GuildStateService(this);
svcList.Add(_svcGuildState);
_svcCommonFunctions = new Services.CommonFunctions.CommonFunctionsService(this);
return svcList.AsReadOnly();
}

12
Kerobot/ModuleBase.cs
View file

@ -93,6 +93,11 @@ namespace Kerobot
protected Task<BanKickResult> BanAsync(SocketGuild guild, string source, ulong targetUser, int purgeDays, string reason, string dmMsg)
=> Kerobot.BanOrKickAsync(RemovalType.Ban, guild, source, targetUser, purgeDays, reason, dmMsg);
/// <summary>
/// Similar to <see cref="BanAsync(SocketGuild, string, ulong, int, string, string)"/>, but making use of an
/// EntityCache lookup to determine the target.
/// </summary>
/// <param name="targetSearch">The EntityCache search string.</param>
protected Task<BanKickResult> BanAsync(SocketGuild guild, SocketGuildUser source, string targetSearch, string reason, string dmMsg)
{
// TODO requires EntityCache lookup. Do this when that feature gets implemented.
@ -116,7 +121,12 @@ namespace Kerobot
protected Task<BanKickResult> KickAsync(SocketGuild guild, string source, ulong targetUser, string reason, string dmMsg)
=> Kerobot.BanOrKickAsync(RemovalType.Ban, guild, source, targetUser, 0, reason, dmMsg);
protected Task<BanKickResult> KickAsync(SocketGuild guild, SocketUser user, string reason, string dmMsg)
/// <summary>
/// Similar to <see cref="KickAsync(SocketGuild, string, ulong, string, string)"/>, but making use of an
/// EntityCache lookup to determine the target.
/// </summary>
/// <param name="targetSearch">The EntityCache search string.</param>
protected Task<BanKickResult> KickAsync(SocketGuild guild, string source, string targetSearch, string reason, string dmMsg)
{
// TODO requires EntityCache lookup. Do this when that feature gets implemented.
throw new NotImplementedException();

10
Kerobot/Services/EntityCache/EntityCacheService.cs Normal file
View file

@ -0,0 +1,10 @@
using System;
namespace Kerobot.Services.EntityCache
{
public class EntityCacheService
{
public EntityCacheService()
{
}
}
}

16
Kerobot/Services/UserCache/UserCacheService.cs Normal file
View file

@ -0,0 +1,16 @@
using System;
namespace Kerobot.Services.EntityCache
{
/// <summary>
/// Provides and maintains a database-backed cache of users.
/// It is meant to work as an addition to Discord.Net's own user caching capabilities, and its main purpose
/// is to be able to provide basic information on users which the bot may not currently be aware about.
/// </summary>
class EntityCacheService : Service
{
public EntityCacheService(Kerobot kb) : base(kb)
{
}
}
}