diff --git a/CodeDocumentation/SharedLibraryCore/ColorCode.md b/CodeDocumentation/SharedLibraryCore/ColorCode.md index f4f77cd..92740cf 100644 --- a/CodeDocumentation/SharedLibraryCore/ColorCode.md +++ b/CodeDocumentation/SharedLibraryCore/ColorCode.md @@ -33,7 +33,7 @@ Microsoft.AspNetCore.Razor.TagHelpers.TagHelper --> SharedLibraryCore.ColorCode ### Constructors #### ColorCode -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/TagHelpers/ColorCode.cs#L13) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/BaseRConParser.cs#L130) ```csharp public ColorCode(ApplicationConfiguration appConfig) ``` @@ -44,7 +44,7 @@ public ColorCode(ApplicationConfiguration appConfig) ### Methods #### Process -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/TagHelpers/ColorCode.cs#L21) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/DynamicRConParserConfiguration.cs#L16) ```csharp public override void Process(TagHelperContext context, TagHelperOutput output) ``` diff --git a/CodeDocumentation/SharedLibraryCore/DvarT.md b/CodeDocumentation/SharedLibraryCore/DvarT.md index 45119f1..55829fa 100644 --- a/CodeDocumentation/SharedLibraryCore/DvarT.md +++ b/CodeDocumentation/SharedLibraryCore/DvarT.md @@ -25,6 +25,7 @@ ## Details ### Constructors #### Dvar +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IW4MServer.cs#L985) ```csharp public Dvar() ``` diff --git a/CodeDocumentation/SharedLibraryCore/GameEvent.md b/CodeDocumentation/SharedLibraryCore/GameEvent.md index e228ca0..5bc522e 100644 --- a/CodeDocumentation/SharedLibraryCore/GameEvent.md +++ b/CodeDocumentation/SharedLibraryCore/GameEvent.md @@ -61,30 +61,32 @@ SharedLibraryCore.Events.CoreEvent --> SharedLibraryCore.GameEvent ### Constructors #### GameEvent -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Events/GameEvent.cs#L260) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IW4MServer.cs#L1017) ```csharp public GameEvent() ``` ### Methods #### Finalize -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Events/GameEvent.cs#L277) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IW4MServer.cs#L1032) ```csharp protected override void Finalize() ``` #### Complete -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Events/GameEvent.cs#L313) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IW4MServer.cs#L1754) ```csharp public void Complete() ``` #### WaitAsync [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IW4MServer.cs#L1755) ```csharp public async Task WaitAsync() ``` #### WaitAsync [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/ApplicationManager.cs#L48) ```csharp public async Task WaitAsync(TimeSpan timeSpan, CancellationToken token) ``` diff --git a/CodeDocumentation/SharedLibraryCore/Gametype.md b/CodeDocumentation/SharedLibraryCore/Gametype.md index 94770b5..7ecb0df 100644 --- a/CodeDocumentation/SharedLibraryCore/Gametype.md +++ b/CodeDocumentation/SharedLibraryCore/Gametype.md @@ -21,6 +21,7 @@ ## Details ### Constructors #### Gametype +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/ApplicationManager.cs#L51) ```csharp public Gametype() ``` diff --git a/CodeDocumentation/SharedLibraryCore/Map.md b/CodeDocumentation/SharedLibraryCore/Map.md index 6cbd705..d4d7ca2 100644 --- a/CodeDocumentation/SharedLibraryCore/Map.md +++ b/CodeDocumentation/SharedLibraryCore/Map.md @@ -27,13 +27,14 @@ ## Details ### Constructors #### Map +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/ApplicationManager.cs#L57) ```csharp public Map() ``` ### Methods #### ToString -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Game/Map.cs#L9) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/ApplicationManager.cs#L56) ```csharp public override string ToString() ``` diff --git a/CodeDocumentation/SharedLibraryCore/Server.md b/CodeDocumentation/SharedLibraryCore/Server.md index d772755..8bfe651 100644 --- a/CodeDocumentation/SharedLibraryCore/Server.md +++ b/CodeDocumentation/SharedLibraryCore/Server.md @@ -114,7 +114,7 @@ SharedLibraryCore.Interfaces.IGameServer --> SharedLibraryCore.Server ### Constructors #### Server -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L103) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/ApplicationManager.cs#L57) ```csharp public Server(ILogger logger, ILogger deprecatedLogger, ServerConfiguration config, IManager mgr, IRConConnectionFactory rconConnectionFactory, IGameLogReaderFactory gameLogReaderFactory, IServiceProvider serviceProvider) ``` @@ -131,6 +131,7 @@ public Server(ILogger logger, ILogger deprecatedLogger, ServerConfigurat ### Methods #### Kick [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/PageList.cs#L21) ```csharp public abstract Task Kick(string reason, EFClient target, EFClient origin, EFPenalty originalPenalty) ``` @@ -140,9 +141,10 @@ public abstract Task Kick(string reason, EFClient target, EFClient origin, EFPen | `string` | reason | | | [`EFClient`](database/models/EFClient.md) | target | | | [`EFClient`](database/models/EFClient.md) | origin | | -| `EFPenalty` | originalPenalty | | +| [`EFPenalty`](../data/models/EFPenalty.md) | originalPenalty | | #### ExecuteCommandAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/BaseRConParser.cs#L76) ```csharp public abstract Task ExecuteCommandAsync(string command, CancellationToken token) ``` @@ -153,6 +155,7 @@ public abstract Task ExecuteCommandAsync(string command, CancellationTok | `CancellationToken` | token | | #### SetDvarAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/BaseRConParser.cs#L75) ```csharp public abstract Task SetDvarAsync(string name, object value, CancellationToken token) ``` @@ -164,7 +167,7 @@ public abstract Task SetDvarAsync(string name, object value, CancellationToken t | `CancellationToken` | token | | #### GetClientsAsList -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L176) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/BaseRConParser.cs#L75) ```csharp public List GetClientsAsList() ``` @@ -175,6 +178,7 @@ Returns list of all current players #### OnClientConnected +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/BaseRConParser.cs#L76) ```csharp public abstract Task OnClientConnected(EFClient P) ``` @@ -190,6 +194,7 @@ Add a player to the server's player list True if player added successfully, false otherwise #### OnClientDisconnected +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/BaseRConParser.cs#L76) ```csharp public abstract Task OnClientDisconnected(EFClient client) ``` @@ -205,7 +210,7 @@ Remove player by client number true if removal succeeded, false otherwise #### GetClientByName -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L16707566) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/BaseRConParser.cs#L77) ```csharp public List GetClientByName(string pName) ``` @@ -222,7 +227,7 @@ Get a player by name Matching player if found #### ProcessUpdatesAsync -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L229) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/BaseRConParser.cs#L77) ```csharp public virtual Task ProcessUpdatesAsync(CancellationToken token) ``` @@ -232,6 +237,7 @@ public virtual Task ProcessUpdatesAsync(CancellationToken token) | `CancellationToken` | token | | #### ProcessEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/BaseRConParser.cs#L78) ```csharp protected abstract Task ProcessEvent(GameEvent E) ``` @@ -247,6 +253,7 @@ Process any server event True on sucess #### ExecuteEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/BaseRConParser.cs#L78) ```csharp public abstract Task ExecuteEvent(GameEvent E) ``` @@ -256,7 +263,7 @@ public abstract Task ExecuteEvent(GameEvent E) | [`GameEvent`](./GameEvent.md) | E | | #### Broadcast [1/2] -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L248) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/BaseRConParser.cs#L79) ```csharp public GameEvent Broadcast(string message, EFClient sender) ``` @@ -270,7 +277,7 @@ public GameEvent Broadcast(string message, EFClient sender) Send a message to all players #### Broadcast [2/2] -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L270) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/BaseRConParser.cs#L79) ```csharp public void Broadcast(IEnumerable messages, EFClient sender) ``` @@ -281,6 +288,7 @@ public void Broadcast(IEnumerable messages, EFClient sender) | [`EFClient`](database/models/EFClient.md) | sender | | #### BroadcastAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/BaseRConParser.cs#L80) ```csharp public async Task BroadcastAsync(IEnumerable messages, EFClient sender, CancellationToken token) ``` @@ -292,6 +300,7 @@ public async Task BroadcastAsync(IEnumerable messages, EFClient sender, | `CancellationToken` | token | | #### Tell +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/BaseRConParser.cs#L80) ```csharp protected async Task Tell(string message, EFClient targetClient) ``` @@ -305,7 +314,7 @@ protected async Task Tell(string message, EFClient targetClient) Send a message to a particular players #### ToAdmins -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L343) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/BaseRConParser.cs#L81) ```csharp public void ToAdmins(string message) ``` @@ -318,7 +327,7 @@ public void ToAdmins(string message) Send a message to all admins on the server #### Kick [2/2] -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L356) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/BaseRConParser.cs#L81) ```csharp public Task Kick(string reason, EFClient target, EFClient origin) ``` @@ -363,6 +372,7 @@ public abstract Task Ban(string reason, EFClient target, EFClient origin, bool i Perm ban a player from the server #### Warn +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/BaseRConParser.cs#L16707566) ```csharp public abstract Task Warn(string reason, EFClient target, EFClient origin) ``` @@ -391,6 +401,7 @@ Unban a player by npID / GUID #### LoadMap +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/BaseRConParser.cs#L187) ```csharp public async Task LoadMap(string mapName) ``` @@ -410,7 +421,7 @@ public abstract void InitializeTokens() Initalize the macro variables #### InitializeAutoMessages -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L407) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/BaseRConParser.cs#L16707566) ```csharp protected void InitializeAutoMessages() ``` @@ -418,17 +429,19 @@ protected void InitializeAutoMessages() Initialize the messages to be broadcasted #### ToString -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L419) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/BaseRConParser.cs#L251) ```csharp public override string ToString() ``` #### ScriptLoaded +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/BaseRConParser.cs#L358) ```csharp protected async Task ScriptLoaded() ``` #### GetIdForServer +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/BaseRConParser.cs#L367) ```csharp public abstract Task GetIdForServer(Server server) ``` @@ -438,7 +451,7 @@ public abstract Task GetIdForServer(Server server) | [`Server`](sharedlibrarycore/Server.md) | server | | #### GetClientByNumber -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L16707566) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/BaseRConParser.cs#L372) ```csharp public EFClient GetClientByNumber(int clientNumber) ``` diff --git a/CodeDocumentation/SharedLibraryCore/Utilities.md b/CodeDocumentation/SharedLibraryCore/Utilities.md index d4f8a8b..55eaf49 100644 --- a/CodeDocumentation/SharedLibraryCore/Utilities.md +++ b/CodeDocumentation/SharedLibraryCore/Utilities.md @@ -27,7 +27,7 @@ | Returns | Name | | --- | --- | | `IServiceCollection` | [`AddConfiguration`](#addconfiguration)(`IServiceCollection` serviceCollection, `string` fileName, `TConfigurationType` defaultConfig) | -| `double``[]` | [`AngleStuff`](#anglestuff)(`Vector3` a, `Vector3` b) | +| `double``[]` | [`AngleStuff`](#anglestuff)([`Vector3`](../data/models/Vector3.md) a, [`Vector3`](../data/models/Vector3.md) b) | | [`EFClient`](database/models/EFClient.md) | [`AsConsoleClient`](#asconsoleclient)([`IGameServer`](interfaces/IGameServer.md) server) | | `string` | [`CapClientName`](#capclientname)(`string` name, `int` maxLength)
caps client name to the specified character length - 3
and adds ellipses to the end of the remaining client name | | `long` | [`ConvertGuidToLong`](#convertguidtolong-12)(`...`) | @@ -39,7 +39,7 @@ | `Task`<`string``[]`> | [`ExecuteCommandAsync`](#executecommandasync-12)(`...`) | | `string` | [`FindRuleForReason`](#findruleforreason)(`string` reason, [`ApplicationConfiguration`](configuration/ApplicationConfiguration.md) appConfig, [`Server`](./Server.md) server) | | `string` | [`FixDirectoryCharacters`](#fixdirectorycharacters)(`string` path)
replaces any directory separator chars with the platform specific character | -| `Vector3` | [`FixIW4Angles`](#fixiw4angles)(`Vector3` vector) | +| [`Vector3`](../data/models/Vector3.md) | [`FixIW4Angles`](#fixiw4angles)([`Vector3`](../data/models/Vector3.md) vector) | | `string` | [`FixIW4ForwardSlash`](#fixiw4forwardslash)(`string` str)
returns a "fixed" string that prevents message truncation in IW4 (and probably other Q3 clients) | | `string` | [`FormatExt`](#formatext)(`string` input, `object``[]` values) | | `string` | [`FormatMessageForEngine`](#formatmessageforengine)(`string` str, [`IRConParserConfiguration`](interfaces/IRConParserConfiguration.md) config) | @@ -86,12 +86,12 @@ | `float` | [`ToDegrees`](#todegrees)(`float` value) | | `string` | [`ToLocalizedLevelName`](#tolocalizedlevelname)(`Permission` permission) | | `string` | [`ToNumericalString`](#tonumericalstring-14)(`...`) | -| [`EFClient`](database/models/EFClient.md) | [`ToPartialClient`](#topartialclient)(`EFClient` client) | +| [`EFClient`](database/models/EFClient.md) | [`ToPartialClient`](#topartialclient)([`EFClient`](../data/models/client/EFClient.md) client) | | `float` | [`ToRadians`](#toradians)(`float` value) | | `string` | [`ToStandardFormat`](#tostandardformat-12)(`...`) | | `string` | [`ToTranslatedName`](#totranslatedname)([`MetaType`](interfaces/MetaType.md) metaType) | | `string` | [`TrimNewLine`](#trimnewline)(`string` str)
trims new line and whitespace from string | -| `Task`<`bool`> | [`TryCreatePenalty`](#trycreatepenalty)(`EFPenalty` penalty, [`IEntityService`](interfaces/IEntityServiceT.md)<`EFPenalty`> penaltyService, `ILogger` logger) | +| `Task`<`bool`> | [`TryCreatePenalty`](#trycreatepenalty)([`EFPenalty`](../data/models/EFPenalty.md) penalty, [`IEntityService`](interfaces/IEntityServiceT.md)<[`EFPenalty`](../data/models/EFPenalty.md)> penaltyService, `ILogger` logger) | | `Task`<`T`> | [`WithTimeout`](#withtimeout-12)(`...`) | | `Task` | [`WithWaitCancellation`](#withwaitcancellation-12)(`...`)
https://www.planetgeek.ch/2016/12/08/async-method-without-cancellation-support-do-it-my-way/ | @@ -104,7 +104,7 @@ ## Details ### Methods #### ToStandardFormat [1/2] -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L53) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/DynamicRConParserConfiguration.cs#L20) ```csharp public static string ToStandardFormat(Nullable time) ``` @@ -114,7 +114,7 @@ public static string ToStandardFormat(Nullable time) | `Nullable`<`DateTime`> | time | | #### ToStandardFormat [2/2] -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L54) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/DynamicRConParserConfiguration.cs#L21) ```csharp public static string ToStandardFormat(DateTime time) ``` @@ -124,7 +124,7 @@ public static string ToStandardFormat(DateTime time) | `DateTime` | time | | #### IW4MAdminClient -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L57) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/DynamicRConParserConfiguration.cs#L21) ```csharp public static EFClient IW4MAdminClient(Server server) ``` @@ -134,7 +134,7 @@ public static EFClient IW4MAdminClient(Server server) | [`Server`](./Server.md) | server | | #### AsConsoleClient -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L73) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/DynamicRConParserConfiguration.cs#L22) ```csharp public static EFClient AsConsoleClient(IGameServer server) ``` @@ -144,7 +144,7 @@ public static EFClient AsConsoleClient(IGameServer server) | [`IGameServer`](interfaces/IGameServer.md) | server | | #### RemoveWords -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L97) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/DynamicRConParserConfiguration.cs#L23) ```csharp public static string RemoveWords(string str, int num) ``` @@ -155,7 +155,7 @@ public static string RemoveWords(string str, int num) | `int` | num | | #### CapClientName -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L123) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/DynamicRConParserConfiguration.cs#L23) ```csharp public static string CapClientName(string name, int maxLength) ``` @@ -173,7 +173,7 @@ caps client name to the specified character length - 3 #### MatchPermission -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L133) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/DynamicRConParserConfiguration.cs#L24) ```csharp public static Permission MatchPermission(string str) ``` @@ -183,7 +183,7 @@ public static Permission MatchPermission(string str) | `string` | str | | #### StripColors -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L153) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/DynamicRConParserConfiguration.cs#L24) ```csharp public static string StripColors(string str) ``` @@ -199,7 +199,7 @@ Remove all IW Engine color codes #### FixIW4ForwardSlash -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L170) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/DynamicRConParserConfiguration.cs#L25) ```csharp public static string FixIW4ForwardSlash(string str) ``` @@ -215,7 +215,7 @@ returns a "fixed" string that prevents message truncation in IW4 (and probably o #### RemoveDiacritics -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L175) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/DynamicRConParserConfiguration.cs#L25) ```csharp public static string RemoveDiacritics(string text) ``` @@ -225,7 +225,7 @@ public static string RemoveDiacritics(string text) | `string` | text | | #### FormatMessageForEngine -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L191) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/DynamicRConParserConfiguration.cs#L26) ```csharp public static string FormatMessageForEngine(string str, IRConParserConfiguration config) ``` @@ -236,7 +236,7 @@ public static string FormatMessageForEngine(string str, IRConParserConfiguration | [`IRConParserConfiguration`](interfaces/IRConParserConfiguration.md) | config | | #### IsZombieServer -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L223) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/DynamicRConParserConfiguration.cs#L26) ```csharp public static bool IsZombieServer(Server server) ``` @@ -252,7 +252,7 @@ indicates if the given server is running a zombie game mode #### IsCodGame -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L229) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/DynamicRConParserConfiguration.cs#L27) ```csharp public static bool IsCodGame(Server server) ``` @@ -262,7 +262,7 @@ public static bool IsCodGame(Server server) | [`Server`](./Server.md) | server | | #### ConvertLevelToColor -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L240) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/DynamicRConParserConfiguration.cs#L27) ```csharp public static string ConvertLevelToColor(Permission level, string localizedLevel) ``` @@ -273,7 +273,7 @@ public static string ConvertLevelToColor(Permission level, string localizedLevel | `string` | localizedLevel | | #### ToLocalizedLevelName -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L256) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/DynamicRConParserConfiguration.cs#L28) ```csharp public static string ToLocalizedLevelName(Permission permission) ``` @@ -283,6 +283,7 @@ public static string ToLocalizedLevelName(Permission permission) | `Permission` | permission | | #### ProcessMessageToken +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/DynamicRConParserConfiguration.cs#L28) ```csharp public static async Task ProcessMessageToken(Server server, IList tokens, string str) ``` @@ -294,7 +295,7 @@ public static async Task ProcessMessageToken(Server server, IList fallback) ``` @@ -333,7 +334,7 @@ public static long ConvertGuidToLong(string str, NumberStyles numberStyle, Nulla | `Nullable`<`long`> | fallback | | #### ConvertGuidToLong [2/2] -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L358) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/DynamicRConParserConfiguration.cs#L30) ```csharp public static long ConvertGuidToLong(string str, NumberStyles numberStyle, bool convertSigned, Nullable fallback) ``` @@ -346,7 +347,7 @@ public static long ConvertGuidToLong(string str, NumberStyles numberStyle, bool | `Nullable`<`long`> | fallback | | #### IsBotGuid -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L419) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/DynamicRConParserConfiguration.cs#L31) ```csharp public static bool IsBotGuid(string guid) ``` @@ -363,7 +364,7 @@ determines if the guid provided appears to be a bot guid true if is bot guid, otherwise false #### GenerateGuidFromString -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L429) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/DynamicRConParserConfiguration.cs#L31) ```csharp public static long GenerateGuidFromString(string value) ``` @@ -379,7 +380,7 @@ generates a numerical hashcode from a string value #### GetStableHashCode -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L435) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/DynamicRConParserConfiguration.cs#L32) ```csharp public static int GetStableHashCode(string str) ``` @@ -389,7 +390,7 @@ public static int GetStableHashCode(string str) | `string` | str | | #### ConvertToIP -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L457) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/DynamicRConParserConfiguration.cs#L32) ```csharp public static Nullable ConvertToIP(string str) ``` @@ -399,7 +400,7 @@ public static Nullable ConvertToIP(string str) | `string` | str | | #### ConvertIPtoString -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L465) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/DynamicRConParserConfiguration.cs#L33) ```csharp public static string ConvertIPtoString(Nullable ip) ``` @@ -409,7 +410,7 @@ public static string ConvertIPtoString(Nullable ip) | `Nullable`<`int`> | ip | | #### GetGame -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L470) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/DynamicRConParserConfiguration.cs#L33) ```csharp public static Game GetGame(string gameName) ``` @@ -419,7 +420,7 @@ public static Game GetGame(string gameName) | `string` | gameName | | #### ParseTimespan -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L510) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/DynamicRConParserConfiguration.cs#L34) ```csharp public static TimeSpan ParseTimespan(string input) ``` @@ -429,7 +430,7 @@ public static TimeSpan ParseTimespan(string input) | `string` | input | | #### HasPermission [1/2] -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L16707566) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/DynamicRConParserConfiguration.cs#L34) ```csharp public static bool HasPermission(IEnumerable permissionsSet, TEntity entity, TPermission permission) where TEntity : Enum @@ -443,7 +444,7 @@ where TPermission : Enum | `TPermission` | permission | | #### HasPermission [2/2] -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L589) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/DynamicRConParserConfiguration.cs#L35) ```csharp public static bool HasPermission(ApplicationConfiguration appConfig, Permission permissionLevel, TEntity entity, TPermission permission) where TEntity : Enum @@ -458,7 +459,7 @@ where TPermission : Enum | `TPermission` | permission | | #### LinkedPenaltyTypes -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L599) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/DynamicRConParserConfiguration.cs#L35) ```csharp public static PenaltyType LinkedPenaltyTypes() ``` @@ -469,7 +470,7 @@ returns a list of penalty types that should be shown across all profiles #### IsPrivileged -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L616) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/DynamicRConParserConfiguration.cs#L36) ```csharp public static bool IsPrivileged(EFClient p) ``` @@ -485,7 +486,7 @@ Helper extension that determines if a user is a privileged client #### PromptBool -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L628) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/DynamicRConParserConfiguration.cs#L36) ```csharp public static bool PromptBool(string question, string description, bool defaultValue) ``` @@ -503,7 +504,7 @@ prompt user to answer a yes/no question #### PromptSelection -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L645) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/DynamicRConParserConfiguration.cs#L38) ```csharp public static Tuple PromptSelection(string question, T defaultValue, string description, T[] selections) where T : @@ -517,7 +518,7 @@ where T : | `T``[]` | selections | | #### PromptInt -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L16707566) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/DynamicRConParserConfiguration.cs#L38) ```csharp public static int PromptInt(string question, string description, int minValue, int maxValue, Nullable defaultValue) ``` @@ -531,7 +532,7 @@ public static int PromptInt(string question, string description, int minValue, i | `Nullable`<`int`> | defaultValue | | #### PromptString -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L16707566) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/DynamicRConParserConfiguration.cs#L25) ```csharp public static string PromptString(string question, string description, string defaultValue) ``` @@ -549,7 +550,7 @@ prompt use to enter a string response #### DictionaryFromKeyValue -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L738) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/StatusResponse.cs#L9) ```csharp public static Dictionary DictionaryFromKeyValue(string eventLine) ``` @@ -559,7 +560,7 @@ public static Dictionary DictionaryFromKeyValue(string eventLine | `string` | eventLine | | #### GetCommandLine -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L761) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/StatusResponse.cs#L9) ```csharp public static string GetCommandLine(int pId) ``` @@ -569,7 +570,7 @@ public static string GetCommandLine(int pId) | `int` | pId | | #### IsRemoteLog -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L789) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/StatusResponse.cs#L10) ```csharp public static bool IsRemoteLog(string log) ``` @@ -585,7 +586,7 @@ indicates if the given log path is a remote (http) uri #### ToBase64UrlSafeString -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L794) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/StatusResponse.cs#L10) ```csharp public static string ToBase64UrlSafeString(string src) ``` @@ -595,6 +596,7 @@ public static string ToBase64UrlSafeString(string src) | `string` | src | | #### GetDvarAsync [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/StatusResponse.cs#L11) ```csharp public static async Task> GetDvarAsync(Server server, string dvarName, T fallbackValue, CancellationToken token) where T : @@ -608,6 +610,7 @@ where T : | `CancellationToken` | token | | #### GetDvarAsync [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/StatusResponse.cs#L11) ```csharp public static async Task> GetDvarAsync(Server server, string dvarName, T fallbackValue) where T : @@ -620,6 +623,7 @@ where T : | `T` | fallbackValue | | #### GetMappedDvarValueOrDefaultAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/StatusResponse.cs#L12) ```csharp public static async Task> GetMappedDvarValueOrDefaultAsync(Server server, string dvarName, string infoResponseName, IDictionary infoResponse, T overrideDefault, CancellationToken token) where T : @@ -635,6 +639,7 @@ where T : | `CancellationToken` | token | | #### SetDvarAsync [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/StatusResponse.cs#L12) ```csharp public static async Task SetDvarAsync(Server server, string dvarName, object dvarValue, CancellationToken token) ``` @@ -647,6 +652,7 @@ public static async Task SetDvarAsync(Server server, string dvarName, object dva | `CancellationToken` | token | | #### SetDvarAsync [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/StatusResponse.cs#L13) ```csharp public static async Task SetDvarAsync(Server server, string dvarName, object dvarValue) ``` @@ -658,6 +664,7 @@ public static async Task SetDvarAsync(Server server, string dvarName, object dva | `object` | dvarValue | | #### ExecuteCommandAsync [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/StatusResponse.cs#L13) ```csharp public static async Task ExecuteCommandAsync(Server server, string commandName, CancellationToken token) ``` @@ -679,6 +686,7 @@ public static async Task ExecuteCommandAsync(Server server, string comma | `string` | commandName | | #### GetStatusAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/QueryHelpers/ClientResourceQueryHelper.cs#L30) ```csharp public static async Task GetStatusAsync(Server server, CancellationToken token) ``` @@ -711,7 +719,7 @@ public static string GetVersionAsString() ``` #### FormatExt -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L913) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/QueryHelpers/ClientResourceQueryHelper.cs#L16707566) ```csharp public static string FormatExt(string input, object[] values) ``` @@ -722,7 +730,7 @@ public static string FormatExt(string input, object[] values) | `object``[]` | values | | #### IsInternal -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L940) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/QueryHelpers/ClientResourceQueryHelper.cs#L16707566) ```csharp public static bool IsInternal(IPAddress toTest) ``` @@ -739,6 +747,7 @@ https://stackoverflow.com/questions/8113546/how-to-determine-whether-an-ip-addre Returns true if the IP is internal, false if it is external #### GetExternalIP +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/QueryHelpers/ClientResourceQueryHelper.cs#L16707566) ```csharp public static async Task GetExternalIP() ``` @@ -749,7 +758,7 @@ retrieves the external IP address of the current running machine #### IsQuickMessage -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L986) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/QueryHelpers/ClientResourceQueryHelper.cs#L180) ```csharp public static bool IsQuickMessage(string message) ``` @@ -765,7 +774,7 @@ Determines if the given message is a quick message true if the #### TrimNewLine -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L996) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/QueryHelpers/ClientResourceQueryHelper.cs#L16707566) ```csharp public static string TrimNewLine(string str) ``` @@ -781,17 +790,17 @@ trims new line and whitespace from string #### FixIW4Angles -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1001) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/QueryHelpers/ClientResourceQueryHelper.cs#L16707566) ```csharp public static Vector3 FixIW4Angles(Vector3 vector) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| `Vector3` | vector | | +| [`Vector3`](../data/models/Vector3.md) | vector | | #### ToRadians -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1010) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/QueryHelpers/ClientResourceQueryHelper.cs#L16707566) ```csharp public static float ToRadians(float value) ``` @@ -801,7 +810,7 @@ public static float ToRadians(float value) | `float` | value | | #### ToDegrees -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1015) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/QueryHelpers/ClientResourceQueryHelper.cs#L16707566) ```csharp public static float ToDegrees(float value) ``` @@ -811,28 +820,30 @@ public static float ToDegrees(float value) | `float` | value | | #### AngleStuff -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1020) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/QueryHelpers/ClientResourceQueryHelper.cs#L16707566) ```csharp public static double AngleStuff(Vector3 a, Vector3 b) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| `Vector3` | a | | -| `Vector3` | b | | +| [`Vector3`](../data/models/Vector3.md) | a | | +| [`Vector3`](../data/models/Vector3.md) | b | | #### TryCreatePenalty +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/QueryHelpers/ClientResourceQueryHelper.cs#L16707566) ```csharp public static async Task TryCreatePenalty(EFPenalty penalty, IEntityService penaltyService, ILogger logger) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| `EFPenalty` | penalty | | -| [`IEntityService`](interfaces/IEntityServiceT.md)<`EFPenalty`> | penaltyService | | +| [`EFPenalty`](../data/models/EFPenalty.md) | penalty | | +| [`IEntityService`](interfaces/IEntityServiceT.md)<[`EFPenalty`](../data/models/EFPenalty.md)> | penaltyService | | | `ILogger` | logger | | #### WithWaitCancellation [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/QueryHelpers/ClientResourceQueryHelper.cs#L16707566) ```csharp public static async Task WithWaitCancellation(Task task, CancellationToken cancellationToken) ``` @@ -846,6 +857,7 @@ public static async Task WithWaitCancellation(Task task, CancellationToken cance https://www.planetgeek.ch/2016/12/08/async-method-without-cancellation-support-do-it-my-way/ #### WithWaitCancellation [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/PluginImporter.cs#L30) ```csharp public static async Task WithWaitCancellation(Task task, CancellationToken cancellationToken) where T : @@ -857,6 +869,7 @@ where T : | `CancellationToken` | cancellationToken | | #### WithTimeout [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/PluginImporter.cs#L44) ```csharp public static async Task WithTimeout(Task task, TimeSpan timeout) where T : @@ -868,6 +881,7 @@ where T : | `TimeSpan` | timeout | | #### WithTimeout [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/PluginImporter.cs#L78) ```csharp public static async Task WithTimeout(Task task, TimeSpan timeout) ``` @@ -878,7 +892,7 @@ public static async Task WithTimeout(Task task, TimeSpan timeout) | `TimeSpan` | timeout | | #### ShouldHideLevel -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1094) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/PluginImporter.cs#L152) ```csharp public static bool ShouldHideLevel(Permission perm) ``` @@ -888,7 +902,7 @@ public static bool ShouldHideLevel(Permission perm) | `Permission` | perm | | #### SplitTranslationTokens -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1104) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/PluginImporter.cs#L169) ```csharp public static WebfrontTranslationHelper SplitTranslationTokens(string translationKey) ``` @@ -904,7 +918,7 @@ parses translation string into tokens that are able to be formatted by the webfr #### FixDirectoryCharacters -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1156) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/PluginImporter.cs#L56) ```csharp public static string FixDirectoryCharacters(string path) ``` @@ -920,7 +934,7 @@ replaces any directory separator chars with the platform specific character #### HumanizeForCurrentCulture [1/2] -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1169) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptCommand.cs#L28) ```csharp public static string HumanizeForCurrentCulture(TimeSpan timeSpan, int precision, TimeUnit maxUnit, TimeUnit minUnit, string collectionSeparator, bool toWords) ``` @@ -951,7 +965,7 @@ public static string HumanizeForCurrentCulture(DateTime input, bool utcDate, Nul | `CultureInfo` | culture | | #### ToTranslatedName -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1184) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPlugin.cs#L35) ```csharp public static string ToTranslatedName(MetaType metaType) ``` @@ -961,17 +975,17 @@ public static string ToTranslatedName(MetaType metaType) | [`MetaType`](interfaces/MetaType.md) | metaType | | #### ToPartialClient -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1189) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPlugin.cs#L35) ```csharp public static EFClient ToPartialClient(EFClient client) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| `EFClient` | client | | +| [`EFClient`](../data/models/client/EFClient.md) | client | | #### ToNumericalString [1/4] -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1215) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPlugin.cs#L37) ```csharp public static string ToNumericalString(Nullable value) ``` @@ -981,7 +995,7 @@ public static string ToNumericalString(Nullable value) | `Nullable`<`int`> | value | | #### ToNumericalString [2/4] -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1220) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPlugin.cs#L37) ```csharp public static string ToNumericalString(int value) ``` @@ -991,7 +1005,7 @@ public static string ToNumericalString(int value) | `int` | value | | #### ToNumericalString [3/4] -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1225) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPlugin.cs#L39) ```csharp public static string ToNumericalString(double value, int precision) ``` @@ -1002,7 +1016,7 @@ public static string ToNumericalString(double value, int precision) | `int` | precision | | #### ToNumericalString [4/4] -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1232) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPlugin.cs#L39) ```csharp public static string ToNumericalString(Nullable value, int precision) ``` @@ -1013,7 +1027,7 @@ public static string ToNumericalString(Nullable value, int precision) | `int` | precision | | #### FragmentMessageForDisplay -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1237) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPlugin.cs#L44) ```csharp public static string FragmentMessageForDisplay(string message) ``` @@ -1023,7 +1037,7 @@ public static string FragmentMessageForDisplay(string message) | `string` | message | | #### FindRuleForReason -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L16707566) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPlugin.cs#L44) ```csharp public static string FindRuleForReason(string reason, ApplicationConfiguration appConfig, Server server) ``` @@ -1035,7 +1049,7 @@ public static string FindRuleForReason(string reason, ApplicationConfiguration a | [`Server`](./Server.md) | server | | #### MakeAbbreviation -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1294) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPlugin.cs#L46) ```csharp public static string MakeAbbreviation(string gameName) ``` @@ -1045,7 +1059,7 @@ public static string MakeAbbreviation(string gameName) | `string` | gameName | | #### AddConfiguration -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L16707566) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPlugin.cs#L50) ```csharp public static IServiceCollection AddConfiguration(IServiceCollection serviceCollection, string fileName, TConfigurationType defaultConfig) where TConfigurationType : @@ -1058,7 +1072,7 @@ where TConfigurationType : | `TConfigurationType` | defaultConfig | | #### ExecuteAfterDelay [1/3] -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1337) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPlugin.cs#L71) ```csharp public static void ExecuteAfterDelay(TimeSpan duration, Func action, CancellationToken token) ``` @@ -1094,7 +1108,7 @@ public static void ExecuteAfterDelay(Func action, int d | `CancellationToken` | token | | #### g__InputOrDefault|55_0 -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L690) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPlugin.cs#L297) ```csharp internal static string g__InputOrDefault|55_0() ``` diff --git a/CodeDocumentation/SharedLibraryCore/commands/CommandArgument.md b/CodeDocumentation/SharedLibraryCore/commands/CommandArgument.md index 027b470..660e13d 100644 --- a/CodeDocumentation/SharedLibraryCore/commands/CommandArgument.md +++ b/CodeDocumentation/SharedLibraryCore/commands/CommandArgument.md @@ -27,6 +27,7 @@ Holds information about command args ### Constructors #### CommandArgument +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20180902035612_AddFractionAndIsKill.Designer.cs#L16) ```csharp public CommandArgument() ``` diff --git a/CodeDocumentation/SharedLibraryCore/commands/CommandProcessing.md b/CodeDocumentation/SharedLibraryCore/commands/CommandProcessing.md index 0e99412..d94d652 100644 --- a/CodeDocumentation/SharedLibraryCore/commands/CommandProcessing.md +++ b/CodeDocumentation/SharedLibraryCore/commands/CommandProcessing.md @@ -20,12 +20,14 @@ ## Details ### Constructors #### CommandProcessing +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20180904154622_AddVisibilityPercentage.Designer.cs#L16) ```csharp public CommandProcessing() ``` ### Methods #### ValidateCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20180904154622_AddVisibilityPercentage.cs#L17) ```csharp public static async Task ValidateCommand(GameEvent gameEvent, ApplicationConfiguration appConfig, CommandConfiguration commandConfig) ``` diff --git a/CodeDocumentation/SharedLibraryCore/commands/ExecuteRConCommand.md b/CodeDocumentation/SharedLibraryCore/commands/ExecuteRConCommand.md index a84977a..6646620 100644 --- a/CodeDocumentation/SharedLibraryCore/commands/ExecuteRConCommand.md +++ b/CodeDocumentation/SharedLibraryCore/commands/ExecuteRConCommand.md @@ -48,6 +48,7 @@ public ExecuteRConCommand(CommandConfiguration config, ITranslationLookup transl ### Methods #### ExecuteAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20181125193243_MakeClientIPNullable.cs#L76) ```csharp public override async Task ExecuteAsync(GameEvent E) ``` diff --git a/CodeDocumentation/SharedLibraryCore/commands/FlagClientCommand.md b/CodeDocumentation/SharedLibraryCore/commands/FlagClientCommand.md index 0021c12..fc50a79 100644 --- a/CodeDocumentation/SharedLibraryCore/commands/FlagClientCommand.md +++ b/CodeDocumentation/SharedLibraryCore/commands/FlagClientCommand.md @@ -48,6 +48,7 @@ public FlagClientCommand(CommandConfiguration config, ITranslationLookup transla ### Methods #### ExecuteAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20180922231600_ReaddACSnapshot.cs#L128) ```csharp public override async Task ExecuteAsync(GameEvent E) ``` diff --git a/CodeDocumentation/SharedLibraryCore/commands/KickCommand.md b/CodeDocumentation/SharedLibraryCore/commands/KickCommand.md index 917587a..aa3364b 100644 --- a/CodeDocumentation/SharedLibraryCore/commands/KickCommand.md +++ b/CodeDocumentation/SharedLibraryCore/commands/KickCommand.md @@ -49,6 +49,7 @@ public KickCommand(ApplicationConfiguration appConfig, CommandConfiguration conf ### Methods #### ExecuteAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20180910221749_AddRatingIndexes.Designer.cs#L16) ```csharp public override async Task ExecuteAsync(GameEvent gameEvent) ``` diff --git a/CodeDocumentation/SharedLibraryCore/commands/LoadMapCommand.md b/CodeDocumentation/SharedLibraryCore/commands/LoadMapCommand.md index b295218..b55ac75 100644 --- a/CodeDocumentation/SharedLibraryCore/commands/LoadMapCommand.md +++ b/CodeDocumentation/SharedLibraryCore/commands/LoadMapCommand.md @@ -48,6 +48,7 @@ public LoadMapCommand(CommandConfiguration config, ITranslationLookup translatio ### Methods #### ExecuteAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20180922231310_RemoveACSnapShot.cs#L28) ```csharp public override async Task ExecuteAsync(GameEvent E) ``` diff --git a/CodeDocumentation/SharedLibraryCore/commands/MapRotateCommand.md b/CodeDocumentation/SharedLibraryCore/commands/MapRotateCommand.md index f0c6e2c..01bd374 100644 --- a/CodeDocumentation/SharedLibraryCore/commands/MapRotateCommand.md +++ b/CodeDocumentation/SharedLibraryCore/commands/MapRotateCommand.md @@ -48,6 +48,7 @@ public MapRotateCommand(CommandConfiguration config, ITranslationLookup translat ### Methods #### ExecuteAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20180912015012_AddPreviousCurrentValueToEFChangeHistory.cs#L22) ```csharp public override async Task ExecuteAsync(GameEvent E) ``` diff --git a/CodeDocumentation/SharedLibraryCore/commands/MaskCommand.md b/CodeDocumentation/SharedLibraryCore/commands/MaskCommand.md index a12f44e..51251c8 100644 --- a/CodeDocumentation/SharedLibraryCore/commands/MaskCommand.md +++ b/CodeDocumentation/SharedLibraryCore/commands/MaskCommand.md @@ -48,6 +48,7 @@ public MaskCommand(CommandConfiguration config, ITranslationLookup translationLo ### Methods #### ExecuteAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20181014171848_MakePenaltyExpirationNullable.cs#L96) ```csharp public override async Task ExecuteAsync(GameEvent E) ``` diff --git a/CodeDocumentation/SharedLibraryCore/commands/NextMapCommand.md b/CodeDocumentation/SharedLibraryCore/commands/NextMapCommand.md index c25e2b5..5af6070 100644 --- a/CodeDocumentation/SharedLibraryCore/commands/NextMapCommand.md +++ b/CodeDocumentation/SharedLibraryCore/commands/NextMapCommand.md @@ -53,6 +53,7 @@ public NextMapCommand(CommandConfiguration config, ITranslationLookup translatio ### Methods #### GetNextMap +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20190222234742_AddIndexToEFMeta-KeyAndClientId.cs#L24) ```csharp public static async Task GetNextMap(Server s, ITranslationLookup lookup) ``` @@ -63,6 +64,7 @@ public static async Task GetNextMap(Server s, ITranslationLookup lookup) | [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | lookup | | #### ExecuteAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20190222234742_AddIndexToEFMeta-KeyAndClientId.Designer.cs#L16) ```csharp public override async Task ExecuteAsync(GameEvent E) ``` diff --git a/CodeDocumentation/SharedLibraryCore/commands/OwnerCommand.md b/CodeDocumentation/SharedLibraryCore/commands/OwnerCommand.md index 8d86363..e6dab56 100644 --- a/CodeDocumentation/SharedLibraryCore/commands/OwnerCommand.md +++ b/CodeDocumentation/SharedLibraryCore/commands/OwnerCommand.md @@ -48,6 +48,7 @@ public OwnerCommand(CommandConfiguration config, ITranslationLookup translationL ### Methods #### ExecuteAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20180908004053_AddWhenToRating.cs#L9) ```csharp public override async Task ExecuteAsync(GameEvent E) ``` diff --git a/CodeDocumentation/SharedLibraryCore/commands/PruneAdminsCommand.md b/CodeDocumentation/SharedLibraryCore/commands/PruneAdminsCommand.md index f7fcee4..12bc539 100644 --- a/CodeDocumentation/SharedLibraryCore/commands/PruneAdminsCommand.md +++ b/CodeDocumentation/SharedLibraryCore/commands/PruneAdminsCommand.md @@ -45,10 +45,11 @@ public PruneAdminsCommand(CommandConfiguration config, ITranslationLookup transl | --- | --- | --- | | [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | | | [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | | -| `IDatabaseContextFactory` | contextFactory | | +| [`IDatabaseContextFactory`](../../data/abstractions/IDatabaseContextFactory.md) | contextFactory | | ### Methods #### ExecuteAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20181127144417_AddEndpointToEFServerUpdateServerIdType.cs#L16) ```csharp public override async Task ExecuteAsync(GameEvent E) ``` diff --git a/CodeDocumentation/SharedLibraryCore/commands/QuitCommand.md b/CodeDocumentation/SharedLibraryCore/commands/QuitCommand.md index 38886a3..22db256 100644 --- a/CodeDocumentation/SharedLibraryCore/commands/QuitCommand.md +++ b/CodeDocumentation/SharedLibraryCore/commands/QuitCommand.md @@ -48,6 +48,7 @@ public QuitCommand(CommandConfiguration config, ITranslationLookup translationLo ### Methods #### ExecuteAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20180907020706_AddVision.cs#L8) ```csharp public override async Task ExecuteAsync(GameEvent E) ``` diff --git a/CodeDocumentation/SharedLibraryCore/commands/RestartCommand.md b/CodeDocumentation/SharedLibraryCore/commands/RestartCommand.md index 61d518a..4d2d3a8 100644 --- a/CodeDocumentation/SharedLibraryCore/commands/RestartCommand.md +++ b/CodeDocumentation/SharedLibraryCore/commands/RestartCommand.md @@ -48,6 +48,7 @@ public RestartCommand(CommandConfiguration config, ITranslationLookup translatio ### Methods #### ExecuteAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20180907020706_AddVision.Designer.cs#L16) ```csharp public override async Task ExecuteAsync(GameEvent gameEvent) ``` diff --git a/CodeDocumentation/SharedLibraryCore/commands/RunAsCommand.md b/CodeDocumentation/SharedLibraryCore/commands/RunAsCommand.md index 83d67af..e2a2601 100644 --- a/CodeDocumentation/SharedLibraryCore/commands/RunAsCommand.md +++ b/CodeDocumentation/SharedLibraryCore/commands/RunAsCommand.md @@ -42,6 +42,7 @@ public RunAsCommand(CommandConfiguration config, ITranslationLookup lookup) ### Methods #### ExecuteAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20190615145212_AddAvgRecoilOffset.cs#L8) ```csharp public override async Task ExecuteAsync(GameEvent gameEvent) ``` diff --git a/CodeDocumentation/SharedLibraryCore/commands/TempBanCommand.md b/CodeDocumentation/SharedLibraryCore/commands/TempBanCommand.md index 9b4065a..59c084c 100644 --- a/CodeDocumentation/SharedLibraryCore/commands/TempBanCommand.md +++ b/CodeDocumentation/SharedLibraryCore/commands/TempBanCommand.md @@ -49,6 +49,7 @@ public TempBanCommand(ApplicationConfiguration appConfig, CommandConfiguration c ### Methods #### ExecuteAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20180911184224_AddEFAliasNameIndex.cs#L8) ```csharp public override async Task ExecuteAsync(GameEvent gameEvent) ``` diff --git a/CodeDocumentation/SharedLibraryCore/commands/UnbanCommand.md b/CodeDocumentation/SharedLibraryCore/commands/UnbanCommand.md index 3eeb129..dc1ecf6 100644 --- a/CodeDocumentation/SharedLibraryCore/commands/UnbanCommand.md +++ b/CodeDocumentation/SharedLibraryCore/commands/UnbanCommand.md @@ -48,6 +48,7 @@ public UnbanCommand(CommandConfiguration config, ITranslationLookup translationL ### Methods #### ExecuteAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20180911190823_AddEFAliasNameMaxLength24.cs#L21) ```csharp public override async Task ExecuteAsync(GameEvent gameEvent) ``` diff --git a/CodeDocumentation/SharedLibraryCore/commands/UnlinkClientCommand.md b/CodeDocumentation/SharedLibraryCore/commands/UnlinkClientCommand.md index ad5329c..d41e98b 100644 --- a/CodeDocumentation/SharedLibraryCore/commands/UnlinkClientCommand.md +++ b/CodeDocumentation/SharedLibraryCore/commands/UnlinkClientCommand.md @@ -56,6 +56,7 @@ public UnlinkClientCommand(CommandConfiguration config, ITranslationLookup looku ### Methods #### ExecuteAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20190615145212_AddAvgRecoilOffset.Designer.cs#L16) ```csharp public override async Task ExecuteAsync(GameEvent E) ``` diff --git a/CodeDocumentation/SharedLibraryCore/configuration/DefaultSettings.md b/CodeDocumentation/SharedLibraryCore/configuration/DefaultSettings.md index 29285c5..eb9b003 100644 --- a/CodeDocumentation/SharedLibraryCore/configuration/DefaultSettings.md +++ b/CodeDocumentation/SharedLibraryCore/configuration/DefaultSettings.md @@ -43,6 +43,7 @@ SharedLibraryCore.Interfaces.IBaseConfiguration --> SharedLibraryCore.Configurat ### Constructors #### DefaultSettings +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/Postgresql/20220404185627_AddSearchableIPToEFAlias.Designer.cs#L19) ```csharp public DefaultSettings() ``` diff --git a/CodeDocumentation/SharedLibraryCore/configuration/GameStringConfiguration.md b/CodeDocumentation/SharedLibraryCore/configuration/GameStringConfiguration.md index fe123fb..ad8f98f 100644 --- a/CodeDocumentation/SharedLibraryCore/configuration/GameStringConfiguration.md +++ b/CodeDocumentation/SharedLibraryCore/configuration/GameStringConfiguration.md @@ -27,6 +27,7 @@ System.Collections.Generic.Dictionary_2 --> SharedLibraryCore.Configuration.Game ### Constructors #### GameStringConfiguration +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/Postgresql/20220404192553_AddIndexToSearchableIPToEFAlias.cs#L10) ```csharp public GameStringConfiguration() ``` diff --git a/CodeDocumentation/SharedLibraryCore/configuration/GametypeConfiguration.md b/CodeDocumentation/SharedLibraryCore/configuration/GametypeConfiguration.md index aa8ccdc..391ddd0 100644 --- a/CodeDocumentation/SharedLibraryCore/configuration/GametypeConfiguration.md +++ b/CodeDocumentation/SharedLibraryCore/configuration/GametypeConfiguration.md @@ -21,6 +21,7 @@ ## Details ### Constructors #### GametypeConfiguration +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/QueryHelpers/ClientResourceQueryHelper.cs#L16707566) ```csharp public GametypeConfiguration() ``` diff --git a/CodeDocumentation/SharedLibraryCore/configuration/MapConfiguration.md b/CodeDocumentation/SharedLibraryCore/configuration/MapConfiguration.md index 6e7c87c..71c478b 100644 --- a/CodeDocumentation/SharedLibraryCore/configuration/MapConfiguration.md +++ b/CodeDocumentation/SharedLibraryCore/configuration/MapConfiguration.md @@ -21,6 +21,7 @@ ## Details ### Constructors #### MapConfiguration +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/Postgresql/20220609135210_AddIndexToEFRankingHistoryCreatedDatetime.Designer.cs#L19) ```csharp public MapConfiguration() ``` diff --git a/CodeDocumentation/SharedLibraryCore/configuration/SocialAccountConfiguration.md b/CodeDocumentation/SharedLibraryCore/configuration/SocialAccountConfiguration.md index df56d2f..f240259 100644 --- a/CodeDocumentation/SharedLibraryCore/configuration/SocialAccountConfiguration.md +++ b/CodeDocumentation/SharedLibraryCore/configuration/SocialAccountConfiguration.md @@ -23,6 +23,7 @@ ## Details ### Constructors #### SocialAccountConfiguration +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Alerts/AlertManager.cs#L50) ```csharp public SocialAccountConfiguration() ``` diff --git a/CodeDocumentation/SharedLibraryCore/configuration/WebfrontConfiguration.md b/CodeDocumentation/SharedLibraryCore/configuration/WebfrontConfiguration.md index 54c7118..690c973 100644 --- a/CodeDocumentation/SharedLibraryCore/configuration/WebfrontConfiguration.md +++ b/CodeDocumentation/SharedLibraryCore/configuration/WebfrontConfiguration.md @@ -20,6 +20,7 @@ ## Details ### Constructors #### WebfrontConfiguration +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20180601172317_AddActivityAmount.Designer.cs#L18) ```csharp public WebfrontConfiguration() ``` diff --git a/CodeDocumentation/SharedLibraryCore/database/models/EFClient.md b/CodeDocumentation/SharedLibraryCore/database/models/EFClient.md index e99e78b..91c3405 100644 --- a/CodeDocumentation/SharedLibraryCore/database/models/EFClient.md +++ b/CodeDocumentation/SharedLibraryCore/database/models/EFClient.md @@ -9,7 +9,7 @@ SharedLibraryCore.Database.Models.EFClient[[EFClient]] end subgraph Data.Models.Client -Data.Models.Client.EFClient[[EFClient]] + Data.Models.Client.EFClient[[EFClient]] end Data.Models.Client.EFClient --> SharedLibraryCore.Database.Models.EFClient ``` @@ -77,7 +77,9 @@ Data.Models.Client.EFClient --> SharedLibraryCore.Database.Models.EFClient ## Details ### Inheritance - - `EFClient` + - [ +`EFClient` +](../../../data/models/client/EFClient.md) ### Nested types #### Enums @@ -86,26 +88,26 @@ Data.Models.Client.EFClient --> SharedLibraryCore.Database.Models.EFClient ### Constructors #### EFClient -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L53) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginWebRequest.cs#L6) ```csharp public EFClient() ``` ### Methods #### Finalize -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L147) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/GeoLocationResult.cs#L10) ```csharp protected override void Finalize() ``` #### ToString -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L152) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/GeoLocationResult.cs#L10) ```csharp public override string ToString() ``` #### Tell [1/2] -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L162) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/GeoLocationResult.cs#L11) ```csharp public GameEvent Tell(string message) ``` @@ -118,7 +120,7 @@ public GameEvent Tell(string message) send a message directly to the connected client #### Tell [2/2] -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L186) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/GeoLocationResult.cs#L11) ```csharp public void Tell(IEnumerable messages) ``` @@ -128,6 +130,7 @@ public void Tell(IEnumerable messages) | `IEnumerable`<`string`> | messages | | #### TellAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/GeoLocationResult.cs#L12) ```csharp public async Task TellAsync(IEnumerable messages, CancellationToken token) ``` @@ -138,7 +141,7 @@ public async Task TellAsync(IEnumerable messages, CancellationToken toke | `CancellationToken` | token | | #### Warn -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L214) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/GeoLocationResult.cs#L12) ```csharp public GameEvent Warn(string warnReason, EFClient sender) ``` @@ -168,7 +171,7 @@ clear all warnings for a client #### Report -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L16707566) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/GeoLocationService.cs#L13) ```csharp public GameEvent Report(string reportReason, EFClient sender) ``` @@ -185,7 +188,7 @@ report a client for a given reason #### Flag -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L317) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/GeoLocationService.cs#L19) ```csharp public GameEvent Flag(string flagReason, EFClient sender, Nullable flagLength) ``` @@ -197,7 +200,7 @@ public GameEvent Flag(string flagReason, EFClient sender, Nullable fla | `Nullable`<`TimeSpan`> | flagLength | | #### Unflag -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L350) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/InteractionRegistration.cs#L22) ```csharp public GameEvent Unflag(string unflagReason, EFClient sender) ``` @@ -214,7 +217,7 @@ unflag a client for a given reason game event for the un flug #### Kick [1/2] -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L381) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/InteractionRegistration.cs#L16707566) ```csharp public GameEvent Kick(string kickReason, EFClient sender) ``` @@ -228,7 +231,7 @@ public GameEvent Kick(string kickReason, EFClient sender) kick a client for the given reason #### Kick [2/2] -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L392) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/InteractionRegistration.cs#L62) ```csharp public GameEvent Kick(string kickReason, EFClient sender, EFPenalty originalPenalty) ``` @@ -237,13 +240,13 @@ public GameEvent Kick(string kickReason, EFClient sender, EFPenalty originalPena | --- | --- | --- | | `string` | kickReason | reason to kick for | | [`EFClient`](sharedlibrarycore/database/models/EFClient.md) | sender | client performing the kick | -| `EFPenalty` | originalPenalty | original client penalty | +| [`EFPenalty`](../../../data/models/EFPenalty.md) | originalPenalty | original client penalty | ##### Summary kick a client for the given reason #### TempBan -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L422) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/InteractionRegistration.cs#L76) ```csharp public GameEvent TempBan(string tempbanReason, TimeSpan banLength, EFClient sender) ``` @@ -301,7 +304,7 @@ public GameEvent SetLevel(Permission newPermission, EFClient sender) | [`EFClient`](sharedlibrarycore/database/models/EFClient.md) | sender | | #### IsAbleToConnectSimple -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L548) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/LogPathGeneratorInfo.cs#L14) ```csharp public bool IsAbleToConnectSimple() ``` @@ -309,11 +312,13 @@ public bool IsAbleToConnectSimple() Handles any client related logic on connection #### OnDisconnect +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/LogPathGeneratorInfo.cs#L14) ```csharp public async Task OnDisconnect() ``` #### OnJoin +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/LogPathGeneratorInfo.cs#L20) ```csharp public async Task OnJoin(Nullable ipAddress, bool enableImplicitLinking) ``` @@ -324,6 +329,7 @@ public async Task OnJoin(Nullable ipAddress, bool enableImplicitLinking) | `bool` | enableImplicitLinking | | #### CanConnect +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/LogPathGeneratorInfo.cs#L20) ```csharp public async Task CanConnect(Nullable ipAddress, bool enableImplicitLinking) ``` @@ -334,7 +340,7 @@ public async Task CanConnect(Nullable ipAddress, bool enableImplicitL | `bool` | enableImplicitLinking | | #### UpdateTeam -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L787) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/LogPathGeneratorInfo.cs#L26) ```csharp public void UpdateTeam(string newTeam) ``` @@ -344,18 +350,19 @@ public void UpdateTeam(string newTeam) | `string` | newTeam | | #### Lock +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/LogPathGeneratorInfo.cs#L26) ```csharp public async Task Lock() ``` #### Unlock -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L810) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/LogPathGeneratorInfo.cs#L32) ```csharp public void Unlock() ``` #### Equals -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L818) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/LogPathGeneratorInfo.cs#L32) ```csharp public override bool Equals(object obj) ``` @@ -365,7 +372,7 @@ public override bool Equals(object obj) | `object` | obj | | #### GetHashCode -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L823) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/LogPathGeneratorInfo.cs#L38) ```csharp public override int GetHashCode() ``` diff --git a/CodeDocumentation/SharedLibraryCore/dtos/AuditInfo.md b/CodeDocumentation/SharedLibraryCore/dtos/AuditInfo.md index 0b0699a..163c530 100644 --- a/CodeDocumentation/SharedLibraryCore/dtos/AuditInfo.md +++ b/CodeDocumentation/SharedLibraryCore/dtos/AuditInfo.md @@ -34,6 +34,7 @@ data transfer class for audit information ### Constructors #### AuditInfo +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginV2.cs#L55) ```csharp public AuditInfo() ``` diff --git a/CodeDocumentation/SharedLibraryCore/dtos/ChatInfo.md b/CodeDocumentation/SharedLibraryCore/dtos/ChatInfo.md index ec23e0d..9b11bb0 100644 --- a/CodeDocumentation/SharedLibraryCore/dtos/ChatInfo.md +++ b/CodeDocumentation/SharedLibraryCore/dtos/ChatInfo.md @@ -27,6 +27,7 @@ ## Details ### Constructors #### ChatInfo +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Client/Stats/Reference/EFWeapon.cs#L10) ```csharp public ChatInfo() ``` diff --git a/CodeDocumentation/SharedLibraryCore/dtos/ClientCountSnapshot.md b/CodeDocumentation/SharedLibraryCore/dtos/ClientCountSnapshot.md index fc1e199..c4af012 100644 --- a/CodeDocumentation/SharedLibraryCore/dtos/ClientCountSnapshot.md +++ b/CodeDocumentation/SharedLibraryCore/dtos/ClientCountSnapshot.md @@ -25,6 +25,7 @@ ## Details ### Constructors #### ClientCountSnapshot +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Client/Stats/Reference/EFWeaponAttachmentCombo.cs#L11) ```csharp public ClientCountSnapshot() ``` diff --git a/CodeDocumentation/SharedLibraryCore/dtos/ClientInfo.md b/CodeDocumentation/SharedLibraryCore/dtos/ClientInfo.md index 174d18e..11a902d 100644 --- a/CodeDocumentation/SharedLibraryCore/dtos/ClientInfo.md +++ b/CodeDocumentation/SharedLibraryCore/dtos/ClientInfo.md @@ -26,6 +26,7 @@ ## Details ### Constructors #### ClientInfo +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginV2.cs#L518) ```csharp public ClientInfo() ``` diff --git a/CodeDocumentation/SharedLibraryCore/dtos/CommandResponseInfo.md b/CodeDocumentation/SharedLibraryCore/dtos/CommandResponseInfo.md index 1851275..fa12e37 100644 --- a/CodeDocumentation/SharedLibraryCore/dtos/CommandResponseInfo.md +++ b/CodeDocumentation/SharedLibraryCore/dtos/CommandResponseInfo.md @@ -21,6 +21,7 @@ ## Details ### Constructors #### CommandResponseInfo +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/Sqlite/20180409183408_InitialCreate.cs#L448) ```csharp public CommandResponseInfo() ``` diff --git a/CodeDocumentation/SharedLibraryCore/dtos/EntityInfo.md b/CodeDocumentation/SharedLibraryCore/dtos/EntityInfo.md index 65e32e6..d55c928 100644 --- a/CodeDocumentation/SharedLibraryCore/dtos/EntityInfo.md +++ b/CodeDocumentation/SharedLibraryCore/dtos/EntityInfo.md @@ -27,6 +27,7 @@ This class holds the basic info for api entities ### Constructors #### EntityInfo +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/Sqlite/20180502195450_Update.Designer.cs#L19) ```csharp public EntityInfo() ``` diff --git a/CodeDocumentation/SharedLibraryCore/dtos/FindClientRequest.md b/CodeDocumentation/SharedLibraryCore/dtos/FindClientRequest.md index 1710951..04deb78 100644 --- a/CodeDocumentation/SharedLibraryCore/dtos/FindClientRequest.md +++ b/CodeDocumentation/SharedLibraryCore/dtos/FindClientRequest.md @@ -34,6 +34,7 @@ SharedLibraryCore.Dtos.PaginationRequest --> SharedLibraryCore.Dtos.FindClientRe ### Constructors #### FindClientRequest +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/Sqlite/20180614014303_IndexForEFAlias.cs#L18) ```csharp public FindClientRequest() ``` diff --git a/CodeDocumentation/SharedLibraryCore/dtos/FindClientResult.md b/CodeDocumentation/SharedLibraryCore/dtos/FindClientResult.md index f16459a..f421675 100644 --- a/CodeDocumentation/SharedLibraryCore/dtos/FindClientResult.md +++ b/CodeDocumentation/SharedLibraryCore/dtos/FindClientResult.md @@ -22,6 +22,7 @@ ## Details ### Constructors #### FindClientResult +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/Sqlite/20180904154622_AddVisibilityPercentage.cs#L8) ```csharp public FindClientResult() ``` diff --git a/CodeDocumentation/SharedLibraryCore/dtos/IW4MAdminInfo.md b/CodeDocumentation/SharedLibraryCore/dtos/IW4MAdminInfo.md index b8d5ad0..9fc4310 100644 --- a/CodeDocumentation/SharedLibraryCore/dtos/IW4MAdminInfo.md +++ b/CodeDocumentation/SharedLibraryCore/dtos/IW4MAdminInfo.md @@ -27,6 +27,7 @@ ## Details ### Constructors #### IW4MAdminInfo +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/MasterCommunication.cs#L140) ```csharp public IW4MAdminInfo() ``` diff --git a/CodeDocumentation/SharedLibraryCore/dtos/LookupValueT.md b/CodeDocumentation/SharedLibraryCore/dtos/LookupValueT.md index b149f5f..eaba5f0 100644 --- a/CodeDocumentation/SharedLibraryCore/dtos/LookupValueT.md +++ b/CodeDocumentation/SharedLibraryCore/dtos/LookupValueT.md @@ -31,6 +31,7 @@ SharedLibraryCore.Interfaces.ILookupValue_1 --> SharedLibraryCore.Dtos.LookupVal ### Constructors #### LookupValue +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/MasterCommunication.cs#L16707566) ```csharp public LookupValue() ``` diff --git a/CodeDocumentation/SharedLibraryCore/dtos/PenaltyInfo.md b/CodeDocumentation/SharedLibraryCore/dtos/PenaltyInfo.md index aac4c2b..1a7943a 100644 --- a/CodeDocumentation/SharedLibraryCore/dtos/PenaltyInfo.md +++ b/CodeDocumentation/SharedLibraryCore/dtos/PenaltyInfo.md @@ -49,6 +49,7 @@ SharedLibraryCore.Dtos.SharedInfo --> SharedLibraryCore.Dtos.PenaltyInfo ### Constructors #### PenaltyInfo +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/MetaService.cs#L16707566) ```csharp public PenaltyInfo() ``` diff --git a/CodeDocumentation/SharedLibraryCore/dtos/PlayerInfo.md b/CodeDocumentation/SharedLibraryCore/dtos/PlayerInfo.md index 30a20e8..486293e 100644 --- a/CodeDocumentation/SharedLibraryCore/dtos/PlayerInfo.md +++ b/CodeDocumentation/SharedLibraryCore/dtos/PlayerInfo.md @@ -15,7 +15,7 @@ #### Public properties | Type | Name | Methods | | --- | --- | --- | -| `EFPenalty` | [`ActivePenalty`](#activepenalty) | `get, set` | +| [`EFPenalty`](../../data/models/EFPenalty.md) | [`ActivePenalty`](#activepenalty) | `get, set` | | `string` | [`ActivePenaltyType`](#activepenaltytype) | `get, set` | | `List`<(`string` Item1, `DateTime` Item2)> | [`Aliases`](#aliases) | `get, set` | | `bool` | [`Authenticated`](#authenticated) | `get, set` | @@ -46,6 +46,7 @@ ## Details ### Constructors #### PlayerInfo +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/Sqlite/20201118023106_AddSentIngameFlagToClientMessage.Designer.cs#L16) ```csharp public PlayerInfo() ``` diff --git a/CodeDocumentation/SharedLibraryCore/dtos/ServerInfo.md b/CodeDocumentation/SharedLibraryCore/dtos/ServerInfo.md index 0aea53e..bcbdf37 100644 --- a/CodeDocumentation/SharedLibraryCore/dtos/ServerInfo.md +++ b/CodeDocumentation/SharedLibraryCore/dtos/ServerInfo.md @@ -39,6 +39,7 @@ ## Details ### Constructors #### ServerInfo +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/Sqlite/20220102214442_RemoveUniqueAliasIndexConstraint.cs#L12) ```csharp public ServerInfo() ``` diff --git a/CodeDocumentation/SharedLibraryCore/dtos/meta/requests/BaseClientMetaRequest.md b/CodeDocumentation/SharedLibraryCore/dtos/meta/requests/BaseClientMetaRequest.md index 5389693..00b2055 100644 --- a/CodeDocumentation/SharedLibraryCore/dtos/meta/requests/BaseClientMetaRequest.md +++ b/CodeDocumentation/SharedLibraryCore/dtos/meta/requests/BaseClientMetaRequest.md @@ -29,6 +29,7 @@ SharedLibraryCore.Dtos.PaginationRequest --> SharedLibraryCore.Dtos.Meta.Request ### Constructors #### BaseClientMetaRequest +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/Postgresql/20180912015012_AddPreviousCurrentValueToEFChangeHistory.cs#L8) ```csharp public BaseClientMetaRequest() ``` diff --git a/CodeDocumentation/SharedLibraryCore/dtos/meta/requests/ReceivedPenaltyRequest.md b/CodeDocumentation/SharedLibraryCore/dtos/meta/requests/ReceivedPenaltyRequest.md index 870a350..7be4336 100644 --- a/CodeDocumentation/SharedLibraryCore/dtos/meta/requests/ReceivedPenaltyRequest.md +++ b/CodeDocumentation/SharedLibraryCore/dtos/meta/requests/ReceivedPenaltyRequest.md @@ -20,6 +20,7 @@ SharedLibraryCore.Dtos.Meta.Requests.BaseClientMetaRequest --> SharedLibraryCore ### Constructors #### ReceivedPenaltyRequest +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IO/BaseConfigurationHandlerV2.cs#L16707566) ```csharp public ReceivedPenaltyRequest() ``` diff --git a/CodeDocumentation/SharedLibraryCore/dtos/meta/responses/AdministeredPenaltyResponse.md b/CodeDocumentation/SharedLibraryCore/dtos/meta/responses/AdministeredPenaltyResponse.md index 01814ba..7abdbb8 100644 --- a/CodeDocumentation/SharedLibraryCore/dtos/meta/responses/AdministeredPenaltyResponse.md +++ b/CodeDocumentation/SharedLibraryCore/dtos/meta/responses/AdministeredPenaltyResponse.md @@ -20,6 +20,7 @@ SharedLibraryCore.Dtos.Meta.Responses.ReceivedPenaltyResponse --> SharedLibraryC ### Constructors #### AdministeredPenaltyResponse +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/Sqlite/20220329163928_AddConnectionInterruptedToEFServerSnapshot.cs#L10) ```csharp public AdministeredPenaltyResponse() ``` diff --git a/CodeDocumentation/SharedLibraryCore/dtos/meta/responses/BaseMetaResponse.md b/CodeDocumentation/SharedLibraryCore/dtos/meta/responses/BaseMetaResponse.md index 90fed89..2dc8519 100644 --- a/CodeDocumentation/SharedLibraryCore/dtos/meta/responses/BaseMetaResponse.md +++ b/CodeDocumentation/SharedLibraryCore/dtos/meta/responses/BaseMetaResponse.md @@ -43,6 +43,7 @@ SharedLibraryCore.Interfaces.IClientMetaResponse --> SharedLibraryCore.Dtos.Meta ### Constructors #### BaseMetaResponse +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/Sqlite/20220609022511_AddIndexToEFRankingHistoryCreatedDatetime.cs#L18) ```csharp public BaseMetaResponse() ``` diff --git a/CodeDocumentation/SharedLibraryCore/dtos/meta/responses/ClientNoteMetaResponse.md b/CodeDocumentation/SharedLibraryCore/dtos/meta/responses/ClientNoteMetaResponse.md index 9e626a1..1ffc207 100644 --- a/CodeDocumentation/SharedLibraryCore/dtos/meta/responses/ClientNoteMetaResponse.md +++ b/CodeDocumentation/SharedLibraryCore/dtos/meta/responses/ClientNoteMetaResponse.md @@ -23,6 +23,7 @@ ## Details ### Constructors #### ClientNoteMetaResponse +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/ServerDataViewer.cs#L16707566) ```csharp public ClientNoteMetaResponse() ``` diff --git a/CodeDocumentation/SharedLibraryCore/dtos/meta/responses/InformationResponse.md b/CodeDocumentation/SharedLibraryCore/dtos/meta/responses/InformationResponse.md index 69c5770..5860ce8 100644 --- a/CodeDocumentation/SharedLibraryCore/dtos/meta/responses/InformationResponse.md +++ b/CodeDocumentation/SharedLibraryCore/dtos/meta/responses/InformationResponse.md @@ -29,6 +29,7 @@ SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse --> SharedLibraryCore.Dto ### Constructors #### InformationResponse +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/Postgresql/20180409183408_InitialCreate.cs#L12) ```csharp public InformationResponse() ``` diff --git a/CodeDocumentation/SharedLibraryCore/dtos/meta/responses/MessageResponse.md b/CodeDocumentation/SharedLibraryCore/dtos/meta/responses/MessageResponse.md index 4e02fce..494c761 100644 --- a/CodeDocumentation/SharedLibraryCore/dtos/meta/responses/MessageResponse.md +++ b/CodeDocumentation/SharedLibraryCore/dtos/meta/responses/MessageResponse.md @@ -35,6 +35,7 @@ SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse --> SharedLibraryCore.Dto ### Constructors #### MessageResponse +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/Postgresql/20180531212903_AddAutomatedOffenseAndRatingHistory.Designer.cs#L18) ```csharp public MessageResponse() ``` diff --git a/CodeDocumentation/SharedLibraryCore/dtos/meta/responses/PermissionLevelChangedResponse.md b/CodeDocumentation/SharedLibraryCore/dtos/meta/responses/PermissionLevelChangedResponse.md index 777f21b..a2d52a2 100644 --- a/CodeDocumentation/SharedLibraryCore/dtos/meta/responses/PermissionLevelChangedResponse.md +++ b/CodeDocumentation/SharedLibraryCore/dtos/meta/responses/PermissionLevelChangedResponse.md @@ -32,6 +32,7 @@ SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse --> SharedLibraryCore.Dto ### Constructors #### PermissionLevelChangedResponse +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/Postgresql/20180605191706_AddEFACSnapshots.cs#L127) ```csharp public PermissionLevelChangedResponse() ``` diff --git a/CodeDocumentation/SharedLibraryCore/dtos/meta/responses/ReceivedPenaltyResponse.md b/CodeDocumentation/SharedLibraryCore/dtos/meta/responses/ReceivedPenaltyResponse.md index 9503d2f..6985315 100644 --- a/CodeDocumentation/SharedLibraryCore/dtos/meta/responses/ReceivedPenaltyResponse.md +++ b/CodeDocumentation/SharedLibraryCore/dtos/meta/responses/ReceivedPenaltyResponse.md @@ -39,6 +39,7 @@ SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse --> SharedLibraryCore.Dto ### Constructors #### ReceivedPenaltyResponse +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IO/BaseConfigurationHandlerV2.cs#L207) ```csharp public ReceivedPenaltyResponse() ``` diff --git a/CodeDocumentation/SharedLibraryCore/events/game/ClientCommandEvent.md b/CodeDocumentation/SharedLibraryCore/events/game/ClientCommandEvent.md index efd883b..10733ed 100644 --- a/CodeDocumentation/SharedLibraryCore/events/game/ClientCommandEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/game/ClientCommandEvent.md @@ -20,6 +20,7 @@ SharedLibraryCore.Events.Game.ClientMessageEvent --> SharedLibraryCore.Events.Ga ### Constructors #### ClientCommandEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/PluginImporter.cs#L98) ```csharp public ClientCommandEvent() ``` diff --git a/CodeDocumentation/SharedLibraryCore/events/game/ClientDamageEvent.md b/CodeDocumentation/SharedLibraryCore/events/game/ClientDamageEvent.md index 69ba739..c62953f 100644 --- a/CodeDocumentation/SharedLibraryCore/events/game/ClientDamageEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/game/ClientDamageEvent.md @@ -47,6 +47,7 @@ SharedLibraryCore.Events.Game.ClientGameEvent --> SharedLibraryCore.Events.Game. ### Constructors #### ClientDamageEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Client/Stats/EFClientStatistics.cs#L78) ```csharp public ClientDamageEvent() ``` diff --git a/CodeDocumentation/SharedLibraryCore/events/game/ClientEnterMatchEvent.md b/CodeDocumentation/SharedLibraryCore/events/game/ClientEnterMatchEvent.md index d801bfb..7e6ccc0 100644 --- a/CodeDocumentation/SharedLibraryCore/events/game/ClientEnterMatchEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/game/ClientEnterMatchEvent.md @@ -21,6 +21,7 @@ SharedLibraryCore.Events.Game.ClientGameEvent --> SharedLibraryCore.Events.Game. ### Constructors #### ClientEnterMatchEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Client/Stats/EFClientStatistics.cs#L80) ```csharp public ClientEnterMatchEvent() ``` diff --git a/CodeDocumentation/SharedLibraryCore/events/game/ClientExitMatchEvent.md b/CodeDocumentation/SharedLibraryCore/events/game/ClientExitMatchEvent.md index 249fe80..ead2253 100644 --- a/CodeDocumentation/SharedLibraryCore/events/game/ClientExitMatchEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/game/ClientExitMatchEvent.md @@ -21,6 +21,7 @@ SharedLibraryCore.Events.Game.ClientGameEvent --> SharedLibraryCore.Events.Game. ### Constructors #### ClientExitMatchEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPlugin.cs#L380) ```csharp public ClientExitMatchEvent() ``` diff --git a/CodeDocumentation/SharedLibraryCore/events/game/ClientGameEvent.md b/CodeDocumentation/SharedLibraryCore/events/game/ClientGameEvent.md index c9700a8..2e28ef6 100644 --- a/CodeDocumentation/SharedLibraryCore/events/game/ClientGameEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/game/ClientGameEvent.md @@ -32,6 +32,7 @@ SharedLibraryCore.Events.Game.GameEventV2 --> SharedLibraryCore.Events.Game.Clie ### Constructors #### ClientGameEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPlugin.cs#L339) ```csharp protected ClientGameEvent() ``` diff --git a/CodeDocumentation/SharedLibraryCore/events/game/ClientJoinTeamEvent.md b/CodeDocumentation/SharedLibraryCore/events/game/ClientJoinTeamEvent.md index ce027f8..4a24183 100644 --- a/CodeDocumentation/SharedLibraryCore/events/game/ClientJoinTeamEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/game/ClientJoinTeamEvent.md @@ -29,6 +29,7 @@ SharedLibraryCore.Events.Game.ClientGameEvent --> SharedLibraryCore.Events.Game. ### Constructors #### ClientJoinTeamEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPlugin.cs#L375) ```csharp public ClientJoinTeamEvent() ``` diff --git a/CodeDocumentation/SharedLibraryCore/events/game/ClientKillEvent.md b/CodeDocumentation/SharedLibraryCore/events/game/ClientKillEvent.md index 0244d67..eeb22c1 100644 --- a/CodeDocumentation/SharedLibraryCore/events/game/ClientKillEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/game/ClientKillEvent.md @@ -20,6 +20,7 @@ SharedLibraryCore.Events.Game.ClientDamageEvent --> SharedLibraryCore.Events.Gam ### Constructors #### ClientKillEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Client/Stats/EFClientStatistics.cs#L120) ```csharp public ClientKillEvent() ``` diff --git a/CodeDocumentation/SharedLibraryCore/events/game/ClientMessageEvent.md b/CodeDocumentation/SharedLibraryCore/events/game/ClientMessageEvent.md index 54ed3d6..aab5a38 100644 --- a/CodeDocumentation/SharedLibraryCore/events/game/ClientMessageEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/game/ClientMessageEvent.md @@ -28,6 +28,7 @@ SharedLibraryCore.Events.Game.ClientGameEvent --> SharedLibraryCore.Events.Game. ### Constructors #### ClientMessageEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPlugin.cs#L16707566) ```csharp public ClientMessageEvent() ``` diff --git a/CodeDocumentation/SharedLibraryCore/events/game/GameEventV2.md b/CodeDocumentation/SharedLibraryCore/events/game/GameEventV2.md index 9929edb..b913a22 100644 --- a/CodeDocumentation/SharedLibraryCore/events/game/GameEventV2.md +++ b/CodeDocumentation/SharedLibraryCore/events/game/GameEventV2.md @@ -30,6 +30,7 @@ SharedLibraryCore.GameEvent --> SharedLibraryCore.Events.Game.GameEventV2 ### Constructors #### GameEventV2 +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Client/Stats/EFClientStatistics.cs#L125) ```csharp protected GameEventV2() ``` diff --git a/CodeDocumentation/SharedLibraryCore/events/game/GameScriptEvent.md b/CodeDocumentation/SharedLibraryCore/events/game/GameScriptEvent.md index 2d25c14..64b7298 100644 --- a/CodeDocumentation/SharedLibraryCore/events/game/GameScriptEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/game/GameScriptEvent.md @@ -28,6 +28,7 @@ SharedLibraryCore.Events.Game.GameEventV2 --> SharedLibraryCore.Events.Game.Game ### Constructors #### GameScriptEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Client/Stats/EFHitLocationCount.cs#L10) ```csharp public GameScriptEvent() ``` diff --git a/CodeDocumentation/SharedLibraryCore/events/game/MatchEndEvent.md b/CodeDocumentation/SharedLibraryCore/events/game/MatchEndEvent.md index 5ec4ae3..3bc857c 100644 --- a/CodeDocumentation/SharedLibraryCore/events/game/MatchEndEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/game/MatchEndEvent.md @@ -28,6 +28,7 @@ SharedLibraryCore.Events.Game.GameEventV2 --> SharedLibraryCore.Events.Game.Matc ### Constructors #### MatchEndEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Client/Stats/EFHitLocationCount.cs#L14) ```csharp public MatchEndEvent() ``` diff --git a/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/PlayerConsumedPerkGameEvent.md b/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/PlayerConsumedPerkGameEvent.md index 857c7d7..9c1ade7 100644 --- a/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/PlayerConsumedPerkGameEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/PlayerConsumedPerkGameEvent.md @@ -20,7 +20,7 @@ SharedLibraryCore.Events.Game.ClientGameEvent --> SharedLibraryCore.Events.Game. #### Public properties | Type | Name | Methods | | --- | --- | --- | -| `EFClient` | [`Consumer`](#consumer) | `get` | +| [`EFClient`](../../../../../data/models/client/EFClient.md) | [`Consumer`](#consumer) | `get` | | `string` | [`PerkName`](#perkname) | `get, init` | ## Details @@ -31,6 +31,7 @@ SharedLibraryCore.Events.Game.ClientGameEvent --> SharedLibraryCore.Events.Game. ### Constructors #### PlayerConsumedPerkGameEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Client/Stats/EFHitLocationCount.cs#L21) ```csharp public PlayerConsumedPerkGameEvent() ``` diff --git a/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/PlayerDamageGameEvent.md b/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/PlayerDamageGameEvent.md index fce177d..8eb7e51 100644 --- a/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/PlayerDamageGameEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/PlayerDamageGameEvent.md @@ -22,6 +22,7 @@ SharedLibraryCore.Events.Game.ClientDamageEvent --> SharedLibraryCore.Events.Gam ### Constructors #### PlayerDamageGameEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginHelper.cs#L47) ```csharp public PlayerDamageGameEvent() ``` diff --git a/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/PlayerDownedGameEvent.md b/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/PlayerDownedGameEvent.md index 48a8a1b..608e251 100644 --- a/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/PlayerDownedGameEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/PlayerDownedGameEvent.md @@ -23,6 +23,7 @@ SharedLibraryCore.Events.Game.ClientGameEvent --> SharedLibraryCore.Events.Game. ### Constructors #### PlayerDownedGameEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Client/Stats/EFHitLocationCount.cs#L23) ```csharp public PlayerDownedGameEvent() ``` diff --git a/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/PlayerGrabbedPowerupGameEvent.md b/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/PlayerGrabbedPowerupGameEvent.md index 1a5e584..a2315ab 100644 --- a/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/PlayerGrabbedPowerupGameEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/PlayerGrabbedPowerupGameEvent.md @@ -20,7 +20,7 @@ SharedLibraryCore.Events.Game.ClientGameEvent --> SharedLibraryCore.Events.Game. #### Public properties | Type | Name | Methods | | --- | --- | --- | -| `EFClient` | [`Grabber`](#grabber) | `get` | +| [`EFClient`](../../../../../data/models/client/EFClient.md) | [`Grabber`](#grabber) | `get` | | `string` | [`PowerupName`](#powerupname) | `get, init` | ## Details @@ -31,6 +31,7 @@ SharedLibraryCore.Events.Game.ClientGameEvent --> SharedLibraryCore.Events.Game. ### Constructors #### PlayerGrabbedPowerupGameEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginHelper.cs#L70) ```csharp public PlayerGrabbedPowerupGameEvent() ``` diff --git a/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/PlayerRevivedGameEvent.md b/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/PlayerRevivedGameEvent.md index dc3d7e0..ed735f8 100644 --- a/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/PlayerRevivedGameEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/PlayerRevivedGameEvent.md @@ -20,8 +20,8 @@ SharedLibraryCore.Events.Game.ClientGameEvent --> SharedLibraryCore.Events.Game. #### Public properties | Type | Name | Methods | | --- | --- | --- | -| `EFClient` | [`Revived`](#revived) | `get` | -| `EFClient` | [`Reviver`](#reviver) | `get` | +| [`EFClient`](../../../../../data/models/client/EFClient.md) | [`Revived`](#revived) | `get` | +| [`EFClient`](../../../../../data/models/client/EFClient.md) | [`Reviver`](#reviver) | `get` | ## Details ### Inheritance @@ -31,6 +31,7 @@ SharedLibraryCore.Events.Game.ClientGameEvent --> SharedLibraryCore.Events.Game. ### Constructors #### PlayerRevivedGameEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Client/Stats/EFRating.cs#L12) ```csharp public PlayerRevivedGameEvent() ``` diff --git a/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/PlayerRoundDataGameEvent.md b/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/PlayerRoundDataGameEvent.md index e6abb00..36ab3ab 100644 --- a/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/PlayerRoundDataGameEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/PlayerRoundDataGameEvent.md @@ -32,6 +32,7 @@ SharedLibraryCore.Events.Game.ClientGameEvent --> SharedLibraryCore.Events.Game. ### Constructors #### PlayerRoundDataGameEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginV2.cs#L52) ```csharp public PlayerRoundDataGameEvent() ``` diff --git a/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/RoundCompleteGameEvent.md b/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/RoundCompleteGameEvent.md index 8627735..e1a7c55 100644 --- a/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/RoundCompleteGameEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/RoundCompleteGameEvent.md @@ -30,6 +30,7 @@ SharedLibraryCore.Events.Game.GameEventV2 --> SharedLibraryCore.Events.Game.Game ### Constructors #### RoundCompleteGameEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginV2.cs#L52) ```csharp public RoundCompleteGameEvent() ``` diff --git a/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/ZombieDamageGameEvent.md b/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/ZombieDamageGameEvent.md index 39e83df..b866df8 100644 --- a/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/ZombieDamageGameEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/ZombieDamageGameEvent.md @@ -22,6 +22,7 @@ SharedLibraryCore.Events.Game.ClientDamageEvent --> SharedLibraryCore.Events.Gam ### Constructors #### ZombieDamageGameEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginV2.cs#L52) ```csharp public ZombieDamageGameEvent() ``` diff --git a/CodeDocumentation/SharedLibraryCore/events/management/ClientExecuteCommandEvent.md b/CodeDocumentation/SharedLibraryCore/events/management/ClientExecuteCommandEvent.md index 131f653..f299af3 100644 --- a/CodeDocumentation/SharedLibraryCore/events/management/ClientExecuteCommandEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/management/ClientExecuteCommandEvent.md @@ -29,6 +29,7 @@ SharedLibraryCore.Events.Management.ClientStateEvent --> SharedLibraryCore.Event ### Constructors #### ClientExecuteCommandEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Client/Stats/EFClientRatingHistory.cs#L14) ```csharp public ClientExecuteCommandEvent() ``` diff --git a/CodeDocumentation/SharedLibraryCore/events/management/ClientPenaltyEvent.md b/CodeDocumentation/SharedLibraryCore/events/management/ClientPenaltyEvent.md index 55266f9..f0d7a64 100644 --- a/CodeDocumentation/SharedLibraryCore/events/management/ClientPenaltyEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/management/ClientPenaltyEvent.md @@ -17,8 +17,8 @@ SharedLibraryCore.Events.Management.ManagementEvent --> SharedLibraryCore.Events #### Public properties | Type | Name | Methods | | --- | --- | --- | -| `EFClient` | [`Client`](#client) | `get, init` | -| `EFPenalty` | [`Penalty`](#penalty) | `get, init` | +| [`EFClient`](../../../data/models/client/EFClient.md) | [`Client`](#client) | `get, init` | +| [`EFPenalty`](../../../data/models/EFPenalty.md) | [`Penalty`](#penalty) | `get, init` | ## Details ### Inheritance @@ -28,6 +28,7 @@ SharedLibraryCore.Events.Management.ManagementEvent --> SharedLibraryCore.Events ### Constructors #### ClientPenaltyEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Client/Stats/EFClientStatistics.cs#L23) ```csharp public ClientPenaltyEvent() ``` diff --git a/CodeDocumentation/SharedLibraryCore/events/management/ClientPenaltyRevokeEvent.md b/CodeDocumentation/SharedLibraryCore/events/management/ClientPenaltyRevokeEvent.md index f7d5bbc..d8cfeec 100644 --- a/CodeDocumentation/SharedLibraryCore/events/management/ClientPenaltyRevokeEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/management/ClientPenaltyRevokeEvent.md @@ -20,6 +20,7 @@ SharedLibraryCore.Events.Management.ClientPenaltyEvent --> SharedLibraryCore.Eve ### Constructors #### ClientPenaltyRevokeEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Client/Stats/EFClientStatistics.cs#L23) ```csharp public ClientPenaltyRevokeEvent() ``` diff --git a/CodeDocumentation/SharedLibraryCore/events/management/ClientPermissionChangeEvent.md b/CodeDocumentation/SharedLibraryCore/events/management/ClientPermissionChangeEvent.md index 2887051..f2603ff 100644 --- a/CodeDocumentation/SharedLibraryCore/events/management/ClientPermissionChangeEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/management/ClientPermissionChangeEvent.md @@ -29,6 +29,7 @@ SharedLibraryCore.Events.Management.ClientStateEvent --> SharedLibraryCore.Event ### Constructors #### ClientPermissionChangeEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/QueryHelpers/ClientResourceQueryHelper.cs#L170) ```csharp public ClientPermissionChangeEvent() ``` diff --git a/CodeDocumentation/SharedLibraryCore/events/management/ClientStateAuthorizeEvent.md b/CodeDocumentation/SharedLibraryCore/events/management/ClientStateAuthorizeEvent.md index 90393e5..12f6255 100644 --- a/CodeDocumentation/SharedLibraryCore/events/management/ClientStateAuthorizeEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/management/ClientStateAuthorizeEvent.md @@ -21,6 +21,7 @@ SharedLibraryCore.Events.Management.ClientStateEvent --> SharedLibraryCore.Event ### Constructors #### ClientStateAuthorizeEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/QueryHelpers/ClientResourceQueryHelper.cs#L16707566) ```csharp public ClientStateAuthorizeEvent() ``` diff --git a/CodeDocumentation/SharedLibraryCore/events/management/ClientStateDisposeEvent.md b/CodeDocumentation/SharedLibraryCore/events/management/ClientStateDisposeEvent.md index 88f3bd0..57294fd 100644 --- a/CodeDocumentation/SharedLibraryCore/events/management/ClientStateDisposeEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/management/ClientStateDisposeEvent.md @@ -21,6 +21,7 @@ SharedLibraryCore.Events.Management.ClientStateEvent --> SharedLibraryCore.Event ### Constructors #### ClientStateDisposeEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Client/Stats/EFClientStatistics.cs#L32) ```csharp public ClientStateDisposeEvent() ``` diff --git a/CodeDocumentation/SharedLibraryCore/events/management/ClientStateEvent.md b/CodeDocumentation/SharedLibraryCore/events/management/ClientStateEvent.md index 90efb14..43c0a1b 100644 --- a/CodeDocumentation/SharedLibraryCore/events/management/ClientStateEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/management/ClientStateEvent.md @@ -28,6 +28,7 @@ SharedLibraryCore.Events.Management.ManagementEvent --> SharedLibraryCore.Events ### Constructors #### ClientStateEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Client/Stats/EFClientStatistics.cs#L34) ```csharp protected ClientStateEvent() ``` diff --git a/CodeDocumentation/SharedLibraryCore/events/management/ClientStateInitializeEvent.md b/CodeDocumentation/SharedLibraryCore/events/management/ClientStateInitializeEvent.md index 5de6c68..206feb2 100644 --- a/CodeDocumentation/SharedLibraryCore/events/management/ClientStateInitializeEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/management/ClientStateInitializeEvent.md @@ -21,6 +21,7 @@ SharedLibraryCore.Events.Management.ClientStateEvent --> SharedLibraryCore.Event ### Constructors #### ClientStateInitializeEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Client/Stats/EFClientStatistics.cs#L34) ```csharp public ClientStateInitializeEvent() ``` diff --git a/CodeDocumentation/SharedLibraryCore/events/management/LoginEvent.md b/CodeDocumentation/SharedLibraryCore/events/management/LoginEvent.md index da27bb4..447bdc9 100644 --- a/CodeDocumentation/SharedLibraryCore/events/management/LoginEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/management/LoginEvent.md @@ -33,6 +33,7 @@ SharedLibraryCore.Events.Management.ManagementEvent --> SharedLibraryCore.Events ### Constructors #### LoginEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/PluginImporter.cs#L94) ```csharp public LoginEvent() ``` diff --git a/CodeDocumentation/SharedLibraryCore/events/management/LogoutEvent.md b/CodeDocumentation/SharedLibraryCore/events/management/LogoutEvent.md index 7b66347..0e1fe25 100644 --- a/CodeDocumentation/SharedLibraryCore/events/management/LogoutEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/management/LogoutEvent.md @@ -20,6 +20,7 @@ SharedLibraryCore.Events.Management.LoginEvent --> SharedLibraryCore.Events.Mana ### Constructors #### LogoutEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/PluginImporter.cs#L94) ```csharp public LogoutEvent() ``` diff --git a/CodeDocumentation/SharedLibraryCore/events/management/ManagementEvent.md b/CodeDocumentation/SharedLibraryCore/events/management/ManagementEvent.md index 92d69e7..728eb56 100644 --- a/CodeDocumentation/SharedLibraryCore/events/management/ManagementEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/management/ManagementEvent.md @@ -23,6 +23,7 @@ SharedLibraryCore.Events.CoreEvent --> SharedLibraryCore.Events.Management.Manag ### Constructors #### ManagementEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/PluginImporter.cs#L94) ```csharp public ManagementEvent() ``` diff --git a/CodeDocumentation/SharedLibraryCore/events/server/ClientDataUpdateEvent.md b/CodeDocumentation/SharedLibraryCore/events/server/ClientDataUpdateEvent.md index 23a67b8..d935ed8 100644 --- a/CodeDocumentation/SharedLibraryCore/events/server/ClientDataUpdateEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/server/ClientDataUpdateEvent.md @@ -28,6 +28,7 @@ SharedLibraryCore.Events.Server.GameServerEvent --> SharedLibraryCore.Events.Ser ### Constructors #### ClientDataUpdateEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/CoreEventHandler.cs#L16707566) ```csharp public ClientDataUpdateEvent() ``` diff --git a/CodeDocumentation/SharedLibraryCore/events/server/ConnectionInterruptEvent.md b/CodeDocumentation/SharedLibraryCore/events/server/ConnectionInterruptEvent.md index e9c8a86..ee4735c 100644 --- a/CodeDocumentation/SharedLibraryCore/events/server/ConnectionInterruptEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/server/ConnectionInterruptEvent.md @@ -21,6 +21,7 @@ SharedLibraryCore.Events.Server.GameServerEvent --> SharedLibraryCore.Events.Ser ### Constructors #### ConnectionInterruptEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Client/Stats/EFClientHitStatistic.cs#L36) ```csharp public ConnectionInterruptEvent() ``` diff --git a/CodeDocumentation/SharedLibraryCore/events/server/ConnectionRestoreEvent.md b/CodeDocumentation/SharedLibraryCore/events/server/ConnectionRestoreEvent.md index f9e8e26..9219f15 100644 --- a/CodeDocumentation/SharedLibraryCore/events/server/ConnectionRestoreEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/server/ConnectionRestoreEvent.md @@ -21,6 +21,7 @@ SharedLibraryCore.Events.Server.GameServerEvent --> SharedLibraryCore.Events.Ser ### Constructors #### ConnectionRestoreEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Client/Stats/EFClientHitStatistic.cs#L39) ```csharp public ConnectionRestoreEvent() ``` diff --git a/CodeDocumentation/SharedLibraryCore/events/server/GameServerEvent.md b/CodeDocumentation/SharedLibraryCore/events/server/GameServerEvent.md index 870d80f..f953a03 100644 --- a/CodeDocumentation/SharedLibraryCore/events/server/GameServerEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/server/GameServerEvent.md @@ -31,6 +31,7 @@ SharedLibraryCore.Events.CoreEvent --> SharedLibraryCore.Events.Server.GameServe ### Constructors #### GameServerEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Main.cs#L327) ```csharp protected GameServerEvent() ``` diff --git a/CodeDocumentation/SharedLibraryCore/events/server/MonitorStartEvent.md b/CodeDocumentation/SharedLibraryCore/events/server/MonitorStartEvent.md index 7f32e98..65aef89 100644 --- a/CodeDocumentation/SharedLibraryCore/events/server/MonitorStartEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/server/MonitorStartEvent.md @@ -21,6 +21,7 @@ SharedLibraryCore.Events.Server.GameServerEvent --> SharedLibraryCore.Events.Ser ### Constructors #### MonitorStartEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Main.cs#L383) ```csharp public MonitorStartEvent() ``` diff --git a/CodeDocumentation/SharedLibraryCore/events/server/MonitorStopEvent.md b/CodeDocumentation/SharedLibraryCore/events/server/MonitorStopEvent.md index 2402980..b9cdea6 100644 --- a/CodeDocumentation/SharedLibraryCore/events/server/MonitorStopEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/server/MonitorStopEvent.md @@ -21,6 +21,7 @@ SharedLibraryCore.Events.Server.GameServerEvent --> SharedLibraryCore.Events.Ser ### Constructors #### MonitorStopEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Main.cs#L384) ```csharp public MonitorStopEvent() ``` diff --git a/CodeDocumentation/SharedLibraryCore/events/server/ServerCommandExecuteEvent.md b/CodeDocumentation/SharedLibraryCore/events/server/ServerCommandExecuteEvent.md index 1d242d0..7cf4185 100644 --- a/CodeDocumentation/SharedLibraryCore/events/server/ServerCommandExecuteEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/server/ServerCommandExecuteEvent.md @@ -29,6 +29,7 @@ SharedLibraryCore.Events.Server.GameServerEvent --> SharedLibraryCore.Events.Ser ### Constructors #### ServerCommandExecuteEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Client/Stats/EFClientHitStatistic.cs#L59) ```csharp public ServerCommandExecuteEvent() ``` diff --git a/CodeDocumentation/SharedLibraryCore/events/server/ServerValueReceiveEvent.md b/CodeDocumentation/SharedLibraryCore/events/server/ServerValueReceiveEvent.md index 52f26df..d68cb38 100644 --- a/CodeDocumentation/SharedLibraryCore/events/server/ServerValueReceiveEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/server/ServerValueReceiveEvent.md @@ -29,6 +29,7 @@ SharedLibraryCore.Events.Server.GameServerEvent --> SharedLibraryCore.Events.Ser ### Constructors #### ServerValueReceiveEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Client/Stats/EFClientHitStatistic.cs#L89) ```csharp public ServerValueReceiveEvent() ``` diff --git a/CodeDocumentation/SharedLibraryCore/events/server/ServerValueSetCompleteEvent.md b/CodeDocumentation/SharedLibraryCore/events/server/ServerValueSetCompleteEvent.md index 79d204c..15a7a8d 100644 --- a/CodeDocumentation/SharedLibraryCore/events/server/ServerValueSetCompleteEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/server/ServerValueSetCompleteEvent.md @@ -30,6 +30,7 @@ SharedLibraryCore.Events.Server.GameServerEvent --> SharedLibraryCore.Events.Ser ### Constructors #### ServerValueSetCompleteEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Client/Stats/EFClientRankingHistory.cs#L25) ```csharp public ServerValueSetCompleteEvent() ``` diff --git a/CodeDocumentation/SharedLibraryCore/formatting/ColorCodeMapping.md b/CodeDocumentation/SharedLibraryCore/formatting/ColorCodeMapping.md index 4520d50..8ec9b9a 100644 --- a/CodeDocumentation/SharedLibraryCore/formatting/ColorCodeMapping.md +++ b/CodeDocumentation/SharedLibraryCore/formatting/ColorCodeMapping.md @@ -20,6 +20,7 @@ System.Collections.Generic.Dictionary_2 --> SharedLibraryCore.Formatting.ColorCo ### Constructors #### ColorCodeMapping +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/ApplicationManager.cs#L16707566) ```csharp public ColorCodeMapping() ``` diff --git a/CodeDocumentation/SharedLibraryCore/helpers/BuildNumberJsonConverter.md b/CodeDocumentation/SharedLibraryCore/helpers/BuildNumberJsonConverter.md index 0bbf4c0..6ed693c 100644 --- a/CodeDocumentation/SharedLibraryCore/helpers/BuildNumberJsonConverter.md +++ b/CodeDocumentation/SharedLibraryCore/helpers/BuildNumberJsonConverter.md @@ -35,6 +35,7 @@ JSON converter for the build number ### Constructors #### BuildNumberJsonConverter +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IW4MServer.cs#L16707566) ```csharp public BuildNumberJsonConverter() ``` diff --git a/CodeDocumentation/SharedLibraryCore/helpers/Hashing.md b/CodeDocumentation/SharedLibraryCore/helpers/Hashing.md index 517fb50..68c9d61 100644 --- a/CodeDocumentation/SharedLibraryCore/helpers/Hashing.md +++ b/CodeDocumentation/SharedLibraryCore/helpers/Hashing.md @@ -20,6 +20,7 @@ ## Details ### Constructors #### Hashing +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IW4MServer.cs#L16707566) ```csharp public Hashing() ``` diff --git a/CodeDocumentation/SharedLibraryCore/helpers/MessageToken.md b/CodeDocumentation/SharedLibraryCore/helpers/MessageToken.md index 089c026..d557b03 100644 --- a/CodeDocumentation/SharedLibraryCore/helpers/MessageToken.md +++ b/CodeDocumentation/SharedLibraryCore/helpers/MessageToken.md @@ -38,6 +38,7 @@ public MessageToken(string Name, Func> Value) ### Methods #### ProcessAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/ApplicationManager.cs#L665) ```csharp public async Task ProcessAsync(Server server) ``` diff --git a/CodeDocumentation/SharedLibraryCore/helpers/ParseEnumT.md b/CodeDocumentation/SharedLibraryCore/helpers/ParseEnumT.md index 8157e4d..d538060 100644 --- a/CodeDocumentation/SharedLibraryCore/helpers/ParseEnumT.md +++ b/CodeDocumentation/SharedLibraryCore/helpers/ParseEnumT.md @@ -21,6 +21,7 @@ ## Details ### Constructors #### ParseEnum +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/ApplicationManager.cs#L842) ```csharp public ParseEnum() ``` diff --git a/CodeDocumentation/SharedLibraryCore/helpers/Report.md b/CodeDocumentation/SharedLibraryCore/helpers/Report.md index 6006119..609fcf2 100644 --- a/CodeDocumentation/SharedLibraryCore/helpers/Report.md +++ b/CodeDocumentation/SharedLibraryCore/helpers/Report.md @@ -23,6 +23,7 @@ ## Details ### Constructors #### Report +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Client/Stats/EFACSnapshot.cs#L36) ```csharp public Report() ``` diff --git a/CodeDocumentation/SharedLibraryCore/helpers/ResourceQueryHelperResultT.md b/CodeDocumentation/SharedLibraryCore/helpers/ResourceQueryHelperResultT.md index e516af0..f204053 100644 --- a/CodeDocumentation/SharedLibraryCore/helpers/ResourceQueryHelperResultT.md +++ b/CodeDocumentation/SharedLibraryCore/helpers/ResourceQueryHelperResultT.md @@ -34,6 +34,7 @@ generic class for passing information about a resource query ### Constructors #### ResourceQueryHelperResult +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/ApplicationManager.cs#L245) ```csharp public ResourceQueryHelperResult() ``` diff --git a/CodeDocumentation/SharedLibraryCore/helpers/TokenIdentifier.md b/CodeDocumentation/SharedLibraryCore/helpers/TokenIdentifier.md index f20afd5..2b6121c 100644 --- a/CodeDocumentation/SharedLibraryCore/helpers/TokenIdentifier.md +++ b/CodeDocumentation/SharedLibraryCore/helpers/TokenIdentifier.md @@ -31,6 +31,7 @@ SharedLibraryCore.Interfaces.ITokenIdentifier --> SharedLibraryCore.Helpers.Toke ### Constructors #### TokenIdentifier +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Client/Stats/EFACSnapshot.cs#L45) ```csharp public TokenIdentifier() ``` diff --git a/CodeDocumentation/SharedLibraryCore/interfaces/IAlertManager.md b/CodeDocumentation/SharedLibraryCore/interfaces/IAlertManager.md index 099e900..5ac0bbf 100644 --- a/CodeDocumentation/SharedLibraryCore/interfaces/IAlertManager.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IAlertManager.md @@ -32,6 +32,7 @@ ## Details ### Methods #### Initialize +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFAlias.cs#L17) ```csharp public Task Initialize() ``` @@ -42,6 +43,7 @@ Initializes the manager #### RetrieveAlerts +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFAlias.cs#L17) ```csharp public IEnumerable RetrieveAlerts(EFClient client) ``` @@ -57,6 +59,7 @@ Get all the alerts for given client #### AddAlert +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/MetaService.cs#L263) ```csharp public void AddAlert(AlertState alert) ``` @@ -66,6 +69,7 @@ public void AddAlert(AlertState alert) | `AlertState` | alert | | #### MarkAlertAsRead +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/MetaService.cs#L283) ```csharp public void MarkAlertAsRead(Guid alertId) ``` @@ -78,6 +82,7 @@ public void MarkAlertAsRead(Guid alertId) Marks an alert as read and removes it from the manager #### MarkAllAlertsAsRead +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/MetaServiceV2.cs#L24) ```csharp public void MarkAllAlertsAsRead(int recipientId) ``` @@ -90,6 +95,7 @@ public void MarkAllAlertsAsRead(int recipientId) Mark all alerts intended for the given recipientId as read #### RegisterStaticAlertSource +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFAlias.cs#L21) ```csharp public void RegisterStaticAlertSource(Func>> alertSource) ``` diff --git a/CodeDocumentation/SharedLibraryCore/interfaces/IBaseConfiguration.md b/CodeDocumentation/SharedLibraryCore/interfaces/IBaseConfiguration.md index a0e8be2..8271e50 100644 --- a/CodeDocumentation/SharedLibraryCore/interfaces/IBaseConfiguration.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IBaseConfiguration.md @@ -22,11 +22,13 @@ ## Details ### Methods #### Name +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFAliasLink.cs#L9) ```csharp public string Name() ``` #### Generate +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFAliasLink.cs#L9) ```csharp public IBaseConfiguration Generate() ``` diff --git a/CodeDocumentation/SharedLibraryCore/interfaces/IClientNoticeMessageFormatter.md b/CodeDocumentation/SharedLibraryCore/interfaces/IClientNoticeMessageFormatter.md index 72932cf..54ff903 100644 --- a/CodeDocumentation/SharedLibraryCore/interfaces/IClientNoticeMessageFormatter.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IClientNoticeMessageFormatter.md @@ -16,11 +16,12 @@ #### Public methods | Returns | Name | | --- | --- | -| `string` | [`BuildFormattedMessage`](#buildformattedmessage)([`IRConParserConfiguration`](./IRConParserConfiguration.md) config, `EFPenalty` currentPenalty, `EFPenalty` originalPenalty)
builds a game formatted notice message | +| `string` | [`BuildFormattedMessage`](#buildformattedmessage)([`IRConParserConfiguration`](./IRConParserConfiguration.md) config, [`EFPenalty`](../../data/models/EFPenalty.md) currentPenalty, [`EFPenalty`](../../data/models/EFPenalty.md) originalPenalty)
builds a game formatted notice message | ## Details ### Methods #### BuildFormattedMessage +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/MiddlewareActionHandler.cs#L15) ```csharp public string BuildFormattedMessage(IRConParserConfiguration config, EFPenalty currentPenalty, EFPenalty originalPenalty) ``` @@ -28,8 +29,8 @@ public string BuildFormattedMessage(IRConParserConfiguration config, EFPenalty c | Type | Name | Description | | --- | --- | --- | | [`IRConParserConfiguration`](./IRConParserConfiguration.md) | config | RCon parser config | -| `EFPenalty` | currentPenalty | current penalty the message is for | -| `EFPenalty` | originalPenalty | previous penalty the current penalty relates to | +| [`EFPenalty`](../../data/models/EFPenalty.md) | currentPenalty | current penalty the message is for | +| [`EFPenalty`](../../data/models/EFPenalty.md) | originalPenalty | previous penalty the current penalty relates to | ##### Summary builds a game formatted notice message diff --git a/CodeDocumentation/SharedLibraryCore/interfaces/IConfigurationHandlerFactory.md b/CodeDocumentation/SharedLibraryCore/interfaces/IConfigurationHandlerFactory.md index 9782f5f..46fcb99 100644 --- a/CodeDocumentation/SharedLibraryCore/interfaces/IConfigurationHandlerFactory.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IConfigurationHandlerFactory.md @@ -30,6 +30,7 @@ defines the capabilities of the configuration handler factory ### Methods #### GetConfigurationHandler +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/ParserMatchResult.cs#L19) ```csharp public IConfigurationHandler GetConfigurationHandler(string name) where T : IBaseConfiguration @@ -40,6 +41,7 @@ where T : IBaseConfiguration | `string` | name | | #### GetConfigurationHandlerAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFChangeHistory.cs#L26) ```csharp public Task> GetConfigurationHandlerAsync(string name) where T : IBaseConfiguration diff --git a/CodeDocumentation/SharedLibraryCore/interfaces/IConfigurationHandlerT.md b/CodeDocumentation/SharedLibraryCore/interfaces/IConfigurationHandlerT.md index 3a7a126..3aeade9 100644 --- a/CodeDocumentation/SharedLibraryCore/interfaces/IConfigurationHandlerT.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IConfigurationHandlerT.md @@ -36,21 +36,25 @@ SharedLibraryCore.Interfaces.IBaseConfiguration --> SharedLibraryCore.Interfaces ## Details ### Methods #### Save +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/MiddlewareActionHandler.cs#L60) ```csharp public Task Save() ``` #### BuildAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/ParserMatchResult.cs#L14) ```csharp public Task BuildAsync() ``` #### Configuration +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/ParserMatchResult.cs#L14) ```csharp public T Configuration() ``` #### Set +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/ParserMatchResult.cs#L19) ```csharp public void Set(T config) ``` diff --git a/CodeDocumentation/SharedLibraryCore/interfaces/IConfigurationHandlerV2T.md b/CodeDocumentation/SharedLibraryCore/interfaces/IConfigurationHandlerV2T.md index fdfefa7..92319bd 100644 --- a/CodeDocumentation/SharedLibraryCore/interfaces/IConfigurationHandlerV2T.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IConfigurationHandlerV2T.md @@ -23,6 +23,7 @@ ## Details ### Methods #### Get +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/RemoteAssemblyHandler.cs#L24) ```csharp public Task Get(string configurationName, TConfigurationType defaultConfiguration) ``` @@ -33,6 +34,7 @@ public Task Get(string configurationName, TConfigurationType | `TConfigurationType` | defaultConfiguration | | #### Set [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/RemoteAssemblyHandler.cs#L31) ```csharp public Task Set(TConfigurationType configuration) ``` @@ -42,6 +44,7 @@ public Task Set(TConfigurationType configuration) | `TConfigurationType` | configuration | | #### Set [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/RemoteAssemblyHandler.cs#L37) ```csharp public Task Set() ``` diff --git a/CodeDocumentation/SharedLibraryCore/interfaces/ICoreEventHandler.md b/CodeDocumentation/SharedLibraryCore/interfaces/ICoreEventHandler.md index c6b2d97..4fd0c8a 100644 --- a/CodeDocumentation/SharedLibraryCore/interfaces/ICoreEventHandler.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/ICoreEventHandler.md @@ -28,6 +28,7 @@ Handles games events (from log, manual events, etc) ### Methods #### QueueEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/RemoteCommandService.cs#L21) ```csharp public void QueueEvent(IManager manager, CoreEvent coreEvent) ``` @@ -41,6 +42,7 @@ public void QueueEvent(IManager manager, CoreEvent coreEvent) Add a core event event to the queue to be processed #### StartProcessing +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFMeta.cs#L17) ```csharp public void StartProcessing(CancellationToken token) ``` diff --git a/CodeDocumentation/SharedLibraryCore/interfaces/IEntityServiceT.md b/CodeDocumentation/SharedLibraryCore/interfaces/IEntityServiceT.md index 442e13a..8117775 100644 --- a/CodeDocumentation/SharedLibraryCore/interfaces/IEntityServiceT.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IEntityServiceT.md @@ -27,6 +27,7 @@ ## Details ### Methods #### Create +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFMeta.cs#L19) ```csharp public Task Create(T entity) ``` @@ -36,6 +37,7 @@ public Task Create(T entity) | `T` | entity | | #### Delete +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/SerializationHelpers.cs#L16) ```csharp public Task Delete(T entity) ``` @@ -45,6 +47,7 @@ public Task Delete(T entity) | `T` | entity | | #### Update +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/SerializationHelpers.cs#L21) ```csharp public Task Update(T entity) ``` @@ -54,6 +57,7 @@ public Task Update(T entity) | `T` | entity | | #### Get +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/SerializationHelpers.cs#L26) ```csharp public Task Get(int entityID) ``` @@ -63,6 +67,7 @@ public Task Get(int entityID) | `int` | entityID | | #### GetUnique +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFMeta.cs#L22) ```csharp public Task GetUnique(long entityProperty, object altKey) ``` @@ -73,6 +78,7 @@ public Task GetUnique(long entityProperty, object altKey) | `object` | altKey | | #### Find +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/SerializationHelpers.cs#L34) ```csharp public Task> Find(Func expression) ``` diff --git a/CodeDocumentation/SharedLibraryCore/interfaces/IEventParser.md b/CodeDocumentation/SharedLibraryCore/interfaces/IEventParser.md index 81cf08e..16792b7 100644 --- a/CodeDocumentation/SharedLibraryCore/interfaces/IEventParser.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IEventParser.md @@ -32,6 +32,7 @@ ## Details ### Methods #### GenerateGameEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFMeta.cs#L37) ```csharp public GameEvent GenerateGameEvent(string logLine) ``` @@ -47,6 +48,7 @@ Generates a game event based on log line input #### RegisterCustomEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/ServerDataCollector.cs#L33) ```csharp public void RegisterCustomEvent(string eventSubtype, string eventTriggerValue, Func eventModifier) ``` diff --git a/CodeDocumentation/SharedLibraryCore/interfaces/IGameLogReader.md b/CodeDocumentation/SharedLibraryCore/interfaces/IGameLogReader.md index 7f8f89c..85dd9f3 100644 --- a/CodeDocumentation/SharedLibraryCore/interfaces/IGameLogReader.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IGameLogReader.md @@ -34,6 +34,7 @@ represents the abstraction of game log reading ### Methods #### ReadEventsFromLog +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Meta/MetaRegistration.cs#L34) ```csharp public Task> ReadEventsFromLog(long fileSizeDiff, long startPosition, Server server) ``` diff --git a/CodeDocumentation/SharedLibraryCore/interfaces/IGameLogReaderFactory.md b/CodeDocumentation/SharedLibraryCore/interfaces/IGameLogReaderFactory.md index 87b8566..cbe0b2a 100644 --- a/CodeDocumentation/SharedLibraryCore/interfaces/IGameLogReaderFactory.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IGameLogReaderFactory.md @@ -27,6 +27,7 @@ factory interface to create game log readers based on the log file uri ### Methods #### CreateGameLogReader +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Meta/MetaRegistration.cs#L54) ```csharp public IGameLogReader CreateGameLogReader(Uri[] logUris, IEventParser eventParser) ``` diff --git a/CodeDocumentation/SharedLibraryCore/interfaces/IGameServer.md b/CodeDocumentation/SharedLibraryCore/interfaces/IGameServer.md index 2372944..4c9f891 100644 --- a/CodeDocumentation/SharedLibraryCore/interfaces/IGameServer.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IGameServer.md @@ -36,12 +36,13 @@ | Returns | Name | | --- | --- | | `Task`<`string``[]`> | [`ExecuteCommandAsync`](#executecommandasync)(`string` command, `CancellationToken` token)
Execute a server command | -| `Task` | [`Kick`](#kick)(`string` reason, [`EFClient`](../database/models/EFClient.md) target, [`EFClient`](../database/models/EFClient.md) origin, `EFPenalty` previousPenalty)
kicks target on behalf of origin for given reason | +| `Task` | [`Kick`](#kick)(`string` reason, [`EFClient`](../database/models/EFClient.md) target, [`EFClient`](../database/models/EFClient.md) origin, [`EFPenalty`](../../data/models/EFPenalty.md) previousPenalty)
kicks target on behalf of origin for given reason | | `Task` | [`SetDvarAsync`](#setdvarasync)(`string` name, `object` value, `CancellationToken` token)
Set value for server dvar | ## Details ### Methods #### Kick +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFPenaltyIdentifier.cs#L10) ```csharp public Task Kick(string reason, EFClient target, EFClient origin, EFPenalty previousPenalty) ``` @@ -51,7 +52,7 @@ public Task Kick(string reason, EFClient target, EFClient origin, EFPenalty prev | `string` | reason | reason client is being kicked | | [`EFClient`](../database/models/EFClient.md) | target | client to kick | | [`EFClient`](../database/models/EFClient.md) | origin | source of kick action | -| `EFPenalty` | previousPenalty | previous penalty the kick is occuring for (if applicable) | +| [`EFPenalty`](../../data/models/EFPenalty.md) | previousPenalty | previous penalty the kick is occuring for (if applicable) | ##### Summary kicks target on behalf of origin for given reason @@ -60,6 +61,7 @@ kicks target on behalf of origin for given reason #### ExecuteCommandAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFPenaltyIdentifier.cs#L12) ```csharp public Task ExecuteCommandAsync(string command, CancellationToken token) ``` @@ -76,6 +78,7 @@ Execute a server command Collection of console command output lines #### SetDvarAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFPenaltyIdentifier.cs#L12) ```csharp public Task SetDvarAsync(string name, object value, CancellationToken token) ``` diff --git a/CodeDocumentation/SharedLibraryCore/interfaces/IGameServerInstanceFactory.md b/CodeDocumentation/SharedLibraryCore/interfaces/IGameServerInstanceFactory.md index 7c6b250..4376c85 100644 --- a/CodeDocumentation/SharedLibraryCore/interfaces/IGameServerInstanceFactory.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IGameServerInstanceFactory.md @@ -27,6 +27,7 @@ defines the capabilities of game server instance factory ### Methods #### CreateServer +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Vector3.cs#L11) ```csharp public Server CreateServer(ServerConfiguration config, IManager manager) ``` diff --git a/CodeDocumentation/SharedLibraryCore/interfaces/IGeoLocationService.md b/CodeDocumentation/SharedLibraryCore/interfaces/IGeoLocationService.md index 7cf6859..5e4bb89 100644 --- a/CodeDocumentation/SharedLibraryCore/interfaces/IGeoLocationService.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IGeoLocationService.md @@ -21,6 +21,7 @@ ## Details ### Methods #### Locate +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IO/GameLogEventDetection.cs#L20) ```csharp public Task Locate(string address) ``` diff --git a/CodeDocumentation/SharedLibraryCore/interfaces/IInteractionRegistration.md b/CodeDocumentation/SharedLibraryCore/interfaces/IInteractionRegistration.md index 63d2188..22e8fe8 100644 --- a/CodeDocumentation/SharedLibraryCore/interfaces/IInteractionRegistration.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IInteractionRegistration.md @@ -25,6 +25,7 @@ ## Details ### Methods #### RegisterScriptInteraction +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IO/NetworkGameLogReader.cs#L25) ```csharp public void RegisterScriptInteraction(string interactionName, string source, Delegate interactionRegistration) ``` @@ -36,6 +37,7 @@ public void RegisterScriptInteraction(string interactionName, string source, Del | `Delegate` | interactionRegistration | | #### RegisterInteraction +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IO/NetworkLogState.cs#L12) ```csharp public void RegisterInteraction(string interactionName, Func, Nullable, CancellationToken, Task> interactionRegistration) ``` @@ -46,6 +48,7 @@ public void RegisterInteraction(string interactionName, Func, Null | `Func`<`Nullable`<`int`>, `Nullable`<`Game`>, `CancellationToken`, `Task`<[`IInteractionData`](./IInteractionData.md)>> | interactionRegistration | | #### UnregisterInteraction +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IO/NetworkLogState.cs#L37) ```csharp public void UnregisterInteraction(string interactionName) ``` @@ -55,6 +58,7 @@ public void UnregisterInteraction(string interactionName) | `string` | interactionName | | #### GetInteractions +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IO/NetworkLogState.cs#L16707566) ```csharp public Task> GetInteractions(string interactionPrefix, Nullable clientId, Nullable game, CancellationToken token) ``` @@ -67,6 +71,7 @@ public Task> GetInteractions(string interactionPre | `CancellationToken` | token | | #### ProcessInteraction +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IO/NetworkLogState.cs#L104) ```csharp public Task ProcessInteraction(string interactionId, int originId, Nullable targetId, Nullable game, IDictionary meta, CancellationToken token) ``` diff --git a/CodeDocumentation/SharedLibraryCore/interfaces/ILogger.md b/CodeDocumentation/SharedLibraryCore/interfaces/ILogger.md index a03a28a..dea4c4e 100644 --- a/CodeDocumentation/SharedLibraryCore/interfaces/ILogger.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/ILogger.md @@ -26,6 +26,7 @@ ## Details ### Methods #### WriteVerbose +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IO/NetworkLogState.cs#L16707566) ```csharp public void WriteVerbose(string msg) ``` @@ -35,6 +36,7 @@ public void WriteVerbose(string msg) | `string` | msg | | #### WriteInfo +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Zombie/ZombieAggregateClientStat.cs#L23) ```csharp public void WriteInfo(string msg) ``` @@ -44,6 +46,7 @@ public void WriteInfo(string msg) | `string` | msg | | #### WriteDebug +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IO/NetworkLogState.cs#L129) ```csharp public void WriteDebug(string msg) ``` @@ -53,6 +56,7 @@ public void WriteDebug(string msg) | `string` | msg | | #### WriteWarning +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IO/NetworkLogState.cs#L129) ```csharp public void WriteWarning(string msg) ``` @@ -62,6 +66,7 @@ public void WriteWarning(string msg) | `string` | msg | | #### WriteError +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IO/NetworkLogState.cs#L130) ```csharp public void WriteError(string msg) ``` @@ -71,6 +76,7 @@ public void WriteError(string msg) | `string` | msg | | #### WriteAssert +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IO/NetworkLogState.cs#L131) ```csharp public void WriteAssert(bool condition, string msg) ``` diff --git a/CodeDocumentation/SharedLibraryCore/interfaces/IManager.md b/CodeDocumentation/SharedLibraryCore/interfaces/IManager.md index 0a4c039..4bc8eb1 100644 --- a/CodeDocumentation/SharedLibraryCore/interfaces/IManager.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IManager.md @@ -63,26 +63,31 @@ ## Details ### Methods #### Init +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Factories/RConConnectionFactory.cs#L33) ```csharp public Task Init() ``` #### Start +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Factories/RConConnectionFactory.cs#L19) ```csharp public Task Start() ``` #### Stop +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Factories/ScriptCommandFactory.cs#L25) ```csharp public Task Stop() ``` #### Restart +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Factories/ScriptCommandFactory.cs#L35) ```csharp public Task Restart() ``` #### GetLogger +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Extensions/CommandExtensions.cs#L19) ```csharp public ILogger GetLogger(long serverId) ``` @@ -92,26 +97,31 @@ public ILogger GetLogger(long serverId) | `long` | serverId | | #### GetServers +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Extensions/CommandExtensions.cs#L16707566) ```csharp public IList GetServers() ``` #### GetCommands +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Extensions/CommandExtensions.cs#L16707566) ```csharp public IList GetCommands() ``` #### GetMessageTokens +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Extensions/ScriptPluginExtensions.cs#L16707566) ```csharp public IList GetMessageTokens() ``` #### GetActiveClients +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Extensions/ScriptPluginExtensions.cs#L16707566) ```csharp public IList GetActiveClients() ``` #### FindActiveClient +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Extensions/StartupExtensions.cs#L24) ```csharp public EFClient FindActiveClient(EFClient client) ``` @@ -121,21 +131,25 @@ public EFClient FindActiveClient(EFClient client) | [`EFClient`](../database/models/EFClient.md) | client | | #### GetApplicationSettings +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Extensions/StartupExtensions.cs#L16707566) ```csharp public IConfigurationHandler GetApplicationSettings() ``` #### GetClientService +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/BaseEventParser.cs#L129) ```csharp public ClientService GetClientService() ``` #### GetPenaltyService +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/BaseEventParser.cs#L127) ```csharp public PenaltyService GetPenaltyService() ``` #### GetPageList +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/BaseEventParser.cs#L127) ```csharp public IPageList GetPageList() ``` @@ -146,6 +160,7 @@ provides a page list to add and remove from #### ExecuteSharedDatabaseOperation +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/BaseEventParser.cs#L129) ```csharp public Task> ExecuteSharedDatabaseOperation(string operationName) where T : @@ -156,6 +171,7 @@ where T : | `string` | operationName | | #### RegisterSharedDatabaseOperation +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/BaseEventParser.cs#L129) ```csharp public void RegisterSharedDatabaseOperation(Task operation, string operationName) ``` @@ -166,6 +182,7 @@ public void RegisterSharedDatabaseOperation(Task operation, string operat | `string` | operationName | | #### GenerateDynamicRConParser +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/BaseEventParser.cs#L131) ```csharp public IRConParser GenerateDynamicRConParser(string name) ``` @@ -181,6 +198,7 @@ generates an rcon parser that can be configured by script plugins new rcon parser instance #### GenerateDynamicEventParser +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/BaseEventParser.cs#L131) ```csharp public IEventParser GenerateDynamicEventParser(string name) ``` @@ -196,6 +214,7 @@ Generates an event parser that can be configured by script plugins new event parser instance #### ExecuteEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/BaseEventParser.cs#L133) ```csharp public Task ExecuteEvent(GameEvent gameEvent) ``` @@ -205,6 +224,7 @@ public Task ExecuteEvent(GameEvent gameEvent) | [`GameEvent`](../GameEvent.md) | gameEvent | | #### AddEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/BaseEventParser.cs#L133) ```csharp public void AddEvent(GameEvent gameEvent) ``` @@ -217,6 +237,7 @@ public void AddEvent(GameEvent gameEvent) queues an event for processing #### QueueEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/BaseEventParser.cs#L135) ```csharp public void QueueEvent(CoreEvent coreEvent) ``` @@ -229,6 +250,7 @@ public void QueueEvent(CoreEvent coreEvent) queues an event for processing #### AddAdditionalCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/BaseEventParser.cs#L135) ```csharp public void AddAdditionalCommand(IManagerCommand command) ``` @@ -241,6 +263,7 @@ public void AddAdditionalCommand(IManagerCommand command) adds an additional (script) command to the command list #### RemoveCommandByName +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/BaseEventParser.cs#L138) ```csharp public void RemoveCommandByName(string name) ``` diff --git a/CodeDocumentation/SharedLibraryCore/interfaces/IManagerCommand.md b/CodeDocumentation/SharedLibraryCore/interfaces/IManagerCommand.md index 5abe3ac..416375c 100644 --- a/CodeDocumentation/SharedLibraryCore/interfaces/IManagerCommand.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IManagerCommand.md @@ -41,6 +41,7 @@ Defines the basic properties of a command ### Methods #### ExecuteAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/DynamicEventParserConfiguration.cs#L16) ```csharp public Task ExecuteAsync(GameEvent gameEvent) ``` diff --git a/CodeDocumentation/SharedLibraryCore/interfaces/IMasterCommunication.md b/CodeDocumentation/SharedLibraryCore/interfaces/IMasterCommunication.md index c2e8192..e82deb8 100644 --- a/CodeDocumentation/SharedLibraryCore/interfaces/IMasterCommunication.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IMasterCommunication.md @@ -28,6 +28,7 @@ defines the capabilities of the communication to the master server ### Methods #### CheckVersion +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/DynamicEventParserConfiguration.cs#L16) ```csharp public Task CheckVersion() ``` @@ -38,6 +39,7 @@ checks the current version of IW4MAdmin against the master version #### RunUploadStatus +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/DynamicEventParserConfiguration.cs#L17) ```csharp public Task RunUploadStatus(CancellationToken token) ``` diff --git a/CodeDocumentation/SharedLibraryCore/interfaces/IMetaRegistration.md b/CodeDocumentation/SharedLibraryCore/interfaces/IMetaRegistration.md index c16e6b1..5ef0ee0 100644 --- a/CodeDocumentation/SharedLibraryCore/interfaces/IMetaRegistration.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IMetaRegistration.md @@ -21,6 +21,7 @@ ## Details ### Methods #### Register +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/DynamicEventParserConfiguration.cs#L19) ```csharp public void Register() ``` diff --git a/CodeDocumentation/SharedLibraryCore/interfaces/IMetaService.md b/CodeDocumentation/SharedLibraryCore/interfaces/IMetaService.md index fe49c11..587ca28 100644 --- a/CodeDocumentation/SharedLibraryCore/interfaces/IMetaService.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IMetaService.md @@ -19,7 +19,7 @@ | `Task` | [`AddPersistentMeta`](#addpersistentmeta-12)(`...`)
adds or updates meta key and value to the database | | `void` | [`AddRuntimeMeta`](#addruntimemeta)([`MetaType`](./MetaType.md) metaKey, `Func`<`T`, `Task`<`IEnumerable`<`V`>>> metaAction) | | `Task` | [`DecrementPersistentMeta`](#decrementpersistentmeta)(`string` metaKey, `int` decrementAmount, `int` clientId)
decrements meta value and persists to the database if the meta value does not already exist it will be set to the decrement amount | -| `Task`<`EFMeta`> | [`GetPersistentMeta`](#getpersistentmeta-12)(`...`)
retrieves meta data for given client and key | +| `Task`<[`EFMeta`](../../data/models/EFMeta.md)> | [`GetPersistentMeta`](#getpersistentmeta-12)(`...`)
retrieves meta data for given client and key | | `Task`<`IEnumerable`<[`IClientMeta`](./IClientMeta.md)>> | [`GetRuntimeMeta`](#getruntimemeta-12)(`...`)
retrieves all the runtime meta information for given client idea | | `Task` | [`IncrementPersistentMeta`](#incrementpersistentmeta)(`string` metaKey, `int` incrementAmount, `int` clientId)
increments meta value and persists to the database if the meta value does not already exist it will be set to the increment amount | | `Task` | [`RemovePersistentMeta`](#removepersistentmeta-12)(`...`)
removes meta key with given value | @@ -28,6 +28,7 @@ ## Details ### Methods #### AddPersistentMeta [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/DynamicEventParserConfiguration.cs#L20) ```csharp public Task AddPersistentMeta(string metaKey, string metaValue, EFClient client, EFMeta linkedMeta) ``` @@ -37,7 +38,7 @@ public Task AddPersistentMeta(string metaKey, string metaValue, EFClient client, | `string` | metaKey | key of meta data | | `string` | metaValue | value of the meta data | | [`EFClient`](../database/models/EFClient.md) | client | client to save the meta for | -| `EFMeta` | linkedMeta | | +| [`EFMeta`](../../data/models/EFMeta.md) | linkedMeta | | ##### Summary adds or updates meta key and value to the database @@ -46,6 +47,7 @@ adds or updates meta key and value to the database #### SetPersistentMeta +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/DynamicEventParserConfiguration.cs#L20) ```csharp public Task SetPersistentMeta(string metaKey, string metaValue, int clientId) ``` @@ -63,6 +65,7 @@ adds or updates meta key and value to the database #### IncrementPersistentMeta +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/DynamicEventParserConfiguration.cs#L21) ```csharp public Task IncrementPersistentMeta(string metaKey, int incrementAmount, int clientId) ``` @@ -80,6 +83,7 @@ increments meta value and persists to the database if the meta value does not al #### DecrementPersistentMeta +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/DynamicEventParserConfiguration.cs#L21) ```csharp public Task DecrementPersistentMeta(string metaKey, int decrementAmount, int clientId) ``` @@ -97,6 +101,7 @@ decrements meta value and persists to the database if the meta value does not al #### AddPersistentMeta [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/DynamicEventParserConfiguration.cs#L22) ```csharp public Task AddPersistentMeta(string metaKey, string metaValue) ``` @@ -113,6 +118,7 @@ adds or updates meta key and value to the database #### RemovePersistentMeta [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/DynamicEventParserConfiguration.cs#L22) ```csharp public Task RemovePersistentMeta(string metaKey, EFClient client) ``` @@ -129,6 +135,7 @@ removes meta key with given value #### RemovePersistentMeta [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/DynamicEventParserConfiguration.cs#L23) ```csharp public Task RemovePersistentMeta(string metaKey, string metaValue) ``` @@ -145,6 +152,7 @@ removes meta key with given value #### GetPersistentMeta [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/DynamicEventParserConfiguration.cs#L23) ```csharp public Task GetPersistentMeta(string metaKey, EFClient client) ``` @@ -161,6 +169,7 @@ retrieves meta data for given client and key #### GetPersistentMeta [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/DynamicEventParserConfiguration.cs#L24) ```csharp public Task> GetPersistentMeta(string metaKey) ``` @@ -176,6 +185,7 @@ retrieves collection of meta for given key #### AddRuntimeMeta +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/DynamicEventParserConfiguration.cs#L24) ```csharp public void AddRuntimeMeta(MetaType metaKey, Func>> metaAction) where T : PaginationRequest @@ -188,6 +198,7 @@ where V : IClientMeta | `Func`<`T`, `Task`<`IEnumerable`<`V`>>> | metaAction | | #### GetRuntimeMeta [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/DynamicEventParserConfiguration.cs#L25) ```csharp public Task> GetRuntimeMeta(ClientPaginationRequest request) ``` @@ -203,6 +214,7 @@ retrieves all the runtime meta information for given client idea #### GetRuntimeMeta [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/DynamicEventParserConfiguration.cs#L25) ```csharp public Task> GetRuntimeMeta(ClientPaginationRequest request, MetaType metaType) where T : IClientMeta diff --git a/CodeDocumentation/SharedLibraryCore/interfaces/IMetaServiceV2.md b/CodeDocumentation/SharedLibraryCore/interfaces/IMetaServiceV2.md index 50e891e..3b52d99 100644 --- a/CodeDocumentation/SharedLibraryCore/interfaces/IMetaServiceV2.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IMetaServiceV2.md @@ -18,8 +18,8 @@ | --- | --- | | `void` | [`AddRuntimeMeta`](#addruntimemeta)([`MetaType`](./MetaType.md) metaKey, `Func`<`T`, `CancellationToken`, `Task`<`IEnumerable`<`TReturn`>>> metaAction) | | `Task` | [`DecrementPersistentMeta`](#decrementpersistentmeta)(`string` metaKey, `int` decrementAmount, `int` clientId, `CancellationToken` token)
decrements meta value and persists to the database if the meta value does not already exist it will be set to the decrement amount the assumption is made that the existing value is Int32 | -| `Task`<`EFMeta`> | [`GetPersistentMeta`](#getpersistentmeta-12)(`...`)
retrieves meta entry | -| `Task`<`EFMeta`> | [`GetPersistentMetaByLookup`](#getpersistentmetabylookup)(`string` metaKey, `string` lookupKey, `int` clientId, `CancellationToken` token)
retrieves meta entry by with associated lookup value as string | +| `Task`<[`EFMeta`](../../data/models/EFMeta.md)> | [`GetPersistentMeta`](#getpersistentmeta-12)(`...`)
retrieves meta entry | +| `Task`<[`EFMeta`](../../data/models/EFMeta.md)> | [`GetPersistentMetaByLookup`](#getpersistentmetabylookup)(`string` metaKey, `string` lookupKey, `int` clientId, `CancellationToken` token)
retrieves meta entry by with associated lookup value as string | | `Task`<`T`> | [`GetPersistentMetaValue`](#getpersistentmetavalue-12)(`...`) | | `Task`<`IEnumerable`<[`IClientMeta`](./IClientMeta.md)>> | [`GetRuntimeMeta`](#getruntimemeta-12)(`...`)
retrieves all the runtime meta information for given client idea | | `Task` | [`IncrementPersistentMeta`](#incrementpersistentmeta)(`string` metaKey, `int` incrementAmount, `int` clientId, `CancellationToken` token)
increments meta value and persists to the database if the meta value does not already exist it will be set to the increment amount the assumption is made that the existing value is Int32 | @@ -31,6 +31,7 @@ ## Details ### Methods #### SetPersistentMeta [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/DynamicEventParserConfiguration.cs#L26) ```csharp public Task SetPersistentMeta(string metaKey, string metaValue, int clientId, CancellationToken token) ``` @@ -49,6 +50,7 @@ adds or updates meta key and value to the database as simple string #### SetPersistentMetaValue [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/DynamicEventParserConfiguration.cs#L26) ```csharp public Task SetPersistentMetaValue(string metaKey, T metaValue, int clientId, CancellationToken token) where T : @@ -62,6 +64,7 @@ where T : | `CancellationToken` | token | | #### SetPersistentMetaForLookupKey +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/DynamicEventParserConfiguration.cs#L27) ```csharp public Task SetPersistentMetaForLookupKey(string metaKey, string lookupKey, int lookupId, int clientId, CancellationToken token) ``` @@ -81,6 +84,7 @@ Sets meta key to a linked lookup key and id #### IncrementPersistentMeta +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/DynamicEventParserConfiguration.cs#L27) ```csharp public Task IncrementPersistentMeta(string metaKey, int incrementAmount, int clientId, CancellationToken token) ``` @@ -99,6 +103,7 @@ increments meta value and persists to the database if the meta value does not al #### DecrementPersistentMeta +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/DynamicEventParserConfiguration.cs#L29) ```csharp public Task DecrementPersistentMeta(string metaKey, int decrementAmount, int clientId, CancellationToken token) ``` @@ -117,6 +122,7 @@ decrements meta value and persists to the database if the meta value does not al #### GetPersistentMeta [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/DynamicEventParserConfiguration.cs#L29) ```csharp public Task GetPersistentMeta(string metaKey, int clientId, CancellationToken token) ``` @@ -134,6 +140,7 @@ retrieves meta entry #### GetPersistentMetaValue [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/DynamicEventParserConfiguration.cs#L27) ```csharp public Task GetPersistentMetaValue(string metaKey, int clientId, CancellationToken token) where T : @@ -146,6 +153,7 @@ where T : | `CancellationToken` | token | | #### GetPersistentMetaByLookup +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/ParserPatternMatcher.cs#L18) ```csharp public Task GetPersistentMetaByLookup(string metaKey, string lookupKey, int clientId, CancellationToken token) ``` @@ -164,6 +172,7 @@ retrieves meta entry by with associated lookup value as string #### RemovePersistentMeta [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/ParserPatternMatcher.cs#L24) ```csharp public Task RemovePersistentMeta(string metaKey, int clientId, CancellationToken token) ``` @@ -181,6 +190,7 @@ removes meta key with given value #### SetPersistentMeta [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Zombie/ZombieRoundClientStat.cs#L10) ```csharp public Task SetPersistentMeta(string metaKey, string metaValue, CancellationToken token) ``` @@ -198,6 +208,7 @@ adds or updates meta key and value to the database #### SetPersistentMetaValue [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Configuration/ScriptPluginConfiguration.cs#L8) ```csharp public Task SetPersistentMetaValue(string metaKey, T metaValue, CancellationToken token) where T : @@ -210,6 +221,7 @@ where T : | `CancellationToken` | token | | #### RemovePersistentMeta [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Configuration/ScriptPluginConfiguration.cs#L11) ```csharp public Task RemovePersistentMeta(string metaKey, CancellationToken token) ``` @@ -226,6 +238,7 @@ removes meta key with given value #### GetPersistentMeta [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Zombie/ZombieRoundClientStat.cs#L11) ```csharp public Task GetPersistentMeta(string metaKey, CancellationToken token) ``` @@ -242,6 +255,7 @@ retrieves collection of meta for given key #### GetPersistentMetaValue [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/AddClientNoteCommand.cs#L17) ```csharp public Task GetPersistentMetaValue(string metaKey, CancellationToken token) where T : @@ -253,6 +267,7 @@ where T : | `CancellationToken` | token | | #### AddRuntimeMeta +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Zombie/ZombieRoundClientStat.cs#L12) ```csharp public void AddRuntimeMeta(MetaType metaKey, Func>> metaAction) where T : PaginationRequest @@ -265,6 +280,7 @@ where TReturn : IClientMeta | `Func`<`T`, `CancellationToken`, `Task`<`IEnumerable`<`TReturn`>>> | metaAction | | #### GetRuntimeMeta [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/FindPlayerCommand.cs#L17) ```csharp public Task> GetRuntimeMeta(ClientPaginationRequest request, CancellationToken token) ``` @@ -281,6 +297,7 @@ retrieves all the runtime meta information for given client idea #### GetRuntimeMeta [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Server/EFServer.cs#L11) ```csharp public Task> GetRuntimeMeta(ClientPaginationRequest request, MetaType metaType, CancellationToken token) where T : IClientMeta diff --git a/CodeDocumentation/SharedLibraryCore/interfaces/IMiddlewareActionHandler.md b/CodeDocumentation/SharedLibraryCore/interfaces/IMiddlewareActionHandler.md index d9d8519..ce08680 100644 --- a/CodeDocumentation/SharedLibraryCore/interfaces/IMiddlewareActionHandler.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IMiddlewareActionHandler.md @@ -28,6 +28,7 @@ used to handle middleware actions registered from arbitrary assemblies ### Methods #### Register +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Server/EFServer.cs#L13) ```csharp public void Register(T actionType, IMiddlewareAction action, string name) where T : @@ -40,6 +41,7 @@ where T : | `string` | name | | #### Execute +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/ListAdminsCommand.cs#L16) ```csharp public Task Execute(T value, string name) where T : diff --git a/CodeDocumentation/SharedLibraryCore/interfaces/IMiddlewareActionT.md b/CodeDocumentation/SharedLibraryCore/interfaces/IMiddlewareActionT.md index 26913c0..03b2bd4 100644 --- a/CodeDocumentation/SharedLibraryCore/interfaces/IMiddlewareActionT.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IMiddlewareActionT.md @@ -33,6 +33,7 @@ represents an invokable middleware action ### Methods #### Invoke +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/HelpCommand.cs#L20) ```csharp public Task Invoke(T original) ``` diff --git a/CodeDocumentation/SharedLibraryCore/interfaces/IModelConfiguration.md b/CodeDocumentation/SharedLibraryCore/interfaces/IModelConfiguration.md index f64845b..6ebb098 100644 --- a/CodeDocumentation/SharedLibraryCore/interfaces/IModelConfiguration.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IModelConfiguration.md @@ -21,6 +21,7 @@ ## Details ### Methods #### Configure +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/ListAdminsCommand.cs#L27) ```csharp public void Configure(ModelBuilder builder) ``` diff --git a/CodeDocumentation/SharedLibraryCore/interfaces/IParserPatternMatcher.md b/CodeDocumentation/SharedLibraryCore/interfaces/IParserPatternMatcher.md index f52bedc..bb73d38 100644 --- a/CodeDocumentation/SharedLibraryCore/interfaces/IParserPatternMatcher.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IParserPatternMatcher.md @@ -28,6 +28,7 @@ defines the capabilities of a parser pattern ### Methods #### Match +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/ListReportsCommand.cs#L36) ```csharp public IMatchResult Match(string input) ``` @@ -43,6 +44,7 @@ converts input string into pattern groups group matches #### Compile +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/MapAndGameTypeCommand.cs#L22) ```csharp public void Compile(string pattern) ``` diff --git a/CodeDocumentation/SharedLibraryCore/interfaces/IParserRegexFactory.md b/CodeDocumentation/SharedLibraryCore/interfaces/IParserRegexFactory.md index e35972a..d8f8a94 100644 --- a/CodeDocumentation/SharedLibraryCore/interfaces/IParserRegexFactory.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IParserRegexFactory.md @@ -27,6 +27,7 @@ defines the capabilities of the parser regex factory ### Methods #### CreateParserRegex +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Server/EFServer.cs#L20) ```csharp public ParserRegex CreateParserRegex() ``` diff --git a/CodeDocumentation/SharedLibraryCore/interfaces/IPlugin.md b/CodeDocumentation/SharedLibraryCore/interfaces/IPlugin.md index 33301e3..ba92cc6 100644 --- a/CodeDocumentation/SharedLibraryCore/interfaces/IPlugin.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IPlugin.md @@ -33,6 +33,7 @@ ## Details ### Methods #### OnLoadAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/ReadMessageCommand.cs#L22) ```csharp public Task OnLoadAsync(IManager manager) ``` @@ -42,11 +43,13 @@ public Task OnLoadAsync(IManager manager) | [`IManager`](./IManager.md) | manager | | #### OnUnloadAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Server/EFServerSnapshot.cs#L21) ```csharp public Task OnUnloadAsync() ``` #### OnEventAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/ReportClientCommand.cs#L15) ```csharp public Task OnEventAsync(GameEvent gameEvent, Server server) ``` @@ -57,6 +60,7 @@ public Task OnEventAsync(GameEvent gameEvent, Server server) | [`Server`](../Server.md) | server | | #### OnTickAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Server/EFServerSnapshot.cs#L24) ```csharp public Task OnTickAsync(Server S) ``` diff --git a/CodeDocumentation/SharedLibraryCore/interfaces/IPluginImporter.md b/CodeDocumentation/SharedLibraryCore/interfaces/IPluginImporter.md index c3c8647..65ebd2f 100644 --- a/CodeDocumentation/SharedLibraryCore/interfaces/IPluginImporter.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IPluginImporter.md @@ -28,6 +28,7 @@ defines the capabilities of the plugin importer ### Methods #### DiscoverAssemblyPluginImplementations +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/SayAllCommand.cs#L15) ```csharp public (IEnumerable Item1, IEnumerable Item2, IEnumerable Item3) DiscoverAssemblyPluginImplementations() ``` @@ -38,6 +39,7 @@ discovers C# assembly plugin and command types tuple of IPlugin implementation type definitions, and IManagerCommand type definitions #### DiscoverScriptPlugins +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/SayAllCommand.cs#L34) ```csharp public IEnumerable<(Type Item1, string Item2)> DiscoverScriptPlugins() ``` diff --git a/CodeDocumentation/SharedLibraryCore/interfaces/IRConConnection.md b/CodeDocumentation/SharedLibraryCore/interfaces/IRConConnection.md index 778015b..7044c68 100644 --- a/CodeDocumentation/SharedLibraryCore/interfaces/IRConConnection.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IRConConnection.md @@ -28,6 +28,7 @@ defines the capabilities of an RCon connection ### Methods #### SendQueryAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/SayCommand.cs#L34) ```csharp public Task SendQueryAsync(QueryType type, string parameters, CancellationToken token) ``` @@ -39,6 +40,7 @@ public Task SendQueryAsync(QueryType type, string parameters, Cancellati | `CancellationToken` | token | | #### SetConfiguration +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/WhoAmICommand.cs#L14) ```csharp public void SetConfiguration(IRConParser config) ``` diff --git a/CodeDocumentation/SharedLibraryCore/interfaces/IRConConnectionFactory.md b/CodeDocumentation/SharedLibraryCore/interfaces/IRConConnectionFactory.md index 56d6269..6d69fb2 100644 --- a/CodeDocumentation/SharedLibraryCore/interfaces/IRConConnectionFactory.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IRConConnectionFactory.md @@ -27,6 +27,7 @@ defines the capabilities of an RCon connection factory ### Methods #### CreateConnection +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/WhoAmICommand.cs#L25) ```csharp public IRConConnection CreateConnection(IPEndPoint ipEndpoint, string password, string rconEngine) ``` diff --git a/CodeDocumentation/SharedLibraryCore/interfaces/IRConParser.md b/CodeDocumentation/SharedLibraryCore/interfaces/IRConParser.md index a4be919..0142388 100644 --- a/CodeDocumentation/SharedLibraryCore/interfaces/IRConParser.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IRConParser.md @@ -39,6 +39,7 @@ ## Details ### Methods #### GetDvarAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/ClientTags/TagMeta.cs#L8) ```csharp public Task> GetDvarAsync(IRConConnection connection, string dvarName, T fallbackValue, CancellationToken token) where T : @@ -52,6 +53,7 @@ where T : | `CancellationToken` | token | | #### SetDvarAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/ClientTags/TagMeta.cs#L9) ```csharp public Task SetDvarAsync(IRConConnection connection, string dvarName, object dvarValue, CancellationToken token) ``` @@ -70,6 +72,7 @@ set value of DVAR by name #### ExecuteCommandAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/ClientTags/TagMeta.cs#L11) ```csharp public Task ExecuteCommandAsync(IRConConnection connection, string command, CancellationToken token) ``` @@ -87,6 +90,7 @@ executes a console command on the server #### GetStatusAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/ClientTags/TagMeta.cs#L11) ```csharp public Task GetStatusAsync(IRConConnection connection, CancellationToken token) ``` @@ -103,6 +107,7 @@ get the list of connected clients from status response [IStatusResponse](./IStatusResponse.md) #### GetOverrideDvarName +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/ClientTags/TagMeta.cs#L12) ```csharp public string GetOverrideDvarName(string dvarName) ``` @@ -119,6 +124,7 @@ retrieves the value of given dvar key if it exists in the override dict #### GetDefaultDvarValue +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/ClientTags/TagMeta.cs#L12) ```csharp public T GetDefaultDvarValue(string dvarName) where T : @@ -129,6 +135,7 @@ where T : | `string` | dvarName | | #### OverrideTimeoutForCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Server/EFServerStatistics.cs#L14) ```csharp public Nullable OverrideTimeoutForCommand(string command) ``` diff --git a/CodeDocumentation/SharedLibraryCore/interfaces/IRemoteAssemblyHandler.md b/CodeDocumentation/SharedLibraryCore/interfaces/IRemoteAssemblyHandler.md index c6fb61c..98761a8 100644 --- a/CodeDocumentation/SharedLibraryCore/interfaces/IRemoteAssemblyHandler.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IRemoteAssemblyHandler.md @@ -22,6 +22,7 @@ ## Details ### Methods #### DecryptAssemblies +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/API/Master/ApiServer.cs#L21) ```csharp public IEnumerable DecryptAssemblies(string[] encryptedAssemblies) ``` @@ -31,6 +32,7 @@ public IEnumerable DecryptAssemblies(string[] encryptedAssemblies) | `string``[]` | encryptedAssemblies | | #### DecryptScripts +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/API/Master/ApiServer.cs#L23) ```csharp public IEnumerable DecryptScripts(string[] encryptedScripts) ``` diff --git a/CodeDocumentation/SharedLibraryCore/interfaces/IRemoteCommandService.md b/CodeDocumentation/SharedLibraryCore/interfaces/IRemoteCommandService.md index d4e9577..e547476 100644 --- a/CodeDocumentation/SharedLibraryCore/interfaces/IRemoteCommandService.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IRemoteCommandService.md @@ -22,6 +22,7 @@ ## Details ### Methods #### Execute +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/API/Master/ApiServer.cs#L23) ```csharp public Task> Execute(int originId, Nullable targetId, string command, IEnumerable arguments, Server server) ``` @@ -35,6 +36,7 @@ public Task> Execute(int originId, Nullable Item2)> ExecuteWithResult(int originId, Nullable targetId, string command, IEnumerable arguments, Server server) ``` diff --git a/CodeDocumentation/SharedLibraryCore/interfaces/IResourceQueryHelperTT.md b/CodeDocumentation/SharedLibraryCore/interfaces/IResourceQueryHelperTT.md index 728a980..3f38375 100644 --- a/CodeDocumentation/SharedLibraryCore/interfaces/IResourceQueryHelperTT.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IResourceQueryHelperTT.md @@ -34,6 +34,7 @@ defines the capabilities of a resource queryier ### Methods #### QueryResource +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/API/Master/ApiServer.cs#L25) ```csharp public Task> QueryResource(QueryType query) ``` diff --git a/CodeDocumentation/SharedLibraryCore/interfaces/IScriptCommandFactory.md b/CodeDocumentation/SharedLibraryCore/interfaces/IScriptCommandFactory.md index e81cd7e..361e64b 100644 --- a/CodeDocumentation/SharedLibraryCore/interfaces/IScriptCommandFactory.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IScriptCommandFactory.md @@ -27,6 +27,7 @@ defines capabilities of script command factory ### Methods #### CreateScriptCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/API/Master/ApiServer.cs#L27) ```csharp public IManagerCommand CreateScriptCommand(string name, string alias, string description, string permission, bool isTargetRequired, IEnumerable args, Func executeAction, IEnumerable supportedGames) ``` diff --git a/CodeDocumentation/SharedLibraryCore/interfaces/IScriptPluginFactory.md b/CodeDocumentation/SharedLibraryCore/interfaces/IScriptPluginFactory.md index ba9e9e4..5655625 100644 --- a/CodeDocumentation/SharedLibraryCore/interfaces/IScriptPluginFactory.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IScriptPluginFactory.md @@ -21,6 +21,7 @@ ## Details ### Methods #### CreateScriptPlugin +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/API/Master/ApiServer.cs#L27) ```csharp public object CreateScriptPlugin(Type type, string fileName) ``` diff --git a/CodeDocumentation/SharedLibraryCore/interfaces/IScriptPluginServiceResolver.md b/CodeDocumentation/SharedLibraryCore/interfaces/IScriptPluginServiceResolver.md index 2c9c494..09ce794 100644 --- a/CodeDocumentation/SharedLibraryCore/interfaces/IScriptPluginServiceResolver.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IScriptPluginServiceResolver.md @@ -27,6 +27,7 @@ interface used to dynamically resolve services by string name ### Methods #### ResolveService [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/API/Master/ApiServer.cs#L29) ```csharp public object ResolveService(string serviceName) ``` @@ -42,6 +43,7 @@ resolves a service with the given name #### ResolveService [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/API/Master/ApiServer.cs#L29) ```csharp public object ResolveService(string serviceName, string[] genericParameters) ``` diff --git a/CodeDocumentation/SharedLibraryCore/interfaces/IScriptPluginTimerHelper.md b/CodeDocumentation/SharedLibraryCore/interfaces/IScriptPluginTimerHelper.md index ba2d107..6421d46 100644 --- a/CodeDocumentation/SharedLibraryCore/interfaces/IScriptPluginTimerHelper.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IScriptPluginTimerHelper.md @@ -40,6 +40,7 @@ public void Start(int delay, int interval) | `int` | interval | | #### Start [2/3] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/API/Master/IMasterApi.cs#L14) ```csharp public void Start(int interval) ``` @@ -49,16 +50,19 @@ public void Start(int interval) | `int` | interval | | #### Start [3/3] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/API/Master/IMasterApi.cs#L14) ```csharp public void Start() ``` #### Stop +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Client/EFClient.cs#L57) ```csharp public void Stop() ``` #### OnTick +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/API/Master/IMasterApi.cs#L20) ```csharp public void OnTick(Delegate action, string actionName) ``` @@ -69,6 +73,7 @@ public void OnTick(Delegate action, string actionName) | `string` | actionName | | #### SetDependency +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Client/EFClient.cs#L59) ```csharp public void SetDependency(SemaphoreSlim dependentSemaphore) ``` diff --git a/CodeDocumentation/SharedLibraryCore/interfaces/IServerDataCollector.md b/CodeDocumentation/SharedLibraryCore/interfaces/IServerDataCollector.md index a29f340..77bb9b9 100644 --- a/CodeDocumentation/SharedLibraryCore/interfaces/IServerDataCollector.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IServerDataCollector.md @@ -21,6 +21,7 @@ ## Details ### Methods #### BeginCollectionAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/API/Master/IMasterApi.cs#L27) ```csharp public Task BeginCollectionAsync(Nullable period, CancellationToken cancellationToken) ``` diff --git a/CodeDocumentation/SharedLibraryCore/interfaces/IServerDataViewer.md b/CodeDocumentation/SharedLibraryCore/interfaces/IServerDataViewer.md index 4f63dad..2cc8d4d 100644 --- a/CodeDocumentation/SharedLibraryCore/interfaces/IServerDataViewer.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IServerDataViewer.md @@ -30,6 +30,7 @@ Exposes methods to get analytical data about server(s) ### Methods #### MaxConcurrentClientsAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/API/Master/IMasterApi.cs#L27) ```csharp public Task<(Nullable Item1, Nullable Item2)> MaxConcurrentClientsAsync(Nullable serverId, Nullable gameCode, Nullable overPeriod, CancellationToken token) ``` @@ -42,6 +43,7 @@ public Task<(Nullable Item1, Nullable Item2)> MaxConcurrentClient | `CancellationToken` | token | | #### ClientCountsAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/API/Master/IMasterApi.cs#L31) ```csharp public Task<(int Item1, int Item2)> ClientCountsAsync(Nullable overPeriod, Nullable gameCode, CancellationToken token) ``` @@ -53,6 +55,7 @@ public Task<(int Item1, int Item2)> ClientCountsAsync(Nullable overPer | `CancellationToken` | token | | #### ClientHistoryAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/API/Master/IMasterApi.cs#L31) ```csharp public Task> ClientHistoryAsync(Nullable overPeriod, CancellationToken token) ``` @@ -63,6 +66,7 @@ public Task> ClientHistoryAsync(Nullable RankedClientsCountAsync(Nullable serverId, CancellationToken token) ``` diff --git a/CodeDocumentation/SharedLibraryCore/interfaces/ITokenAuthentication.md b/CodeDocumentation/SharedLibraryCore/interfaces/ITokenAuthentication.md index 8cdf5bc..52f6e32 100644 --- a/CodeDocumentation/SharedLibraryCore/interfaces/ITokenAuthentication.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/ITokenAuthentication.md @@ -22,6 +22,7 @@ ## Details ### Methods #### GenerateNextToken +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/API/Master/IMasterApi.cs#L43) ```csharp public TokenState GenerateNextToken(ITokenIdentifier authInfo) ``` @@ -37,6 +38,7 @@ generates and returns a token for the given network id 4 character string token #### AuthorizeToken +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/API/Master/IMasterApi.cs#L43) ```csharp public bool AuthorizeToken(ITokenIdentifier authInfo) ``` diff --git a/CodeDocumentation/SharedLibraryCore/interfaces/ParserRegex.md b/CodeDocumentation/SharedLibraryCore/interfaces/ParserRegex.md index b6406b6..56c2162 100644 --- a/CodeDocumentation/SharedLibraryCore/interfaces/ParserRegex.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/ParserRegex.md @@ -43,7 +43,7 @@ public ParserRegex(IParserPatternMatcher pattern) ### Methods #### AddMapping -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Helpers/ParserRegex.cs#L82) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/MetaService.cs#L220) ```csharp public void AddMapping(object mapKey, object mapValue) ``` diff --git a/CodeDocumentation/SharedLibraryCore/localization/ClientPermission.md b/CodeDocumentation/SharedLibraryCore/localization/ClientPermission.md index 22aafbc..a61ef5b 100644 --- a/CodeDocumentation/SharedLibraryCore/localization/ClientPermission.md +++ b/CodeDocumentation/SharedLibraryCore/localization/ClientPermission.md @@ -21,6 +21,7 @@ ## Details ### Constructors #### ClientPermission +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/DatedRecord.cs#L7) ```csharp public ClientPermission() ``` diff --git a/CodeDocumentation/SharedLibraryCore/localization/Layout.md b/CodeDocumentation/SharedLibraryCore/localization/Layout.md index 40a089d..dc7e28b 100644 --- a/CodeDocumentation/SharedLibraryCore/localization/Layout.md +++ b/CodeDocumentation/SharedLibraryCore/localization/Layout.md @@ -22,7 +22,7 @@ ## Details ### Constructors #### Layout -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Localization/Layout.cs#L11) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/LogPathGeneratorInfo.cs#L44) ```csharp public Layout(Dictionary set) ``` diff --git a/CodeDocumentation/SharedLibraryCore/localization/TranslationLookup.md b/CodeDocumentation/SharedLibraryCore/localization/TranslationLookup.md index b1182fa..eb19b17 100644 --- a/CodeDocumentation/SharedLibraryCore/localization/TranslationLookup.md +++ b/CodeDocumentation/SharedLibraryCore/localization/TranslationLookup.md @@ -31,6 +31,7 @@ SharedLibraryCore.Interfaces.ITranslationLookup --> SharedLibraryCore.Localizati ### Constructors #### TranslationLookup +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/MasterCommunication.cs#L30) ```csharp public TranslationLookup() ``` diff --git a/CodeDocumentation/SharedLibraryCore/queryhelper/ClientPaginationRequest.md b/CodeDocumentation/SharedLibraryCore/queryhelper/ClientPaginationRequest.md index 2cbf322..7936108 100644 --- a/CodeDocumentation/SharedLibraryCore/queryhelper/ClientPaginationRequest.md +++ b/CodeDocumentation/SharedLibraryCore/queryhelper/ClientPaginationRequest.md @@ -29,6 +29,7 @@ SharedLibraryCore.Dtos.PaginationRequest --> SharedLibraryCore.QueryHelper.Clien ### Constructors #### ClientPaginationRequest +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginWebRequest.cs#L6) ```csharp public ClientPaginationRequest() ``` diff --git a/CodeDocumentation/SharedLibraryCore/rcon/CommandPrefix.md b/CodeDocumentation/SharedLibraryCore/rcon/CommandPrefix.md index 3fa289b..18eeeb0 100644 --- a/CodeDocumentation/SharedLibraryCore/rcon/CommandPrefix.md +++ b/CodeDocumentation/SharedLibraryCore/rcon/CommandPrefix.md @@ -33,6 +33,7 @@ ## Details ### Constructors #### CommandPrefix +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginWebRequest.cs#L5) ```csharp public CommandPrefix() ``` diff --git a/CodeDocumentation/SharedLibraryCore/rcon/StaticHelpers.md b/CodeDocumentation/SharedLibraryCore/rcon/StaticHelpers.md index ead35bd..9f1b677 100644 --- a/CodeDocumentation/SharedLibraryCore/rcon/StaticHelpers.md +++ b/CodeDocumentation/SharedLibraryCore/rcon/StaticHelpers.md @@ -24,7 +24,7 @@ ### Methods #### SocketTimeout -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/RCon/StaticHelpers.cs#L54) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginWebRequest.cs#L5) ```csharp public static TimeSpan SocketTimeout(int retryAttempt) ``` diff --git a/CodeDocumentation/SharedLibraryCore/repositories/AuditInformationRepository.md b/CodeDocumentation/SharedLibraryCore/repositories/AuditInformationRepository.md index 57ab116..42eb2f4 100644 --- a/CodeDocumentation/SharedLibraryCore/repositories/AuditInformationRepository.md +++ b/CodeDocumentation/SharedLibraryCore/repositories/AuditInformationRepository.md @@ -36,17 +36,18 @@ implementation if IAuditInformationRepository ### Constructors #### AuditInformationRepository -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Repositories/AuditInformationRepository.cs#L19) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginTimerHelper.cs#L63) ```csharp public AuditInformationRepository(IDatabaseContextFactory contextFactory) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| `IDatabaseContextFactory` | contextFactory | | +| [`IDatabaseContextFactory`](../../data/abstractions/IDatabaseContextFactory.md) | contextFactory | | ### Methods #### ListAuditInformation +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginV2.cs#L34) ```csharp public virtual async Task> ListAuditInformation(PaginationRequest paginationInfo) ``` diff --git a/CodeDocumentation/SharedLibraryCore/services/ChangeHistoryService.md b/CodeDocumentation/SharedLibraryCore/services/ChangeHistoryService.md index 86f210e..4731a9b 100644 --- a/CodeDocumentation/SharedLibraryCore/services/ChangeHistoryService.md +++ b/CodeDocumentation/SharedLibraryCore/services/ChangeHistoryService.md @@ -20,7 +20,7 @@ ## Details ### Constructors #### ChangeHistoryService -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Services/ChangeHistoryService.cs#L16) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPlugin.cs#L16707566) ```csharp public ChangeHistoryService(ILogger logger, IDatabaseContextFactory contextFactory) ``` @@ -28,10 +28,11 @@ public ChangeHistoryService(ILogger logger, IDatabaseConte | Type | Name | Description | | --- | --- | --- | | `ILogger`<[`ChangeHistoryService`](sharedlibrarycore/services/ChangeHistoryService.md)> | logger | | -| `IDatabaseContextFactory` | contextFactory | | +| [`IDatabaseContextFactory`](../../data/abstractions/IDatabaseContextFactory.md) | contextFactory | | ### Methods #### Add +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPlugin.cs#L16707566) ```csharp public async Task Add(GameEvent e) ``` diff --git a/CodeDocumentation/SharedLibraryCore/services/ClientService.md b/CodeDocumentation/SharedLibraryCore/services/ClientService.md index 596a169..e498926 100644 --- a/CodeDocumentation/SharedLibraryCore/services/ClientService.md +++ b/CodeDocumentation/SharedLibraryCore/services/ClientService.md @@ -55,7 +55,7 @@ SharedLibraryCore.Interfaces.IResourceQueryHelper_2 --> SharedLibraryCore.Servic ### Constructors #### ClientService -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Services/ClientService.cs#L53) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPlugin.cs#L401) ```csharp public ClientService(ILogger logger, IDatabaseContextFactory databaseContextFactory, ApplicationConfiguration appConfig, IGeoLocationService geoLocationService) ``` @@ -63,12 +63,13 @@ public ClientService(ILogger logger, IDatabaseContextFactory data | Type | Name | Description | | --- | --- | --- | | `ILogger`<[`ClientService`](sharedlibrarycore/services/ClientService.md)> | logger | | -| `IDatabaseContextFactory` | databaseContextFactory | | +| [`IDatabaseContextFactory`](../../data/abstractions/IDatabaseContextFactory.md) | databaseContextFactory | | | [`ApplicationConfiguration`](../configuration/ApplicationConfiguration.md) | appConfig | | | [`IGeoLocationService`](../interfaces/IGeoLocationService.md) | geoLocationService | | ### Methods #### Create +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPlugin.cs#L518) ```csharp public virtual async Task Create(EFClient entity) ``` @@ -78,7 +79,7 @@ public virtual async Task Create(EFClient entity) | [`EFClient`](../database/models/EFClient.md) | entity | | #### Delete -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Services/ClientService.cs#L165) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPlugin.cs#L314) ```csharp public virtual Task Delete(EFClient entity) ``` @@ -88,7 +89,7 @@ public virtual Task Delete(EFClient entity) | [`EFClient`](../database/models/EFClient.md) | entity | | #### Find -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Services/ClientService.cs#L170) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPlugin.cs#L556) ```csharp public virtual Task> Find(Func e) ``` @@ -126,6 +127,7 @@ public virtual async Task Update(EFClient temporalClient) | [`EFClient`](../database/models/EFClient.md) | temporalClient | | #### QueryResource +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginConfigurationWrapper.cs#L23) ```csharp public virtual async Task> QueryResource(FindClientRequest query) ``` @@ -141,6 +143,7 @@ find clients matching the given query #### UpdateLevel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginConfigurationWrapper.cs#L80) ```csharp public virtual async Task UpdateLevel(Permission newPermission, EFClient temporalClient, EFClient origin) ``` @@ -152,6 +155,7 @@ public virtual async Task UpdateLevel(Permission newPermission, EFClient tempora | [`EFClient`](../database/models/EFClient.md) | origin | | #### UpdateAlias +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginConfigurationWrapper.cs#L83) ```csharp public async Task UpdateAlias(EFClient temporalClient) ``` @@ -161,6 +165,7 @@ public async Task UpdateAlias(EFClient temporalClient) | [`EFClient`](../database/models/EFClient.md) | temporalClient | | #### GetClientReportCount +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginConfigurationWrapper.cs#L119) ```csharp public async Task GetClientReportCount(int clientId) ``` @@ -176,6 +181,7 @@ retrieves the number of times the given client id has been reported #### CanBeAutoFlagged +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginConfigurationWrapper.cs#L124) ```csharp public async Task CanBeAutoFlagged(int clientId) ``` @@ -191,6 +197,7 @@ indicates if the given clientid can be autoflagged #### UnlinkClient +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginFactory.cs#L13) ```csharp public async Task UnlinkClient(int clientId) ``` @@ -206,11 +213,13 @@ Unlinks shared GUID account into its own separate account #### GetOwners +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginFactory.cs#L19) ```csharp public async Task> GetOwners() ``` #### HasOwnerAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginHelper.cs#L17) ```csharp public async Task HasOwnerAsync(CancellationToken token) ``` @@ -220,6 +229,7 @@ public async Task HasOwnerAsync(CancellationToken token) | `CancellationToken` | token | | #### GetOwnerCount +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginHelper.cs#L27) ```csharp public virtual async Task GetOwnerCount() ``` @@ -231,6 +241,7 @@ retrieves the number of owners #### GetClientForLogin +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginHelper.cs#L32) ```csharp public async Task GetClientForLogin(int clientId) ``` @@ -240,6 +251,7 @@ public async Task GetClientForLogin(int clientId) | `int` | clientId | | #### GetPrivilegedClients +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginHelper.cs#L38) ```csharp public async Task> GetPrivilegedClients(bool includeName) ``` @@ -249,6 +261,7 @@ public async Task> GetPrivilegedClients(bool includeName) | `bool` | includeName | | #### FindClientsByIdentifier +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginHelper.cs#L16707566) ```csharp public async Task> FindClientsByIdentifier(string identifier) ``` @@ -258,11 +271,13 @@ public async Task> FindClientsByIdentifier(string identifier) | `string` | identifier | | #### GetTotalClientsAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginHelper.cs#L16707566) ```csharp public async Task GetTotalClientsAsync() ``` #### GetRecentClientCount +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginHelper.cs#L80) ```csharp public async Task GetRecentClientCount() ``` @@ -273,6 +288,7 @@ Returns the number of clients seen today #### GetRecentClients +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginServiceResolver.cs#L14) ```csharp public async Task> GetRecentClients(PaginationRequest request) ``` @@ -288,6 +304,7 @@ gets the 10 most recently added clients to IW4MAdmin #### GetClientNameById +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginServiceResolver.cs#L20) ```csharp public async Task GetClientNameById(int clientId) ``` diff --git a/CodeDocumentation/SharedLibraryCore/services/PenaltyService.md b/CodeDocumentation/SharedLibraryCore/services/PenaltyService.md index 0f19dab..742354e 100644 --- a/CodeDocumentation/SharedLibraryCore/services/PenaltyService.md +++ b/CodeDocumentation/SharedLibraryCore/services/PenaltyService.md @@ -21,46 +21,48 @@ SharedLibraryCore.Interfaces.IEntityService_1 --> SharedLibraryCore.Services.Pen #### Public methods | Returns | Name | | --- | --- | -| `Task`<`List`<`EFPenalty`>> | [`ActivePenaltiesByRecentIdentifiers`](#activepenaltiesbyrecentidentifiers)(`int` linkId) | -| `Task`<`EFPenalty`> | [`Create`](#create)(`EFPenalty` newEntity) | +| `Task`<`List`<[`EFPenalty`](../../data/models/EFPenalty.md)>> | [`ActivePenaltiesByRecentIdentifiers`](#activepenaltiesbyrecentidentifiers)(`int` linkId) | +| `Task`<[`EFPenalty`](../../data/models/EFPenalty.md)> | [`Create`](#create)([`EFPenalty`](../../data/models/EFPenalty.md) newEntity) | | `Task` | [`CreatePenaltyIdentifier`](#createpenaltyidentifier)(`int` penaltyId, `long` networkId, `int` ipv4Address) | -| `Task`<`EFPenalty`> | [`Delete`](#delete)(`EFPenalty` entity) | -| `Task`<`IList`<`EFPenalty`>> | [`Find`](#find)(`Func`<`EFPenalty`, `bool`> expression) | -| `Task`<`EFPenalty`> | [`Get`](#get)(`int` entityID) | -| `Task`<`List`<`EFPenalty`>> | [`GetActivePenaltiesAsync`](#getactivepenaltiesasync)(`int` linkId, `int` currentAliasId, `long` networkId, `Game` game, `Nullable`<`int`> ip) | -| `Task`<`List`<`EFPenalty`>> | [`GetActivePenaltiesByIdentifier`](#getactivepenaltiesbyidentifier)(`Nullable`<`int`> ip, `long` networkId, `Game` game) | +| `Task`<[`EFPenalty`](../../data/models/EFPenalty.md)> | [`Delete`](#delete)([`EFPenalty`](../../data/models/EFPenalty.md) entity) | +| `Task`<`IList`<[`EFPenalty`](../../data/models/EFPenalty.md)>> | [`Find`](#find)(`Func`<[`EFPenalty`](../../data/models/EFPenalty.md), `bool`> expression) | +| `Task`<[`EFPenalty`](../../data/models/EFPenalty.md)> | [`Get`](#get)(`int` entityID) | +| `Task`<`List`<[`EFPenalty`](../../data/models/EFPenalty.md)>> | [`GetActivePenaltiesAsync`](#getactivepenaltiesasync)(`int` linkId, `int` currentAliasId, `long` networkId, `Game` game, `Nullable`<`int`> ip) | +| `Task`<`List`<[`EFPenalty`](../../data/models/EFPenalty.md)>> | [`GetActivePenaltiesByIdentifier`](#getactivepenaltiesbyidentifier)(`Nullable`<`int`> ip, `long` networkId, `Game` game) | | `Task`<`IList`<[`PenaltyInfo`](../dtos/PenaltyInfo.md)>> | [`GetRecentPenalties`](#getrecentpenalties)(`int` count, `int` offset, `PenaltyType` showOnly, `bool` ignoreAutomated) | -| `Task`<`EFPenalty`> | [`GetUnique`](#getunique)(`long` entityProperty, `object` altKey) | +| `Task`<[`EFPenalty`](../../data/models/EFPenalty.md)> | [`GetUnique`](#getunique)(`long` entityProperty, `object` altKey) | | `Task` | [`RemoveActivePenalties`](#removeactivepenalties)(`int` aliasLinkId, `long` networkId, `Game` game, `Nullable`<`int`> ipAddress) | -| `Task`<`EFPenalty`> | [`Update`](#update)(`EFPenalty` entity) | +| `Task`<[`EFPenalty`](../../data/models/EFPenalty.md)> | [`Update`](#update)([`EFPenalty`](../../data/models/EFPenalty.md) entity) | ## Details ### Inheritance - - [`IEntityService`](../interfaces/IEntityServiceT.md)<`EFPenalty`> + - [`IEntityService`](../interfaces/IEntityServiceT.md)<[`EFPenalty`](../../data/models/EFPenalty.md)> ### Constructors #### PenaltyService -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Services/PenaltyService.cs#L20) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginServiceResolver.cs#L16707566) ```csharp public PenaltyService(IDatabaseContextFactory contextFactory, ApplicationConfiguration appConfig) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| `IDatabaseContextFactory` | contextFactory | | +| [`IDatabaseContextFactory`](../../data/abstractions/IDatabaseContextFactory.md) | contextFactory | | | [`ApplicationConfiguration`](../configuration/ApplicationConfiguration.md) | appConfig | | ### Methods #### Create +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginServiceResolver.cs#L28) ```csharp public virtual async Task Create(EFPenalty newEntity) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| `EFPenalty` | newEntity | | +| [`EFPenalty`](../../data/models/EFPenalty.md) | newEntity | | #### CreatePenaltyIdentifier +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginTimerHelper.cs#L18) ```csharp public async Task CreatePenaltyIdentifier(int penaltyId, long networkId, int ipv4Address) ``` @@ -72,26 +74,27 @@ public async Task CreatePenaltyIdentifier(int penaltyId, long networkId, int ipv | `int` | ipv4Address | | #### Delete -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Services/PenaltyService.cs#L77) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginTimerHelper.cs#L33) ```csharp public virtual Task Delete(EFPenalty entity) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| `EFPenalty` | entity | | +| [`EFPenalty`](../../data/models/EFPenalty.md) | entity | | #### Find +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginTimerHelper.cs#L43) ```csharp public virtual async Task> Find(Func expression) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| `Func`<`EFPenalty`, `bool`> | expression | | +| `Func`<[`EFPenalty`](../../data/models/EFPenalty.md), `bool`> | expression | | #### Get -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Services/PenaltyService.cs#L87) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginTimerHelper.cs#L69) ```csharp public virtual Task Get(int entityID) ``` @@ -101,7 +104,7 @@ public virtual Task Get(int entityID) | `int` | entityID | | #### GetUnique -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Services/PenaltyService.cs#L92) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginTimerHelper.cs#L74) ```csharp public virtual Task GetUnique(long entityProperty, object altKey) ``` @@ -112,16 +115,17 @@ public virtual Task GetUnique(long entityProperty, object altKey) | `object` | altKey | | #### Update -[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Services/PenaltyService.cs#L97) +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginTimerHelper.cs#L79) ```csharp public virtual Task Update(EFPenalty entity) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| `EFPenalty` | entity | | +| [`EFPenalty`](../../data/models/EFPenalty.md) | entity | | #### GetRecentPenalties +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginTimerHelper.cs#L93) ```csharp public async Task> GetRecentPenalties(int count, int offset, PenaltyType showOnly, bool ignoreAutomated) ``` @@ -134,6 +138,7 @@ public async Task> GetRecentPenalties(int count, int offset, | `bool` | ignoreAutomated | | #### GetActivePenaltiesAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginTimerHelper.cs#L112) ```csharp public async Task> GetActivePenaltiesAsync(int linkId, int currentAliasId, long networkId, Game game, Nullable ip) ``` @@ -158,6 +163,7 @@ public async Task> GetActivePenaltiesByIdentifier(Nullable | `Game` | game | | #### ActivePenaltiesByRecentIdentifiers +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginTimerHelper.cs#L196) ```csharp public async Task> ActivePenaltiesByRecentIdentifiers(int linkId) ``` @@ -167,6 +173,7 @@ public async Task> ActivePenaltiesByRecentIdentifiers(int linkId | `int` | linkId | | #### RemoveActivePenalties +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginTimerHelper.cs#L200) ```csharp public virtual async Task RemoveActivePenalties(int aliasLinkId, long networkId, Game game, Nullable ipAddress) ``` diff --git a/CodeDocumentation/data/abstractions/IAuditFields.md b/CodeDocumentation/data/abstractions/IAuditFields.md new file mode 100644 index 0000000..d1d1419 --- /dev/null +++ b/CodeDocumentation/data/abstractions/IAuditFields.md @@ -0,0 +1,20 @@ +# IAuditFields `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Abstractions + Data.Abstractions.IAuditFields[[IAuditFields]] + end +``` + +## Details +### Constructors +#### IAuditFields +```csharp +public IAuditFields() +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/abstractions/IDataValueCacheTT.md b/CodeDocumentation/data/abstractions/IDataValueCacheTT.md new file mode 100644 index 0000000..c556557 --- /dev/null +++ b/CodeDocumentation/data/abstractions/IDataValueCacheTT.md @@ -0,0 +1,71 @@ +# IDataValueCache< TEntityType, TReturnType> `Public interface` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Abstractions + Data.Abstractions.IDataValueCache_2[[IDataValueCache< TEntityType,TReturnType >]] + class Data.Abstractions.IDataValueCache_2 interfaceStyle; + + end +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task`<`TReturnType`> | [`GetCacheItem`](#getcacheitem-12)(`...`) | +| `void` | [`SetCacheItem`](#setcacheitem-12)(`...`) | + +## Details +### Methods +#### SetCacheItem [1/2] +```csharp +public void SetCacheItem(Func, CancellationToken, Task> itemGetter, string keyName, Nullable expirationTime, bool autoRefresh) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Func`<`DbSet`<`TEntityType`>, `CancellationToken`, `Task`<`TReturnType`>> | itemGetter | | +| `string` | keyName | | +| `Nullable`<`TimeSpan`> | expirationTime | | +| `bool` | autoRefresh | | + +#### SetCacheItem [2/2] +```csharp +public void SetCacheItem(Func, IEnumerable, CancellationToken, Task> itemGetter, string keyName, IEnumerable ids, Nullable expirationTime, bool autoRefresh) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Func`<`DbSet`<`TEntityType`>, `IEnumerable`<`object`>, `CancellationToken`, `Task`<`TReturnType`>> | itemGetter | | +| `string` | keyName | | +| `IEnumerable`<`object`> | ids | | +| `Nullable`<`TimeSpan`> | expirationTime | | +| `bool` | autoRefresh | | + +#### GetCacheItem [1/2] +```csharp +public Task GetCacheItem(string keyName, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | keyName | | +| `CancellationToken` | token | | + +#### GetCacheItem [2/2] +```csharp +public Task GetCacheItem(string keyName, IEnumerable ids, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | keyName | | +| `IEnumerable`<`object`> | ids | | +| `CancellationToken` | token | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/abstractions/IDatabaseContextFactory.md b/CodeDocumentation/data/abstractions/IDatabaseContextFactory.md new file mode 100644 index 0000000..a4fc554 --- /dev/null +++ b/CodeDocumentation/data/abstractions/IDatabaseContextFactory.md @@ -0,0 +1,38 @@ +# IDatabaseContextFactory `Public interface` + +## Description +describes the capabilities of the database context factory + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Abstractions + Data.Abstractions.IDatabaseContextFactory[[IDatabaseContextFactory]] + class Data.Abstractions.IDatabaseContextFactory interfaceStyle; + end +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| [`DatabaseContext`](../context/DatabaseContext.md) | [`CreateContext`](#createcontext)(`Nullable`<`bool`> enableTracking) | + +## Details +### Summary +describes the capabilities of the database context factory + +### Methods +#### CreateContext +```csharp +public DatabaseContext CreateContext(Nullable enableTracking) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Nullable`<`bool`> | enableTracking | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/abstractions/ILookupCacheT.md b/CodeDocumentation/data/abstractions/ILookupCacheT.md new file mode 100644 index 0000000..53639f5 --- /dev/null +++ b/CodeDocumentation/data/abstractions/ILookupCacheT.md @@ -0,0 +1,57 @@ +# ILookupCache< T> `Public interface` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Abstractions + Data.Abstractions.ILookupCache_1[[ILookupCache< T >]] + class Data.Abstractions.ILookupCache_1 interfaceStyle; + + end +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task`<`T`> | [`AddAsync`](#addasync)(`T` item) | +| `Task`<`T`> | [`FirstAsync`](#firstasync)(`Func`<`T`, `bool`> query) | +| `IEnumerable`<`T`> | [`GetAll`](#getall)() | +| `Task` | [`InitializeAsync`](#initializeasync)() | + +## Details +### Methods +#### InitializeAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Services/PenaltyService.cs#L230) +```csharp +public Task InitializeAsync() +``` + +#### AddAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Services/PenaltyService.cs#L247) +```csharp +public Task AddAsync(T item) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `T` | item | | + +#### FirstAsync +```csharp +public Task FirstAsync(Func query) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Func`<`T`, `bool`> | query | | + +#### GetAll +```csharp +public IEnumerable GetAll() +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/abstractions/IPropertyExtender.md b/CodeDocumentation/data/abstractions/IPropertyExtender.md new file mode 100644 index 0000000..4cfd7bd --- /dev/null +++ b/CodeDocumentation/data/abstractions/IPropertyExtender.md @@ -0,0 +1,54 @@ +# IPropertyExtender `Internal interface` + +## Description +describes the capability of extending properties by name + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Abstractions + Data.Abstractions.IPropertyExtender[[IPropertyExtender]] + class Data.Abstractions.IPropertyExtender interfaceStyle; + end +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `T` | [`GetAdditionalProperty`](#getadditionalproperty)(`string` name) | +| `void` | [`SetAdditionalProperty`](#setadditionalproperty)(`string` name, `object` value)
adds or updates property by name | + +## Details +### Summary +describes the capability of extending properties by name + +### Methods +#### SetAdditionalProperty +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Services/PenaltyService.cs#L16707566) +```csharp +public void SetAdditionalProperty(string name, object value) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | name | unique name of the property | +| `object` | value | value of the property | + +##### Summary +adds or updates property by name + +#### GetAdditionalProperty +```csharp +public T GetAdditionalProperty(string name) +where T : +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | name | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/abstractions/IUniqueId.md b/CodeDocumentation/data/abstractions/IUniqueId.md new file mode 100644 index 0000000..33b049f --- /dev/null +++ b/CodeDocumentation/data/abstractions/IUniqueId.md @@ -0,0 +1,34 @@ +# IUniqueId `Public interface` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Abstractions + Data.Abstractions.IUniqueId[[IUniqueId]] + class Data.Abstractions.IUniqueId interfaceStyle; + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `long` | [`Id`](#id) | `get` | +| `string` | [`Value`](#value) | `get` | + +## Details +### Properties +#### Id +```csharp +public long Id { get; } +``` + +#### Value +```csharp +public string Value { get; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/context/ContextSeed.md b/CodeDocumentation/data/context/ContextSeed.md new file mode 100644 index 0000000..2597ddf --- /dev/null +++ b/CodeDocumentation/data/context/ContextSeed.md @@ -0,0 +1,32 @@ +# ContextSeed `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Context + Data.Context.ContextSeed[[ContextSeed]] + end +``` + +## Members +### Methods +#### Public Static methods +| Returns | Name | +| --- | --- | +| `Task` | [`Seed`](#seed)([`IDatabaseContextFactory`](../abstractions/IDatabaseContextFactory.md) contextFactory, `CancellationToken` token) | + +## Details +### Methods +#### Seed +```csharp +public static async Task Seed(IDatabaseContextFactory contextFactory, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`IDatabaseContextFactory`](../abstractions/IDatabaseContextFactory.md) | contextFactory | | +| `CancellationToken` | token | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/context/DatabaseContext.md b/CodeDocumentation/data/context/DatabaseContext.md new file mode 100644 index 0000000..91a438c --- /dev/null +++ b/CodeDocumentation/data/context/DatabaseContext.md @@ -0,0 +1,254 @@ +# DatabaseContext `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Context + Data.Context.DatabaseContext[[DatabaseContext]] + class Data.Context.DatabaseContext abstractStyle; + end + subgraph Microsoft.EntityFrameworkCore +Microsoft.EntityFrameworkCore.DbContext[[DbContext]] + end +Microsoft.EntityFrameworkCore.DbContext --> Data.Context.DatabaseContext +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `DbSet`<[`EFACSnapshot`](../models/client/stats/EFACSnapshot.md)> | [`ACSnapshots`](#acsnapshots) | `get, set` | +| `DbSet`<[`EFAliasLink`](../models/EFAliasLink.md)> | [`AliasLinks`](#aliaslinks) | `get, set` | +| `DbSet`<[`EFAlias`](../models/EFAlias.md)> | [`Aliases`](#aliases) | `get, set` | +| `DbSet`<[`EFClientKill`](../models/client/EFClientKill.md)> | [`ClientKills`](#clientkills) | `get, set` | +| `DbSet`<[`EFClientMessage`](../models/client/EFClientMessage.md)> | [`ClientMessages`](#clientmessages) | `get, set` | +| `DbSet`<[`EFClientStatistics`](../models/client/stats/EFClientStatistics.md)> | [`ClientStatistics`](#clientstatistics) | `get, set` | +| `DbSet`<[`EFClient`](../models/client/EFClient.md)> | [`Clients`](#clients) | `get, set` | +| `DbSet`<[`EFClientConnectionHistory`](../models/client/EFClientConnectionHistory.md)> | [`ConnectionHistory`](#connectionhistory) | `get, set` | +| `DbSet`<[`EFChangeHistory`](../models/EFChangeHistory.md)> | [`EFChangeHistory`](#efchangehistory) | `get, set` | +| `DbSet`<[`EFMeta`](../models/EFMeta.md)> | [`EFMeta`](#efmeta) | `get, set` | +| `DbSet`<[`EFHitLocation`](../models/client/stats/reference/EFHitLocation.md)> | [`HitLocations`](#hitlocations) | `get, set` | +| `DbSet`<[`EFClientHitStatistic`](../models/client/stats/EFClientHitStatistic.md)> | [`HitStatistics`](#hitstatistics) | `get, set` | +| `DbSet`<[`EFInboxMessage`](../models/misc/EFInboxMessage.md)> | [`InboxMessages`](#inboxmessages) | `get, set` | +| `DbSet`<[`EFMap`](../models/client/stats/reference/EFMap.md)> | [`Maps`](#maps) | `get, set` | +| `DbSet`<[`EFPenalty`](../models/EFPenalty.md)> | [`Penalties`](#penalties) | `get, set` | +| `DbSet`<[`EFPenaltyIdentifier`](../models/EFPenaltyIdentifier.md)> | [`PenaltyIdentifiers`](#penaltyidentifiers) | `get, set` | +| `DbSet`<[`EFServerSnapshot`](../models/server/EFServerSnapshot.md)> | [`ServerSnapshots`](#serversnapshots) | `get, set` | +| `DbSet`<[`EFServerStatistics`](../models/server/EFServerStatistics.md)> | [`ServerStatistics`](#serverstatistics) | `get, set` | +| `DbSet`<[`EFServer`](../models/server/EFServer.md)> | [`Servers`](#servers) | `get, set` | +| `DbSet`<[`EFACSnapshotVector3`](../models/client/EFACSnapshotVector3.md)> | [`SnapshotVector3s`](#snapshotvector3s) | `get, set` | +| `DbSet`<[`Vector3`](../models/Vector3.md)> | [`Vector3s`](#vector3s) | `get, set` | +| `DbSet`<[`EFWeaponAttachment`](../models/client/stats/reference/EFWeaponAttachment.md)> | [`WeaponAttachments`](#weaponattachments) | `get, set` | +| `DbSet`<[`EFWeapon`](../models/client/stats/reference/EFWeapon.md)> | [`Weapons`](#weapons) | `get, set` | +| `DbSet`<[`ZombieAggregateClientStat`](../models/zombie/ZombieAggregateClientStat.md)> | [`ZombieClientStatAggregates`](#zombieclientstataggregates) | `get, set` | +| `DbSet`<[`ZombieClientStatRecord`](../models/zombie/ZombieClientStatRecord.md)> | [`ZombieClientStatRecords`](#zombieclientstatrecords) | `get, set` | +| `DbSet`<[`ZombieMatchClientStat`](../models/zombie/ZombieMatchClientStat.md)> | [`ZombieMatchClientStats`](#zombiematchclientstats) | `get, set` | +| `DbSet`<[`ZombieMatch`](../models/zombie/ZombieMatch.md)> | [`ZombieMatches`](#zombiematches) | `get, set` | +| `DbSet`<[`ZombieRoundClientStat`](../models/zombie/ZombieRoundClientStat.md)> | [`ZombieRoundClientStats`](#zombieroundclientstats) | `get, set` | + +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `int` | [`SaveChanges`](#savechanges)() | +| `Task`<`int`> | [`SaveChangesAsync`](#savechangesasync)(`bool` acceptAllChangesOnSuccess, `CancellationToken` cancellationToken) | + +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`OnModelCreating`](#onmodelcreating)(`ModelBuilder` modelBuilder) | + +## Details +### Inheritance + - `DbContext` + +### Constructors +#### DatabaseContext [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Services/ClientService.cs#L16707566) +```csharp +public DatabaseContext() +``` + +#### DatabaseContext [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Context/DatabaseContext.cs#L76) +```csharp +protected DatabaseContext(DbContextOptions options) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `DbContextOptions` | options | | + +### Methods +#### SaveChangesAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Context/DatabaseContext.cs#L82) +```csharp +public override Task SaveChangesAsync(bool acceptAllChangesOnSuccess, CancellationToken cancellationToken) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `bool` | acceptAllChangesOnSuccess | | +| `CancellationToken` | cancellationToken | | + +#### SaveChanges +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Services/ClientService.cs#L16707566) +```csharp +public override int SaveChanges() +``` + +#### OnModelCreating +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Context/DatabaseContext.cs#L94) +```csharp +protected override void OnModelCreating(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +### Properties +#### Clients +```csharp +public DbSet Clients { get; set; } +``` + +#### Aliases +```csharp +public DbSet Aliases { get; set; } +``` + +#### AliasLinks +```csharp +public DbSet AliasLinks { get; set; } +``` + +#### Penalties +```csharp +public DbSet Penalties { get; set; } +``` + +#### PenaltyIdentifiers +```csharp +public DbSet PenaltyIdentifiers { get; set; } +``` + +#### EFMeta +```csharp +public DbSet EFMeta { get; set; } +``` + +#### EFChangeHistory +```csharp +public DbSet EFChangeHistory { get; set; } +``` + +#### Vector3s +```csharp +public DbSet Vector3s { get; set; } +``` + +#### SnapshotVector3s +```csharp +public DbSet SnapshotVector3s { get; set; } +``` + +#### ACSnapshots +```csharp +public DbSet ACSnapshots { get; set; } +``` + +#### Servers +```csharp +public DbSet Servers { get; set; } +``` + +#### ClientKills +```csharp +public DbSet ClientKills { get; set; } +``` + +#### ClientMessages +```csharp +public DbSet ClientMessages { get; set; } +``` + +#### ServerStatistics +```csharp +public DbSet ServerStatistics { get; set; } +``` + +#### ClientStatistics +```csharp +public DbSet ClientStatistics { get; set; } +``` + +#### HitLocations +```csharp +public DbSet HitLocations { get; set; } +``` + +#### HitStatistics +```csharp +public DbSet HitStatistics { get; set; } +``` + +#### Weapons +```csharp +public DbSet Weapons { get; set; } +``` + +#### WeaponAttachments +```csharp +public DbSet WeaponAttachments { get; set; } +``` + +#### Maps +```csharp +public DbSet Maps { get; set; } +``` + +#### InboxMessages +```csharp +public DbSet InboxMessages { get; set; } +``` + +#### ServerSnapshots +```csharp +public DbSet ServerSnapshots { get; set; } +``` + +#### ConnectionHistory +```csharp +public DbSet ConnectionHistory { get; set; } +``` + +#### ZombieMatches +```csharp +public DbSet ZombieMatches { get; set; } +``` + +#### ZombieMatchClientStats +```csharp +public DbSet ZombieMatchClientStats { get; set; } +``` + +#### ZombieRoundClientStats +```csharp +public DbSet ZombieRoundClientStats { get; set; } +``` + +#### ZombieClientStatAggregates +```csharp +public DbSet ZombieClientStatAggregates { get; set; } +``` + +#### ZombieClientStatRecords +```csharp +public DbSet ZombieClientStatRecords { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/extensions/MigrationExtensions.md b/CodeDocumentation/data/extensions/MigrationExtensions.md new file mode 100644 index 0000000..14cbb43 --- /dev/null +++ b/CodeDocumentation/data/extensions/MigrationExtensions.md @@ -0,0 +1,27 @@ +# MigrationExtensions `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Extensions + Data.Extensions.MigrationExtensions[[MigrationExtensions]] + end +``` + +## Members +### Properties +#### Public Static properties +| Type | Name | Methods | +| --- | --- | --- | +| `bool` | [`IsMigration`](#ismigration) | `get` | + +## Details +### Properties +#### IsMigration +```csharp +public static bool IsMigration { get; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/helpers/DataValueCacheTT.md b/CodeDocumentation/data/helpers/DataValueCacheTT.md new file mode 100644 index 0000000..ecbec05 --- /dev/null +++ b/CodeDocumentation/data/helpers/DataValueCacheTT.md @@ -0,0 +1,105 @@ +# DataValueCache<TEntityType, TReturnType> `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Helpers + Data.Helpers.DataValueCache_2[[DataValueCache< TEntityType,TReturnType >]] + + end + subgraph Data.Abstractions + Data.Abstractions.IDataValueCache_2[[IDataValueCache< TEntityType,TReturnType >]] + class Data.Abstractions.IDataValueCache_2 interfaceStyle; + + end +Data.Abstractions.IDataValueCache_2 --> Data.Helpers.DataValueCache_2 +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`Finalize`](#finalize)() | + +#### Public methods +| Returns | Name | +| --- | --- | +| `Task`<`TReturnType`> | [`GetCacheItem`](#getcacheitem-12)(`...`) | +| `void` | [`SetCacheItem`](#setcacheitem-12)(`...`) | + +## Details +### Inheritance + - [`IDataValueCache`](../abstractions/IDataValueCacheTT.md)<`TEntityType`, `TReturnType`> + +### Constructors +#### DataValueCache +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Helpers/DataValueCache.cs#L20) +```csharp +public DataValueCache(ILogger> logger, IDatabaseContextFactory contextFactory) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ILogger`<[`DataValueCache`](data/helpers/DataValueCacheTT.md)<`TEntityType`, `TReturnType`>> | logger | | +| [`IDatabaseContextFactory`](../abstractions/IDatabaseContextFactory.md) | contextFactory | | + +### Methods +#### Finalize +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Helpers/DataValueCache.cs#L48) +```csharp +protected override void Finalize() +``` + +#### SetCacheItem [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Helpers/DataValueCache.cs#L16707566) +```csharp +public virtual void SetCacheItem(Func, CancellationToken, Task> getter, string key, Nullable expirationTime, bool autoRefresh) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Func`<`DbSet`<`TEntityType`>, `CancellationToken`, `Task`<`TReturnType`>> | getter | | +| `string` | key | | +| `Nullable`<`TimeSpan`> | expirationTime | | +| `bool` | autoRefresh | | + +#### SetCacheItem [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Helpers/DataValueCache.cs#L16707566) +```csharp +public virtual void SetCacheItem(Func, IEnumerable, CancellationToken, Task> getter, string key, IEnumerable ids, Nullable expirationTime, bool autoRefresh) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Func`<`DbSet`<`TEntityType`>, `IEnumerable`<`object`>, `CancellationToken`, `Task`<`TReturnType`>> | getter | | +| `string` | key | | +| `IEnumerable`<`object`> | ids | | +| `Nullable`<`TimeSpan`> | expirationTime | | +| `bool` | autoRefresh | | + +#### GetCacheItem [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Helpers/DataValueCache.cs#L105) +```csharp +public virtual Task GetCacheItem(string keyName, CancellationToken cancellationToken) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | keyName | | +| `CancellationToken` | cancellationToken | | + +#### GetCacheItem [2/2] +```csharp +public virtual async Task GetCacheItem(string keyName, IEnumerable ids, CancellationToken cancellationToken) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | keyName | | +| `IEnumerable`<`object`> | ids | | +| `CancellationToken` | cancellationToken | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/helpers/LookupCacheT.md b/CodeDocumentation/data/helpers/LookupCacheT.md new file mode 100644 index 0000000..e383db8 --- /dev/null +++ b/CodeDocumentation/data/helpers/LookupCacheT.md @@ -0,0 +1,83 @@ +# LookupCache<T> `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Abstractions + Data.Abstractions.IUniqueId[[IUniqueId]] + class Data.Abstractions.IUniqueId interfaceStyle; + Data.Abstractions.ILookupCache_1[[ILookupCache< T >]] + class Data.Abstractions.ILookupCache_1 interfaceStyle; + + end + subgraph Data.Helpers + Data.Helpers.LookupCache_1[[LookupCache< T >]] + Data.Helpers.LookupCache_1T((T)); + Data.Helpers.LookupCache_1 -- where --o Data.Helpers.LookupCache_1T +Data.Abstractions.IUniqueId --> Data.Helpers.LookupCache_1T + + end +Data.Abstractions.ILookupCache_1 --> Data.Helpers.LookupCache_1 +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task`<`T`> | [`AddAsync`](#addasync)(`T` item) | +| `Task`<`T`> | [`FirstAsync`](#firstasync)(`Func`<`T`, `bool`> query) | +| `IEnumerable`<`T`> | [`GetAll`](#getall)() | +| `Task` | [`InitializeAsync`](#initializeasync)() | + +## Details +### Inheritance + - [`ILookupCache`](../abstractions/ILookupCacheT.md)<`T`> + +### Constructors +#### LookupCache +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Helpers/LookupCache.cs#L18) +```csharp +public LookupCache(ILogger> logger, IDatabaseContextFactory contextFactory) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ILogger`<[`LookupCache`](data/helpers/LookupCacheT.md)<`T`>> | logger | | +| [`IDatabaseContextFactory`](../abstractions/IDatabaseContextFactory.md) | contextFactory | | + +### Methods +#### AddAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Services/ClientService.cs#L16707566) +```csharp +public virtual async Task AddAsync(T item) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `T` | item | | + +#### FirstAsync +```csharp +public virtual async Task FirstAsync(Func query) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Func`<`T`, `bool`> | query | | + +#### GetAll +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Helpers/LookupCache.cs#L85) +```csharp +public virtual IEnumerable GetAll() +``` + +#### InitializeAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Services/ClientService.cs#L16707566) +```csharp +public virtual async Task InitializeAsync() +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrationcontext/MySqlDatabaseContext.md b/CodeDocumentation/data/migrationcontext/MySqlDatabaseContext.md new file mode 100644 index 0000000..381eabc --- /dev/null +++ b/CodeDocumentation/data/migrationcontext/MySqlDatabaseContext.md @@ -0,0 +1,59 @@ +# MySqlDatabaseContext `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.MigrationContext + Data.MigrationContext.MySqlDatabaseContext[[MySqlDatabaseContext]] + end + subgraph Data.Context + Data.Context.DatabaseContext[[DatabaseContext]] + class Data.Context.DatabaseContext abstractStyle; + end +Data.Context.DatabaseContext --> Data.MigrationContext.MySqlDatabaseContext +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`OnConfiguring`](#onconfiguring)(`DbContextOptionsBuilder` optionsBuilder) | + +## Details +### Inheritance + - [ +`DatabaseContext` +](../context/DatabaseContext.md) + +### Constructors +#### MySqlDatabaseContext [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/MigrationContext/MySqlDatabaseContext.cs#L10) +```csharp +public MySqlDatabaseContext() +``` + +#### MySqlDatabaseContext [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Services/ClientService.cs#L562) +```csharp +public MySqlDatabaseContext(DbContextOptions options) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `DbContextOptions` | options | | + +### Methods +#### OnConfiguring +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/MigrationContext/MySqlDatabaseContext.cs#L24) +```csharp +protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `DbContextOptionsBuilder` | optionsBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrationcontext/PostgresqlDatabaseContext.md b/CodeDocumentation/data/migrationcontext/PostgresqlDatabaseContext.md new file mode 100644 index 0000000..9cc7521 --- /dev/null +++ b/CodeDocumentation/data/migrationcontext/PostgresqlDatabaseContext.md @@ -0,0 +1,59 @@ +# PostgresqlDatabaseContext `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.MigrationContext + Data.MigrationContext.PostgresqlDatabaseContext[[PostgresqlDatabaseContext]] + end + subgraph Data.Context + Data.Context.DatabaseContext[[DatabaseContext]] + class Data.Context.DatabaseContext abstractStyle; + end +Data.Context.DatabaseContext --> Data.MigrationContext.PostgresqlDatabaseContext +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`OnConfiguring`](#onconfiguring)(`DbContextOptionsBuilder` optionsBuilder) | + +## Details +### Inheritance + - [ +`DatabaseContext` +](../context/DatabaseContext.md) + +### Constructors +#### PostgresqlDatabaseContext [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/MigrationContext/PostgresqlDatabaseContext.cs#L10) +```csharp +public PostgresqlDatabaseContext() +``` + +#### PostgresqlDatabaseContext [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/MigrationContext/PostgresqlDatabaseContext.cs#L18) +```csharp +public PostgresqlDatabaseContext(DbContextOptions options) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `DbContextOptions` | options | | + +### Methods +#### OnConfiguring +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/MigrationContext/PostgresqlDatabaseContext.cs#L23) +```csharp +protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `DbContextOptionsBuilder` | optionsBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrationcontext/SqliteDatabaseContext.md b/CodeDocumentation/data/migrationcontext/SqliteDatabaseContext.md new file mode 100644 index 0000000..1c5c7cf --- /dev/null +++ b/CodeDocumentation/data/migrationcontext/SqliteDatabaseContext.md @@ -0,0 +1,59 @@ +# SqliteDatabaseContext `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.MigrationContext + Data.MigrationContext.SqliteDatabaseContext[[SqliteDatabaseContext]] + end + subgraph Data.Context + Data.Context.DatabaseContext[[DatabaseContext]] + class Data.Context.DatabaseContext abstractStyle; + end +Data.Context.DatabaseContext --> Data.MigrationContext.SqliteDatabaseContext +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`OnConfiguring`](#onconfiguring)(`DbContextOptionsBuilder` optionsBuilder) | + +## Details +### Inheritance + - [ +`DatabaseContext` +](../context/DatabaseContext.md) + +### Constructors +#### SqliteDatabaseContext [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/MigrationContext/SqliteDatabaseContext.cs#L10) +```csharp +public SqliteDatabaseContext() +``` + +#### SqliteDatabaseContext [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Services/ClientService.cs#L709) +```csharp +public SqliteDatabaseContext(DbContextOptions options) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `DbContextOptions` | options | | + +### Methods +#### OnConfiguring +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/MigrationContext/SqliteDatabaseContext.cs#L24) +```csharp +protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `DbContextOptionsBuilder` | optionsBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AddActivityAmount.md b/CodeDocumentation/data/migrations/mysql/AddActivityAmount.md new file mode 100644 index 0000000..d1b6527 --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AddActivityAmount.md @@ -0,0 +1,68 @@ +# AddActivityAmount `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AddActivityAmount[[AddActivityAmount]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AddActivityAmount +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddActivityAmount +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/Validation/ApplicationConfigurationValidator.cs#L13) +```csharp +public AddActivityAmount() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/WebfrontConfiguration.cs#L5) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/WebfrontConfiguration.cs#L5) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20180601172317_AddActivityAmount.Designer.cs#L18) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AddAdvancedStats.md b/CodeDocumentation/data/migrations/mysql/AddAdvancedStats.md new file mode 100644 index 0000000..b284deb --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AddAdvancedStats.md @@ -0,0 +1,67 @@ +# AddAdvancedStats `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AddAdvancedStats[[AddAdvancedStats]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AddAdvancedStats +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddAdvancedStats +```csharp +public AddAdvancedStats() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20210315222843_AddAdvancedStats.cs#L10) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L16707566) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20210315222843_AddAdvancedStats.Designer.cs#L16) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AddAlternateKeyToEFClients.md b/CodeDocumentation/data/migrations/mysql/AddAlternateKeyToEFClients.md new file mode 100644 index 0000000..e3bbcb0 --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AddAlternateKeyToEFClients.md @@ -0,0 +1,67 @@ +# AddAlternateKeyToEFClients `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AddAlternateKeyToEFClients[[AddAlternateKeyToEFClients]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AddAlternateKeyToEFClients +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddAlternateKeyToEFClients +```csharp +public AddAlternateKeyToEFClients() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Services/ClientService.cs#L726) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20220613192602_AddAlternateKeyToEFClients.cs#L39) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20220613192602_AddAlternateKeyToEFClients.Designer.cs#L18) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AddAuditFieldsToEFPenaltyIdentifier.md b/CodeDocumentation/data/migrations/mysql/AddAuditFieldsToEFPenaltyIdentifier.md new file mode 100644 index 0000000..012d1f0 --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AddAuditFieldsToEFPenaltyIdentifier.md @@ -0,0 +1,68 @@ +# AddAuditFieldsToEFPenaltyIdentifier `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AddAuditFieldsToEFPenaltyIdentifier[[AddAuditFieldsToEFPenaltyIdentifier]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AddAuditFieldsToEFPenaltyIdentifier +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddAuditFieldsToEFPenaltyIdentifier +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L16707566) +```csharp +public AddAuditFieldsToEFPenaltyIdentifier() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L16707566) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20220223150028_AddAuditFieldsToEFPenaltyIdentifier.cs#L31) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20220223150028_AddAuditFieldsToEFPenaltyIdentifier.Designer.cs#L18) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AddAutomatedOffenseAndRatingHistory.md b/CodeDocumentation/data/migrations/mysql/AddAutomatedOffenseAndRatingHistory.md new file mode 100644 index 0000000..aada397 --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AddAutomatedOffenseAndRatingHistory.md @@ -0,0 +1,68 @@ +# AddAutomatedOffenseAndRatingHistory `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AddAutomatedOffenseAndRatingHistory[[AddAutomatedOffenseAndRatingHistory]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AddAutomatedOffenseAndRatingHistory +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddAutomatedOffenseAndRatingHistory +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L16707566) +```csharp +public AddAutomatedOffenseAndRatingHistory() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L125) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L130) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L135) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AddAvgRecoilOffset.md b/CodeDocumentation/data/migrations/mysql/AddAvgRecoilOffset.md new file mode 100644 index 0000000..2717084 --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AddAvgRecoilOffset.md @@ -0,0 +1,67 @@ +# AddAvgRecoilOffset `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AddAvgRecoilOffset[[AddAvgRecoilOffset]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AddAvgRecoilOffset +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddAvgRecoilOffset +```csharp +public AddAvgRecoilOffset() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20190615145212_AddAvgRecoilOffset.cs#L8) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/UnlinkClientCommand.cs#L17) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20190615145212_AddAvgRecoilOffset.Designer.cs#L16) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AddClientMeta.md b/CodeDocumentation/data/migrations/mysql/AddClientMeta.md new file mode 100644 index 0000000..260ccc7 --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AddClientMeta.md @@ -0,0 +1,67 @@ +# AddClientMeta `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AddClientMeta[[AddClientMeta]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AddClientMeta +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddClientMeta +```csharp +public AddClientMeta() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/Validation/ServerConfigurationValidator.cs#L10) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/Extensions/ConfigurationExtensions.cs#L17) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/Extensions/ConfigurationExtensions.cs#L42) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AddConnectionInterruptedToEFServerSnapshot.md b/CodeDocumentation/data/migrations/mysql/AddConnectionInterruptedToEFServerSnapshot.md new file mode 100644 index 0000000..53e95d7 --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AddConnectionInterruptedToEFServerSnapshot.md @@ -0,0 +1,67 @@ +# AddConnectionInterruptedToEFServerSnapshot `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AddConnectionInterruptedToEFServerSnapshot[[AddConnectionInterruptedToEFServerSnapshot]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AddConnectionInterruptedToEFServerSnapshot +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddConnectionInterruptedToEFServerSnapshot +```csharp +public AddConnectionInterruptedToEFServerSnapshot() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20220329213440_AddConnectionInterruptedToEFServerSnapshot.cs#L10) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20220329213440_AddConnectionInterruptedToEFServerSnapshot.cs#L19) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L16707566) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AddCurrentSnapValueToSnapshot.md b/CodeDocumentation/data/migrations/mysql/AddCurrentSnapValueToSnapshot.md new file mode 100644 index 0000000..4ac0b60 --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AddCurrentSnapValueToSnapshot.md @@ -0,0 +1,67 @@ +# AddCurrentSnapValueToSnapshot `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AddCurrentSnapValueToSnapshot[[AddCurrentSnapValueToSnapshot]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AddCurrentSnapValueToSnapshot +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddCurrentSnapValueToSnapshot +```csharp +public AddCurrentSnapValueToSnapshot() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20190914011524_AddCurrentSnapValueToSnapshot.cs#L8) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20190914011524_AddCurrentSnapValueToSnapshot.cs#L17) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Events/GameEvent.cs#L16707566) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AddDescendingTimeSentIndexEFClientMessages.md b/CodeDocumentation/data/migrations/mysql/AddDescendingTimeSentIndexEFClientMessages.md new file mode 100644 index 0000000..5965bd6 --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AddDescendingTimeSentIndexEFClientMessages.md @@ -0,0 +1,68 @@ +# AddDescendingTimeSentIndexEFClientMessages `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AddDescendingTimeSentIndexEFClientMessages[[AddDescendingTimeSentIndexEFClientMessages]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AddDescendingTimeSentIndexEFClientMessages +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddDescendingTimeSentIndexEFClientMessages +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Services/ClientService.cs#L434) +```csharp +public AddDescendingTimeSentIndexEFClientMessages() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20220616224602_AddDescendingTimeSentIndexEFClientMessages.cs#L11) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20220616224602_AddDescendingTimeSentIndexEFClientMessages.cs#L23) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20220616224602_AddDescendingTimeSentIndexEFClientMessages.Designer.cs#L18) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AddEFACSnapshots.md b/CodeDocumentation/data/migrations/mysql/AddEFACSnapshots.md new file mode 100644 index 0000000..dfec280 --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AddEFACSnapshots.md @@ -0,0 +1,67 @@ +# AddEFACSnapshots `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AddEFACSnapshots[[AddEFACSnapshots]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AddEFACSnapshots +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddEFACSnapshots +```csharp +public AddEFACSnapshots() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/Attributes/ConfigurationLinked.cs#L8) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/Attributes/ConfigurationLinked.cs#L13) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/Attributes/ConfigurationLinked.cs#L13) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AddEFAliasNameIndex.md b/CodeDocumentation/data/migrations/mysql/AddEFAliasNameIndex.md new file mode 100644 index 0000000..bfcc9a8 --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AddEFAliasNameIndex.md @@ -0,0 +1,67 @@ +# AddEFAliasNameIndex `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AddEFAliasNameIndex[[AddEFAliasNameIndex]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AddEFAliasNameIndex +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddEFAliasNameIndex +```csharp +public AddEFAliasNameIndex() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20180911184224_AddEFAliasNameIndex.cs#L8) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L232) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L308) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AddEFAliasNameMaxLength24.md b/CodeDocumentation/data/migrations/mysql/AddEFAliasNameMaxLength24.md new file mode 100644 index 0000000..23d079c --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AddEFAliasNameMaxLength24.md @@ -0,0 +1,67 @@ +# AddEFAliasNameMaxLength24 `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AddEFAliasNameMaxLength24[[AddEFAliasNameMaxLength24]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AddEFAliasNameMaxLength24 +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddEFAliasNameMaxLength24 +```csharp +public AddEFAliasNameMaxLength24() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L356) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20180911190823_AddEFAliasNameMaxLength24.cs#L21) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L413) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AddEFClientConnectionHistory.md b/CodeDocumentation/data/migrations/mysql/AddEFClientConnectionHistory.md new file mode 100644 index 0000000..5b416fd --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AddEFClientConnectionHistory.md @@ -0,0 +1,67 @@ +# AddEFClientConnectionHistory `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AddEFClientConnectionHistory[[AddEFClientConnectionHistory]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AddEFClientConnectionHistory +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddEFClientConnectionHistory +```csharp +public AddEFClientConnectionHistory() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20210831231006_AddEFClientConnectionHistory.cs#L10) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L16707566) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20210831231006_AddEFClientConnectionHistory.Designer.cs#L16) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AddEFInboxMessage.md b/CodeDocumentation/data/migrations/mysql/AddEFInboxMessage.md new file mode 100644 index 0000000..4fd4e25 --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AddEFInboxMessage.md @@ -0,0 +1,68 @@ +# AddEFInboxMessage `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AddEFInboxMessage[[AddEFInboxMessage]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AddEFInboxMessage +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddEFInboxMessage +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L16707566) +```csharp +public AddEFInboxMessage() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L16707566) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20210709010749_AddEFInboxMessage.cs#L65) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20210709010749_AddEFInboxMessage.Designer.cs#L16) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AddEFPenaltyIdentifier.md b/CodeDocumentation/data/migrations/mysql/AddEFPenaltyIdentifier.md new file mode 100644 index 0000000..cdb8ade --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AddEFPenaltyIdentifier.md @@ -0,0 +1,67 @@ +# AddEFPenaltyIdentifier `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AddEFPenaltyIdentifier[[AddEFPenaltyIdentifier]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AddEFPenaltyIdentifier +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddEFPenaltyIdentifier +```csharp +public AddEFPenaltyIdentifier() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20220222215149_AddEFPenaltyIdentifier.cs#L11) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20220222215149_AddEFPenaltyIdentifier.cs#L52) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L16707566) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AddEFServerSnapshot.md b/CodeDocumentation/data/migrations/mysql/AddEFServerSnapshot.md new file mode 100644 index 0000000..4729ff8 --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AddEFServerSnapshot.md @@ -0,0 +1,67 @@ +# AddEFServerSnapshot `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AddEFServerSnapshot[[AddEFServerSnapshot]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AddEFServerSnapshot +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddEFServerSnapshot +```csharp +public AddEFServerSnapshot() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20210826222452_AddEFServerSnapshot.cs#L10) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20210826222452_AddEFServerSnapshot.cs#L53) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L16707566) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AddEloField.md b/CodeDocumentation/data/migrations/mysql/AddEloField.md new file mode 100644 index 0000000..c390137 --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AddEloField.md @@ -0,0 +1,68 @@ +# AddEloField `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AddEloField[[AddEloField]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AddEloField +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddEloField +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L56) +```csharp +public AddEloField() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L48) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L52) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L52) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AddEndpointToEFServerUpdateServerIdType.md b/CodeDocumentation/data/migrations/mysql/AddEndpointToEFServerUpdateServerIdType.md new file mode 100644 index 0000000..61418b0 --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AddEndpointToEFServerUpdateServerIdType.md @@ -0,0 +1,67 @@ +# AddEndpointToEFServerUpdateServerIdType `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AddEndpointToEFServerUpdateServerIdType[[AddEndpointToEFServerUpdateServerIdType]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AddEndpointToEFServerUpdateServerIdType +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddEndpointToEFServerUpdateServerIdType +```csharp +public AddEndpointToEFServerUpdateServerIdType() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L988) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20181127144417_AddEndpointToEFServerUpdateServerIdType.cs#L16) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L1051) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AddEvadePenaltyFlag.md b/CodeDocumentation/data/migrations/mysql/AddEvadePenaltyFlag.md new file mode 100644 index 0000000..37364ed --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AddEvadePenaltyFlag.md @@ -0,0 +1,67 @@ +# AddEvadePenaltyFlag `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AddEvadePenaltyFlag[[AddEvadePenaltyFlag]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AddEvadePenaltyFlag +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddEvadePenaltyFlag +```csharp +public AddEvadePenaltyFlag() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L1093) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L1112) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L1139) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AddFractionAndIsKill.md b/CodeDocumentation/data/migrations/mysql/AddFractionAndIsKill.md new file mode 100644 index 0000000..ae70b69 --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AddFractionAndIsKill.md @@ -0,0 +1,68 @@ +# AddFractionAndIsKill `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AddFractionAndIsKill[[AddFractionAndIsKill]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AddFractionAndIsKill +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddFractionAndIsKill +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/CommandExtensions.cs#L6) +```csharp +public AddFractionAndIsKill() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/CommandArgument.cs#L16) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/CommandArgument.cs#L16) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20180902035612_AddFractionAndIsKill.Designer.cs#L16) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AddGameNameToEFServer.md b/CodeDocumentation/data/migrations/mysql/AddGameNameToEFServer.md new file mode 100644 index 0000000..a15578b --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AddGameNameToEFServer.md @@ -0,0 +1,68 @@ +# AddGameNameToEFServer `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AddGameNameToEFServer[[AddGameNameToEFServer]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AddGameNameToEFServer +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddGameNameToEFServer +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/RunAsCommand.cs#L11) +```csharp +public AddGameNameToEFServer() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/PrivateMessageAdminsCommand.cs#L23) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/RequestTokenCommand.cs#L14) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/RequestTokenCommand.cs#L24) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AddGameToEFClient.md b/CodeDocumentation/data/migrations/mysql/AddGameToEFClient.md new file mode 100644 index 0000000..54f0baf --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AddGameToEFClient.md @@ -0,0 +1,68 @@ +# AddGameToEFClient `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AddGameToEFClient[[AddGameToEFClient]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AddGameToEFClient +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddGameToEFClient +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Services/ClientService.cs#L433) +```csharp +public AddGameToEFClient() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Services/ClientService.cs#L86) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Services/ClientService.cs#L427) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Services/ClientService.cs#L427) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AddHitLocationReferenceToEFACSnapshot.md b/CodeDocumentation/data/migrations/mysql/AddHitLocationReferenceToEFACSnapshot.md new file mode 100644 index 0000000..6e45c5c --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AddHitLocationReferenceToEFACSnapshot.md @@ -0,0 +1,67 @@ +# AddHitLocationReferenceToEFACSnapshot `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AddHitLocationReferenceToEFACSnapshot[[AddHitLocationReferenceToEFACSnapshot]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AddHitLocationReferenceToEFACSnapshot +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddHitLocationReferenceToEFACSnapshot +```csharp +public AddHitLocationReferenceToEFACSnapshot() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20210629022028_AddHitLocationReferenceToEFACSnapshot.cs#L8) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L16707566) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20210629022028_AddHitLocationReferenceToEFACSnapshot.Designer.cs#L16) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AddHostnameToEFServer.md b/CodeDocumentation/data/migrations/mysql/AddHostnameToEFServer.md new file mode 100644 index 0000000..ceb74be --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AddHostnameToEFServer.md @@ -0,0 +1,68 @@ +# AddHostnameToEFServer `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AddHostnameToEFServer[[AddHostnameToEFServer]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AddHostnameToEFServer +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddHostnameToEFServer +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L200) +```csharp +public AddHostnameToEFServer() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L180) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L181) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L182) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AddImpersonationIdToEFChangeHistory.md b/CodeDocumentation/data/migrations/mysql/AddImpersonationIdToEFChangeHistory.md new file mode 100644 index 0000000..4d5746d --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AddImpersonationIdToEFChangeHistory.md @@ -0,0 +1,67 @@ +# AddImpersonationIdToEFChangeHistory `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AddImpersonationIdToEFChangeHistory[[AddImpersonationIdToEFChangeHistory]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AddImpersonationIdToEFChangeHistory +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddImpersonationIdToEFChangeHistory +```csharp +public AddImpersonationIdToEFChangeHistory() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L16707566) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20200423225137_AddImpersonationIdToEFChangeHistory.cs#L16) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20200423225137_AddImpersonationIdToEFChangeHistory.Designer.cs#L16) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AddIndexToEFMetaKeyAndClientId.md b/CodeDocumentation/data/migrations/mysql/AddIndexToEFMetaKeyAndClientId.md new file mode 100644 index 0000000..e3c3187 --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AddIndexToEFMetaKeyAndClientId.md @@ -0,0 +1,68 @@ +# AddIndexToEFMetaKeyAndClientId `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AddIndexToEFMetaKeyAndClientId[[AddIndexToEFMetaKeyAndClientId]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AddIndexToEFMetaKeyAndClientId +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddIndexToEFMetaKeyAndClientId +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/PrivateMessageAdminsCommand.cs#L12) +```csharp +public AddIndexToEFMetaKeyAndClientId() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L1178) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20190222234742_AddIndexToEFMeta-KeyAndClientId.cs#L24) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20190222234742_AddIndexToEFMeta-KeyAndClientId.Designer.cs#L16) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AddIndexToEFRankingHistoryCreatedDatetime.md b/CodeDocumentation/data/migrations/mysql/AddIndexToEFRankingHistoryCreatedDatetime.md new file mode 100644 index 0000000..841614f --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AddIndexToEFRankingHistoryCreatedDatetime.md @@ -0,0 +1,68 @@ +# AddIndexToEFRankingHistoryCreatedDatetime `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AddIndexToEFRankingHistoryCreatedDatetime[[AddIndexToEFRankingHistoryCreatedDatetime]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AddIndexToEFRankingHistoryCreatedDatetime +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddIndexToEFRankingHistoryCreatedDatetime +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Services/ClientService.cs#L560) +```csharp +public AddIndexToEFRankingHistoryCreatedDatetime() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Services/ClientService.cs#L440) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Services/ClientService.cs#L448) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Services/ClientService.cs#L456) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AddIndexToMessageTimeSent.md b/CodeDocumentation/data/migrations/mysql/AddIndexToMessageTimeSent.md new file mode 100644 index 0000000..8587b57 --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AddIndexToMessageTimeSent.md @@ -0,0 +1,68 @@ +# AddIndexToMessageTimeSent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AddIndexToMessageTimeSent[[AddIndexToMessageTimeSent]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AddIndexToMessageTimeSent +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddIndexToMessageTimeSent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L644) +```csharp +public AddIndexToMessageTimeSent() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L610) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L621) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L633) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AddIndexToSearchableIPToEFAlias.md b/CodeDocumentation/data/migrations/mysql/AddIndexToSearchableIPToEFAlias.md new file mode 100644 index 0000000..f0c85cc --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AddIndexToSearchableIPToEFAlias.md @@ -0,0 +1,67 @@ +# AddIndexToSearchableIPToEFAlias `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AddIndexToSearchableIPToEFAlias[[AddIndexToSearchableIPToEFAlias]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AddIndexToSearchableIPToEFAlias +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddIndexToSearchableIPToEFAlias +```csharp +public AddIndexToSearchableIPToEFAlias() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Services/ChangeHistoryService.cs#L16707566) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20220404192417_AddIndexToSearchableIPToEFAlias.cs#L18) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20220404192417_AddIndexToSearchableIPToEFAlias.Designer.cs#L18) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AddIsPasswordProtectedColumn.md b/CodeDocumentation/data/migrations/mysql/AddIsPasswordProtectedColumn.md new file mode 100644 index 0000000..3940934 --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AddIsPasswordProtectedColumn.md @@ -0,0 +1,68 @@ +# AddIsPasswordProtectedColumn `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AddIsPasswordProtectedColumn[[AddIsPasswordProtectedColumn]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AddIsPasswordProtectedColumn +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddIsPasswordProtectedColumn +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1295) +```csharp +public AddIsPasswordProtectedColumn() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L459) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L795) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L895) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AddLastConnectionIndexEFClient.md b/CodeDocumentation/data/migrations/mysql/AddLastConnectionIndexEFClient.md new file mode 100644 index 0000000..76c3e46 --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AddLastConnectionIndexEFClient.md @@ -0,0 +1,68 @@ +# AddLastConnectionIndexEFClient `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AddLastConnectionIndexEFClient[[AddLastConnectionIndexEFClient]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AddLastConnectionIndexEFClient +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddLastConnectionIndexEFClient +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Services/ClientService.cs#L514) +```csharp +public AddLastConnectionIndexEFClient() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Services/ClientService.cs#L467) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Services/ClientService.cs#L480) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Services/ClientService.cs#L488) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AddMissingActiveColumns.md b/CodeDocumentation/data/migrations/mysql/AddMissingActiveColumns.md new file mode 100644 index 0000000..6dcb094 --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AddMissingActiveColumns.md @@ -0,0 +1,67 @@ +# AddMissingActiveColumns `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AddMissingActiveColumns[[AddMissingActiveColumns]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AddMissingActiveColumns +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddMissingActiveColumns +```csharp +public AddMissingActiveColumns() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20191230140947_AddMissingActiveColumns.cs#L8) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L16707566) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20191230140947_AddMissingActiveColumns.Designer.cs#L16) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AddPreviousCurrentValueToEFChangeHistory.md b/CodeDocumentation/data/migrations/mysql/AddPreviousCurrentValueToEFChangeHistory.md new file mode 100644 index 0000000..31e1d7e --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AddPreviousCurrentValueToEFChangeHistory.md @@ -0,0 +1,67 @@ +# AddPreviousCurrentValueToEFChangeHistory `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AddPreviousCurrentValueToEFChangeHistory[[AddPreviousCurrentValueToEFChangeHistory]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AddPreviousCurrentValueToEFChangeHistory +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddPreviousCurrentValueToEFChangeHistory +```csharp +public AddPreviousCurrentValueToEFChangeHistory() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L439) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20180912015012_AddPreviousCurrentValueToEFChangeHistory.cs#L22) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L468) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AddRatingIndexes.md b/CodeDocumentation/data/migrations/mysql/AddRatingIndexes.md new file mode 100644 index 0000000..50b37d8 --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AddRatingIndexes.md @@ -0,0 +1,68 @@ +# AddRatingIndexes `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AddRatingIndexes[[AddRatingIndexes]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AddRatingIndexes +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddRatingIndexes +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L236) +```csharp +public AddRatingIndexes() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L167) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L185) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20180910221749_AddRatingIndexes.Designer.cs#L16) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AddRecoilOffsetToSnapshot.md b/CodeDocumentation/data/migrations/mysql/AddRecoilOffsetToSnapshot.md new file mode 100644 index 0000000..314fecf --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AddRecoilOffsetToSnapshot.md @@ -0,0 +1,68 @@ +# AddRecoilOffsetToSnapshot `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AddRecoilOffsetToSnapshot[[AddRecoilOffsetToSnapshot]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AddRecoilOffsetToSnapshot +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddRecoilOffsetToSnapshot +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/BaseController.cs#L96) +```csharp +public AddRecoilOffsetToSnapshot() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20190615214055_AddRecoilOffsetToSnapshot.cs#L8) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20190615214055_AddRecoilOffsetToSnapshot.cs#L17) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/BaseController.cs#L58) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AddRollingKDR.md b/CodeDocumentation/data/migrations/mysql/AddRollingKDR.md new file mode 100644 index 0000000..4de5750 --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AddRollingKDR.md @@ -0,0 +1,68 @@ +# AddRollingKDR `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AddRollingKDR[[AddRollingKDR]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AddRollingKDR +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddRollingKDR +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L60) +```csharp +public AddRollingKDR() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L56) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L57) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L57) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AddSearchNameToEFAlias.md b/CodeDocumentation/data/migrations/mysql/AddSearchNameToEFAlias.md new file mode 100644 index 0000000..e563a5c --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AddSearchNameToEFAlias.md @@ -0,0 +1,68 @@ +# AddSearchNameToEFAlias `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AddSearchNameToEFAlias[[AddSearchNameToEFAlias]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AddSearchNameToEFAlias +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddSearchNameToEFAlias +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/BaseController.cs#L179) +```csharp +public AddSearchNameToEFAlias() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/BaseController.cs#L174) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/BaseController.cs#L176) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/BaseController.cs#L177) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AddSearchableIPToEFAlias.md b/CodeDocumentation/data/migrations/mysql/AddSearchableIPToEFAlias.md new file mode 100644 index 0000000..f4a94f4 --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AddSearchableIPToEFAlias.md @@ -0,0 +1,67 @@ +# AddSearchableIPToEFAlias `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AddSearchableIPToEFAlias[[AddSearchableIPToEFAlias]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AddSearchableIPToEFAlias +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddSearchableIPToEFAlias +```csharp +public AddSearchableIPToEFAlias() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20220404151444_AddSearchableIPToEFAlias.cs#L10) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20220404151444_AddSearchableIPToEFAlias.cs#L23) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Services/ChangeHistoryService.cs#L45) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AddSentIngameFlagToClientMessage.md b/CodeDocumentation/data/migrations/mysql/AddSentIngameFlagToClientMessage.md new file mode 100644 index 0000000..43f2832 --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AddSentIngameFlagToClientMessage.md @@ -0,0 +1,67 @@ +# AddSentIngameFlagToClientMessage `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AddSentIngameFlagToClientMessage[[AddSentIngameFlagToClientMessage]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AddSentIngameFlagToClientMessage +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddSentIngameFlagToClientMessage +```csharp +public AddSentIngameFlagToClientMessage() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L583) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20201118023106_AddSentIngameFlagToClientMessage.cs#L17) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1276) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AddSessionSnapHitsToSnapshot.md b/CodeDocumentation/data/migrations/mysql/AddSessionSnapHitsToSnapshot.md new file mode 100644 index 0000000..d4a84dc --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AddSessionSnapHitsToSnapshot.md @@ -0,0 +1,68 @@ +# AddSessionSnapHitsToSnapshot `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AddSessionSnapHitsToSnapshot[[AddSessionSnapHitsToSnapshot]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AddSessionSnapHitsToSnapshot +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddSessionSnapHitsToSnapshot +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L179) +```csharp +public AddSessionSnapHitsToSnapshot() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20190914012015_AddSessionSnapHitsToSnapshot.cs#L8) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20190914012015_AddSessionSnapHitsToSnapshot.cs#L17) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L133) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AddSnapHitCountToClientStatistics.md b/CodeDocumentation/data/migrations/mysql/AddSnapHitCountToClientStatistics.md new file mode 100644 index 0000000..3f1b41b --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AddSnapHitCountToClientStatistics.md @@ -0,0 +1,67 @@ +# AddSnapHitCountToClientStatistics `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AddSnapHitCountToClientStatistics[[AddSnapHitCountToClientStatistics]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AddSnapHitCountToClientStatistics +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddSnapHitCountToClientStatistics +```csharp +public AddSnapHitCountToClientStatistics() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20190901180209_AddSnapHitCountToClientStatistics.cs#L8) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/BaseController.cs#L16707566) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20190901180209_AddSnapHitCountToClientStatistics.Designer.cs#L16) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AddVisibilityPercentage.md b/CodeDocumentation/data/migrations/mysql/AddVisibilityPercentage.md new file mode 100644 index 0000000..b57a667 --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AddVisibilityPercentage.md @@ -0,0 +1,68 @@ +# AddVisibilityPercentage `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AddVisibilityPercentage[[AddVisibilityPercentage]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AddVisibilityPercentage +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddVisibilityPercentage +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L26) +```csharp +public AddVisibilityPercentage() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/CommandExtensions.cs#L11) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20180904154622_AddVisibilityPercentage.cs#L17) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20180904154622_AddVisibilityPercentage.Designer.cs#L16) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AddVision.md b/CodeDocumentation/data/migrations/mysql/AddVision.md new file mode 100644 index 0000000..f7f2664 --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AddVision.md @@ -0,0 +1,68 @@ +# AddVision `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AddVision[[AddVision]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AddVision +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddVision +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L69) +```csharp +public AddVision() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20180907020706_AddVision.cs#L8) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L47) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20180907020706_AddVision.Designer.cs#L16) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AddWeaponReferenceAndServerIdToEFACSnapshot.md b/CodeDocumentation/data/migrations/mysql/AddWeaponReferenceAndServerIdToEFACSnapshot.md new file mode 100644 index 0000000..2e82a7a --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AddWeaponReferenceAndServerIdToEFACSnapshot.md @@ -0,0 +1,67 @@ +# AddWeaponReferenceAndServerIdToEFACSnapshot `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AddWeaponReferenceAndServerIdToEFACSnapshot[[AddWeaponReferenceAndServerIdToEFACSnapshot]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AddWeaponReferenceAndServerIdToEFACSnapshot +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddWeaponReferenceAndServerIdToEFACSnapshot +```csharp +public AddWeaponReferenceAndServerIdToEFACSnapshot() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20210628160144_AddWeaponReferenceAndServerIdToEFACSnapshot.cs#L8) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20210628160144_AddWeaponReferenceAndServerIdToEFACSnapshot.cs#L34) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L16707566) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AddWeaponReferenceToEFClientKill.md b/CodeDocumentation/data/migrations/mysql/AddWeaponReferenceToEFClientKill.md new file mode 100644 index 0000000..20e30e9 --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AddWeaponReferenceToEFClientKill.md @@ -0,0 +1,68 @@ +# AddWeaponReferenceToEFClientKill `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AddWeaponReferenceToEFClientKill[[AddWeaponReferenceToEFClientKill]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AddWeaponReferenceToEFClientKill +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddWeaponReferenceToEFClientKill +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L16707566) +```csharp +public AddWeaponReferenceToEFClientKill() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L16707566) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20210628153649_AddWeaponReferenceToEFClientKill.cs#L16) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20210628153649_AddWeaponReferenceToEFClientKill.Designer.cs#L16) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AddWhenToRating.md b/CodeDocumentation/data/migrations/mysql/AddWhenToRating.md new file mode 100644 index 0000000..4d4db0d --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AddWhenToRating.md @@ -0,0 +1,68 @@ +# AddWhenToRating `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AddWhenToRating[[AddWhenToRating]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AddWhenToRating +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddWhenToRating +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L148) +```csharp +public AddWhenToRating() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20180908004053_AddWhenToRating.cs#L9) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L108) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L132) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AlterEFRatingIndex.md b/CodeDocumentation/data/migrations/mysql/AlterEFRatingIndex.md new file mode 100644 index 0000000..d009003 --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AlterEFRatingIndex.md @@ -0,0 +1,68 @@ +# AlterEFRatingIndex `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AlterEFRatingIndex[[AlterEFRatingIndex]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AlterEFRatingIndex +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AlterEFRatingIndex +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/BaseController.cs#L113) +```csharp +public AlterEFRatingIndex() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/BaseController.cs#L103) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/BaseController.cs#L107) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/BaseController.cs#L109) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/AvgSnapValueToClientStatistics.md b/CodeDocumentation/data/migrations/mysql/AvgSnapValueToClientStatistics.md new file mode 100644 index 0000000..e855595 --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/AvgSnapValueToClientStatistics.md @@ -0,0 +1,67 @@ +# AvgSnapValueToClientStatistics `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.AvgSnapValueToClientStatistics[[AvgSnapValueToClientStatistics]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.AvgSnapValueToClientStatistics +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AvgSnapValueToClientStatistics +```csharp +public AvgSnapValueToClientStatistics() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/BaseController.cs#L179) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20190831210503_AvgSnapValueToClientStatistics.cs#L17) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/BaseController.cs#L16707566) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/EnforceUniqueIndexForEFAliasIPName.md b/CodeDocumentation/data/migrations/mysql/EnforceUniqueIndexForEFAliasIPName.md new file mode 100644 index 0000000..37d823c --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/EnforceUniqueIndexForEFAliasIPName.md @@ -0,0 +1,68 @@ +# EnforceUniqueIndexForEFAliasIPName `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.EnforceUniqueIndexForEFAliasIPName[[EnforceUniqueIndexForEFAliasIPName]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.EnforceUniqueIndexForEFAliasIPName +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### EnforceUniqueIndexForEFAliasIPName +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L16707566) +```csharp +public EnforceUniqueIndexForEFAliasIPName() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20191030000713_EnforceUniqueIndexForEFAliasIPName.cs#L8) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L439) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20191030000713_EnforceUniqueIndexForEFAliasIPName.Designer.cs#L16) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/IndexForEFAlias.md b/CodeDocumentation/data/migrations/mysql/IndexForEFAlias.md new file mode 100644 index 0000000..72c15e1 --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/IndexForEFAlias.md @@ -0,0 +1,68 @@ +# IndexForEFAlias `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.IndexForEFAlias[[IndexForEFAlias]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.IndexForEFAlias +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### IndexForEFAlias +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/CommandArgument.cs#L11) +```csharp +public IndexForEFAlias() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/Attributes/LocalizedDisplayName.cs#L9) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/Attributes/LocalizedDisplayName.cs#L14) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/CommandArgument.cs#L11) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/InitialCreate.md b/CodeDocumentation/data/migrations/mysql/InitialCreate.md new file mode 100644 index 0000000..8ce8847 --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/InitialCreate.md @@ -0,0 +1,68 @@ +# InitialCreate `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.InitialCreate[[InitialCreate]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.InitialCreate +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### InitialCreate +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L42) +```csharp +public InitialCreate() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L35) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L39) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L39) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/MakeClientIPNullable.md b/CodeDocumentation/data/migrations/mysql/MakeClientIPNullable.md new file mode 100644 index 0000000..710e09e --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/MakeClientIPNullable.md @@ -0,0 +1,68 @@ +# MakeClientIPNullable `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.MakeClientIPNullable[[MakeClientIPNullable]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.MakeClientIPNullable +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### MakeClientIPNullable +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L974) +```csharp +public MakeClientIPNullable() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L927) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20181125193243_MakeClientIPNullable.cs#L76) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L963) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/MakeEFPenaltyLinkIdNullable.md b/CodeDocumentation/data/migrations/mysql/MakeEFPenaltyLinkIdNullable.md new file mode 100644 index 0000000..8e61af9 --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/MakeEFPenaltyLinkIdNullable.md @@ -0,0 +1,67 @@ +# MakeEFPenaltyLinkIdNullable `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.MakeEFPenaltyLinkIdNullable[[MakeEFPenaltyLinkIdNullable]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.MakeEFPenaltyLinkIdNullable +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### MakeEFPenaltyLinkIdNullable +```csharp +public MakeEFPenaltyLinkIdNullable() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20220222230049_MakeEFPenaltyLinkIdNullable.cs#L10) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L16707566) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20220222230049_MakeEFPenaltyLinkIdNullable.Designer.cs#L18) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/MakePenaltyExpirationNullable.md b/CodeDocumentation/data/migrations/mysql/MakePenaltyExpirationNullable.md new file mode 100644 index 0000000..10bf943 --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/MakePenaltyExpirationNullable.md @@ -0,0 +1,67 @@ +# MakePenaltyExpirationNullable `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.MakePenaltyExpirationNullable[[MakePenaltyExpirationNullable]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.MakePenaltyExpirationNullable +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### MakePenaltyExpirationNullable +```csharp +public MakePenaltyExpirationNullable() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L846) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20181014171848_MakePenaltyExpirationNullable.cs#L96) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L878) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/MySqlDatabaseContextModelSnapshot.md b/CodeDocumentation/data/migrations/mysql/MySqlDatabaseContextModelSnapshot.md new file mode 100644 index 0000000..4756f74 --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/MySqlDatabaseContextModelSnapshot.md @@ -0,0 +1,45 @@ +# MySqlDatabaseContextModelSnapshot `Internal class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.MySqlDatabaseContextModelSnapshot[[MySqlDatabaseContextModelSnapshot]] + end + subgraph Microsoft.EntityFrameworkCore.Infrastructure +Microsoft.EntityFrameworkCore.Infrastructure.ModelSnapshot[[ModelSnapshot]] + end +Microsoft.EntityFrameworkCore.Infrastructure.ModelSnapshot --> Data.Migrations.MySql.MySqlDatabaseContextModelSnapshot +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildModel`](#buildmodel)(`ModelBuilder` modelBuilder) | + +## Details +### Inheritance + - `ModelSnapshot` + +### Constructors +#### MySqlDatabaseContextModelSnapshot +```csharp +public MySqlDatabaseContextModelSnapshot() +``` + +### Methods +#### BuildModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/MySqlDatabaseContextModelSnapshot.cs#L16) +```csharp +protected override void BuildModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/ReaddACSnapshot.md b/CodeDocumentation/data/migrations/mysql/ReaddACSnapshot.md new file mode 100644 index 0000000..e3de03c --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/ReaddACSnapshot.md @@ -0,0 +1,67 @@ +# ReaddACSnapshot `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.ReaddACSnapshot[[ReaddACSnapshot]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.ReaddACSnapshot +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### ReaddACSnapshot +```csharp +public ReaddACSnapshot() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L748) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20180922231600_ReaddACSnapshot.cs#L128) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L797) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/RemoveACSnapShot.md b/CodeDocumentation/data/migrations/mysql/RemoveACSnapShot.md new file mode 100644 index 0000000..565ad22 --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/RemoveACSnapShot.md @@ -0,0 +1,67 @@ +# RemoveACSnapShot `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.RemoveACSnapShot[[RemoveACSnapShot]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.RemoveACSnapShot +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### RemoveACSnapShot +```csharp +public RemoveACSnapShot() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L658) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20180922231310_RemoveACSnapShot.cs#L28) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L700) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/RemoveUniqueAliasIndexConstraint.md b/CodeDocumentation/data/migrations/mysql/RemoveUniqueAliasIndexConstraint.md new file mode 100644 index 0000000..dbc6824 --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/RemoveUniqueAliasIndexConstraint.md @@ -0,0 +1,68 @@ +# RemoveUniqueAliasIndexConstraint `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.RemoveUniqueAliasIndexConstraint[[RemoveUniqueAliasIndexConstraint]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.RemoveUniqueAliasIndexConstraint +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### RemoveUniqueAliasIndexConstraint +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L16707566) +```csharp +public RemoveUniqueAliasIndexConstraint() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L16707566) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20220102221729_RemoveUniqueAliasIndexConstraint.cs#L20) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20220102221729_RemoveUniqueAliasIndexConstraint.Designer.cs#L16) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/RenameClientHitLocationCountColumns.md b/CodeDocumentation/data/migrations/mysql/RenameClientHitLocationCountColumns.md new file mode 100644 index 0000000..94e2477 --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/RenameClientHitLocationCountColumns.md @@ -0,0 +1,68 @@ +# RenameClientHitLocationCountColumns `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.RenameClientHitLocationCountColumns[[RenameClientHitLocationCountColumns]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.RenameClientHitLocationCountColumns +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### RenameClientHitLocationCountColumns +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L224) +```csharp +public RenameClientHitLocationCountColumns() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L345) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20191004172550_RenameClientHitLocationCountColumns.cs#L148) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L221) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/SetCaseSensitiveCoallationForAliasNameMySQL.md b/CodeDocumentation/data/migrations/mysql/SetCaseSensitiveCoallationForAliasNameMySQL.md new file mode 100644 index 0000000..d1e35a9 --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/SetCaseSensitiveCoallationForAliasNameMySQL.md @@ -0,0 +1,67 @@ +# SetCaseSensitiveCoallationForAliasNameMySQL `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.SetCaseSensitiveCoallationForAliasNameMySQL[[SetCaseSensitiveCoallationForAliasNameMySQL]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.SetCaseSensitiveCoallationForAliasNameMySQL +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### SetCaseSensitiveCoallationForAliasNameMySQL +```csharp +public SetCaseSensitiveCoallationForAliasNameMySQL() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20191225202141_SetCaseSensitiveCoallationForAliasNameMySQL.cs#L8) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20191225202141_SetCaseSensitiveCoallationForAliasNameMySQL.cs#L20) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L16707566) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/Update.md b/CodeDocumentation/data/migrations/mysql/Update.md new file mode 100644 index 0000000..6218161 --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/Update.md @@ -0,0 +1,68 @@ +# Update `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.Update[[Update]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.Update +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### Update +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L48) +```csharp +public Update() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L42) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L45) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L45) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/UpdateEFMetaToSupportLinkedMeta.md b/CodeDocumentation/data/migrations/mysql/UpdateEFMetaToSupportLinkedMeta.md new file mode 100644 index 0000000..b9e8d3f --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/UpdateEFMetaToSupportLinkedMeta.md @@ -0,0 +1,68 @@ +# UpdateEFMetaToSupportLinkedMeta `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.UpdateEFMetaToSupportLinkedMeta[[UpdateEFMetaToSupportLinkedMeta]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.UpdateEFMetaToSupportLinkedMeta +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### UpdateEFMetaToSupportLinkedMeta +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L820) +```csharp +public UpdateEFMetaToSupportLinkedMeta() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20210124170830_UpdateEFMetaToSupportLinkedMeta.cs#L8) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L562) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20210124170830_UpdateEFMetaToSupportLinkedMeta.Designer.cs#L16) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/UpdateEFMetaToSupportNonClientMeta.md b/CodeDocumentation/data/migrations/mysql/UpdateEFMetaToSupportNonClientMeta.md new file mode 100644 index 0000000..4d4d0f0 --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/UpdateEFMetaToSupportNonClientMeta.md @@ -0,0 +1,68 @@ +# UpdateEFMetaToSupportNonClientMeta `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.UpdateEFMetaToSupportNonClientMeta[[UpdateEFMetaToSupportNonClientMeta]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.UpdateEFMetaToSupportNonClientMeta +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### UpdateEFMetaToSupportNonClientMeta +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L272) +```csharp +public UpdateEFMetaToSupportNonClientMeta() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20210123023921_UpdateEFMetaToSupportNonClientMeta.cs#L8) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20210123023921_UpdateEFMetaToSupportNonClientMeta.cs#L30) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20210123023921_UpdateEFMetaToSupportNonClientMeta.Designer.cs#L16) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/UpdateEFRatingIndex.md b/CodeDocumentation/data/migrations/mysql/UpdateEFRatingIndex.md new file mode 100644 index 0000000..fc6e12d --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/UpdateEFRatingIndex.md @@ -0,0 +1,68 @@ +# UpdateEFRatingIndex `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.UpdateEFRatingIndex[[UpdateEFRatingIndex]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.UpdateEFRatingIndex +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### UpdateEFRatingIndex +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L576) +```csharp +public UpdateEFRatingIndex() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20201114232340_UpdateEFRatingIndex.cs#L8) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20201114232340_UpdateEFRatingIndex.cs#L16) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L560) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/UpdateMigrationsToMySql.md b/CodeDocumentation/data/migrations/mysql/UpdateMigrationsToMySql.md new file mode 100644 index 0000000..cda69ba --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/UpdateMigrationsToMySql.md @@ -0,0 +1,68 @@ +# UpdateMigrationsToMySql `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.UpdateMigrationsToMySql[[UpdateMigrationsToMySql]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.UpdateMigrationsToMySql +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### UpdateMigrationsToMySql +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1320) +```csharp +public UpdateMigrationsToMySql() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L16707566) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20201124024731_UpdateMigrationsToMySql.cs#L1174) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1307) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/mysql/UseJunctionTableForSnapshotVector3.md b/CodeDocumentation/data/migrations/mysql/UseJunctionTableForSnapshotVector3.md new file mode 100644 index 0000000..13b5528 --- /dev/null +++ b/CodeDocumentation/data/migrations/mysql/UseJunctionTableForSnapshotVector3.md @@ -0,0 +1,68 @@ +# UseJunctionTableForSnapshotVector3 `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.MySql + Data.Migrations.MySql.UseJunctionTableForSnapshotVector3[[UseJunctionTableForSnapshotVector3]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.MySql.UseJunctionTableForSnapshotVector3 +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### UseJunctionTableForSnapshotVector3 +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Events/GameEvent.cs#L16707566) +```csharp +public UseJunctionTableForSnapshotVector3() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20190901223620_UseJunctionTableForSnapshotVector3.cs#L10) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Command.cs#L36) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/MySql/20190901223620_UseJunctionTableForSnapshotVector3.Designer.cs#L16) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AddActivityAmount.md b/CodeDocumentation/data/migrations/postgresql/AddActivityAmount.md new file mode 100644 index 0000000..8c354d8 --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AddActivityAmount.md @@ -0,0 +1,68 @@ +# AddActivityAmount `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AddActivityAmount[[AddActivityAmount]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AddActivityAmount +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddActivityAmount +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/PermissionLevelChangedResponse.cs#L17) +```csharp +public AddActivityAmount() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/PermissionLevelChangedResponse.cs#L12) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/PermissionLevelChangedResponse.cs#L12) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/PermissionLevelChangedResponse.cs#L14) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AddAdvancedStats.md b/CodeDocumentation/data/migrations/postgresql/AddAdvancedStats.md new file mode 100644 index 0000000..7823e5c --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AddAdvancedStats.md @@ -0,0 +1,68 @@ +# AddAdvancedStats `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AddAdvancedStats[[AddAdvancedStats]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AddAdvancedStats +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddAdvancedStats +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommandProperties.cs#L17) +```csharp +public AddAdvancedStats() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommandConfiguration.cs#L32) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommandConfiguration.cs#L37) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommandConfiguration.cs#L17) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AddAlternateKeyToEFClients.md b/CodeDocumentation/data/migrations/postgresql/AddAlternateKeyToEFClients.md new file mode 100644 index 0000000..77916f7 --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AddAlternateKeyToEFClients.md @@ -0,0 +1,67 @@ +# AddAlternateKeyToEFClients `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AddAlternateKeyToEFClients[[AddAlternateKeyToEFClients]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AddAlternateKeyToEFClients +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddAlternateKeyToEFClients +```csharp +public AddAlternateKeyToEFClients() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/QuickMessageConfiguration.cs#L8) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/QuickMessageConfiguration.cs#L9) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/QuickMessageConfiguration.cs#L9) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AddAuditFieldsToEFPenaltyIdentifier.md b/CodeDocumentation/data/migrations/postgresql/AddAuditFieldsToEFPenaltyIdentifier.md new file mode 100644 index 0000000..dc16d55 --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AddAuditFieldsToEFPenaltyIdentifier.md @@ -0,0 +1,68 @@ +# AddAuditFieldsToEFPenaltyIdentifier `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AddAuditFieldsToEFPenaltyIdentifier[[AddAuditFieldsToEFPenaltyIdentifier]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AddAuditFieldsToEFPenaltyIdentifier +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddAuditFieldsToEFPenaltyIdentifier +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/DefaultSettings.cs#L11) +```csharp +public AddAuditFieldsToEFPenaltyIdentifier() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/DefaultSettings.cs#L10) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/DefaultSettings.cs#L10) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/DefaultSettings.cs#L11) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AddAutomatedOffenseAndRatingHistory.md b/CodeDocumentation/data/migrations/postgresql/AddAutomatedOffenseAndRatingHistory.md new file mode 100644 index 0000000..ca5c0d7 --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AddAutomatedOffenseAndRatingHistory.md @@ -0,0 +1,68 @@ +# AddAutomatedOffenseAndRatingHistory `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AddAutomatedOffenseAndRatingHistory[[AddAutomatedOffenseAndRatingHistory]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AddAutomatedOffenseAndRatingHistory +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddAutomatedOffenseAndRatingHistory +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/PermissionLevelChangedResponse.cs#L9) +```csharp +public AddAutomatedOffenseAndRatingHistory() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/MessageResponse.cs#L34) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/MessageResponse.cs#L36) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/Postgresql/20180531212903_AddAutomatedOffenseAndRatingHistory.Designer.cs#L18) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AddAvgRecoilOffset.md b/CodeDocumentation/data/migrations/postgresql/AddAvgRecoilOffset.md new file mode 100644 index 0000000..9629a29 --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AddAvgRecoilOffset.md @@ -0,0 +1,68 @@ +# AddAvgRecoilOffset `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AddAvgRecoilOffset[[AddAvgRecoilOffset]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AddAvgRecoilOffset +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddAvgRecoilOffset +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L86) +```csharp +public AddAvgRecoilOffset() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L82) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L82) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L86) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AddClientMeta.md b/CodeDocumentation/data/migrations/postgresql/AddClientMeta.md new file mode 100644 index 0000000..4321c8e --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AddClientMeta.md @@ -0,0 +1,68 @@ +# AddClientMeta `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AddClientMeta[[AddClientMeta]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AddClientMeta +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddClientMeta +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/PermissionLevelChangedResponse.cs#L19) +```csharp +public AddClientMeta() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/PermissionLevelChangedResponse.cs#L17) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/PermissionLevelChangedResponse.cs#L18) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/PermissionLevelChangedResponse.cs#L18) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AddConnectionInterruptedToEFServerSnapshot.md b/CodeDocumentation/data/migrations/postgresql/AddConnectionInterruptedToEFServerSnapshot.md new file mode 100644 index 0000000..39c6a1d --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AddConnectionInterruptedToEFServerSnapshot.md @@ -0,0 +1,68 @@ +# AddConnectionInterruptedToEFServerSnapshot `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AddConnectionInterruptedToEFServerSnapshot[[AddConnectionInterruptedToEFServerSnapshot]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AddConnectionInterruptedToEFServerSnapshot +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddConnectionInterruptedToEFServerSnapshot +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/DefaultSettings.cs#L13) +```csharp +public AddConnectionInterruptedToEFServerSnapshot() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/DefaultSettings.cs#L12) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/DefaultSettings.cs#L12) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/DefaultSettings.cs#L13) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AddCurrentSnapValueToSnapshot.md b/CodeDocumentation/data/migrations/postgresql/AddCurrentSnapValueToSnapshot.md new file mode 100644 index 0000000..4dd1278 --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AddCurrentSnapValueToSnapshot.md @@ -0,0 +1,68 @@ +# AddCurrentSnapValueToSnapshot `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AddCurrentSnapValueToSnapshot[[AddCurrentSnapValueToSnapshot]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AddCurrentSnapValueToSnapshot +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddCurrentSnapValueToSnapshot +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L129) +```csharp +public AddCurrentSnapValueToSnapshot() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L126) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L126) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L129) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AddDescendingTimeSentIndexEFClientMessages.md b/CodeDocumentation/data/migrations/postgresql/AddDescendingTimeSentIndexEFClientMessages.md new file mode 100644 index 0000000..948635f --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AddDescendingTimeSentIndexEFClientMessages.md @@ -0,0 +1,68 @@ +# AddDescendingTimeSentIndexEFClientMessages `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AddDescendingTimeSentIndexEFClientMessages[[AddDescendingTimeSentIndexEFClientMessages]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AddDescendingTimeSentIndexEFClientMessages +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddDescendingTimeSentIndexEFClientMessages +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L26) +```csharp +public AddDescendingTimeSentIndexEFClientMessages() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L32) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L23) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L23) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AddEFACSnapshots.md b/CodeDocumentation/data/migrations/postgresql/AddEFACSnapshots.md new file mode 100644 index 0000000..77af0d6 --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AddEFACSnapshots.md @@ -0,0 +1,68 @@ +# AddEFACSnapshots `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AddEFACSnapshots[[AddEFACSnapshots]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AddEFACSnapshots +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddEFACSnapshots +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/ReceivedPenaltyResponse.cs#L8) +```csharp +public AddEFACSnapshots() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/PermissionLevelChangedResponse.cs#L19) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/Postgresql/20180605191706_AddEFACSnapshots.cs#L127) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/ReceivedPenaltyResponse.cs#L8) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AddEFAliasNameIndex.md b/CodeDocumentation/data/migrations/postgresql/AddEFAliasNameIndex.md new file mode 100644 index 0000000..0abc97a --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AddEFAliasNameIndex.md @@ -0,0 +1,68 @@ +# AddEFAliasNameIndex `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AddEFAliasNameIndex[[AddEFAliasNameIndex]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AddEFAliasNameIndex +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddEFAliasNameIndex +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/UpdatedAliasResponse.cs#L9) +```csharp +public AddEFAliasNameIndex() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/UpdatedAliasResponse.cs#L5) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/UpdatedAliasResponse.cs#L6) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/UpdatedAliasResponse.cs#L6) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AddEFAliasNameMaxLength24.md b/CodeDocumentation/data/migrations/postgresql/AddEFAliasNameMaxLength24.md new file mode 100644 index 0000000..e2aeef6 --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AddEFAliasNameMaxLength24.md @@ -0,0 +1,68 @@ +# AddEFAliasNameMaxLength24 `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AddEFAliasNameMaxLength24[[AddEFAliasNameMaxLength24]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AddEFAliasNameMaxLength24 +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddEFAliasNameMaxLength24 +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Requests/BaseClientMetaRequest.cs#L5) +```csharp +public AddEFAliasNameMaxLength24() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/UpdatedAliasResponse.cs#L19) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/UpdatedAliasResponse.cs#L6) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Requests/BaseClientMetaRequest.cs#L5) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AddEFClientConnectionHistory.md b/CodeDocumentation/data/migrations/postgresql/AddEFClientConnectionHistory.md new file mode 100644 index 0000000..8e94ccc --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AddEFClientConnectionHistory.md @@ -0,0 +1,68 @@ +# AddEFClientConnectionHistory `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AddEFClientConnectionHistory[[AddEFClientConnectionHistory]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AddEFClientConnectionHistory +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddEFClientConnectionHistory +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommunityInformationConfiguration.cs#L40) +```csharp +public AddEFClientConnectionHistory() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommunityInformationConfiguration.cs#L5) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommunityInformationConfiguration.cs#L39) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommunityInformationConfiguration.cs#L39) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AddEFInboxMessage.md b/CodeDocumentation/data/migrations/postgresql/AddEFInboxMessage.md new file mode 100644 index 0000000..4fc8464 --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AddEFInboxMessage.md @@ -0,0 +1,68 @@ +# AddEFInboxMessage `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AddEFInboxMessage[[AddEFInboxMessage]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AddEFInboxMessage +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddEFInboxMessage +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommunityInformationConfiguration.cs#L10) +```csharp +public AddEFInboxMessage() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommunityInformationConfiguration.cs#L7) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommunityInformationConfiguration.cs#L7) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommunityInformationConfiguration.cs#L10) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AddEFPenaltyIdentifier.md b/CodeDocumentation/data/migrations/postgresql/AddEFPenaltyIdentifier.md new file mode 100644 index 0000000..d89b9f2 --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AddEFPenaltyIdentifier.md @@ -0,0 +1,68 @@ +# AddEFPenaltyIdentifier `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AddEFPenaltyIdentifier[[AddEFPenaltyIdentifier]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AddEFPenaltyIdentifier +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddEFPenaltyIdentifier +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/DefaultSettings.cs#L7) +```csharp +public AddEFPenaltyIdentifier() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommunityInformationConfiguration.cs#L42) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Alerts/AlertManager.cs#L50) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/DefaultSettings.cs#L7) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AddEFServerSnapshot.md b/CodeDocumentation/data/migrations/postgresql/AddEFServerSnapshot.md new file mode 100644 index 0000000..5a7c410 --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AddEFServerSnapshot.md @@ -0,0 +1,68 @@ +# AddEFServerSnapshot `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AddEFServerSnapshot[[AddEFServerSnapshot]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AddEFServerSnapshot +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddEFServerSnapshot +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommunityInformationConfiguration.cs#L34) +```csharp +public AddEFServerSnapshot() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommunityInformationConfiguration.cs#L12) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommunityInformationConfiguration.cs#L12) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommunityInformationConfiguration.cs#L34) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AddEloField.md b/CodeDocumentation/data/migrations/postgresql/AddEloField.md new file mode 100644 index 0000000..1b609f5 --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AddEloField.md @@ -0,0 +1,68 @@ +# AddEloField `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AddEloField[[AddEloField]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AddEloField +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddEloField +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/MessageResponse.cs#L24) +```csharp +public AddEloField() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/MessageResponse.cs#L14) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/MessageResponse.cs#L19) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/MessageResponse.cs#L19) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AddEndpointToEFServerUpdateServerIdType.md b/CodeDocumentation/data/migrations/postgresql/AddEndpointToEFServerUpdateServerIdType.md new file mode 100644 index 0000000..bf58d45 --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AddEndpointToEFServerUpdateServerIdType.md @@ -0,0 +1,68 @@ +# AddEndpointToEFServerUpdateServerIdType `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AddEndpointToEFServerUpdateServerIdType[[AddEndpointToEFServerUpdateServerIdType]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AddEndpointToEFServerUpdateServerIdType +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddEndpointToEFServerUpdateServerIdType +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L59) +```csharp +public AddEndpointToEFServerUpdateServerIdType() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L55) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L55) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L59) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AddEvadePenaltyFlag.md b/CodeDocumentation/data/migrations/postgresql/AddEvadePenaltyFlag.md new file mode 100644 index 0000000..53eefb9 --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AddEvadePenaltyFlag.md @@ -0,0 +1,68 @@ +# AddEvadePenaltyFlag `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AddEvadePenaltyFlag[[AddEvadePenaltyFlag]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AddEvadePenaltyFlag +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddEvadePenaltyFlag +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L66) +```csharp +public AddEvadePenaltyFlag() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L62) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L62) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L66) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AddFractionAndIsKill.md b/CodeDocumentation/data/migrations/postgresql/AddFractionAndIsKill.md new file mode 100644 index 0000000..2040d99 --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AddFractionAndIsKill.md @@ -0,0 +1,68 @@ +# AddFractionAndIsKill `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AddFractionAndIsKill[[AddFractionAndIsKill]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AddFractionAndIsKill +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddFractionAndIsKill +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/ReceivedPenaltyResponse.cs#L12) +```csharp +public AddFractionAndIsKill() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/ReceivedPenaltyResponse.cs#L11) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/ReceivedPenaltyResponse.cs#L11) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/ReceivedPenaltyResponse.cs#L12) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AddGameNameToEFServer.md b/CodeDocumentation/data/migrations/postgresql/AddGameNameToEFServer.md new file mode 100644 index 0000000..2ce0729 --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AddGameNameToEFServer.md @@ -0,0 +1,68 @@ +# AddGameNameToEFServer `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AddGameNameToEFServer[[AddGameNameToEFServer]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AddGameNameToEFServer +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddGameNameToEFServer +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L79) +```csharp +public AddGameNameToEFServer() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L75) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L75) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L79) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AddGameToEFClient.md b/CodeDocumentation/data/migrations/postgresql/AddGameToEFClient.md new file mode 100644 index 0000000..9bf130a --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AddGameToEFClient.md @@ -0,0 +1,68 @@ +# AddGameToEFClient `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AddGameToEFClient[[AddGameToEFClient]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AddGameToEFClient +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddGameToEFClient +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/MapConfiguration.cs#L5) +```csharp +public AddGameToEFClient() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/GametypeConfiguration.cs#L6) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/QueryHelpers/ClientResourceQueryHelper.cs#L16707566) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/MapConfiguration.cs#L5) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AddHitLocationReferenceToEFACSnapshot.md b/CodeDocumentation/data/migrations/postgresql/AddHitLocationReferenceToEFACSnapshot.md new file mode 100644 index 0000000..6f27178 --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AddHitLocationReferenceToEFACSnapshot.md @@ -0,0 +1,68 @@ +# AddHitLocationReferenceToEFACSnapshot `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AddHitLocationReferenceToEFACSnapshot[[AddHitLocationReferenceToEFACSnapshot]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AddHitLocationReferenceToEFACSnapshot +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddHitLocationReferenceToEFACSnapshot +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommunityInformationConfiguration.cs#L5) +```csharp +public AddHitLocationReferenceToEFACSnapshot() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommandProperties.cs#L39) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommandProperties.cs#L39) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommunityInformationConfiguration.cs#L5) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AddHostnameToEFServer.md b/CodeDocumentation/data/migrations/postgresql/AddHostnameToEFServer.md new file mode 100644 index 0000000..9fb24e7 --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AddHostnameToEFServer.md @@ -0,0 +1,68 @@ +# AddHostnameToEFServer `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AddHostnameToEFServer[[AddHostnameToEFServer]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AddHostnameToEFServer +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddHostnameToEFServer +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L188) +```csharp +public AddHostnameToEFServer() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L183) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L183) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L188) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AddImpersonationIdToEFChangeHistory.md b/CodeDocumentation/data/migrations/postgresql/AddImpersonationIdToEFChangeHistory.md new file mode 100644 index 0000000..9b34485 --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AddImpersonationIdToEFChangeHistory.md @@ -0,0 +1,68 @@ +# AddImpersonationIdToEFChangeHistory `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AddImpersonationIdToEFChangeHistory[[AddImpersonationIdToEFChangeHistory]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AddImpersonationIdToEFChangeHistory +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddImpersonationIdToEFChangeHistory +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L180) +```csharp +public AddImpersonationIdToEFChangeHistory() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L178) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L178) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L180) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AddIndexToEFMetaKeyAndClientId.md b/CodeDocumentation/data/migrations/postgresql/AddIndexToEFMetaKeyAndClientId.md new file mode 100644 index 0000000..efc10ab --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AddIndexToEFMetaKeyAndClientId.md @@ -0,0 +1,68 @@ +# AddIndexToEFMetaKeyAndClientId `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AddIndexToEFMetaKeyAndClientId[[AddIndexToEFMetaKeyAndClientId]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AddIndexToEFMetaKeyAndClientId +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddIndexToEFMetaKeyAndClientId +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L72) +```csharp +public AddIndexToEFMetaKeyAndClientId() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L69) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L69) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L72) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AddIndexToEFRankingHistoryCreatedDatetime.md b/CodeDocumentation/data/migrations/postgresql/AddIndexToEFRankingHistoryCreatedDatetime.md new file mode 100644 index 0000000..d508202 --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AddIndexToEFRankingHistoryCreatedDatetime.md @@ -0,0 +1,68 @@ +# AddIndexToEFRankingHistoryCreatedDatetime `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AddIndexToEFRankingHistoryCreatedDatetime[[AddIndexToEFRankingHistoryCreatedDatetime]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AddIndexToEFRankingHistoryCreatedDatetime +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddIndexToEFRankingHistoryCreatedDatetime +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/QuickMessageConfiguration.cs#L8) +```csharp +public AddIndexToEFRankingHistoryCreatedDatetime() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/MapConfiguration.cs#L6) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/MapConfiguration.cs#L6) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/Postgresql/20220609135210_AddIndexToEFRankingHistoryCreatedDatetime.Designer.cs#L19) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AddIndexToMessageTimeSent.md b/CodeDocumentation/data/migrations/postgresql/AddIndexToMessageTimeSent.md new file mode 100644 index 0000000..621b5e9 --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AddIndexToMessageTimeSent.md @@ -0,0 +1,68 @@ +# AddIndexToMessageTimeSent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AddIndexToMessageTimeSent[[AddIndexToMessageTimeSent]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AddIndexToMessageTimeSent +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddIndexToMessageTimeSent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L25) +```csharp +public AddIndexToMessageTimeSent() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L22) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L22) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L25) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AddIndexToSearchableIPToEFAlias.md b/CodeDocumentation/data/migrations/postgresql/AddIndexToSearchableIPToEFAlias.md new file mode 100644 index 0000000..1a3e396 --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AddIndexToSearchableIPToEFAlias.md @@ -0,0 +1,68 @@ +# AddIndexToSearchableIPToEFAlias `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AddIndexToSearchableIPToEFAlias[[AddIndexToSearchableIPToEFAlias]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AddIndexToSearchableIPToEFAlias +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddIndexToSearchableIPToEFAlias +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/GametypeConfiguration.cs#L6) +```csharp +public AddIndexToSearchableIPToEFAlias() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/Postgresql/20220404192553_AddIndexToSearchableIPToEFAlias.cs#L10) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/GametypeConfiguration.cs#L5) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/GametypeConfiguration.cs#L5) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AddIsPasswordProtectedColumn.md b/CodeDocumentation/data/migrations/postgresql/AddIsPasswordProtectedColumn.md new file mode 100644 index 0000000..ce8d0dd --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AddIsPasswordProtectedColumn.md @@ -0,0 +1,68 @@ +# AddIsPasswordProtectedColumn `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AddIsPasswordProtectedColumn[[AddIsPasswordProtectedColumn]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AddIsPasswordProtectedColumn +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddIsPasswordProtectedColumn +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L191) +```csharp +public AddIsPasswordProtectedColumn() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L190) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L190) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L191) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AddLastConnectionIndexEFClient.md b/CodeDocumentation/data/migrations/postgresql/AddLastConnectionIndexEFClient.md new file mode 100644 index 0000000..e3dc9aa --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AddLastConnectionIndexEFClient.md @@ -0,0 +1,68 @@ +# AddLastConnectionIndexEFClient `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AddLastConnectionIndexEFClient[[AddLastConnectionIndexEFClient]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AddLastConnectionIndexEFClient +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddLastConnectionIndexEFClient +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L32) +```csharp +public AddLastConnectionIndexEFClient() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L26) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L29) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L29) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AddMissingActiveColumns.md b/CodeDocumentation/data/migrations/postgresql/AddMissingActiveColumns.md new file mode 100644 index 0000000..a6de1ca --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AddMissingActiveColumns.md @@ -0,0 +1,68 @@ +# AddMissingActiveColumns `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AddMissingActiveColumns[[AddMissingActiveColumns]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AddMissingActiveColumns +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddMissingActiveColumns +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L176) +```csharp +public AddMissingActiveColumns() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L174) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L174) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L176) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AddPreviousCurrentValueToEFChangeHistory.md b/CodeDocumentation/data/migrations/postgresql/AddPreviousCurrentValueToEFChangeHistory.md new file mode 100644 index 0000000..739878a --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AddPreviousCurrentValueToEFChangeHistory.md @@ -0,0 +1,68 @@ +# AddPreviousCurrentValueToEFChangeHistory `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AddPreviousCurrentValueToEFChangeHistory[[AddPreviousCurrentValueToEFChangeHistory]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AddPreviousCurrentValueToEFChangeHistory +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddPreviousCurrentValueToEFChangeHistory +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L16) +```csharp +public AddPreviousCurrentValueToEFChangeHistory() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/Postgresql/20180912015012_AddPreviousCurrentValueToEFChangeHistory.cs#L8) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IO/BaseConfigurationHandlerV2.cs#L16707566) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L16) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AddRatingIndexes.md b/CodeDocumentation/data/migrations/postgresql/AddRatingIndexes.md new file mode 100644 index 0000000..182b61f --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AddRatingIndexes.md @@ -0,0 +1,68 @@ +# AddRatingIndexes `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AddRatingIndexes[[AddRatingIndexes]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AddRatingIndexes +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddRatingIndexes +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/UpdatedAliasResponse.cs#L5) +```csharp +public AddRatingIndexes() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/ReceivedPenaltyResponse.cs#L27) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/ReceivedPenaltyResponse.cs#L27) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IO/BaseConfigurationHandlerV2.cs#L207) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AddRecoilOffsetToSnapshot.md b/CodeDocumentation/data/migrations/postgresql/AddRecoilOffsetToSnapshot.md new file mode 100644 index 0000000..1a383f3 --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AddRecoilOffsetToSnapshot.md @@ -0,0 +1,68 @@ +# AddRecoilOffsetToSnapshot `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AddRecoilOffsetToSnapshot[[AddRecoilOffsetToSnapshot]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AddRecoilOffsetToSnapshot +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddRecoilOffsetToSnapshot +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L93) +```csharp +public AddRecoilOffsetToSnapshot() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L89) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L89) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L93) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AddRollingKDR.md b/CodeDocumentation/data/migrations/postgresql/AddRollingKDR.md new file mode 100644 index 0000000..b89c4cf --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AddRollingKDR.md @@ -0,0 +1,68 @@ +# AddRollingKDR `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AddRollingKDR[[AddRollingKDR]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AddRollingKDR +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddRollingKDR +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/MessageResponse.cs#L34) +```csharp +public AddRollingKDR() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/MessageResponse.cs#L24) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/MessageResponse.cs#L29) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/MessageResponse.cs#L29) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AddSearchNameToEFAlias.md b/CodeDocumentation/data/migrations/postgresql/AddSearchNameToEFAlias.md new file mode 100644 index 0000000..801e2ce --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AddSearchNameToEFAlias.md @@ -0,0 +1,68 @@ +# AddSearchNameToEFAlias `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AddSearchNameToEFAlias[[AddSearchNameToEFAlias]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AddSearchNameToEFAlias +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddSearchNameToEFAlias +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L105) +```csharp +public AddSearchNameToEFAlias() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L102) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L102) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L105) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AddSearchableIPToEFAlias.md b/CodeDocumentation/data/migrations/postgresql/AddSearchableIPToEFAlias.md new file mode 100644 index 0000000..6928f0c --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AddSearchableIPToEFAlias.md @@ -0,0 +1,68 @@ +# AddSearchableIPToEFAlias `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AddSearchableIPToEFAlias[[AddSearchableIPToEFAlias]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AddSearchableIPToEFAlias +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddSearchableIPToEFAlias +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/GameStringConfiguration.cs#L10) +```csharp +public AddSearchableIPToEFAlias() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/DefaultSettings.cs#L16) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/DefaultSettings.cs#L21) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/Postgresql/20220404185627_AddSearchableIPToEFAlias.Designer.cs#L19) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AddSentIngameFlagToClientMessage.md b/CodeDocumentation/data/migrations/postgresql/AddSentIngameFlagToClientMessage.md new file mode 100644 index 0000000..65b2dd4 --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AddSentIngameFlagToClientMessage.md @@ -0,0 +1,68 @@ +# AddSentIngameFlagToClientMessage `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AddSentIngameFlagToClientMessage[[AddSentIngameFlagToClientMessage]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AddSentIngameFlagToClientMessage +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddSentIngameFlagToClientMessage +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L208) +```csharp +public AddSentIngameFlagToClientMessage() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L200) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L200) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L204) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AddSessionSnapHitsToSnapshot.md b/CodeDocumentation/data/migrations/postgresql/AddSessionSnapHitsToSnapshot.md new file mode 100644 index 0000000..035eb27 --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AddSessionSnapHitsToSnapshot.md @@ -0,0 +1,68 @@ +# AddSessionSnapHitsToSnapshot `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AddSessionSnapHitsToSnapshot[[AddSessionSnapHitsToSnapshot]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AddSessionSnapHitsToSnapshot +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddSessionSnapHitsToSnapshot +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L135) +```csharp +public AddSessionSnapHitsToSnapshot() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L132) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L132) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L135) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AddSnapHitCountToClientStatistics.md b/CodeDocumentation/data/migrations/postgresql/AddSnapHitCountToClientStatistics.md new file mode 100644 index 0000000..e81008f --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AddSnapHitCountToClientStatistics.md @@ -0,0 +1,68 @@ +# AddSnapHitCountToClientStatistics `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AddSnapHitCountToClientStatistics[[AddSnapHitCountToClientStatistics]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AddSnapHitCountToClientStatistics +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddSnapHitCountToClientStatistics +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L118) +```csharp +public AddSnapHitCountToClientStatistics() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L115) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L115) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L118) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AddVisibilityPercentage.md b/CodeDocumentation/data/migrations/postgresql/AddVisibilityPercentage.md new file mode 100644 index 0000000..88030b4 --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AddVisibilityPercentage.md @@ -0,0 +1,68 @@ +# AddVisibilityPercentage `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AddVisibilityPercentage[[AddVisibilityPercentage]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AddVisibilityPercentage +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddVisibilityPercentage +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/ReceivedPenaltyResponse.cs#L14) +```csharp +public AddVisibilityPercentage() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/ReceivedPenaltyResponse.cs#L13) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/ReceivedPenaltyResponse.cs#L13) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/ReceivedPenaltyResponse.cs#L14) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AddVision.md b/CodeDocumentation/data/migrations/postgresql/AddVision.md new file mode 100644 index 0000000..2ad1e10 --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AddVision.md @@ -0,0 +1,68 @@ +# AddVision `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AddVision[[AddVision]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AddVision +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddVision +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/ReceivedPenaltyResponse.cs#L16) +```csharp +public AddVision() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/ReceivedPenaltyResponse.cs#L15) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/ReceivedPenaltyResponse.cs#L15) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/ReceivedPenaltyResponse.cs#L16) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AddWeaponReferenceAndServerIdToEFACSnapshot.md b/CodeDocumentation/data/migrations/postgresql/AddWeaponReferenceAndServerIdToEFACSnapshot.md new file mode 100644 index 0000000..e388d6b --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AddWeaponReferenceAndServerIdToEFACSnapshot.md @@ -0,0 +1,68 @@ +# AddWeaponReferenceAndServerIdToEFACSnapshot `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AddWeaponReferenceAndServerIdToEFACSnapshot[[AddWeaponReferenceAndServerIdToEFACSnapshot]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AddWeaponReferenceAndServerIdToEFACSnapshot +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddWeaponReferenceAndServerIdToEFACSnapshot +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommandProperties.cs#L39) +```csharp +public AddWeaponReferenceAndServerIdToEFACSnapshot() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommandProperties.cs#L28) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommandProperties.cs#L33) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommandProperties.cs#L33) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AddWeaponReferenceToEFClientKill.md b/CodeDocumentation/data/migrations/postgresql/AddWeaponReferenceToEFClientKill.md new file mode 100644 index 0000000..b011e02 --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AddWeaponReferenceToEFClientKill.md @@ -0,0 +1,68 @@ +# AddWeaponReferenceToEFClientKill `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AddWeaponReferenceToEFClientKill[[AddWeaponReferenceToEFClientKill]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AddWeaponReferenceToEFClientKill +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddWeaponReferenceToEFClientKill +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommandProperties.cs#L28) +```csharp +public AddWeaponReferenceToEFClientKill() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommandProperties.cs#L17) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommandProperties.cs#L22) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommandProperties.cs#L22) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AddWhenToRating.md b/CodeDocumentation/data/migrations/postgresql/AddWhenToRating.md new file mode 100644 index 0000000..78abec8 --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AddWhenToRating.md @@ -0,0 +1,68 @@ +# AddWhenToRating `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AddWhenToRating[[AddWhenToRating]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AddWhenToRating +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddWhenToRating +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/ReceivedPenaltyResponse.cs#L26) +```csharp +public AddWhenToRating() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/ReceivedPenaltyResponse.cs#L18) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/ReceivedPenaltyResponse.cs#L22) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/ReceivedPenaltyResponse.cs#L26) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AlterEFRatingIndex.md b/CodeDocumentation/data/migrations/postgresql/AlterEFRatingIndex.md new file mode 100644 index 0000000..9632b01 --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AlterEFRatingIndex.md @@ -0,0 +1,68 @@ +# AlterEFRatingIndex `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AlterEFRatingIndex[[AlterEFRatingIndex]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AlterEFRatingIndex +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AlterEFRatingIndex +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L99) +```csharp +public AlterEFRatingIndex() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L96) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L96) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L99) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/AvgSnapValueToClientStatistics.md b/CodeDocumentation/data/migrations/postgresql/AvgSnapValueToClientStatistics.md new file mode 100644 index 0000000..b726e6e --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/AvgSnapValueToClientStatistics.md @@ -0,0 +1,68 @@ +# AvgSnapValueToClientStatistics `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.AvgSnapValueToClientStatistics[[AvgSnapValueToClientStatistics]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.AvgSnapValueToClientStatistics +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AvgSnapValueToClientStatistics +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L112) +```csharp +public AvgSnapValueToClientStatistics() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L109) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L109) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L112) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/EnforceUniqueIndexForEFAliasIPName.md b/CodeDocumentation/data/migrations/postgresql/EnforceUniqueIndexForEFAliasIPName.md new file mode 100644 index 0000000..6088c45 --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/EnforceUniqueIndexForEFAliasIPName.md @@ -0,0 +1,68 @@ +# EnforceUniqueIndexForEFAliasIPName `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.EnforceUniqueIndexForEFAliasIPName[[EnforceUniqueIndexForEFAliasIPName]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.EnforceUniqueIndexForEFAliasIPName +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### EnforceUniqueIndexForEFAliasIPName +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L167) +```csharp +public EnforceUniqueIndexForEFAliasIPName() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L158) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L158) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L167) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/IndexForEFAlias.md b/CodeDocumentation/data/migrations/postgresql/IndexForEFAlias.md new file mode 100644 index 0000000..e623f8b --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/IndexForEFAlias.md @@ -0,0 +1,68 @@ +# IndexForEFAlias `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.IndexForEFAlias[[IndexForEFAlias]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.IndexForEFAlias +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### IndexForEFAlias +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/ReceivedPenaltyResponse.cs#L10) +```csharp +public IndexForEFAlias() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/ReceivedPenaltyResponse.cs#L9) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/ReceivedPenaltyResponse.cs#L9) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/ReceivedPenaltyResponse.cs#L10) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/InitialCreate.md b/CodeDocumentation/data/migrations/postgresql/InitialCreate.md new file mode 100644 index 0000000..fa69b83 --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/InitialCreate.md @@ -0,0 +1,68 @@ +# InitialCreate `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.InitialCreate[[InitialCreate]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.InitialCreate +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### InitialCreate +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/MessageResponse.cs#L8) +```csharp +public InitialCreate() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/Postgresql/20180409183408_InitialCreate.cs#L12) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/MessageResponse.cs#L7) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/MessageResponse.cs#L7) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/MakeClientIPNullable.md b/CodeDocumentation/data/migrations/postgresql/MakeClientIPNullable.md new file mode 100644 index 0000000..45b6ca7 --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/MakeClientIPNullable.md @@ -0,0 +1,68 @@ +# MakeClientIPNullable `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.MakeClientIPNullable[[MakeClientIPNullable]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.MakeClientIPNullable +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### MakeClientIPNullable +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L52) +```csharp +public MakeClientIPNullable() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L49) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L49) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L52) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/MakeEFPenaltyLinkIdNullable.md b/CodeDocumentation/data/migrations/postgresql/MakeEFPenaltyLinkIdNullable.md new file mode 100644 index 0000000..9a701b2 --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/MakeEFPenaltyLinkIdNullable.md @@ -0,0 +1,68 @@ +# MakeEFPenaltyLinkIdNullable `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.MakeEFPenaltyLinkIdNullable[[MakeEFPenaltyLinkIdNullable]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.MakeEFPenaltyLinkIdNullable +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### MakeEFPenaltyLinkIdNullable +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/DefaultSettings.cs#L9) +```csharp +public MakeEFPenaltyLinkIdNullable() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/DefaultSettings.cs#L8) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/DefaultSettings.cs#L8) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/DefaultSettings.cs#L9) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/MakePenaltyExpirationNullable.md b/CodeDocumentation/data/migrations/postgresql/MakePenaltyExpirationNullable.md new file mode 100644 index 0000000..bed57d7 --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/MakePenaltyExpirationNullable.md @@ -0,0 +1,68 @@ +# MakePenaltyExpirationNullable `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.MakePenaltyExpirationNullable[[MakePenaltyExpirationNullable]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.MakePenaltyExpirationNullable +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### MakePenaltyExpirationNullable +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L46) +```csharp +public MakePenaltyExpirationNullable() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L43) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L43) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L46) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/PostgresqlDatabaseContextModelSnapshot.md b/CodeDocumentation/data/migrations/postgresql/PostgresqlDatabaseContextModelSnapshot.md new file mode 100644 index 0000000..74301be --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/PostgresqlDatabaseContextModelSnapshot.md @@ -0,0 +1,46 @@ +# PostgresqlDatabaseContextModelSnapshot `Internal class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.PostgresqlDatabaseContextModelSnapshot[[PostgresqlDatabaseContextModelSnapshot]] + end + subgraph Microsoft.EntityFrameworkCore.Infrastructure +Microsoft.EntityFrameworkCore.Infrastructure.ModelSnapshot[[ModelSnapshot]] + end +Microsoft.EntityFrameworkCore.Infrastructure.ModelSnapshot --> Data.Migrations.Postgresql.PostgresqlDatabaseContextModelSnapshot +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildModel`](#buildmodel)(`ModelBuilder` modelBuilder) | + +## Details +### Inheritance + - `ModelSnapshot` + +### Constructors +#### PostgresqlDatabaseContextModelSnapshot +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L35) +```csharp +public PostgresqlDatabaseContextModelSnapshot() +``` + +### Methods +#### BuildModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L32) +```csharp +protected override void BuildModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/ReaddACSnapshot.md b/CodeDocumentation/data/migrations/postgresql/ReaddACSnapshot.md new file mode 100644 index 0000000..4f04590 --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/ReaddACSnapshot.md @@ -0,0 +1,68 @@ +# ReaddACSnapshot `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.ReaddACSnapshot[[ReaddACSnapshot]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.ReaddACSnapshot +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### ReaddACSnapshot +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L41) +```csharp +public ReaddACSnapshot() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L37) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L37) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L41) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/RemoveACSnapShot.md b/CodeDocumentation/data/migrations/postgresql/RemoveACSnapShot.md new file mode 100644 index 0000000..8af8ead --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/RemoveACSnapShot.md @@ -0,0 +1,68 @@ +# RemoveACSnapShot `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.RemoveACSnapShot[[RemoveACSnapShot]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.RemoveACSnapShot +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### RemoveACSnapShot +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L33) +```csharp +public RemoveACSnapShot() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L29) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L29) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L33) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/RemoveUniqueAliasIndexConstraint.md b/CodeDocumentation/data/migrations/postgresql/RemoveUniqueAliasIndexConstraint.md new file mode 100644 index 0000000..b8ee236 --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/RemoveUniqueAliasIndexConstraint.md @@ -0,0 +1,68 @@ +# RemoveUniqueAliasIndexConstraint `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.RemoveUniqueAliasIndexConstraint[[RemoveUniqueAliasIndexConstraint]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.RemoveUniqueAliasIndexConstraint +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### RemoveUniqueAliasIndexConstraint +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommunityInformationConfiguration.cs#L42) +```csharp +public RemoveUniqueAliasIndexConstraint() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommunityInformationConfiguration.cs#L40) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommunityInformationConfiguration.cs#L41) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommunityInformationConfiguration.cs#L41) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/RenameClientHitLocationCountColumns.md b/CodeDocumentation/data/migrations/postgresql/RenameClientHitLocationCountColumns.md new file mode 100644 index 0000000..8d5511b --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/RenameClientHitLocationCountColumns.md @@ -0,0 +1,68 @@ +# RenameClientHitLocationCountColumns `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.RenameClientHitLocationCountColumns[[RenameClientHitLocationCountColumns]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.RenameClientHitLocationCountColumns +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### RenameClientHitLocationCountColumns +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L148) +```csharp +public RenameClientHitLocationCountColumns() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L138) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L138) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L148) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/SetCaseSensitiveCoallationForAliasNameMySQL.md b/CodeDocumentation/data/migrations/postgresql/SetCaseSensitiveCoallationForAliasNameMySQL.md new file mode 100644 index 0000000..a6fd58d --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/SetCaseSensitiveCoallationForAliasNameMySQL.md @@ -0,0 +1,68 @@ +# SetCaseSensitiveCoallationForAliasNameMySQL `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.SetCaseSensitiveCoallationForAliasNameMySQL[[SetCaseSensitiveCoallationForAliasNameMySQL]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.SetCaseSensitiveCoallationForAliasNameMySQL +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### SetCaseSensitiveCoallationForAliasNameMySQL +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L173) +```csharp +public SetCaseSensitiveCoallationForAliasNameMySQL() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L171) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L171) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L173) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/Update.md b/CodeDocumentation/data/migrations/postgresql/Update.md new file mode 100644 index 0000000..b071d35 --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/Update.md @@ -0,0 +1,68 @@ +# Update `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.Update[[Update]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.Update +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### Update +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/MessageResponse.cs#L14) +```csharp +public Update() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/MessageResponse.cs#L8) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/MessageResponse.cs#L9) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/MessageResponse.cs#L9) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/UpdateEFMetaToSupportLinkedMeta.md b/CodeDocumentation/data/migrations/postgresql/UpdateEFMetaToSupportLinkedMeta.md new file mode 100644 index 0000000..de48e43 --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/UpdateEFMetaToSupportLinkedMeta.md @@ -0,0 +1,68 @@ +# UpdateEFMetaToSupportLinkedMeta `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.UpdateEFMetaToSupportLinkedMeta[[UpdateEFMetaToSupportLinkedMeta]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.UpdateEFMetaToSupportLinkedMeta +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### UpdateEFMetaToSupportLinkedMeta +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommandConfiguration.cs#L29) +```csharp +public UpdateEFMetaToSupportLinkedMeta() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommandConfiguration.cs#L23) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommandConfiguration.cs#L23) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommandConfiguration.cs#L29) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/UpdateEFMetaToSupportNonClientMeta.md b/CodeDocumentation/data/migrations/postgresql/UpdateEFMetaToSupportNonClientMeta.md new file mode 100644 index 0000000..7969861 --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/UpdateEFMetaToSupportNonClientMeta.md @@ -0,0 +1,68 @@ +# UpdateEFMetaToSupportNonClientMeta `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.UpdateEFMetaToSupportNonClientMeta[[UpdateEFMetaToSupportNonClientMeta]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.UpdateEFMetaToSupportNonClientMeta +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### UpdateEFMetaToSupportNonClientMeta +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommandConfiguration.cs#L16) +```csharp +public UpdateEFMetaToSupportNonClientMeta() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L233) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L17) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommandConfiguration.cs#L16) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/UpdateEFRatingIndex.md b/CodeDocumentation/data/migrations/postgresql/UpdateEFRatingIndex.md new file mode 100644 index 0000000..a8c92cb --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/UpdateEFRatingIndex.md @@ -0,0 +1,68 @@ +# UpdateEFRatingIndex `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.UpdateEFRatingIndex[[UpdateEFRatingIndex]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.UpdateEFRatingIndex +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### UpdateEFRatingIndex +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L196) +```csharp +public UpdateEFRatingIndex() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L192) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L192) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L196) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/UpdateMigrationsForPostgresql.md b/CodeDocumentation/data/migrations/postgresql/UpdateMigrationsForPostgresql.md new file mode 100644 index 0000000..58ad3fc --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/UpdateMigrationsForPostgresql.md @@ -0,0 +1,68 @@ +# UpdateMigrationsForPostgresql `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.UpdateMigrationsForPostgresql[[UpdateMigrationsForPostgresql]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.UpdateMigrationsForPostgresql +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### UpdateMigrationsForPostgresql +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L212) +```csharp +public UpdateMigrationsForPostgresql() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L208) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L209) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L209) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/postgresql/UseJunctionTableForSnapshotVector3.md b/CodeDocumentation/data/migrations/postgresql/UseJunctionTableForSnapshotVector3.md new file mode 100644 index 0000000..97d7aa6 --- /dev/null +++ b/CodeDocumentation/data/migrations/postgresql/UseJunctionTableForSnapshotVector3.md @@ -0,0 +1,68 @@ +# UseJunctionTableForSnapshotVector3 `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Postgresql + Data.Migrations.Postgresql.UseJunctionTableForSnapshotVector3[[UseJunctionTableForSnapshotVector3]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Postgresql.UseJunctionTableForSnapshotVector3 +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### UseJunctionTableForSnapshotVector3 +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L123) +```csharp +public UseJunctionTableForSnapshotVector3() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L120) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L120) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L123) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddActivityAmount.md b/CodeDocumentation/data/migrations/sqlite/AddActivityAmount.md new file mode 100644 index 0000000..d09041a --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddActivityAmount.md @@ -0,0 +1,68 @@ +# AddActivityAmount `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddActivityAmount[[AddActivityAmount]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddActivityAmount +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddActivityAmount +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/EventInfo.cs#L15) +```csharp +public AddActivityAmount() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/EventInfo.cs#L14) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/EventInfo.cs#L14) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/EventInfo.cs#L15) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddAdditionalClientStatsAndZScore.md b/CodeDocumentation/data/migrations/sqlite/AddAdditionalClientStatsAndZScore.md new file mode 100644 index 0000000..bdabf64 --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddAdditionalClientStatsAndZScore.md @@ -0,0 +1,68 @@ +# AddAdditionalClientStatsAndZScore `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddAdditionalClientStatsAndZScore[[AddAdditionalClientStatsAndZScore]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddAdditionalClientStatsAndZScore +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddAdditionalClientStatsAndZScore +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ServerInfo.cs#L15) +```csharp +public AddAdditionalClientStatsAndZScore() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ServerInfo.cs#L13) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ServerInfo.cs#L14) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ServerInfo.cs#L14) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddAlternateKeyToEFClients.md b/CodeDocumentation/data/migrations/sqlite/AddAlternateKeyToEFClients.md new file mode 100644 index 0000000..7207685 --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddAlternateKeyToEFClients.md @@ -0,0 +1,68 @@ +# AddAlternateKeyToEFClients `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddAlternateKeyToEFClients[[AddAlternateKeyToEFClients]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddAlternateKeyToEFClients +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddAlternateKeyToEFClients +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/ClientNoteMetaResponse.cs#L11) +```csharp +public AddAlternateKeyToEFClients() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/ClientNoteMetaResponse.cs#L9) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/ClientNoteMetaResponse.cs#L9) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/ClientNoteMetaResponse.cs#L11) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddAuditFieldsToEFPenaltyIdentifier.md b/CodeDocumentation/data/migrations/sqlite/AddAuditFieldsToEFPenaltyIdentifier.md new file mode 100644 index 0000000..1db7dc2 --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddAuditFieldsToEFPenaltyIdentifier.md @@ -0,0 +1,67 @@ +# AddAuditFieldsToEFPenaltyIdentifier `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddAuditFieldsToEFPenaltyIdentifier[[AddAuditFieldsToEFPenaltyIdentifier]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddAuditFieldsToEFPenaltyIdentifier +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddAuditFieldsToEFPenaltyIdentifier +```csharp +public AddAuditFieldsToEFPenaltyIdentifier() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/WebfrontTranslationHelper.cs#L6) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/WebfrontTranslationHelper.cs#L7) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/WebfrontTranslationHelper.cs#L7) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddAutomatedOffenseAndRatingHistory.md b/CodeDocumentation/data/migrations/sqlite/AddAutomatedOffenseAndRatingHistory.md new file mode 100644 index 0000000..1d9b41b --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddAutomatedOffenseAndRatingHistory.md @@ -0,0 +1,68 @@ +# AddAutomatedOffenseAndRatingHistory `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddAutomatedOffenseAndRatingHistory[[AddAutomatedOffenseAndRatingHistory]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddAutomatedOffenseAndRatingHistory +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddAutomatedOffenseAndRatingHistory +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/EventInfo.cs#L13) +```csharp +public AddAutomatedOffenseAndRatingHistory() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/EventInfo.cs#L12) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/EventInfo.cs#L12) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/EventInfo.cs#L13) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddAvgRecoilOffset.md b/CodeDocumentation/data/migrations/sqlite/AddAvgRecoilOffset.md new file mode 100644 index 0000000..9f95d98 --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddAvgRecoilOffset.md @@ -0,0 +1,68 @@ +# AddAvgRecoilOffset `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddAvgRecoilOffset[[AddAvgRecoilOffset]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddAvgRecoilOffset +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddAvgRecoilOffset +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PenaltyInfo.cs#L22) +```csharp +public AddAvgRecoilOffset() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PenaltyInfo.cs#L21) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PenaltyInfo.cs#L21) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PenaltyInfo.cs#L22) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddClientMeta.md b/CodeDocumentation/data/migrations/sqlite/AddClientMeta.md new file mode 100644 index 0000000..b910f9d --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddClientMeta.md @@ -0,0 +1,68 @@ +# AddClientMeta `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddClientMeta[[AddClientMeta]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddClientMeta +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddClientMeta +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/EventInfo.cs#L17) +```csharp +public AddClientMeta() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/EventInfo.cs#L16) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/EventInfo.cs#L16) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/EventInfo.cs#L17) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddConnectionInterruptedToEFServerSnapshot.md b/CodeDocumentation/data/migrations/sqlite/AddConnectionInterruptedToEFServerSnapshot.md new file mode 100644 index 0000000..c817a90 --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddConnectionInterruptedToEFServerSnapshot.md @@ -0,0 +1,68 @@ +# AddConnectionInterruptedToEFServerSnapshot `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddConnectionInterruptedToEFServerSnapshot[[AddConnectionInterruptedToEFServerSnapshot]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddConnectionInterruptedToEFServerSnapshot +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddConnectionInterruptedToEFServerSnapshot +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/BaseMetaResponse.cs#L9) +```csharp +public AddConnectionInterruptedToEFServerSnapshot() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/Sqlite/20220329163928_AddConnectionInterruptedToEFServerSnapshot.cs#L10) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/BaseMetaResponse.cs#L8) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/BaseMetaResponse.cs#L8) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddCurrentSnapValueToSnapshot.md b/CodeDocumentation/data/migrations/sqlite/AddCurrentSnapValueToSnapshot.md new file mode 100644 index 0000000..ed81696 --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddCurrentSnapValueToSnapshot.md @@ -0,0 +1,68 @@ +# AddCurrentSnapValueToSnapshot `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddCurrentSnapValueToSnapshot[[AddCurrentSnapValueToSnapshot]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddCurrentSnapValueToSnapshot +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddCurrentSnapValueToSnapshot +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L18) +```csharp +public AddCurrentSnapValueToSnapshot() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L16) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L17) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L17) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddDescendingTimeSentIndexEFClientMessages.md b/CodeDocumentation/data/migrations/sqlite/AddDescendingTimeSentIndexEFClientMessages.md new file mode 100644 index 0000000..e59d05c --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddDescendingTimeSentIndexEFClientMessages.md @@ -0,0 +1,68 @@ +# AddDescendingTimeSentIndexEFClientMessages `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddDescendingTimeSentIndexEFClientMessages[[AddDescendingTimeSentIndexEFClientMessages]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddDescendingTimeSentIndexEFClientMessages +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddDescendingTimeSentIndexEFClientMessages +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/ConnectionHistoryResponse.cs#L7) +```csharp +public AddDescendingTimeSentIndexEFClientMessages() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/ClientNoteMetaResponse.cs#L12) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/ClientNoteMetaResponse.cs#L12) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/ServerDataViewer.cs#L16707566) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddEFACSnapshots.md b/CodeDocumentation/data/migrations/sqlite/AddEFACSnapshots.md new file mode 100644 index 0000000..2382e09 --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddEFACSnapshots.md @@ -0,0 +1,68 @@ +# AddEFACSnapshots `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddEFACSnapshots[[AddEFACSnapshots]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddEFACSnapshots +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddEFACSnapshots +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/FindClientRequest.cs#L13) +```csharp +public AddEFACSnapshots() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/FindClientRequest.cs#L8) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/FindClientRequest.cs#L8) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/FindClientRequest.cs#L13) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddEFAliasNameIndex.md b/CodeDocumentation/data/migrations/sqlite/AddEFAliasNameIndex.md new file mode 100644 index 0000000..52bb802 --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddEFAliasNameIndex.md @@ -0,0 +1,68 @@ +# AddEFAliasNameIndex `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddEFAliasNameIndex[[AddEFAliasNameIndex]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddEFAliasNameIndex +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddEFAliasNameIndex +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/LookupValue.cs#L7) +```csharp +public AddEFAliasNameIndex() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/IW4MAdminInfo.cs#L23) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/MasterCommunication.cs#L140) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/LookupValue.cs#L7) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddEFAliasNameMaxLength24.md b/CodeDocumentation/data/migrations/sqlite/AddEFAliasNameMaxLength24.md new file mode 100644 index 0000000..1d5600e --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddEFAliasNameMaxLength24.md @@ -0,0 +1,68 @@ +# AddEFAliasNameMaxLength24 `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddEFAliasNameMaxLength24[[AddEFAliasNameMaxLength24]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddEFAliasNameMaxLength24 +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddEFAliasNameMaxLength24 +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Page.cs#L5) +```csharp +public AddEFAliasNameMaxLength24() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/LookupValue.cs#L8) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/LookupValue.cs#L8) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/MasterCommunication.cs#L16707566) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddEFClientConnectionHistory.md b/CodeDocumentation/data/migrations/sqlite/AddEFClientConnectionHistory.md new file mode 100644 index 0000000..0ced0bb --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddEFClientConnectionHistory.md @@ -0,0 +1,68 @@ +# AddEFClientConnectionHistory `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddEFClientConnectionHistory[[AddEFClientConnectionHistory]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddEFClientConnectionHistory +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddEFClientConnectionHistory +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ServerInfo.cs#L45) +```csharp +public AddEFClientConnectionHistory() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ServerInfo.cs#L27) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ServerInfo.cs#L28) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ServerInfo.cs#L33) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddEFInboxMessage.md b/CodeDocumentation/data/migrations/sqlite/AddEFInboxMessage.md new file mode 100644 index 0000000..11ca5bf --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddEFInboxMessage.md @@ -0,0 +1,68 @@ +# AddEFInboxMessage `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddEFInboxMessage[[AddEFInboxMessage]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddEFInboxMessage +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddEFInboxMessage +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ServerInfo.cs#L25) +```csharp +public AddEFInboxMessage() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ServerInfo.cs#L23) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ServerInfo.cs#L24) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ServerInfo.cs#L24) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddEFPenaltyIdentifier.md b/CodeDocumentation/data/migrations/sqlite/AddEFPenaltyIdentifier.md new file mode 100644 index 0000000..ff423b0 --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddEFPenaltyIdentifier.md @@ -0,0 +1,68 @@ +# AddEFPenaltyIdentifier `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddEFPenaltyIdentifier[[AddEFPenaltyIdentifier]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddEFPenaltyIdentifier +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddEFPenaltyIdentifier +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/SharedInfo.cs#L7) +```csharp +public AddEFPenaltyIdentifier() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/SharedInfo.cs#L6) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/SharedInfo.cs#L6) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/SharedInfo.cs#L7) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddEFServerSnapshot.md b/CodeDocumentation/data/migrations/sqlite/AddEFServerSnapshot.md new file mode 100644 index 0000000..2fbcad9 --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddEFServerSnapshot.md @@ -0,0 +1,68 @@ +# AddEFServerSnapshot `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddEFServerSnapshot[[AddEFServerSnapshot]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddEFServerSnapshot +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddEFServerSnapshot +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ServerInfo.cs#L27) +```csharp +public AddEFServerSnapshot() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ServerInfo.cs#L25) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ServerInfo.cs#L26) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ServerInfo.cs#L26) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddEloField.md b/CodeDocumentation/data/migrations/sqlite/AddEloField.md new file mode 100644 index 0000000..9ca31a2 --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddEloField.md @@ -0,0 +1,67 @@ +# AddEloField `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddEloField[[AddEloField]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddEloField +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddEloField +```csharp +public AddEloField() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ErrorResponse.cs#L8) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ErrorResponse.cs#L13) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ErrorResponse.cs#L13) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddEndpointToEFServerUpdateServerIdType.md b/CodeDocumentation/data/migrations/sqlite/AddEndpointToEFServerUpdateServerIdType.md new file mode 100644 index 0000000..88bc65a --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddEndpointToEFServerUpdateServerIdType.md @@ -0,0 +1,68 @@ +# AddEndpointToEFServerUpdateServerIdType `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddEndpointToEFServerUpdateServerIdType[[AddEndpointToEFServerUpdateServerIdType]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddEndpointToEFServerUpdateServerIdType +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddEndpointToEFServerUpdateServerIdType +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PenaltyInfo.cs#L14) +```csharp +public AddEndpointToEFServerUpdateServerIdType() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PenaltyInfo.cs#L12) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PenaltyInfo.cs#L13) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PenaltyInfo.cs#L13) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddEvadePenaltyFlag.md b/CodeDocumentation/data/migrations/sqlite/AddEvadePenaltyFlag.md new file mode 100644 index 0000000..b53e1eb --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddEvadePenaltyFlag.md @@ -0,0 +1,68 @@ +# AddEvadePenaltyFlag `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddEvadePenaltyFlag[[AddEvadePenaltyFlag]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddEvadePenaltyFlag +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddEvadePenaltyFlag +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PenaltyInfo.cs#L16) +```csharp +public AddEvadePenaltyFlag() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PenaltyInfo.cs#L14) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PenaltyInfo.cs#L15) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PenaltyInfo.cs#L15) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddFractionAndIsKill.md b/CodeDocumentation/data/migrations/sqlite/AddFractionAndIsKill.md new file mode 100644 index 0000000..79cf5ff --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddFractionAndIsKill.md @@ -0,0 +1,68 @@ +# AddFractionAndIsKill `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddFractionAndIsKill[[AddFractionAndIsKill]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddFractionAndIsKill +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddFractionAndIsKill +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/FindClientResult.cs#L18) +```csharp +public AddFractionAndIsKill() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/FindClientResult.cs#L13) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/FindClientResult.cs#L13) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/FindClientResult.cs#L18) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddGameNameToEFServer.md b/CodeDocumentation/data/migrations/sqlite/AddGameNameToEFServer.md new file mode 100644 index 0000000..6b3a7ca --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddGameNameToEFServer.md @@ -0,0 +1,68 @@ +# AddGameNameToEFServer `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddGameNameToEFServer[[AddGameNameToEFServer]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddGameNameToEFServer +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddGameNameToEFServer +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PenaltyInfo.cs#L20) +```csharp +public AddGameNameToEFServer() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PenaltyInfo.cs#L18) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PenaltyInfo.cs#L19) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PenaltyInfo.cs#L20) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddGameToEFClient.md b/CodeDocumentation/data/migrations/sqlite/AddGameToEFClient.md new file mode 100644 index 0000000..8e4ece5 --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddGameToEFClient.md @@ -0,0 +1,68 @@ +# AddGameToEFClient `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddGameToEFClient[[AddGameToEFClient]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddGameToEFClient +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddGameToEFClient +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/BaseMetaResponse.cs#L15) +```csharp +public AddGameToEFClient() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/BaseMetaResponse.cs#L13) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/BaseMetaResponse.cs#L14) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/BaseMetaResponse.cs#L14) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddHitLocationReferenceToEFACSnapshot.md b/CodeDocumentation/data/migrations/sqlite/AddHitLocationReferenceToEFACSnapshot.md new file mode 100644 index 0000000..5eb8690 --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddHitLocationReferenceToEFACSnapshot.md @@ -0,0 +1,68 @@ +# AddHitLocationReferenceToEFACSnapshot `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddHitLocationReferenceToEFACSnapshot[[AddHitLocationReferenceToEFACSnapshot]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddHitLocationReferenceToEFACSnapshot +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddHitLocationReferenceToEFACSnapshot +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ServerInfo.cs#L23) +```csharp +public AddHitLocationReferenceToEFACSnapshot() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ServerInfo.cs#L21) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ServerInfo.cs#L22) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ServerInfo.cs#L22) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddHostnameToEFServer.md b/CodeDocumentation/data/migrations/sqlite/AddHostnameToEFServer.md new file mode 100644 index 0000000..988329a --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddHostnameToEFServer.md @@ -0,0 +1,68 @@ +# AddHostnameToEFServer `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddHostnameToEFServer[[AddHostnameToEFServer]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddHostnameToEFServer +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddHostnameToEFServer +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L32) +```csharp +public AddHostnameToEFServer() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L31) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L31) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L32) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddImpersonationIdToEFChangeHistory.md b/CodeDocumentation/data/migrations/sqlite/AddImpersonationIdToEFChangeHistory.md new file mode 100644 index 0000000..09e42ef --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddImpersonationIdToEFChangeHistory.md @@ -0,0 +1,68 @@ +# AddImpersonationIdToEFChangeHistory `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddImpersonationIdToEFChangeHistory[[AddImpersonationIdToEFChangeHistory]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddImpersonationIdToEFChangeHistory +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddImpersonationIdToEFChangeHistory +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L30) +```csharp +public AddImpersonationIdToEFChangeHistory() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L28) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L29) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L30) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddIndexToEFMetaKeyAndClientId.md b/CodeDocumentation/data/migrations/sqlite/AddIndexToEFMetaKeyAndClientId.md new file mode 100644 index 0000000..a34c0cd --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddIndexToEFMetaKeyAndClientId.md @@ -0,0 +1,68 @@ +# AddIndexToEFMetaKeyAndClientId `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddIndexToEFMetaKeyAndClientId[[AddIndexToEFMetaKeyAndClientId]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddIndexToEFMetaKeyAndClientId +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddIndexToEFMetaKeyAndClientId +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PenaltyInfo.cs#L18) +```csharp +public AddIndexToEFMetaKeyAndClientId() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PenaltyInfo.cs#L16) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PenaltyInfo.cs#L17) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PenaltyInfo.cs#L17) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddIndexToEFRankingHistoryCreatedDatetime.md b/CodeDocumentation/data/migrations/sqlite/AddIndexToEFRankingHistoryCreatedDatetime.md new file mode 100644 index 0000000..3fe93a6 --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddIndexToEFRankingHistoryCreatedDatetime.md @@ -0,0 +1,68 @@ +# AddIndexToEFRankingHistoryCreatedDatetime `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddIndexToEFRankingHistoryCreatedDatetime[[AddIndexToEFRankingHistoryCreatedDatetime]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddIndexToEFRankingHistoryCreatedDatetime +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddIndexToEFRankingHistoryCreatedDatetime +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/ClientNoteMetaResponse.cs#L8) +```csharp +public AddIndexToEFRankingHistoryCreatedDatetime() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/BaseMetaResponse.cs#L15) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/Sqlite/20220609022511_AddIndexToEFRankingHistoryCreatedDatetime.cs#L18) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/ClientNoteMetaResponse.cs#L8) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddIndexToMessageTimeSent.md b/CodeDocumentation/data/migrations/sqlite/AddIndexToMessageTimeSent.md new file mode 100644 index 0000000..b91cc07 --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddIndexToMessageTimeSent.md @@ -0,0 +1,68 @@ +# AddIndexToMessageTimeSent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddIndexToMessageTimeSent[[AddIndexToMessageTimeSent]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddIndexToMessageTimeSent +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddIndexToMessageTimeSent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PaginationRequest.cs#L18) +```csharp +public AddIndexToMessageTimeSent() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PaginationRequest.cs#L13) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PaginationRequest.cs#L13) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PaginationRequest.cs#L18) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddIndexToSearchableIPToEFAlias.md b/CodeDocumentation/data/migrations/sqlite/AddIndexToSearchableIPToEFAlias.md new file mode 100644 index 0000000..4ce41f9 --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddIndexToSearchableIPToEFAlias.md @@ -0,0 +1,68 @@ +# AddIndexToSearchableIPToEFAlias `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddIndexToSearchableIPToEFAlias[[AddIndexToSearchableIPToEFAlias]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddIndexToSearchableIPToEFAlias +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddIndexToSearchableIPToEFAlias +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/BaseMetaResponse.cs#L13) +```csharp +public AddIndexToSearchableIPToEFAlias() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/BaseMetaResponse.cs#L11) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/BaseMetaResponse.cs#L12) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/BaseMetaResponse.cs#L12) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddIsPasswordProtectedColumn.md b/CodeDocumentation/data/migrations/sqlite/AddIsPasswordProtectedColumn.md new file mode 100644 index 0000000..43a55b0 --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddIsPasswordProtectedColumn.md @@ -0,0 +1,68 @@ +# AddIsPasswordProtectedColumn `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddIsPasswordProtectedColumn[[AddIsPasswordProtectedColumn]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddIsPasswordProtectedColumn +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddIsPasswordProtectedColumn +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L34) +```csharp +public AddIsPasswordProtectedColumn() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L33) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L33) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L34) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddLastConnectionIndexEFClient.md b/CodeDocumentation/data/migrations/sqlite/AddLastConnectionIndexEFClient.md new file mode 100644 index 0000000..952a065 --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddLastConnectionIndexEFClient.md @@ -0,0 +1,67 @@ +# AddLastConnectionIndexEFClient `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddLastConnectionIndexEFClient[[AddLastConnectionIndexEFClient]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddLastConnectionIndexEFClient +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddLastConnectionIndexEFClient +```csharp +public AddLastConnectionIndexEFClient() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/ConnectionHistoryResponse.cs#L7) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/ConnectionHistoryResponse.cs#L8) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/ConnectionHistoryResponse.cs#L8) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddMissingActiveColumns.md b/CodeDocumentation/data/migrations/sqlite/AddMissingActiveColumns.md new file mode 100644 index 0000000..08e135c --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddMissingActiveColumns.md @@ -0,0 +1,68 @@ +# AddMissingActiveColumns `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddMissingActiveColumns[[AddMissingActiveColumns]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddMissingActiveColumns +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddMissingActiveColumns +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L28) +```csharp +public AddMissingActiveColumns() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L26) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L27) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L27) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddPreviousCurrentValueToEFChangeHistory.md b/CodeDocumentation/data/migrations/sqlite/AddPreviousCurrentValueToEFChangeHistory.md new file mode 100644 index 0000000..ae34592 --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddPreviousCurrentValueToEFChangeHistory.md @@ -0,0 +1,67 @@ +# AddPreviousCurrentValueToEFChangeHistory `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddPreviousCurrentValueToEFChangeHistory[[AddPreviousCurrentValueToEFChangeHistory]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddPreviousCurrentValueToEFChangeHistory +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddPreviousCurrentValueToEFChangeHistory +```csharp +public AddPreviousCurrentValueToEFChangeHistory() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Page.cs#L5) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Page.cs#L6) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Page.cs#L6) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddRankingHistory.md b/CodeDocumentation/data/migrations/sqlite/AddRankingHistory.md new file mode 100644 index 0000000..ba0e0b7 --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddRankingHistory.md @@ -0,0 +1,68 @@ +# AddRankingHistory `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddRankingHistory[[AddRankingHistory]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddRankingHistory +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddRankingHistory +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ServerInfo.cs#L17) +```csharp +public AddRankingHistory() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ServerInfo.cs#L15) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ServerInfo.cs#L16) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ServerInfo.cs#L16) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddRatingIndexes.md b/CodeDocumentation/data/migrations/sqlite/AddRatingIndexes.md new file mode 100644 index 0000000..d912757 --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddRatingIndexes.md @@ -0,0 +1,68 @@ +# AddRatingIndexes `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddRatingIndexes[[AddRatingIndexes]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddRatingIndexes +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddRatingIndexes +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/IW4MAdminInfo.cs#L23) +```csharp +public AddRatingIndexes() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/IW4MAdminInfo.cs#L13) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/IW4MAdminInfo.cs#L18) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/IW4MAdminInfo.cs#L18) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddRecoilOffsetToSnapshot.md b/CodeDocumentation/data/migrations/sqlite/AddRecoilOffsetToSnapshot.md new file mode 100644 index 0000000..d1d38a1 --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddRecoilOffsetToSnapshot.md @@ -0,0 +1,68 @@ +# AddRecoilOffsetToSnapshot `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddRecoilOffsetToSnapshot[[AddRecoilOffsetToSnapshot]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddRecoilOffsetToSnapshot +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddRecoilOffsetToSnapshot +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PenaltyInfo.cs#L25) +```csharp +public AddRecoilOffsetToSnapshot() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PenaltyInfo.cs#L23) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PenaltyInfo.cs#L24) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PenaltyInfo.cs#L24) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddRollingKDR.md b/CodeDocumentation/data/migrations/sqlite/AddRollingKDR.md new file mode 100644 index 0000000..b5aa83b --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddRollingKDR.md @@ -0,0 +1,68 @@ +# AddRollingKDR `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddRollingKDR[[AddRollingKDR]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddRollingKDR +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddRollingKDR +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/EventInfo.cs#L11) +```csharp +public AddRollingKDR() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/EventInfo.cs#L10) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/EventInfo.cs#L10) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/EventInfo.cs#L11) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddSearchNameToEFAlias.md b/CodeDocumentation/data/migrations/sqlite/AddSearchNameToEFAlias.md new file mode 100644 index 0000000..5318479 --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddSearchNameToEFAlias.md @@ -0,0 +1,68 @@ +# AddSearchNameToEFAlias `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddSearchNameToEFAlias[[AddSearchNameToEFAlias]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddSearchNameToEFAlias +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddSearchNameToEFAlias +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PenaltyInfo.cs#L40) +```csharp +public AddSearchNameToEFAlias() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PenaltyInfo.cs#L35) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PenaltyInfo.cs#L37) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PenaltyInfo.cs#L37) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddSearchableIPToEFAlias.md b/CodeDocumentation/data/migrations/sqlite/AddSearchableIPToEFAlias.md new file mode 100644 index 0000000..301d368 --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddSearchableIPToEFAlias.md @@ -0,0 +1,68 @@ +# AddSearchableIPToEFAlias `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddSearchableIPToEFAlias[[AddSearchableIPToEFAlias]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddSearchableIPToEFAlias +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddSearchableIPToEFAlias +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/BaseMetaResponse.cs#L11) +```csharp +public AddSearchableIPToEFAlias() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/BaseMetaResponse.cs#L9) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/BaseMetaResponse.cs#L10) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/BaseMetaResponse.cs#L10) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddSentIngameFlagToClientMessage.md b/CodeDocumentation/data/migrations/sqlite/AddSentIngameFlagToClientMessage.md new file mode 100644 index 0000000..a0d3014 --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddSentIngameFlagToClientMessage.md @@ -0,0 +1,68 @@ +# AddSentIngameFlagToClientMessage `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddSentIngameFlagToClientMessage[[AddSentIngameFlagToClientMessage]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddSentIngameFlagToClientMessage +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddSentIngameFlagToClientMessage +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ServerInfo.cs#L11) +```csharp +public AddSentIngameFlagToClientMessage() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L37) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L37) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/Sqlite/20201118023106_AddSentIngameFlagToClientMessage.Designer.cs#L16) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddSessionSnapHitsToSnapshot.md b/CodeDocumentation/data/migrations/sqlite/AddSessionSnapHitsToSnapshot.md new file mode 100644 index 0000000..76d421d --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddSessionSnapHitsToSnapshot.md @@ -0,0 +1,68 @@ +# AddSessionSnapHitsToSnapshot `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddSessionSnapHitsToSnapshot[[AddSessionSnapHitsToSnapshot]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddSessionSnapHitsToSnapshot +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddSessionSnapHitsToSnapshot +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L20) +```csharp +public AddSessionSnapHitsToSnapshot() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L18) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L19) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L19) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddSnapHitCountToClientStatistics.md b/CodeDocumentation/data/migrations/sqlite/AddSnapHitCountToClientStatistics.md new file mode 100644 index 0000000..6c0e618 --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddSnapHitCountToClientStatistics.md @@ -0,0 +1,68 @@ +# AddSnapHitCountToClientStatistics `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddSnapHitCountToClientStatistics[[AddSnapHitCountToClientStatistics]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddSnapHitCountToClientStatistics +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddSnapHitCountToClientStatistics +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L14) +```csharp +public AddSnapHitCountToClientStatistics() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L12) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L13) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L13) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddVisibilityPercentage.md b/CodeDocumentation/data/migrations/sqlite/AddVisibilityPercentage.md new file mode 100644 index 0000000..01cbe8f --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddVisibilityPercentage.md @@ -0,0 +1,68 @@ +# AddVisibilityPercentage `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddVisibilityPercentage[[AddVisibilityPercentage]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddVisibilityPercentage +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddVisibilityPercentage +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/IW4MAdminInfo.cs#L9) +```csharp +public AddVisibilityPercentage() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/Sqlite/20180904154622_AddVisibilityPercentage.cs#L8) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/IW4MAdminInfo.cs#L8) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/IW4MAdminInfo.cs#L8) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddVision.md b/CodeDocumentation/data/migrations/sqlite/AddVision.md new file mode 100644 index 0000000..43aded3 --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddVision.md @@ -0,0 +1,68 @@ +# AddVision `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddVision[[AddVision]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddVision +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddVision +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/IW4MAdminInfo.cs#L11) +```csharp +public AddVision() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/IW4MAdminInfo.cs#L9) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/IW4MAdminInfo.cs#L10) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/IW4MAdminInfo.cs#L10) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddWeaponReferenceAndServerIdToEFACSnapshot.md b/CodeDocumentation/data/migrations/sqlite/AddWeaponReferenceAndServerIdToEFACSnapshot.md new file mode 100644 index 0000000..d79d40b --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddWeaponReferenceAndServerIdToEFACSnapshot.md @@ -0,0 +1,68 @@ +# AddWeaponReferenceAndServerIdToEFACSnapshot `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddWeaponReferenceAndServerIdToEFACSnapshot[[AddWeaponReferenceAndServerIdToEFACSnapshot]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddWeaponReferenceAndServerIdToEFACSnapshot +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddWeaponReferenceAndServerIdToEFACSnapshot +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ServerInfo.cs#L21) +```csharp +public AddWeaponReferenceAndServerIdToEFACSnapshot() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ServerInfo.cs#L19) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ServerInfo.cs#L20) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ServerInfo.cs#L20) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddWeaponReferenceToEFClientKill.md b/CodeDocumentation/data/migrations/sqlite/AddWeaponReferenceToEFClientKill.md new file mode 100644 index 0000000..e5bdfb3 --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddWeaponReferenceToEFClientKill.md @@ -0,0 +1,68 @@ +# AddWeaponReferenceToEFClientKill `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddWeaponReferenceToEFClientKill[[AddWeaponReferenceToEFClientKill]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddWeaponReferenceToEFClientKill +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddWeaponReferenceToEFClientKill +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ServerInfo.cs#L19) +```csharp +public AddWeaponReferenceToEFClientKill() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ServerInfo.cs#L17) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ServerInfo.cs#L18) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ServerInfo.cs#L18) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddWhenToRating.md b/CodeDocumentation/data/migrations/sqlite/AddWhenToRating.md new file mode 100644 index 0000000..09ea1a7 --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddWhenToRating.md @@ -0,0 +1,68 @@ +# AddWhenToRating `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddWhenToRating[[AddWhenToRating]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddWhenToRating +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddWhenToRating +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/IW4MAdminInfo.cs#L13) +```csharp +public AddWhenToRating() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/IW4MAdminInfo.cs#L11) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/IW4MAdminInfo.cs#L12) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/IW4MAdminInfo.cs#L12) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AddZombieStatsInitial.md b/CodeDocumentation/data/migrations/sqlite/AddZombieStatsInitial.md new file mode 100644 index 0000000..a1dbe91 --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AddZombieStatsInitial.md @@ -0,0 +1,68 @@ +# AddZombieStatsInitial `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AddZombieStatsInitial[[AddZombieStatsInitial]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AddZombieStatsInitial +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AddZombieStatsInitial +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/InformationResponse.cs#L6) +```csharp +public AddZombieStatsInitial() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/InformationResponse.cs#L5) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/InformationResponse.cs#L5) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/InformationResponse.cs#L6) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AlterEFRatingIndex.md b/CodeDocumentation/data/migrations/sqlite/AlterEFRatingIndex.md new file mode 100644 index 0000000..3e524df --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AlterEFRatingIndex.md @@ -0,0 +1,68 @@ +# AlterEFRatingIndex `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AlterEFRatingIndex[[AlterEFRatingIndex]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AlterEFRatingIndex +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AlterEFRatingIndex +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PenaltyInfo.cs#L32) +```csharp +public AlterEFRatingIndex() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PenaltyInfo.cs#L27) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PenaltyInfo.cs#L31) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PenaltyInfo.cs#L32) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/AvgSnapValueToClientStatistics.md b/CodeDocumentation/data/migrations/sqlite/AvgSnapValueToClientStatistics.md new file mode 100644 index 0000000..37a6751 --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/AvgSnapValueToClientStatistics.md @@ -0,0 +1,68 @@ +# AvgSnapValueToClientStatistics `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.AvgSnapValueToClientStatistics[[AvgSnapValueToClientStatistics]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.AvgSnapValueToClientStatistics +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### AvgSnapValueToClientStatistics +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L12) +```csharp +public AvgSnapValueToClientStatistics() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/MetaService.cs#L16707566) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L11) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L11) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/EnforceUniqueIndexForEFAliasIPName.md b/CodeDocumentation/data/migrations/sqlite/EnforceUniqueIndexForEFAliasIPName.md new file mode 100644 index 0000000..3448a31 --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/EnforceUniqueIndexForEFAliasIPName.md @@ -0,0 +1,68 @@ +# EnforceUniqueIndexForEFAliasIPName `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.EnforceUniqueIndexForEFAliasIPName[[EnforceUniqueIndexForEFAliasIPName]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.EnforceUniqueIndexForEFAliasIPName +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### EnforceUniqueIndexForEFAliasIPName +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L24) +```csharp +public EnforceUniqueIndexForEFAliasIPName() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L22) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L23) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L23) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/IndexForEFAlias.md b/CodeDocumentation/data/migrations/sqlite/IndexForEFAlias.md new file mode 100644 index 0000000..dfb123f --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/IndexForEFAlias.md @@ -0,0 +1,68 @@ +# IndexForEFAlias `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.IndexForEFAlias[[IndexForEFAlias]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.IndexForEFAlias +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### IndexForEFAlias +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/FindClientResult.cs#L8) +```csharp +public IndexForEFAlias() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/FindClientRequest.cs#L16) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/Sqlite/20180614014303_IndexForEFAlias.cs#L18) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/FindClientResult.cs#L8) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/InitialCreate.md b/CodeDocumentation/data/migrations/sqlite/InitialCreate.md new file mode 100644 index 0000000..c72da49 --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/InitialCreate.md @@ -0,0 +1,68 @@ +# InitialCreate `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.InitialCreate[[InitialCreate]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.InitialCreate +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### InitialCreate +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/EntityInfo.cs#L8) +```csharp +public InitialCreate() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/CommandResponseInfo.cs#L6) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/Sqlite/20180409183408_InitialCreate.cs#L448) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/EntityInfo.cs#L8) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/MakeClientIPNullable.md b/CodeDocumentation/data/migrations/sqlite/MakeClientIPNullable.md new file mode 100644 index 0000000..0910fc4 --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/MakeClientIPNullable.md @@ -0,0 +1,68 @@ +# MakeClientIPNullable `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.MakeClientIPNullable[[MakeClientIPNullable]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.MakeClientIPNullable +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### MakeClientIPNullable +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PenaltyInfo.cs#L12) +```csharp +public MakeClientIPNullable() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PenaltyInfo.cs#L10) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PenaltyInfo.cs#L11) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PenaltyInfo.cs#L11) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/MakeEFPenaltyLinkIdNullable.md b/CodeDocumentation/data/migrations/sqlite/MakeEFPenaltyLinkIdNullable.md new file mode 100644 index 0000000..6c46047 --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/MakeEFPenaltyLinkIdNullable.md @@ -0,0 +1,68 @@ +# MakeEFPenaltyLinkIdNullable `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.MakeEFPenaltyLinkIdNullable[[MakeEFPenaltyLinkIdNullable]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.MakeEFPenaltyLinkIdNullable +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### MakeEFPenaltyLinkIdNullable +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/WebfrontTranslationHelper.cs#L6) +```csharp +public MakeEFPenaltyLinkIdNullable() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/SharedInfo.cs#L6) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/WebfrontTranslationHelper.cs#L5) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/WebfrontTranslationHelper.cs#L5) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/MakePenaltyExpirationNullable.md b/CodeDocumentation/data/migrations/sqlite/MakePenaltyExpirationNullable.md new file mode 100644 index 0000000..335bda5 --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/MakePenaltyExpirationNullable.md @@ -0,0 +1,68 @@ +# MakePenaltyExpirationNullable `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.MakePenaltyExpirationNullable[[MakePenaltyExpirationNullable]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.MakePenaltyExpirationNullable +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### MakePenaltyExpirationNullable +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PenaltyInfo.cs#L10) +```csharp +public MakePenaltyExpirationNullable() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PaginationRequest.cs#L18) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PenaltyInfo.cs#L9) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PenaltyInfo.cs#L9) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/ReaddACSnapshot.md b/CodeDocumentation/data/migrations/sqlite/ReaddACSnapshot.md new file mode 100644 index 0000000..0230d1b --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/ReaddACSnapshot.md @@ -0,0 +1,68 @@ +# ReaddACSnapshot `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.ReaddACSnapshot[[ReaddACSnapshot]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.ReaddACSnapshot +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### ReaddACSnapshot +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PaginationRequest.cs#L32) +```csharp +public ReaddACSnapshot() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PaginationRequest.cs#L30) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PaginationRequest.cs#L30) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PaginationRequest.cs#L32) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/RemoveACSnapShot.md b/CodeDocumentation/data/migrations/sqlite/RemoveACSnapShot.md new file mode 100644 index 0000000..f52169e --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/RemoveACSnapShot.md @@ -0,0 +1,68 @@ +# RemoveACSnapShot `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.RemoveACSnapShot[[RemoveACSnapShot]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.RemoveACSnapShot +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### RemoveACSnapShot +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PaginationRequest.cs#L28) +```csharp +public RemoveACSnapShot() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PaginationRequest.cs#L23) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PaginationRequest.cs#L23) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PaginationRequest.cs#L28) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/RemoveUniqueAliasIndexConstraint.md b/CodeDocumentation/data/migrations/sqlite/RemoveUniqueAliasIndexConstraint.md new file mode 100644 index 0000000..28d6c25 --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/RemoveUniqueAliasIndexConstraint.md @@ -0,0 +1,68 @@ +# RemoveUniqueAliasIndexConstraint `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.RemoveUniqueAliasIndexConstraint[[RemoveUniqueAliasIndexConstraint]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.RemoveUniqueAliasIndexConstraint +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### RemoveUniqueAliasIndexConstraint +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/SharedInfo.cs#L5) +```csharp +public RemoveUniqueAliasIndexConstraint() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ServerInfo.cs#L45) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/Sqlite/20220102214442_RemoveUniqueAliasIndexConstraint.cs#L12) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/SharedInfo.cs#L5) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/RenameClientHitLocationCountColumns.md b/CodeDocumentation/data/migrations/sqlite/RenameClientHitLocationCountColumns.md new file mode 100644 index 0000000..150ee45 --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/RenameClientHitLocationCountColumns.md @@ -0,0 +1,68 @@ +# RenameClientHitLocationCountColumns `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.RenameClientHitLocationCountColumns[[RenameClientHitLocationCountColumns]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.RenameClientHitLocationCountColumns +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### RenameClientHitLocationCountColumns +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L22) +```csharp +public RenameClientHitLocationCountColumns() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L20) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L21) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L21) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/SetCaseSensitiveCoallationForAliasNameMySQL.md b/CodeDocumentation/data/migrations/sqlite/SetCaseSensitiveCoallationForAliasNameMySQL.md new file mode 100644 index 0000000..2423332 --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/SetCaseSensitiveCoallationForAliasNameMySQL.md @@ -0,0 +1,68 @@ +# SetCaseSensitiveCoallationForAliasNameMySQL `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.SetCaseSensitiveCoallationForAliasNameMySQL[[SetCaseSensitiveCoallationForAliasNameMySQL]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.SetCaseSensitiveCoallationForAliasNameMySQL +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### SetCaseSensitiveCoallationForAliasNameMySQL +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L26) +```csharp +public SetCaseSensitiveCoallationForAliasNameMySQL() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L24) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L25) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L25) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/SqliteDatabaseContextModelSnapshot.md b/CodeDocumentation/data/migrations/sqlite/SqliteDatabaseContextModelSnapshot.md new file mode 100644 index 0000000..fe0b0fb --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/SqliteDatabaseContextModelSnapshot.md @@ -0,0 +1,46 @@ +# SqliteDatabaseContextModelSnapshot `Internal class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.SqliteDatabaseContextModelSnapshot[[SqliteDatabaseContextModelSnapshot]] + end + subgraph Microsoft.EntityFrameworkCore.Infrastructure +Microsoft.EntityFrameworkCore.Infrastructure.ModelSnapshot[[ModelSnapshot]] + end +Microsoft.EntityFrameworkCore.Infrastructure.ModelSnapshot --> Data.Migrations.Sqlite.SqliteDatabaseContextModelSnapshot +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildModel`](#buildmodel)(`ModelBuilder` modelBuilder) | + +## Details +### Inheritance + - `ModelSnapshot` + +### Constructors +#### SqliteDatabaseContextModelSnapshot +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/InformationResponse.cs#L7) +```csharp +public SqliteDatabaseContextModelSnapshot() +``` + +### Methods +#### BuildModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/InformationResponse.cs#L7) +```csharp +protected override void BuildModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/Update.md b/CodeDocumentation/data/migrations/sqlite/Update.md new file mode 100644 index 0000000..7e7648e --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/Update.md @@ -0,0 +1,68 @@ +# Update `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.Update[[Update]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.Update +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### Update +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ErrorResponse.cs#L8) +```csharp +public Update() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/EntityInfo.cs#L9) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/EntityInfo.cs#L9) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Migrations/Sqlite/20180502195450_Update.Designer.cs#L19) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/UpdateEFMetaToSupportNonClientMetaAndLinkedMeta.md b/CodeDocumentation/data/migrations/sqlite/UpdateEFMetaToSupportNonClientMetaAndLinkedMeta.md new file mode 100644 index 0000000..acb78c9 --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/UpdateEFMetaToSupportNonClientMetaAndLinkedMeta.md @@ -0,0 +1,68 @@ +# UpdateEFMetaToSupportNonClientMetaAndLinkedMeta `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.UpdateEFMetaToSupportNonClientMetaAndLinkedMeta[[UpdateEFMetaToSupportNonClientMetaAndLinkedMeta]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.UpdateEFMetaToSupportNonClientMetaAndLinkedMeta +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### UpdateEFMetaToSupportNonClientMetaAndLinkedMeta +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ServerInfo.cs#L13) +```csharp +public UpdateEFMetaToSupportNonClientMetaAndLinkedMeta() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ServerInfo.cs#L11) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ServerInfo.cs#L12) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ServerInfo.cs#L12) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/UpdateEFRatingIndex.md b/CodeDocumentation/data/migrations/sqlite/UpdateEFRatingIndex.md new file mode 100644 index 0000000..13442d9 --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/UpdateEFRatingIndex.md @@ -0,0 +1,68 @@ +# UpdateEFRatingIndex `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.UpdateEFRatingIndex[[UpdateEFRatingIndex]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.UpdateEFRatingIndex +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### UpdateEFRatingIndex +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L36) +```csharp +public UpdateEFRatingIndex() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L35) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L35) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L36) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/migrations/sqlite/UseJunctionTableForSnapshotVector3.md b/CodeDocumentation/data/migrations/sqlite/UseJunctionTableForSnapshotVector3.md new file mode 100644 index 0000000..b2c6281 --- /dev/null +++ b/CodeDocumentation/data/migrations/sqlite/UseJunctionTableForSnapshotVector3.md @@ -0,0 +1,68 @@ +# UseJunctionTableForSnapshotVector3 `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Migrations.Sqlite + Data.Migrations.Sqlite.UseJunctionTableForSnapshotVector3[[UseJunctionTableForSnapshotVector3]] + end + subgraph Microsoft.EntityFrameworkCore.Migrations +Microsoft.EntityFrameworkCore.Migrations.Migration[[Migration]] + end +Microsoft.EntityFrameworkCore.Migrations.Migration --> Data.Migrations.Sqlite.UseJunctionTableForSnapshotVector3 +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`BuildTargetModel`](#buildtargetmodel)(`ModelBuilder` modelBuilder) | +| `void` | [`Down`](#down)(`MigrationBuilder` migrationBuilder) | +| `void` | [`Up`](#up)(`MigrationBuilder` migrationBuilder) | + +## Details +### Inheritance + - `Migration` + +### Constructors +#### UseJunctionTableForSnapshotVector3 +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L16) +```csharp +public UseJunctionTableForSnapshotVector3() +``` + +### Methods +#### Up +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L14) +```csharp +protected override void Up(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### Down +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L15) +```csharp +protected override void Down(MigrationBuilder migrationBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `MigrationBuilder` | migrationBuilder | | + +#### BuildTargetModel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PlayerInfo.cs#L15) +```csharp +protected override void BuildTargetModel(ModelBuilder modelBuilder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | modelBuilder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/models/DatedRecord.md b/CodeDocumentation/data/models/DatedRecord.md new file mode 100644 index 0000000..d0874ab --- /dev/null +++ b/CodeDocumentation/data/models/DatedRecord.md @@ -0,0 +1,40 @@ +# DatedRecord `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Models + Data.Models.DatedRecord[[DatedRecord]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `DateTimeOffset` | [`CreatedDateTime`](#createddatetime) | `get, set` | +| `Nullable`<`DateTimeOffset`> | [`UpdatedDateTime`](#updateddatetime) | `get, set` | + +## Details +### Constructors +#### DatedRecord +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/DatedRecord.cs#L7) +```csharp +public DatedRecord() +``` + +### Properties +#### CreatedDateTime +```csharp +public DateTimeOffset CreatedDateTime { get; set; } +``` + +#### UpdatedDateTime +```csharp +public Nullable UpdatedDateTime { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/models/EFAlias.md b/CodeDocumentation/data/models/EFAlias.md new file mode 100644 index 0000000..17aa0c3 --- /dev/null +++ b/CodeDocumentation/data/models/EFAlias.md @@ -0,0 +1,82 @@ +# EFAlias `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Models + Data.Models.EFAlias[[EFAlias]] + Data.Models.SharedEntity[[SharedEntity]] + end +Data.Models.SharedEntity --> Data.Models.EFAlias +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `int` | [`AliasId`](#aliasid) | `get, set` | +| `DateTime` | [`DateAdded`](#dateadded) | `get, set` | +| `Nullable`<`int`> | [`IPAddress`](#ipaddress) | `get, set` | +| [`EFAliasLink`](./EFAliasLink.md) | [`Link`](#link) | `get, set` | +| `int` | [`LinkId`](#linkid) | `get, set` | +| `string` | [`Name`](#name) | `get, set` | +| `string` | [`SearchableIPAddress`](#searchableipaddress) | `get, set` | +| `string` | [`SearchableName`](#searchablename) | `get, set` | + +## Details +### Inheritance + - [ +`SharedEntity` +](./SharedEntity.md) + +### Constructors +#### EFAlias +```csharp +public EFAlias() +``` + +### Properties +#### AliasId +```csharp +public int AliasId { get; set; } +``` + +#### LinkId +```csharp +public int LinkId { get; set; } +``` + +#### Link +```csharp +public virtual EFAliasLink Link { get; set; } +``` + +#### Name +```csharp +public string Name { get; set; } +``` + +#### SearchableName +```csharp +public string SearchableName { get; set; } +``` + +#### IPAddress +```csharp +public Nullable IPAddress { get; set; } +``` + +#### SearchableIPAddress +```csharp +public string SearchableIPAddress { get; set; } +``` + +#### DateAdded +```csharp +public DateTime DateAdded { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/models/EFAliasLink.md b/CodeDocumentation/data/models/EFAliasLink.md new file mode 100644 index 0000000..b5d697a --- /dev/null +++ b/CodeDocumentation/data/models/EFAliasLink.md @@ -0,0 +1,53 @@ +# EFAliasLink `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Models + Data.Models.EFAliasLink[[EFAliasLink]] + Data.Models.SharedEntity[[SharedEntity]] + end +Data.Models.SharedEntity --> Data.Models.EFAliasLink +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `int` | [`AliasLinkId`](#aliaslinkid) | `get, set` | +| `ICollection`<[`EFAlias`](./EFAlias.md)> | [`Children`](#children) | `get, set` | +| `ICollection`<[`EFPenalty`](./EFPenalty.md)> | [`ReceivedPenalties`](#receivedpenalties) | `get, set` | + +## Details +### Inheritance + - [ +`SharedEntity` +](./SharedEntity.md) + +### Constructors +#### EFAliasLink +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFAliasLink.cs#L13) +```csharp +public EFAliasLink() +``` + +### Properties +#### AliasLinkId +```csharp +public int AliasLinkId { get; set; } +``` + +#### Children +```csharp +public virtual ICollection Children { get; set; } +``` + +#### ReceivedPenalties +```csharp +public virtual ICollection ReceivedPenalties { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/models/EFChangeHistory.md b/CodeDocumentation/data/models/EFChangeHistory.md new file mode 100644 index 0000000..b785512 --- /dev/null +++ b/CodeDocumentation/data/models/EFChangeHistory.md @@ -0,0 +1,99 @@ +# EFChangeHistory `Public class` + +## Description +This class models the change to different entities + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Models + Data.Models.EFChangeHistory[[EFChangeHistory]] + Data.Models.SharedEntity[[SharedEntity]] + end +Data.Models.SharedEntity --> Data.Models.EFChangeHistory +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `int` | [`ChangeHistoryId`](#changehistoryid) | `get, set` | +| `string` | [`Comment`](#comment) | `get, set` | +| `string` | [`CurrentValue`](#currentvalue) | `get, set` | +| `Nullable`<`int`> | [`ImpersonationEntityId`](#impersonationentityid) | `get, set` | +| `int` | [`OriginEntityId`](#originentityid) | `get, set` | +| `string` | [`PreviousValue`](#previousvalue) | `get, set` | +| `int` | [`TargetEntityId`](#targetentityid) | `get, set` | +| `DateTime` | [`TimeChanged`](#timechanged) | `get, set` | +| `ChangeType` | [`TypeOfChange`](#typeofchange) | `get, set` | + +## Details +### Summary +This class models the change to different entities + +### Inheritance + - [ +`SharedEntity` +](./SharedEntity.md) + +### Nested types +#### Enums + - `ChangeType` + +### Constructors +#### EFChangeHistory +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/RemoteAssemblyHandler.cs#L50) +```csharp +public EFChangeHistory() +``` + +### Properties +#### ChangeHistoryId +```csharp +public int ChangeHistoryId { get; set; } +``` + +#### OriginEntityId +```csharp +public int OriginEntityId { get; set; } +``` + +#### TargetEntityId +```csharp +public int TargetEntityId { get; set; } +``` + +#### ImpersonationEntityId +```csharp +public Nullable ImpersonationEntityId { get; set; } +``` + +#### TypeOfChange +```csharp +public ChangeType TypeOfChange { get; set; } +``` + +#### TimeChanged +```csharp +public DateTime TimeChanged { get; set; } +``` + +#### Comment +```csharp +public string Comment { get; set; } +``` + +#### PreviousValue +```csharp +public string PreviousValue { get; set; } +``` + +#### CurrentValue +```csharp +public string CurrentValue { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/models/EFMeta.md b/CodeDocumentation/data/models/EFMeta.md new file mode 100644 index 0000000..2f8cf11 --- /dev/null +++ b/CodeDocumentation/data/models/EFMeta.md @@ -0,0 +1,101 @@ +# EFMeta `Public class` + +## Description +This class encapsulates any meta fields as a simple string + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Models + Data.Models.EFMeta[[EFMeta]] + Data.Models.SharedEntity[[SharedEntity]] + end +Data.Models.SharedEntity --> Data.Models.EFMeta +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| [`EFClient`](client/EFClient.md) | [`Client`](#client) | `get, set` | +| `Nullable`<`int`> | [`ClientId`](#clientid) | `get, set` | +| `DateTime` | [`Created`](#created) | `get, set` | +| `string` | [`Extra`](#extra) | `get, set` | +| `string` | [`Key`](#key) | `get, set` | +| [`EFMeta`](data/models/EFMeta.md) | [`LinkedMeta`](#linkedmeta) | `get, set` | +| `Nullable`<`int`> | [`LinkedMetaId`](#linkedmetaid) | `get, set` | +| `int` | [`MetaId`](#metaid) | `get, set` | +| `DateTime` | [`Updated`](#updated) | `get, set` | +| `string` | [`Value`](#value) | `get, set` | + +## Details +### Summary +This class encapsulates any meta fields as a simple string + +### Inheritance + - [ +`SharedEntity` +](./SharedEntity.md) + +### Constructors +#### EFMeta +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFMeta.cs#L19) +```csharp +public EFMeta() +``` + +### Properties +#### MetaId +```csharp +public int MetaId { get; set; } +``` + +#### Created +```csharp +public DateTime Created { get; set; } +``` + +#### Updated +```csharp +public DateTime Updated { get; set; } +``` + +#### ClientId +```csharp +public Nullable ClientId { get; set; } +``` + +#### Client +```csharp +public virtual EFClient Client { get; set; } +``` + +#### Key +```csharp +public string Key { get; set; } +``` + +#### Value +```csharp +public string Value { get; set; } +``` + +#### Extra +```csharp +public string Extra { get; set; } +``` + +#### LinkedMetaId +```csharp +public Nullable LinkedMetaId { get; set; } +``` + +#### LinkedMeta +```csharp +public virtual EFMeta LinkedMeta { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/models/EFPenalty.md b/CodeDocumentation/data/models/EFPenalty.md new file mode 100644 index 0000000..2a4327a --- /dev/null +++ b/CodeDocumentation/data/models/EFPenalty.md @@ -0,0 +1,117 @@ +# EFPenalty `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Models + Data.Models.EFPenalty[[EFPenalty]] + Data.Models.SharedEntity[[SharedEntity]] + end +Data.Models.SharedEntity --> Data.Models.EFPenalty +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`AutomatedOffense`](#automatedoffense) | `get, set` | +| `Nullable`<`DateTime`> | [`Expires`](#expires) | `get, set` | +| `bool` | [`IsEvadedOffense`](#isevadedoffense) | `get, set` | +| [`EFAliasLink`](./EFAliasLink.md) | [`Link`](#link) | `get, set` | +| `Nullable`<`int`> | [`LinkId`](#linkid) | `get, set` | +| [`EFClient`](client/EFClient.md) | [`Offender`](#offender) | `get, set` | +| `int` | [`OffenderId`](#offenderid) | `get, set` | +| `string` | [`Offense`](#offense) | `get, set` | +| `int` | [`PenaltyId`](#penaltyid) | `get, set` | +| [`EFClient`](client/EFClient.md) | [`Punisher`](#punisher) | `get, set` | +| `int` | [`PunisherId`](#punisherid) | `get, set` | +| `PenaltyType` | [`Type`](#type) | `get, set` | +| `DateTime` | [`When`](#when) | `get, set` | + +## Details +### Inheritance + - [ +`SharedEntity` +](./SharedEntity.md) + +### Nested types +#### Enums + - `PenaltyType` + +### Constructors +#### EFPenalty +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Meta/MetaRegistration.cs#L34) +```csharp +public EFPenalty() +``` + +### Properties +#### PenaltyId +```csharp +public int PenaltyId { get; set; } +``` + +#### LinkId +```csharp +public Nullable LinkId { get; set; } +``` + +#### Link +```csharp +public virtual EFAliasLink Link { get; set; } +``` + +#### OffenderId +```csharp +public int OffenderId { get; set; } +``` + +#### Offender +```csharp +public virtual EFClient Offender { get; set; } +``` + +#### PunisherId +```csharp +public int PunisherId { get; set; } +``` + +#### Punisher +```csharp +public virtual EFClient Punisher { get; set; } +``` + +#### When +```csharp +public DateTime When { get; set; } +``` + +#### Expires +```csharp +public Nullable Expires { get; set; } +``` + +#### Offense +```csharp +public string Offense { get; set; } +``` + +#### AutomatedOffense +```csharp +public string AutomatedOffense { get; set; } +``` + +#### IsEvadedOffense +```csharp +public bool IsEvadedOffense { get; set; } +``` + +#### Type +```csharp +public PenaltyType Type { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/models/EFPenaltyIdentifier.md b/CodeDocumentation/data/models/EFPenaltyIdentifier.md new file mode 100644 index 0000000..3215979 --- /dev/null +++ b/CodeDocumentation/data/models/EFPenaltyIdentifier.md @@ -0,0 +1,66 @@ +# EFPenaltyIdentifier `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Models + Data.Models.EFPenaltyIdentifier[[EFPenaltyIdentifier]] + end + subgraph Stats.Models + Stats.Models.AuditFields[[AuditFields]] + end +Stats.Models.AuditFields --> Data.Models.EFPenaltyIdentifier +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `Nullable`<`int`> | [`IPv4Address`](#ipv4address) | `get, set` | +| `long` | [`NetworkId`](#networkid) | `get, set` | +| [`EFPenalty`](./EFPenalty.md) | [`Penalty`](#penalty) | `get, set` | +| `int` | [`PenaltyId`](#penaltyid) | `get, set` | +| `int` | [`PenaltyIdentifierId`](#penaltyidentifierid) | `get, set` | + +## Details +### Inheritance + - [ +`AuditFields` +](../../stats/models/AuditFields.md) + +### Constructors +#### EFPenaltyIdentifier +```csharp +public EFPenaltyIdentifier() +``` + +### Properties +#### PenaltyIdentifierId +```csharp +public int PenaltyIdentifierId { get; set; } +``` + +#### IPv4Address +```csharp +public Nullable IPv4Address { get; set; } +``` + +#### NetworkId +```csharp +public long NetworkId { get; set; } +``` + +#### PenaltyId +```csharp +public int PenaltyId { get; set; } +``` + +#### Penalty +```csharp +public EFPenalty Penalty { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/models/Reference.md b/CodeDocumentation/data/models/Reference.md new file mode 100644 index 0000000..bc0d476 --- /dev/null +++ b/CodeDocumentation/data/models/Reference.md @@ -0,0 +1,26 @@ +# Reference `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Models + Data.Models.Reference[[Reference]] + end +``` + +## Details +### Nested types +#### Enums + - `Game` + - `ConnectionType` + +### Constructors +#### Reference +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Meta/UpdatedAliasResourceQueryHelper.cs#L24) +```csharp +public Reference() +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/models/SharedEntity.md b/CodeDocumentation/data/models/SharedEntity.md new file mode 100644 index 0000000..cb84bea --- /dev/null +++ b/CodeDocumentation/data/models/SharedEntity.md @@ -0,0 +1,87 @@ +# SharedEntity `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Models + Data.Models.SharedEntity[[SharedEntity]] + end + subgraph Data.Abstractions + Data.Abstractions.IPropertyExtender[[IPropertyExtender]] + class Data.Abstractions.IPropertyExtender interfaceStyle; + end +Data.Abstractions.IPropertyExtender --> Data.Models.SharedEntity +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `bool` | [`Active`](#active)
indicates if the entity is active | `get, set` | + +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `void` | [`CopyAdditionalProperties`](#copyadditionalproperties)([`SharedEntity`](data/models/SharedEntity.md) source) | +| `T` | [`GetAdditionalProperty`](#getadditionalproperty)(`string` name) | +| `void` | [`SetAdditionalProperty`](#setadditionalproperty)(`string` name, `object` value) | + +## Details +### Inheritance + - [ +`IPropertyExtender` +](../abstractions/IPropertyExtender.md) + +### Constructors +#### SharedEntity +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/SharedEntity.cs#L13) +```csharp +public SharedEntity() +``` + +### Methods +#### GetAdditionalProperty +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/SharedEntity.cs#L21) +```csharp +public virtual T GetAdditionalProperty(string name) +where T : +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | name | | + +#### SetAdditionalProperty +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IO/BaseConfigurationHandlerV2.cs#L21) +```csharp +public virtual void SetAdditionalProperty(string name, object value) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | name | | +| `object` | value | | + +#### CopyAdditionalProperties +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IO/BaseConfigurationHandlerV2.cs#L45) +```csharp +public void CopyAdditionalProperties(SharedEntity source) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`SharedEntity`](data/models/SharedEntity.md) | source | | + +### Properties +#### Active +```csharp +public bool Active { get; set; } +``` +##### Summary +indicates if the entity is active + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/models/Vector3.md b/CodeDocumentation/data/models/Vector3.md new file mode 100644 index 0000000..4453da8 --- /dev/null +++ b/CodeDocumentation/data/models/Vector3.md @@ -0,0 +1,181 @@ +# Vector3 `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Models + Data.Models.Vector3[[Vector3]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `int` | [`Vector3Id`](#vector3id) | `get, set` | +| `float` | [`X`](#x) | `get, protected set` | +| `float` | [`Y`](#y) | `get, protected set` | +| `float` | [`Z`](#z) | `get, protected set` | + +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `double` | [`AngleBetween`](#anglebetween)([`Vector3`](data/models/Vector3.md) a) | +| `double` | [`DotProduct`](#dotproduct)([`Vector3`](data/models/Vector3.md) a) | +| `bool` | [`Equals`](#equals)(`object` obj) | +| `double` | [`Magnitude`](#magnitude)() | +| `string` | [`ToString`](#tostring)() | + +#### Public Static methods +| Returns | Name | +| --- | --- | +| `double` | [`AbsoluteDistance`](#absolutedistance)([`Vector3`](data/models/Vector3.md) a, [`Vector3`](data/models/Vector3.md) b) | +| `double` | [`Distance`](#distance)([`Vector3`](data/models/Vector3.md) a, [`Vector3`](data/models/Vector3.md) b) | +| [`Vector3`](data/models/Vector3.md) | [`Parse`](#parse)(`string` s) | +| [`Vector3`](data/models/Vector3.md) | [`Subtract`](#subtract)([`Vector3`](data/models/Vector3.md) a, [`Vector3`](data/models/Vector3.md) b) | +| `double` | [`ViewAngleDistance`](#viewangledistance)([`Vector3`](data/models/Vector3.md) a, [`Vector3`](data/models/Vector3.md) b, [`Vector3`](data/models/Vector3.md) c) | + +## Details +### Constructors +#### Vector3 [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IO/ConfigurationWatcher.cs#L11) +```csharp +public Vector3() +``` + +#### Vector3 [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IO/ConfigurationWatcher.cs#L27) +```csharp +public Vector3(float x, float y, float z) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `float` | x | | +| `float` | y | | +| `float` | z | | + +### Methods +#### ToString +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IO/ConfigurationWatcher.cs#L33) +```csharp +public override string ToString() +``` + +#### Equals +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IO/ConfigurationWatcher.cs#L43) +```csharp +public override bool Equals(object obj) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `object` | obj | | + +#### Parse +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IO/ConfigurationWatcher.cs#L51) +```csharp +public static Vector3 Parse(string s) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | s | | + +#### Distance +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IO/GameLogEventDetection.cs#L20) +```csharp +public static double Distance(Vector3 a, Vector3 b) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`Vector3`](data/models/Vector3.md) | a | | +| [`Vector3`](data/models/Vector3.md) | b | | + +#### AbsoluteDistance +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Vector3.cs#L71) +```csharp +public static double AbsoluteDistance(Vector3 a, Vector3 b) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`Vector3`](data/models/Vector3.md) | a | | +| [`Vector3`](data/models/Vector3.md) | b | | + +#### ViewAngleDistance +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Vector3.cs#L83) +```csharp +public static double ViewAngleDistance(Vector3 a, Vector3 b, Vector3 c) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`Vector3`](data/models/Vector3.md) | a | | +| [`Vector3`](data/models/Vector3.md) | b | | +| [`Vector3`](data/models/Vector3.md) | c | | + +#### Subtract +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IO/GameLogReader.cs#L20) +```csharp +public static Vector3 Subtract(Vector3 a, Vector3 b) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`Vector3`](data/models/Vector3.md) | a | | +| [`Vector3`](data/models/Vector3.md) | b | | + +#### DotProduct +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IO/GameLogReader.cs#L22) +```csharp +public double DotProduct(Vector3 a) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`Vector3`](data/models/Vector3.md) | a | | + +#### Magnitude +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IO/GameLogReader.cs#L24) +```csharp +public double Magnitude() +``` + +#### AngleBetween +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Vector3.cs#L113) +```csharp +public double AngleBetween(Vector3 a) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`Vector3`](data/models/Vector3.md) | a | | + +### Properties +#### Vector3Id +```csharp +public int Vector3Id { get; set; } +``` + +#### X +```csharp +public float X { get; protected set; } +``` + +#### Y +```csharp +public float Y { get; protected set; } +``` + +#### Z +```csharp +public float Z { get; protected set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/models/client/EFACSnapshotVector3.md b/CodeDocumentation/data/models/client/EFACSnapshotVector3.md new file mode 100644 index 0000000..07a160f --- /dev/null +++ b/CodeDocumentation/data/models/client/EFACSnapshotVector3.md @@ -0,0 +1,66 @@ +# EFACSnapshotVector3 `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Models.Client + Data.Models.Client.EFACSnapshotVector3[[EFACSnapshotVector3]] + end + subgraph Data.Models + Data.Models.SharedEntity[[SharedEntity]] + end +Data.Models.SharedEntity --> Data.Models.Client.EFACSnapshotVector3 +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `int` | [`ACSnapshotVector3Id`](#acsnapshotvector3id) | `get, set` | +| [`EFACSnapshot`](stats/EFACSnapshot.md) | [`Snapshot`](#snapshot) | `get, set` | +| `int` | [`SnapshotId`](#snapshotid) | `get, set` | +| [`Vector3`](../Vector3.md) | [`Vector`](#vector) | `get, set` | +| `int` | [`Vector3Id`](#vector3id) | `get, set` | + +## Details +### Inheritance + - [ +`SharedEntity` +](../SharedEntity.md) + +### Constructors +#### EFACSnapshotVector3 +```csharp +public EFACSnapshotVector3() +``` + +### Properties +#### ACSnapshotVector3Id +```csharp +public int ACSnapshotVector3Id { get; set; } +``` + +#### SnapshotId +```csharp +public int SnapshotId { get; set; } +``` + +#### Snapshot +```csharp +public EFACSnapshot Snapshot { get; set; } +``` + +#### Vector3Id +```csharp +public int Vector3Id { get; set; } +``` + +#### Vector +```csharp +public Vector3 Vector { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/models/client/EFClient.md b/CodeDocumentation/data/models/client/EFClient.md new file mode 100644 index 0000000..93ce46d --- /dev/null +++ b/CodeDocumentation/data/models/client/EFClient.md @@ -0,0 +1,179 @@ +# EFClient `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Models.Client + Data.Models.Client.EFClient[[EFClient]] + end + subgraph Data.Models + Data.Models.SharedEntity[[SharedEntity]] + end +Data.Models.SharedEntity --> Data.Models.Client.EFClient +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `ICollection`<[`EFPenalty`](../EFPenalty.md)> | [`AdministeredPenalties`](#administeredpenalties) | `get, set` | +| [`EFAliasLink`](../EFAliasLink.md) | [`AliasLink`](#aliaslink) | `get, set` | +| `int` | [`AliasLinkId`](#aliaslinkid) | `get, set` | +| `int` | [`ClientId`](#clientid) | `get, set` | +| `int` | [`Connections`](#connections) | `get, set` | +| [`EFAlias`](../EFAlias.md) | [`CurrentAlias`](#currentalias) | `get, set` | +| `int` | [`CurrentAliasId`](#currentaliasid) | `get, set` | +| `DateTime` | [`FirstConnection`](#firstconnection) | `get, set` | +| `Game` | [`GameName`](#gamename) | `get, set` | +| `DateTime` | [`LastConnection`](#lastconnection) | `get, set` | +| `Permission` | [`Level`](#level) | `get, set` | +| `bool` | [`Masked`](#masked) | `get, set` | +| `ICollection`<[`EFMeta`](../EFMeta.md)> | [`Meta`](#meta) | `get, set` | +| `long` | [`NetworkId`](#networkid) | `get, set` | +| `string` | [`Password`](#password) | `get, set` | +| `string` | [`PasswordSalt`](#passwordsalt) | `get, set` | +| `ICollection`<[`EFPenalty`](../EFPenalty.md)> | [`ReceivedPenalties`](#receivedpenalties) | `get, set` | +| `int` | [`TotalConnectionTime`](#totalconnectiontime) | `get, set` | +| `ICollection`<[`ZombieAggregateClientStat`](../zombie/ZombieAggregateClientStat.md)> | [`ZombieAggregateClientStats`](#zombieaggregateclientstats) | `get, set` | +| `ICollection`<[`ZombieClientStat`](../zombie/ZombieClientStat.md)> | [`ZombieClientStats`](#zombieclientstats) | `get, set` | +| `ICollection`<[`ZombieMatchClientStat`](../zombie/ZombieMatchClientStat.md)> | [`ZombieMatchClientStats`](#zombiematchclientstats) | `get, set` | +| `ICollection`<[`ZombieMatch`](../zombie/ZombieMatch.md)> | [`ZombieMatches`](#zombiematches) | `get, set` | +| `ICollection`<[`ZombieRoundClientStat`](../zombie/ZombieRoundClientStat.md)> | [`ZombieRoundClientStats`](#zombieroundclientstats) | `get, set` | + +## Details +### Inheritance + - [ +`SharedEntity` +](../SharedEntity.md) + +### Nested types +#### Enums + - `Permission` + +### Constructors +#### EFClient +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Alerts/AlertManager.cs#L27) +```csharp +public EFClient() +``` + +### Properties +#### ClientId +```csharp +public int ClientId { get; set; } +``` + +#### NetworkId +```csharp +public long NetworkId { get; set; } +``` + +#### Connections +```csharp +public int Connections { get; set; } +``` + +#### TotalConnectionTime +```csharp +public int TotalConnectionTime { get; set; } +``` + +#### FirstConnection +```csharp +public DateTime FirstConnection { get; set; } +``` + +#### LastConnection +```csharp +public DateTime LastConnection { get; set; } +``` + +#### GameName +```csharp +public Game GameName { get; set; } +``` + +#### Masked +```csharp +public bool Masked { get; set; } +``` + +#### AliasLinkId +```csharp +public int AliasLinkId { get; set; } +``` + +#### AliasLink +```csharp +public virtual EFAliasLink AliasLink { get; set; } +``` + +#### Level +```csharp +public Permission Level { get; set; } +``` + +#### CurrentAliasId +```csharp +public int CurrentAliasId { get; set; } +``` + +#### CurrentAlias +```csharp +public virtual EFAlias CurrentAlias { get; set; } +``` + +#### Password +```csharp +public string Password { get; set; } +``` + +#### PasswordSalt +```csharp +public string PasswordSalt { get; set; } +``` + +#### Meta +```csharp +public virtual ICollection Meta { get; set; } +``` + +#### ReceivedPenalties +```csharp +public virtual ICollection ReceivedPenalties { get; set; } +``` + +#### AdministeredPenalties +```csharp +public virtual ICollection AdministeredPenalties { get; set; } +``` + +#### ZombieAggregateClientStats +```csharp +public virtual ICollection ZombieAggregateClientStats { get; set; } +``` + +#### ZombieClientStats +```csharp +public virtual ICollection ZombieClientStats { get; set; } +``` + +#### ZombieMatches +```csharp +public virtual ICollection ZombieMatches { get; set; } +``` + +#### ZombieMatchClientStats +```csharp +public virtual ICollection ZombieMatchClientStats { get; set; } +``` + +#### ZombieRoundClientStats +```csharp +public virtual ICollection ZombieRoundClientStats { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/models/client/EFClientConnectionHistory.md b/CodeDocumentation/data/models/client/EFClientConnectionHistory.md new file mode 100644 index 0000000..8748bbd --- /dev/null +++ b/CodeDocumentation/data/models/client/EFClientConnectionHistory.md @@ -0,0 +1,73 @@ +# EFClientConnectionHistory `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Models.Client + Data.Models.Client.EFClientConnectionHistory[[EFClientConnectionHistory]] + end + subgraph Stats.Models + Stats.Models.AuditFields[[AuditFields]] + end +Stats.Models.AuditFields --> Data.Models.Client.EFClientConnectionHistory +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| [`EFClient`](./EFClient.md) | [`Client`](#client) | `get, set` | +| `long` | [`ClientConnectionId`](#clientconnectionid) | `get, set` | +| `int` | [`ClientId`](#clientid) | `get, set` | +| `ConnectionType` | [`ConnectionType`](#connectiontype) | `get, set` | +| [`EFServer`](../server/EFServer.md) | [`Server`](#server) | `get, set` | +| `long` | [`ServerId`](#serverid) | `get, set` | + +## Details +### Inheritance + - [ +`AuditFields` +](../../../stats/models/AuditFields.md) + +### Constructors +#### EFClientConnectionHistory +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IW4MServer.cs#L16707566) +```csharp +public EFClientConnectionHistory() +``` + +### Properties +#### ClientConnectionId +```csharp +public long ClientConnectionId { get; set; } +``` + +#### ClientId +```csharp +public int ClientId { get; set; } +``` + +#### Client +```csharp +public EFClient Client { get; set; } +``` + +#### ServerId +```csharp +public long ServerId { get; set; } +``` + +#### Server +```csharp +public EFServer Server { get; set; } +``` + +#### ConnectionType +```csharp +public ConnectionType ConnectionType { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/models/client/EFClientKill.md b/CodeDocumentation/data/models/client/EFClientKill.md new file mode 100644 index 0000000..ad28bf4 --- /dev/null +++ b/CodeDocumentation/data/models/client/EFClientKill.md @@ -0,0 +1,209 @@ +# EFClientKill `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Models.Client + Data.Models.Client.EFClientKill[[EFClientKill]] + end + subgraph Data.Models + Data.Models.SharedEntity[[SharedEntity]] + end +Data.Models.SharedEntity --> Data.Models.Client.EFClientKill +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `float` | [`AdsPercent`](#adspercent) | `get, set` | +| `List`<[`Vector3`](../Vector3.md)> | [`AnglesList`](#angleslist) | `get, set` | +| [`EFClient`](./EFClient.md) | [`Attacker`](#attacker) | `get, set` | +| `int` | [`AttackerId`](#attackerid) | `get, set` | +| `int` | [`Damage`](#damage) | `get, set` | +| [`Vector3`](../Vector3.md) | [`DeathOrigin`](#deathorigin) | `get, set` | +| `int` | [`DeathType`](#deathtype) | `get, set` | +| `double` | [`Distance`](#distance) | `get` | +| `double` | [`Fraction`](#fraction) | `get, set` | +| `int` | [`GameName`](#gamename) | `get, set` | +| `int` | [`HitLoc`](#hitloc) | `get, set` | +| `bool` | [`IsAlive`](#isalive)
Indicates if the attacker was alive after last captured angle | `get, set` | +| `bool` | [`IsKill`](#iskill) | `get, set` | +| `bool` | [`IsKillstreakKill`](#iskillstreakkill) | `get, set` | +| `long` | [`KillId`](#killid) | `get, set` | +| [`Vector3`](../Vector3.md) | [`KillOrigin`](#killorigin) | `get, set` | +| `int` | [`Map`](#map) | `get, set` | +| [`EFServer`](../server/EFServer.md) | [`Server`](#server) | `get, set` | +| `long` | [`ServerId`](#serverid) | `get, set` | +| `long` | [`TimeOffset`](#timeoffset) | `get, set` | +| `long` | [`TimeSinceLastAttack`](#timesincelastattack)
Specifies the last time the attack button was detected as pressed | `get, set` | +| [`EFClient`](./EFClient.md) | [`Victim`](#victim) | `get, set` | +| `int` | [`VictimId`](#victimid) | `get, set` | +| [`Vector3`](../Vector3.md) | [`ViewAngles`](#viewangles) | `get, set` | +| `double` | [`VisibilityPercentage`](#visibilitypercentage) | `get, set` | +| `int` | [`Weapon`](#weapon) | `get, set` | +| `string` | [`WeaponReference`](#weaponreference) | `get, set` | +| `DateTime` | [`When`](#when) | `get, set` | + +## Details +### Inheritance + - [ +`SharedEntity` +](../SharedEntity.md) + +### Constructors +#### EFClientKill +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Helpers/BuildNumberJsonConverter.cs#L23) +```csharp +public EFClientKill() +``` + +### Properties +#### KillId +```csharp +public long KillId { get; set; } +``` + +#### VictimId +```csharp +public int VictimId { get; set; } +``` + +#### Victim +```csharp +public virtual EFClient Victim { get; set; } +``` + +#### AttackerId +```csharp +public int AttackerId { get; set; } +``` + +#### Attacker +```csharp +public virtual EFClient Attacker { get; set; } +``` + +#### ServerId +```csharp +public long ServerId { get; set; } +``` + +#### Server +```csharp +public virtual EFServer Server { get; set; } +``` + +#### HitLoc +```csharp +public int HitLoc { get; set; } +``` + +#### DeathType +```csharp +public int DeathType { get; set; } +``` + +#### Damage +```csharp +public int Damage { get; set; } +``` + +#### Weapon +```csharp +public int Weapon { get; set; } +``` + +#### WeaponReference +```csharp +public string WeaponReference { get; set; } +``` + +#### KillOrigin +```csharp +public Vector3 KillOrigin { get; set; } +``` + +#### DeathOrigin +```csharp +public Vector3 DeathOrigin { get; set; } +``` + +#### ViewAngles +```csharp +public Vector3 ViewAngles { get; set; } +``` + +#### When +```csharp +public DateTime When { get; set; } +``` + +#### Fraction +```csharp +public double Fraction { get; set; } +``` + +#### IsKill +```csharp +public bool IsKill { get; set; } +``` + +#### VisibilityPercentage +```csharp +public double VisibilityPercentage { get; set; } +``` + +#### Distance +```csharp +public double Distance { get; } +``` + +#### Map +```csharp +public int Map { get; set; } +``` + +#### TimeOffset +```csharp +public long TimeOffset { get; set; } +``` + +#### IsKillstreakKill +```csharp +public bool IsKillstreakKill { get; set; } +``` + +#### AdsPercent +```csharp +public float AdsPercent { get; set; } +``` + +#### AnglesList +```csharp +public List AnglesList { get; set; } +``` + +#### GameName +```csharp +public int GameName { get; set; } +``` + +#### IsAlive +```csharp +public bool IsAlive { get; set; } +``` +##### Summary +Indicates if the attacker was alive after last captured angle + +#### TimeSinceLastAttack +```csharp +public long TimeSinceLastAttack { get; set; } +``` +##### Summary +Specifies the last time the attack button was detected as pressed + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/models/client/EFClientMessage.md b/CodeDocumentation/data/models/client/EFClientMessage.md new file mode 100644 index 0000000..68f0ca7 --- /dev/null +++ b/CodeDocumentation/data/models/client/EFClientMessage.md @@ -0,0 +1,85 @@ +# EFClientMessage `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Models.Client + Data.Models.Client.EFClientMessage[[EFClientMessage]] + end + subgraph Data.Models + Data.Models.SharedEntity[[SharedEntity]] + end +Data.Models.SharedEntity --> Data.Models.Client.EFClientMessage +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| [`EFClient`](./EFClient.md) | [`Client`](#client) | `get, set` | +| `int` | [`ClientId`](#clientid) | `get, set` | +| `string` | [`Message`](#message) | `get, set` | +| `long` | [`MessageId`](#messageid) | `get, set` | +| `bool` | [`SentIngame`](#sentingame) | `get, set` | +| [`EFServer`](../server/EFServer.md) | [`Server`](#server) | `get, set` | +| `long` | [`ServerId`](#serverid) | `get, set` | +| `DateTime` | [`TimeSent`](#timesent) | `get, set` | + +## Details +### Inheritance + - [ +`SharedEntity` +](../SharedEntity.md) + +### Constructors +#### EFClientMessage +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Helpers/InteractionData.cs#L16) +```csharp +public EFClientMessage() +``` + +### Properties +#### MessageId +```csharp +public long MessageId { get; set; } +``` + +#### ServerId +```csharp +public long ServerId { get; set; } +``` + +#### Server +```csharp +public virtual EFServer Server { get; set; } +``` + +#### ClientId +```csharp +public int ClientId { get; set; } +``` + +#### Client +```csharp +public virtual EFClient Client { get; set; } +``` + +#### Message +```csharp +public string Message { get; set; } +``` + +#### TimeSent +```csharp +public DateTime TimeSent { get; set; } +``` + +#### SentIngame +```csharp +public bool SentIngame { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/models/client/efclient/Permission.md b/CodeDocumentation/data/models/client/efclient/Permission.md new file mode 100644 index 0000000..ed3f981 --- /dev/null +++ b/CodeDocumentation/data/models/client/efclient/Permission.md @@ -0,0 +1,55 @@ +# Permission `Public enum` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Models.Client.EFClient + Data.Models.Client.EFClient.Permission[[Permission]] + end +``` + +## Details +### Fields +#### Banned +##### Summary +client has been banned + +#### User +##### Summary +default client state upon first connect + +#### Flagged +##### Summary +client has been flagged + +#### Trusted +##### Summary +client is trusted + +#### Moderator +##### Summary +client is a moderator + +#### Administrator +##### Summary +client is an administrator + +#### SeniorAdmin +##### Summary +client is a senior administrator + +#### Owner +##### Summary +client is a owner + +#### Creator +##### Summary +not used + +#### Console +##### Summary +reserved for default account + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/models/client/stats/EFACSnapshot.md b/CodeDocumentation/data/models/client/stats/EFACSnapshot.md new file mode 100644 index 0000000..0ea7a8e --- /dev/null +++ b/CodeDocumentation/data/models/client/stats/EFACSnapshot.md @@ -0,0 +1,265 @@ +# EFACSnapshot `Public class` + +## Description +This class houses the information for anticheat snapshots (used for validating a ban) + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Models.Client.Stats + Data.Models.Client.Stats.EFACSnapshot[[EFACSnapshot]] + end + subgraph Data.Models + Data.Models.SharedEntity[[SharedEntity]] + end +Data.Models.SharedEntity --> Data.Models.Client.Stats.EFACSnapshot +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`CapturedViewAngles`](#capturedviewangles) | `get` | +| [`EFClient`](../EFClient.md) | [`Client`](#client) | `get, set` | +| `int` | [`ClientId`](#clientid) | `get, set` | +| `int` | [`CurrentSessionLength`](#currentsessionlength) | `get, set` | +| `double` | [`CurrentStrain`](#currentstrain) | `get, set` | +| [`Vector3`](../../Vector3.md) | [`CurrentViewAngle`](#currentviewangle) | `get, set` | +| `int` | [`CurrentViewAngleId`](#currentviewangleid) | `get, set` | +| `int` | [`Deaths`](#deaths) | `get, set` | +| `double` | [`Distance`](#distance) | `get, set` | +| `double` | [`EloRating`](#elorating) | `get, set` | +| [`Vector3`](../../Vector3.md) | [`HitDestination`](#hitdestination) | `get, set` | +| `int` | [`HitDestinationId`](#hitdestinationid) | `get, set` | +| `int` | [`HitLocation`](#hitlocation) | `get, set` | +| `string` | [`HitLocationReference`](#hitlocationreference) | `get, set` | +| [`Vector3`](../../Vector3.md) | [`HitOrigin`](#hitorigin) | `get, set` | +| `int` | [`HitOriginId`](#hitoriginid) | `get, set` | +| `int` | [`HitType`](#hittype) | `get, set` | +| `int` | [`Hits`](#hits) | `get, set` | +| `int` | [`Kills`](#kills) | `get, set` | +| [`Vector3`](../../Vector3.md) | [`LastStrainAngle`](#laststrainangle) | `get, set` | +| `int` | [`LastStrainAngleId`](#laststrainangleid) | `get, set` | +| `ICollection`<[`EFACSnapshotVector3`](../EFACSnapshotVector3.md)> | [`PredictedViewAngles`](#predictedviewangles) | `get, set` | +| `double` | [`RecoilOffset`](#recoiloffset) | `get, set` | +| [`EFServer`](../../server/EFServer.md) | [`Server`](#server) | `get, set` | +| `Nullable`<`long`> | [`ServerId`](#serverid) | `get, set` | +| `string` | [`ServerName`](#servername) | `get` | +| `double` | [`SessionAngleOffset`](#sessionangleoffset) | `get, set` | +| `double` | [`SessionAverageSnapValue`](#sessionaveragesnapvalue) | `get, set` | +| `double` | [`SessionSPM`](#sessionspm) | `get, set` | +| `int` | [`SessionScore`](#sessionscore) | `get, set` | +| `int` | [`SessionSnapHits`](#sessionsnaphits) | `get, set` | +| `int` | [`SnapshotId`](#snapshotid) | `get, set` | +| `double` | [`StrainAngleBetween`](#strainanglebetween) | `get, set` | +| `int` | [`TimeSinceLastEvent`](#timesincelastevent) | `get, set` | +| `int` | [`WeaponId`](#weaponid) | `get, set` | +| `string` | [`WeaponReference`](#weaponreference) | `get, set` | +| `DateTime` | [`When`](#when) | `get, set` | + +## Details +### Summary +This class houses the information for anticheat snapshots (used for validating a ban) + +### Inheritance + - [ +`SharedEntity` +](../../SharedEntity.md) + +### Constructors +#### EFACSnapshot +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Exceptions/RConException.cs#L9) +```csharp +public EFACSnapshot() +``` + +### Properties +#### SnapshotId +```csharp +public int SnapshotId { get; set; } +``` + +#### ClientId +```csharp +public int ClientId { get; set; } +``` + +#### Client +```csharp +public EFClient Client { get; set; } +``` + +#### ServerId +```csharp +public Nullable ServerId { get; set; } +``` + +#### Server +```csharp +public EFServer Server { get; set; } +``` + +#### When +```csharp +public DateTime When { get; set; } +``` + +#### CurrentSessionLength +```csharp +public int CurrentSessionLength { get; set; } +``` + +#### TimeSinceLastEvent +```csharp +public int TimeSinceLastEvent { get; set; } +``` + +#### EloRating +```csharp +public double EloRating { get; set; } +``` + +#### SessionScore +```csharp +public int SessionScore { get; set; } +``` + +#### SessionSPM +```csharp +public double SessionSPM { get; set; } +``` + +#### Hits +```csharp +public int Hits { get; set; } +``` + +#### Kills +```csharp +public int Kills { get; set; } +``` + +#### Deaths +```csharp +public int Deaths { get; set; } +``` + +#### CurrentStrain +```csharp +public double CurrentStrain { get; set; } +``` + +#### StrainAngleBetween +```csharp +public double StrainAngleBetween { get; set; } +``` + +#### SessionAngleOffset +```csharp +public double SessionAngleOffset { get; set; } +``` + +#### RecoilOffset +```csharp +public double RecoilOffset { get; set; } +``` + +#### LastStrainAngleId +```csharp +public int LastStrainAngleId { get; set; } +``` + +#### LastStrainAngle +```csharp +public Vector3 LastStrainAngle { get; set; } +``` + +#### HitOriginId +```csharp +public int HitOriginId { get; set; } +``` + +#### HitOrigin +```csharp +public Vector3 HitOrigin { get; set; } +``` + +#### HitDestinationId +```csharp +public int HitDestinationId { get; set; } +``` + +#### HitDestination +```csharp +public Vector3 HitDestination { get; set; } +``` + +#### Distance +```csharp +public double Distance { get; set; } +``` + +#### SessionAverageSnapValue +```csharp +public double SessionAverageSnapValue { get; set; } +``` + +#### SessionSnapHits +```csharp +public int SessionSnapHits { get; set; } +``` + +#### CurrentViewAngleId +```csharp +public int CurrentViewAngleId { get; set; } +``` + +#### CurrentViewAngle +```csharp +public Vector3 CurrentViewAngle { get; set; } +``` + +#### WeaponId +```csharp +public int WeaponId { get; set; } +``` + +#### WeaponReference +```csharp +public string WeaponReference { get; set; } +``` + +#### HitLocation +```csharp +public int HitLocation { get; set; } +``` + +#### HitLocationReference +```csharp +public string HitLocationReference { get; set; } +``` + +#### HitType +```csharp +public int HitType { get; set; } +``` + +#### PredictedViewAngles +```csharp +public virtual ICollection PredictedViewAngles { get; set; } +``` + +#### CapturedViewAngles +```csharp +public string CapturedViewAngles { get; } +``` + +#### ServerName +```csharp +public string ServerName { get; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/models/client/stats/EFClientHitStatistic.md b/CodeDocumentation/data/models/client/stats/EFClientHitStatistic.md new file mode 100644 index 0000000..269d206 --- /dev/null +++ b/CodeDocumentation/data/models/client/stats/EFClientHitStatistic.md @@ -0,0 +1,187 @@ +# EFClientHitStatistic `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Models.Client.Stats + Data.Models.Client.Stats.EFClientHitStatistic[[EFClientHitStatistic]] + end + subgraph Stats.Models + Stats.Models.AuditFields[[AuditFields]] + end +Stats.Models.AuditFields --> Data.Models.Client.Stats.EFClientHitStatistic +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| [`EFClient`](../EFClient.md) | [`Client`](#client) | `get, set` | +| `int` | [`ClientHitStatisticId`](#clienthitstatisticid) | `get, set` | +| `int` | [`ClientId`](#clientid) | `get, set` | +| `int` | [`DamageInflicted`](#damageinflicted)
how much damage the player inflicted | `get, set` | +| `int` | [`DamageReceived`](#damagereceived)
how much damage the player received | `get, set` | +| `int` | [`DeathCount`](#deathcount)
how many kills the player received | `get, set` | +| `int` | [`HitCount`](#hitcount)
how many hits the player got | `get, set` | +| [`EFHitLocation`](reference/EFHitLocation.md) | [`HitLocation`](#hitlocation) | `get, set` | +| `Nullable`<`int`> | [`HitLocationId`](#hitlocationid) | `get, set` | +| `int` | [`KillCount`](#killcount)
how many kills the player got | `get, set` | +| [`EFMeansOfDeath`](reference/EFMeansOfDeath.md) | [`MeansOfDeath`](#meansofdeath) | `get, set` | +| `Nullable`<`int`> | [`MeansOfDeathId`](#meansofdeathid) | `get, set` | +| `int` | [`ReceivedHitCount`](#receivedhitcount)
how many hits the player received | `get, set` | +| `Nullable`<`int`> | [`Score`](#score)
total in-game score | `get, set` | +| [`EFServer`](../../server/EFServer.md) | [`Server`](#server) | `get, set` | +| `Nullable`<`long`> | [`ServerId`](#serverid) | `get, set` | +| `int` | [`SuicideCount`](#suicidecount)
how many times the player killed themself | `get, set` | +| `Nullable`<`int`> | [`UsageSeconds`](#usageseconds)
estimation of time spent with the configuration | `get, set` | +| [`EFWeapon`](reference/EFWeapon.md) | [`Weapon`](#weapon) | `get, set` | +| [`EFWeaponAttachmentCombo`](reference/EFWeaponAttachmentCombo.md) | [`WeaponAttachmentCombo`](#weaponattachmentcombo) | `get, set` | +| `Nullable`<`int`> | [`WeaponAttachmentComboId`](#weaponattachmentcomboid) | `get, set` | +| `Nullable`<`int`> | [`WeaponId`](#weaponid) | `get, set` | + +## Details +### Inheritance + - [ +`AuditFields` +](../../../../stats/models/AuditFields.md) + +### Constructors +#### EFClientHitStatistic +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Events/Server/ServerValueRequestEvent.cs#L13) +```csharp +public EFClientHitStatistic() +``` + +### Properties +#### ClientHitStatisticId +```csharp +public int ClientHitStatisticId { get; set; } +``` + +#### ClientId +```csharp +public int ClientId { get; set; } +``` + +#### Client +```csharp +public virtual EFClient Client { get; set; } +``` + +#### ServerId +```csharp +public Nullable ServerId { get; set; } +``` + +#### Server +```csharp +public virtual EFServer Server { get; set; } +``` + +#### HitLocationId +```csharp +public Nullable HitLocationId { get; set; } +``` + +#### HitLocation +```csharp +public virtual EFHitLocation HitLocation { get; set; } +``` + +#### MeansOfDeathId +```csharp +public Nullable MeansOfDeathId { get; set; } +``` + +#### MeansOfDeath +```csharp +public virtual EFMeansOfDeath MeansOfDeath { get; set; } +``` + +#### WeaponId +```csharp +public Nullable WeaponId { get; set; } +``` + +#### Weapon +```csharp +public virtual EFWeapon Weapon { get; set; } +``` + +#### WeaponAttachmentComboId +```csharp +public Nullable WeaponAttachmentComboId { get; set; } +``` + +#### WeaponAttachmentCombo +```csharp +public virtual EFWeaponAttachmentCombo WeaponAttachmentCombo { get; set; } +``` + +#### HitCount +```csharp +public int HitCount { get; set; } +``` +##### Summary +how many hits the player got + +#### KillCount +```csharp +public int KillCount { get; set; } +``` +##### Summary +how many kills the player got + +#### DamageInflicted +```csharp +public int DamageInflicted { get; set; } +``` +##### Summary +how much damage the player inflicted + +#### ReceivedHitCount +```csharp +public int ReceivedHitCount { get; set; } +``` +##### Summary +how many hits the player received + +#### DeathCount +```csharp +public int DeathCount { get; set; } +``` +##### Summary +how many kills the player received + +#### DamageReceived +```csharp +public int DamageReceived { get; set; } +``` +##### Summary +how much damage the player received + +#### SuicideCount +```csharp +public int SuicideCount { get; set; } +``` +##### Summary +how many times the player killed themself + +#### UsageSeconds +```csharp +public Nullable UsageSeconds { get; set; } +``` +##### Summary +estimation of time spent with the configuration + +#### Score +```csharp +public Nullable Score { get; set; } +``` +##### Summary +total in-game score + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/models/client/stats/EFClientRankingHistory.md b/CodeDocumentation/data/models/client/stats/EFClientRankingHistory.md new file mode 100644 index 0000000..ef5fe40 --- /dev/null +++ b/CodeDocumentation/data/models/client/stats/EFClientRankingHistory.md @@ -0,0 +1,97 @@ +# EFClientRankingHistory `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Models.Client.Stats + Data.Models.Client.Stats.EFClientRankingHistory[[EFClientRankingHistory]] + end + subgraph Stats.Models + Stats.Models.AuditFields[[AuditFields]] + end +Stats.Models.AuditFields --> Data.Models.Client.Stats.EFClientRankingHistory +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| [`EFClient`](../EFClient.md) | [`Client`](#client) | `get, set` | +| `int` | [`ClientId`](#clientid) | `get, set` | +| `long` | [`ClientRankingHistoryId`](#clientrankinghistoryid) | `get, set` | +| `bool` | [`Newest`](#newest) | `get, set` | +| `string` | [`PerformanceBucket`](#performancebucket) | `get, set` | +| `Nullable`<`double`> | [`PerformanceMetric`](#performancemetric) | `get, set` | +| `Nullable`<`int`> | [`Ranking`](#ranking) | `get, set` | +| [`EFServer`](../../server/EFServer.md) | [`Server`](#server) | `get, set` | +| `Nullable`<`long`> | [`ServerId`](#serverid) | `get, set` | +| `Nullable`<`double`> | [`ZScore`](#zscore) | `get, set` | + +## Details +### Inheritance + - [ +`AuditFields` +](../../../../stats/models/AuditFields.md) + +### Constructors +#### EFClientRankingHistory +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Events/Server/ServerValueSetRequestEvent.cs#L16) +```csharp +public EFClientRankingHistory() +``` + +### Properties +#### ClientRankingHistoryId +```csharp +public long ClientRankingHistoryId { get; set; } +``` + +#### ClientId +```csharp +public int ClientId { get; set; } +``` + +#### Client +```csharp +public virtual EFClient Client { get; set; } +``` + +#### ServerId +```csharp +public Nullable ServerId { get; set; } +``` + +#### Server +```csharp +public virtual EFServer Server { get; set; } +``` + +#### Newest +```csharp +public bool Newest { get; set; } +``` + +#### Ranking +```csharp +public Nullable Ranking { get; set; } +``` + +#### ZScore +```csharp +public Nullable ZScore { get; set; } +``` + +#### PerformanceMetric +```csharp +public Nullable PerformanceMetric { get; set; } +``` + +#### PerformanceBucket +```csharp +public string PerformanceBucket { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/models/client/stats/EFClientRatingHistory.md b/CodeDocumentation/data/models/client/stats/EFClientRatingHistory.md new file mode 100644 index 0000000..b2c4352 --- /dev/null +++ b/CodeDocumentation/data/models/client/stats/EFClientRatingHistory.md @@ -0,0 +1,61 @@ +# EFClientRatingHistory `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Models.Client.Stats + Data.Models.Client.Stats.EFClientRatingHistory[[EFClientRatingHistory]] + end + subgraph Data.Models + Data.Models.SharedEntity[[SharedEntity]] + end +Data.Models.SharedEntity --> Data.Models.Client.Stats.EFClientRatingHistory +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| [`EFClient`](../EFClient.md) | [`Client`](#client) | `get, set` | +| `int` | [`ClientId`](#clientid) | `get, set` | +| `int` | [`RatingHistoryId`](#ratinghistoryid) | `get, set` | +| `ICollection`<[`EFRating`](./EFRating.md)> | [`Ratings`](#ratings) | `get, set` | + +## Details +### Inheritance + - [ +`SharedEntity` +](../../SharedEntity.md) + +### Constructors +#### EFClientRatingHistory +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Events/Management/ClientPenaltyEvent.cs#L8) +```csharp +public EFClientRatingHistory() +``` + +### Properties +#### RatingHistoryId +```csharp +public int RatingHistoryId { get; set; } +``` + +#### ClientId +```csharp +public int ClientId { get; set; } +``` + +#### Client +```csharp +public virtual EFClient Client { get; set; } +``` + +#### Ratings +```csharp +public virtual ICollection Ratings { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/models/client/stats/EFClientStatistics.md b/CodeDocumentation/data/models/client/stats/EFClientStatistics.md new file mode 100644 index 0000000..75f9b97 --- /dev/null +++ b/CodeDocumentation/data/models/client/stats/EFClientStatistics.md @@ -0,0 +1,271 @@ +# EFClientStatistics `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Models.Client.Stats + Data.Models.Client.Stats.EFClientStatistics[[EFClientStatistics]] + end + subgraph Data.Models + Data.Models.SharedEntity[[SharedEntity]] + end +Data.Models.SharedEntity --> Data.Models.Client.Stats.EFClientStatistics +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `float` | [`AverageHitOffset`](#averagehitoffset) | `get` | +| `double` | [`AverageSnapValue`](#averagesnapvalue) | `get, set` | +| [`EFClient`](../EFClient.md) | [`Client`](#client) | `get, set` | +| `int` | [`ClientId`](#clientid) | `get, set` | +| `int` | [`DeathStreak`](#deathstreak) | `get, set` | +| `int` | [`Deaths`](#deaths) | `get, set` | +| `double` | [`EloRating`](#elorating) | `get, set` | +| `ICollection`<[`EFHitLocationCount`](./EFHitLocationCount.md)> | [`HitLocations`](#hitlocations) | `get, set` | +| `double` | [`KDR`](#kdr) | `get` | +| `int` | [`KillStreak`](#killstreak) | `get, set` | +| `int` | [`Kills`](#kills) | `get, set` | +| `DateTime` | [`LastActive`](#lastactive) | `get, set` | +| `int` | [`LastScore`](#lastscore) | `get, set` | +| `DateTime` | [`LastStatCalculation`](#laststatcalculation) | `get, set` | +| `DateTime` | [`LastStatHistoryUpdate`](#laststathistoryupdate) | `get, set` | +| [`MatchData`](./MatchData.md) | [`MatchData`](#matchdata) | `get` | +| `double` | [`MaxSessionStrain`](#maxsessionstrain) | `get, set` | +| `double` | [`MaxStrain`](#maxstrain) | `get, set` | +| `double` | [`Performance`](#performance) | `get` | +| `SemaphoreSlim` | [`ProcessingHit`](#processinghit) | `get` | +| `double` | [`RollingWeightedKDR`](#rollingweightedkdr) | `get, set` | +| `int` | [`RoundScore`](#roundscore) | `get` | +| `double` | [`SPM`](#spm) | `get, set` | +| [`EFServer`](../../server/EFServer.md) | [`Server`](#server) | `get, set` | +| `long` | [`ServerId`](#serverid) | `get, set` | +| `int` | [`SessionDeaths`](#sessiondeaths) | `get, set` | +| `int` | [`SessionKills`](#sessionkills) | `get, set` | +| `double` | [`SessionSPM`](#sessionspm) | `get, set` | +| `int` | [`SessionScore`](#sessionscore) | `get, set` | +| `double` | [`Skill`](#skill) | `get, set` | +| `int` | [`SnapHitCount`](#snaphitcount) | `get, set` | +| `int` | [`Team`](#team) | `get, set` | +| `int` | [`TimePlayed`](#timeplayed) | `get, set` | +| `Nullable`<`DateTime`> | [`UpdatedAt`](#updatedat) | `get, set` | +| `double` | [`ZScore`](#zscore) | `get, set` | + +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`Finalize`](#finalize)() | + +#### Public methods +| Returns | Name | +| --- | --- | +| `void` | [`StartNewSession`](#startnewsession)() | + +## Details +### Inheritance + - [ +`SharedEntity` +](../../SharedEntity.md) + +### Constructors +#### EFClientStatistics +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Events/Management/ClientPenaltyEvent.cs#L9) +```csharp +public EFClientStatistics() +``` + +### Methods +#### Finalize +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Events/Management/ClientPenaltyEvent.cs#L9) +```csharp +protected override void Finalize() +``` + +#### StartNewSession +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Events/Game/ClientGameEvent.cs#L7) +```csharp +public void StartNewSession() +``` + +### Properties +#### ClientId +```csharp +public int ClientId { get; set; } +``` + +#### Client +```csharp +public virtual EFClient Client { get; set; } +``` + +#### ServerId +```csharp +public long ServerId { get; set; } +``` + +#### Server +```csharp +public virtual EFServer Server { get; set; } +``` + +#### Kills +```csharp +public int Kills { get; set; } +``` + +#### Deaths +```csharp +public int Deaths { get; set; } +``` + +#### EloRating +```csharp +public double EloRating { get; set; } +``` + +#### ZScore +```csharp +public double ZScore { get; set; } +``` + +#### UpdatedAt +```csharp +public Nullable UpdatedAt { get; set; } +``` + +#### HitLocations +```csharp +public virtual ICollection HitLocations { get; set; } +``` + +#### RollingWeightedKDR +```csharp +public double RollingWeightedKDR { get; set; } +``` + +#### AverageSnapValue +```csharp +public double AverageSnapValue { get; set; } +``` + +#### SnapHitCount +```csharp +public int SnapHitCount { get; set; } +``` + +#### Performance +```csharp +public double Performance { get; } +``` + +#### KDR +```csharp +public double KDR { get; } +``` + +#### SPM +```csharp +public double SPM { get; set; } +``` + +#### Skill +```csharp +public double Skill { get; set; } +``` + +#### TimePlayed +```csharp +public int TimePlayed { get; set; } +``` + +#### MaxStrain +```csharp +public double MaxStrain { get; set; } +``` + +#### AverageHitOffset +```csharp +public float AverageHitOffset { get; } +``` + +#### SessionKills +```csharp +public int SessionKills { get; set; } +``` + +#### SessionDeaths +```csharp +public int SessionDeaths { get; set; } +``` + +#### KillStreak +```csharp +public int KillStreak { get; set; } +``` + +#### DeathStreak +```csharp +public int DeathStreak { get; set; } +``` + +#### LastStatCalculation +```csharp +public DateTime LastStatCalculation { get; set; } +``` + +#### LastScore +```csharp +public int LastScore { get; set; } +``` + +#### LastActive +```csharp +public DateTime LastActive { get; set; } +``` + +#### MaxSessionStrain +```csharp +public double MaxSessionStrain { get; set; } +``` + +#### SessionScore +```csharp +public int SessionScore { get; set; } +``` + +#### RoundScore +```csharp +public int RoundScore { get; } +``` + +#### Team +```csharp +public int Team { get; set; } +``` + +#### LastStatHistoryUpdate +```csharp +public DateTime LastStatHistoryUpdate { get; set; } +``` + +#### SessionSPM +```csharp +public double SessionSPM { get; set; } +``` + +#### ProcessingHit +```csharp +public SemaphoreSlim ProcessingHit { get; } +``` + +#### MatchData +```csharp +public MatchData MatchData { get; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/models/client/stats/EFHitLocationCount.md b/CodeDocumentation/data/models/client/stats/EFHitLocationCount.md new file mode 100644 index 0000000..a2a3cac --- /dev/null +++ b/CodeDocumentation/data/models/client/stats/EFHitLocationCount.md @@ -0,0 +1,91 @@ +# EFHitLocationCount `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Models.Client.Stats + Data.Models.Client.Stats.EFHitLocationCount[[EFHitLocationCount]] + end + subgraph Data.Models + Data.Models.SharedEntity[[SharedEntity]] + end +Data.Models.SharedEntity --> Data.Models.Client.Stats.EFHitLocationCount +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| [`EFClient`](../EFClient.md) | [`Client`](#client) | `get, set` | +| `int` | [`EFClientStatisticsClientId`](#efclientstatisticsclientid) | `get, set` | +| `long` | [`EFClientStatisticsServerId`](#efclientstatisticsserverid) | `get, set` | +| `int` | [`HitCount`](#hitcount) | `get, set` | +| `int` | [`HitLocationCountId`](#hitlocationcountid) | `get, set` | +| `float` | [`HitOffsetAverage`](#hitoffsetaverage) | `get, set` | +| `int` | [`Location`](#location) | `get, set` | +| `float` | [`MaxAngleDistance`](#maxangledistance) | `get, set` | +| [`EFServer`](../../server/EFServer.md) | [`Server`](#server) | `get, set` | + +## Details +### Inheritance + - [ +`SharedEntity` +](../../SharedEntity.md) + +### Constructors +#### EFHitLocationCount +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Events/Game/GameScript/Zombie/PlayerKilledGameEvent.cs#L5) +```csharp +public EFHitLocationCount() +``` + +### Properties +#### HitLocationCountId +```csharp +public int HitLocationCountId { get; set; } +``` + +#### Location +```csharp +public int Location { get; set; } +``` + +#### HitCount +```csharp +public int HitCount { get; set; } +``` + +#### HitOffsetAverage +```csharp +public float HitOffsetAverage { get; set; } +``` + +#### MaxAngleDistance +```csharp +public float MaxAngleDistance { get; set; } +``` + +#### EFClientStatisticsClientId +```csharp +public int EFClientStatisticsClientId { get; set; } +``` + +#### Client +```csharp +public EFClient Client { get; set; } +``` + +#### EFClientStatisticsServerId +```csharp +public long EFClientStatisticsServerId { get; set; } +``` + +#### Server +```csharp +public EFServer Server { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/models/client/stats/EFRating.md b/CodeDocumentation/data/models/client/stats/EFRating.md new file mode 100644 index 0000000..a3d6352 --- /dev/null +++ b/CodeDocumentation/data/models/client/stats/EFRating.md @@ -0,0 +1,97 @@ +# EFRating `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Models.Client.Stats + Data.Models.Client.Stats.EFRating[[EFRating]] + end + subgraph Data.Models + Data.Models.SharedEntity[[SharedEntity]] + end +Data.Models.SharedEntity --> Data.Models.Client.Stats.EFRating +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `int` | [`ActivityAmount`](#activityamount) | `get, set` | +| `bool` | [`Newest`](#newest) | `get, set` | +| `double` | [`Performance`](#performance) | `get, set` | +| `int` | [`Ranking`](#ranking) | `get, set` | +| [`EFClientRatingHistory`](./EFClientRatingHistory.md) | [`RatingHistory`](#ratinghistory) | `get, set` | +| `int` | [`RatingHistoryId`](#ratinghistoryid) | `get, set` | +| `int` | [`RatingId`](#ratingid) | `get, set` | +| [`EFServer`](../../server/EFServer.md) | [`Server`](#server) | `get, set` | +| `Nullable`<`long`> | [`ServerId`](#serverid) | `get, set` | +| `DateTime` | [`When`](#when) | `get, set` | + +## Details +### Inheritance + - [ +`SharedEntity` +](../../SharedEntity.md) + +### Constructors +#### EFRating +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/AuditInfo.cs#L27) +```csharp +public EFRating() +``` + +### Properties +#### RatingId +```csharp +public int RatingId { get; set; } +``` + +#### RatingHistoryId +```csharp +public int RatingHistoryId { get; set; } +``` + +#### RatingHistory +```csharp +public virtual EFClientRatingHistory RatingHistory { get; set; } +``` + +#### ServerId +```csharp +public Nullable ServerId { get; set; } +``` + +#### Server +```csharp +public virtual EFServer Server { get; set; } +``` + +#### Performance +```csharp +public double Performance { get; set; } +``` + +#### Ranking +```csharp +public int Ranking { get; set; } +``` + +#### Newest +```csharp +public bool Newest { get; set; } +``` + +#### ActivityAmount +```csharp +public int ActivityAmount { get; set; } +``` + +#### When +```csharp +public DateTime When { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/models/client/stats/MatchData.md b/CodeDocumentation/data/models/client/stats/MatchData.md new file mode 100644 index 0000000..5b4a086 --- /dev/null +++ b/CodeDocumentation/data/models/client/stats/MatchData.md @@ -0,0 +1,59 @@ +# MatchData `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Models.Client.Stats + Data.Models.Client.Stats.MatchData[[MatchData]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `int` | [`Deaths`](#deaths) | `get, set` | +| `double` | [`Kdr`](#kdr) | `get` | +| `int` | [`Kills`](#kills) | `get, set` | + +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `void` | [`StartNewMatch`](#startnewmatch)() | + +## Details +### Constructors +#### MatchData +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Events/Game/GameScriptEvent.cs#L5) +```csharp +public MatchData() +``` + +### Methods +#### StartNewMatch +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Client/Stats/EFClientStatistics.cs#L125) +```csharp +public void StartNewMatch() +``` + +### Properties +#### Kills +```csharp +public int Kills { get; set; } +``` + +#### Deaths +```csharp +public int Deaths { get; set; } +``` + +#### Kdr +```csharp +public double Kdr { get; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/models/client/stats/reference/EFHitLocation.md b/CodeDocumentation/data/models/client/stats/reference/EFHitLocation.md new file mode 100644 index 0000000..337afa8 --- /dev/null +++ b/CodeDocumentation/data/models/client/stats/reference/EFHitLocation.md @@ -0,0 +1,75 @@ +# EFHitLocation `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Models.Client.Stats.Reference + Data.Models.Client.Stats.Reference.EFHitLocation[[EFHitLocation]] + end + subgraph Data.Abstractions + Data.Abstractions.IUniqueId[[IUniqueId]] + class Data.Abstractions.IUniqueId interfaceStyle; + end + subgraph Stats.Models + Stats.Models.AuditFields[[AuditFields]] + end +Data.Abstractions.IUniqueId --> Data.Models.Client.Stats.Reference.EFHitLocation +Stats.Models.AuditFields --> Data.Models.Client.Stats.Reference.EFHitLocation +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `Game` | [`Game`](#game) | `get, set` | +| `int` | [`HitLocationId`](#hitlocationid) | `get, set` | +| `long` | [`Id`](#id) | `get` | +| `string` | [`Name`](#name) | `get, set` | +| `string` | [`Value`](#value) | `get` | + +## Details +### Inheritance + - [ +`IUniqueId` +](../../../../abstractions/IUniqueId.md) + - [ +`AuditFields` +](../../../../../stats/models/AuditFields.md) + +### Constructors +#### EFHitLocation +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/AuditInfo.cs#L54) +```csharp +public EFHitLocation() +``` + +### Properties +#### HitLocationId +```csharp +public int HitLocationId { get; set; } +``` + +#### Name +```csharp +public string Name { get; set; } +``` + +#### Game +```csharp +public Game Game { get; set; } +``` + +#### Id +```csharp +public virtual long Id { get; } +``` + +#### Value +```csharp +public virtual string Value { get; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/models/client/stats/reference/EFMap.md b/CodeDocumentation/data/models/client/stats/reference/EFMap.md new file mode 100644 index 0000000..d3805f2 --- /dev/null +++ b/CodeDocumentation/data/models/client/stats/reference/EFMap.md @@ -0,0 +1,75 @@ +# EFMap `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Models.Client.Stats.Reference + Data.Models.Client.Stats.Reference.EFMap[[EFMap]] + end + subgraph Data.Abstractions + Data.Abstractions.IUniqueId[[IUniqueId]] + class Data.Abstractions.IUniqueId interfaceStyle; + end + subgraph Stats.Models + Stats.Models.AuditFields[[AuditFields]] + end +Data.Abstractions.IUniqueId --> Data.Models.Client.Stats.Reference.EFMap +Stats.Models.AuditFields --> Data.Models.Client.Stats.Reference.EFMap +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `Game` | [`Game`](#game) | `get, set` | +| `long` | [`Id`](#id) | `get` | +| `int` | [`MapId`](#mapid) | `get, set` | +| `string` | [`Name`](#name) | `get, set` | +| `string` | [`Value`](#value) | `get` | + +## Details +### Inheritance + - [ +`IUniqueId` +](../../../../abstractions/IUniqueId.md) + - [ +`AuditFields` +](../../../../../stats/models/AuditFields.md) + +### Constructors +#### EFMap +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ChatInfo.cs#L11) +```csharp +public EFMap() +``` + +### Properties +#### MapId +```csharp +public int MapId { get; set; } +``` + +#### Name +```csharp +public string Name { get; set; } +``` + +#### Game +```csharp +public Game Game { get; set; } +``` + +#### Id +```csharp +public virtual long Id { get; } +``` + +#### Value +```csharp +public virtual string Value { get; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/models/client/stats/reference/EFMeansOfDeath.md b/CodeDocumentation/data/models/client/stats/reference/EFMeansOfDeath.md new file mode 100644 index 0000000..3f5ccea --- /dev/null +++ b/CodeDocumentation/data/models/client/stats/reference/EFMeansOfDeath.md @@ -0,0 +1,75 @@ +# EFMeansOfDeath `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Models.Client.Stats.Reference + Data.Models.Client.Stats.Reference.EFMeansOfDeath[[EFMeansOfDeath]] + end + subgraph Data.Abstractions + Data.Abstractions.IUniqueId[[IUniqueId]] + class Data.Abstractions.IUniqueId interfaceStyle; + end + subgraph Stats.Models + Stats.Models.AuditFields[[AuditFields]] + end +Data.Abstractions.IUniqueId --> Data.Models.Client.Stats.Reference.EFMeansOfDeath +Stats.Models.AuditFields --> Data.Models.Client.Stats.Reference.EFMeansOfDeath +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `Game` | [`Game`](#game) | `get, set` | +| `long` | [`Id`](#id) | `get` | +| `int` | [`MeansOfDeathId`](#meansofdeathid) | `get, set` | +| `string` | [`Name`](#name) | `get, set` | +| `string` | [`Value`](#value) | `get` | + +## Details +### Inheritance + - [ +`IUniqueId` +](../../../../abstractions/IUniqueId.md) + - [ +`AuditFields` +](../../../../../stats/models/AuditFields.md) + +### Constructors +#### EFMeansOfDeath +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ChatInfo.cs#L15) +```csharp +public EFMeansOfDeath() +``` + +### Properties +#### MeansOfDeathId +```csharp +public int MeansOfDeathId { get; set; } +``` + +#### Name +```csharp +public string Name { get; set; } +``` + +#### Game +```csharp +public Game Game { get; set; } +``` + +#### Id +```csharp +public virtual long Id { get; } +``` + +#### Value +```csharp +public virtual string Value { get; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/models/client/stats/reference/EFWeapon.md b/CodeDocumentation/data/models/client/stats/reference/EFWeapon.md new file mode 100644 index 0000000..00844c4 --- /dev/null +++ b/CodeDocumentation/data/models/client/stats/reference/EFWeapon.md @@ -0,0 +1,75 @@ +# EFWeapon `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Models.Client.Stats.Reference + Data.Models.Client.Stats.Reference.EFWeapon[[EFWeapon]] + end + subgraph Data.Abstractions + Data.Abstractions.IUniqueId[[IUniqueId]] + class Data.Abstractions.IUniqueId interfaceStyle; + end + subgraph Stats.Models + Stats.Models.AuditFields[[AuditFields]] + end +Data.Abstractions.IUniqueId --> Data.Models.Client.Stats.Reference.EFWeapon +Stats.Models.AuditFields --> Data.Models.Client.Stats.Reference.EFWeapon +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `Game` | [`Game`](#game) | `get, set` | +| `long` | [`Id`](#id) | `get` | +| `string` | [`Name`](#name) | `get, set` | +| `string` | [`Value`](#value) | `get` | +| `int` | [`WeaponId`](#weaponid) | `get, set` | + +## Details +### Inheritance + - [ +`IUniqueId` +](../../../../abstractions/IUniqueId.md) + - [ +`AuditFields` +](../../../../../stats/models/AuditFields.md) + +### Constructors +#### EFWeapon +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ClientHistoryInfo.cs#L14) +```csharp +public EFWeapon() +``` + +### Properties +#### WeaponId +```csharp +public int WeaponId { get; set; } +``` + +#### Name +```csharp +public string Name { get; set; } +``` + +#### Game +```csharp +public Game Game { get; set; } +``` + +#### Id +```csharp +public virtual long Id { get; } +``` + +#### Value +```csharp +public virtual string Value { get; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/models/client/stats/reference/EFWeaponAttachment.md b/CodeDocumentation/data/models/client/stats/reference/EFWeaponAttachment.md new file mode 100644 index 0000000..1bc6eac --- /dev/null +++ b/CodeDocumentation/data/models/client/stats/reference/EFWeaponAttachment.md @@ -0,0 +1,75 @@ +# EFWeaponAttachment `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Models.Client.Stats.Reference + Data.Models.Client.Stats.Reference.EFWeaponAttachment[[EFWeaponAttachment]] + end + subgraph Data.Abstractions + Data.Abstractions.IUniqueId[[IUniqueId]] + class Data.Abstractions.IUniqueId interfaceStyle; + end + subgraph Stats.Models + Stats.Models.AuditFields[[AuditFields]] + end +Data.Abstractions.IUniqueId --> Data.Models.Client.Stats.Reference.EFWeaponAttachment +Stats.Models.AuditFields --> Data.Models.Client.Stats.Reference.EFWeaponAttachment +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `Game` | [`Game`](#game) | `get, set` | +| `long` | [`Id`](#id) | `get` | +| `string` | [`Name`](#name) | `get, set` | +| `string` | [`Value`](#value) | `get` | +| `int` | [`WeaponAttachmentId`](#weaponattachmentid) | `get, set` | + +## Details +### Inheritance + - [ +`IUniqueId` +](../../../../abstractions/IUniqueId.md) + - [ +`AuditFields` +](../../../../../stats/models/AuditFields.md) + +### Constructors +#### EFWeaponAttachment +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ClientHistoryInfo.cs#L19) +```csharp +public EFWeaponAttachment() +``` + +### Properties +#### WeaponAttachmentId +```csharp +public int WeaponAttachmentId { get; set; } +``` + +#### Name +```csharp +public string Name { get; set; } +``` + +#### Game +```csharp +public Game Game { get; set; } +``` + +#### Id +```csharp +public virtual long Id { get; } +``` + +#### Value +```csharp +public virtual string Value { get; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/models/client/stats/reference/EFWeaponAttachmentCombo.md b/CodeDocumentation/data/models/client/stats/reference/EFWeaponAttachmentCombo.md new file mode 100644 index 0000000..30eb87d --- /dev/null +++ b/CodeDocumentation/data/models/client/stats/reference/EFWeaponAttachmentCombo.md @@ -0,0 +1,105 @@ +# EFWeaponAttachmentCombo `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Models.Client.Stats.Reference + Data.Models.Client.Stats.Reference.EFWeaponAttachmentCombo[[EFWeaponAttachmentCombo]] + end + subgraph Data.Abstractions + Data.Abstractions.IUniqueId[[IUniqueId]] + class Data.Abstractions.IUniqueId interfaceStyle; + end + subgraph Stats.Models + Stats.Models.AuditFields[[AuditFields]] + end +Data.Abstractions.IUniqueId --> Data.Models.Client.Stats.Reference.EFWeaponAttachmentCombo +Stats.Models.AuditFields --> Data.Models.Client.Stats.Reference.EFWeaponAttachmentCombo +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| [`EFWeaponAttachment`](./EFWeaponAttachment.md) | [`Attachment1`](#attachment1) | `get, set` | +| `int` | [`Attachment1Id`](#attachment1id) | `get, set` | +| [`EFWeaponAttachment`](./EFWeaponAttachment.md) | [`Attachment2`](#attachment2) | `get, set` | +| `Nullable`<`int`> | [`Attachment2Id`](#attachment2id) | `get, set` | +| [`EFWeaponAttachment`](./EFWeaponAttachment.md) | [`Attachment3`](#attachment3) | `get, set` | +| `Nullable`<`int`> | [`Attachment3Id`](#attachment3id) | `get, set` | +| `Game` | [`Game`](#game) | `get, set` | +| `long` | [`Id`](#id) | `get` | +| `string` | [`Value`](#value) | `get` | +| `int` | [`WeaponAttachmentComboId`](#weaponattachmentcomboid) | `get, set` | + +## Details +### Inheritance + - [ +`IUniqueId` +](../../../../abstractions/IUniqueId.md) + - [ +`AuditFields` +](../../../../../stats/models/AuditFields.md) + +### Constructors +#### EFWeaponAttachmentCombo +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/CommandResponseInfo.cs#L6) +```csharp +public EFWeaponAttachmentCombo() +``` + +### Properties +#### WeaponAttachmentComboId +```csharp +public int WeaponAttachmentComboId { get; set; } +``` + +#### Game +```csharp +public Game Game { get; set; } +``` + +#### Attachment1Id +```csharp +public int Attachment1Id { get; set; } +``` + +#### Attachment1 +```csharp +public virtual EFWeaponAttachment Attachment1 { get; set; } +``` + +#### Attachment2Id +```csharp +public Nullable Attachment2Id { get; set; } +``` + +#### Attachment2 +```csharp +public virtual EFWeaponAttachment Attachment2 { get; set; } +``` + +#### Attachment3Id +```csharp +public Nullable Attachment3Id { get; set; } +``` + +#### Attachment3 +```csharp +public virtual EFWeaponAttachment Attachment3 { get; set; } +``` + +#### Id +```csharp +public virtual long Id { get; } +``` + +#### Value +```csharp +public virtual string Value { get; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/models/configuration/StatsModelConfiguration.md b/CodeDocumentation/data/models/configuration/StatsModelConfiguration.md new file mode 100644 index 0000000..eea71f0 --- /dev/null +++ b/CodeDocumentation/data/models/configuration/StatsModelConfiguration.md @@ -0,0 +1,39 @@ +# StatsModelConfiguration `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Models.Configuration + Data.Models.Configuration.StatsModelConfiguration[[StatsModelConfiguration]] + end +``` + +## Members +### Methods +#### Public Static methods +| Returns | Name | +| --- | --- | +| `void` | [`Configure`](#configure)(`ModelBuilder` builder) | + +## Details +### Constructors +#### StatsModelConfiguration +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/API/Master/ApiServer.cs#L19) +```csharp +public StatsModelConfiguration() +``` + +### Methods +#### Configure +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/API/Master/ApiServer.cs#L19) +```csharp +public static void Configure(ModelBuilder builder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | builder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/models/efchangehistory/ChangeType.md b/CodeDocumentation/data/models/efchangehistory/ChangeType.md new file mode 100644 index 0000000..64bef7b --- /dev/null +++ b/CodeDocumentation/data/models/efchangehistory/ChangeType.md @@ -0,0 +1,24 @@ +# ChangeType `Public enum` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Models.EFChangeHistory + Data.Models.EFChangeHistory.ChangeType[[ChangeType]] + end +``` + +## Details +### Fields +#### Permission + + +#### Ban + + +#### Command + + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/models/efpenalty/PenaltyType.md b/CodeDocumentation/data/models/efpenalty/PenaltyType.md new file mode 100644 index 0000000..c164842 --- /dev/null +++ b/CodeDocumentation/data/models/efpenalty/PenaltyType.md @@ -0,0 +1,54 @@ +# PenaltyType `Public enum` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Models.EFPenalty + Data.Models.EFPenalty.PenaltyType[[PenaltyType]] + end +``` + +## Details +### Fields +#### Report + + +#### Warning + + +#### Flag + + +#### Kick + + +#### TempBan + + +#### Ban + + +#### Unban + + +#### Any + + +#### Unflag + + +#### Mute + + +#### TempMute + + +#### Unmute + + +#### Other + + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/models/misc/EFInboxMessage.md b/CodeDocumentation/data/models/misc/EFInboxMessage.md new file mode 100644 index 0000000..f888e8d --- /dev/null +++ b/CodeDocumentation/data/models/misc/EFInboxMessage.md @@ -0,0 +1,91 @@ +# EFInboxMessage `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Models.Misc + Data.Models.Misc.EFInboxMessage[[EFInboxMessage]] + end + subgraph Stats.Models + Stats.Models.AuditFields[[AuditFields]] + end +Stats.Models.AuditFields --> Data.Models.Misc.EFInboxMessage +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| [`EFClient`](../client/EFClient.md) | [`DestinationClient`](#destinationclient) | `get, set` | +| `int` | [`DestinationClientId`](#destinationclientid) | `get, set` | +| `int` | [`InboxMessageId`](#inboxmessageid) | `get, set` | +| `bool` | [`IsDelivered`](#isdelivered) | `get, set` | +| `string` | [`Message`](#message) | `get, set` | +| [`EFServer`](../server/EFServer.md) | [`Server`](#server) | `get, set` | +| `Nullable`<`long`> | [`ServerId`](#serverid) | `get, set` | +| [`EFClient`](../client/EFClient.md) | [`SourceClient`](#sourceclient) | `get, set` | +| `int` | [`SourceClientId`](#sourceclientid) | `get, set` | + +## Details +### Inheritance + - [ +`AuditFields` +](../../../stats/models/AuditFields.md) + +### Constructors +#### EFInboxMessage +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/API/Master/ApiServer.cs#L17) +```csharp +public EFInboxMessage() +``` + +### Properties +#### InboxMessageId +```csharp +public int InboxMessageId { get; set; } +``` + +#### SourceClientId +```csharp +public int SourceClientId { get; set; } +``` + +#### SourceClient +```csharp +public EFClient SourceClient { get; set; } +``` + +#### DestinationClientId +```csharp +public int DestinationClientId { get; set; } +``` + +#### DestinationClient +```csharp +public EFClient DestinationClient { get; set; } +``` + +#### ServerId +```csharp +public Nullable ServerId { get; set; } +``` + +#### Server +```csharp +public EFServer Server { get; set; } +``` + +#### Message +```csharp +public string Message { get; set; } +``` + +#### IsDelivered +```csharp +public bool IsDelivered { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/models/reference/ConnectionType.md b/CodeDocumentation/data/models/reference/ConnectionType.md new file mode 100644 index 0000000..b2728ef --- /dev/null +++ b/CodeDocumentation/data/models/reference/ConnectionType.md @@ -0,0 +1,21 @@ +# ConnectionType `Public enum` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Models.Reference + Data.Models.Reference.ConnectionType[[ConnectionType]] + end +``` + +## Details +### Fields +#### Connect + + +#### Disconnect + + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/models/reference/Game.md b/CodeDocumentation/data/models/reference/Game.md new file mode 100644 index 0000000..fcd0da9 --- /dev/null +++ b/CodeDocumentation/data/models/reference/Game.md @@ -0,0 +1,54 @@ +# Game `Public enum` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Models.Reference + Data.Models.Reference.Game[[Game]] + end +``` + +## Details +### Fields +#### COD + + +#### UKN + + +#### IW3 + + +#### IW4 + + +#### IW5 + + +#### IW6 + + +#### T4 + + +#### T5 + + +#### T6 + + +#### T7 + + +#### SHG1 + + +#### CSGO + + +#### H1 + + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/models/server/EFServer.md b/CodeDocumentation/data/models/server/EFServer.md new file mode 100644 index 0000000..94f1bf9 --- /dev/null +++ b/CodeDocumentation/data/models/server/EFServer.md @@ -0,0 +1,99 @@ +# EFServer `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Models.Server + Data.Models.Server.EFServer[[EFServer]] + end + subgraph Data.Abstractions + Data.Abstractions.IUniqueId[[IUniqueId]] + class Data.Abstractions.IUniqueId interfaceStyle; + end + subgraph Data.Models + Data.Models.SharedEntity[[SharedEntity]] + end +Data.Abstractions.IUniqueId --> Data.Models.Server.EFServer +Data.Models.SharedEntity --> Data.Models.Server.EFServer +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`EndPoint`](#endpoint) | `get, set` | +| `Nullable`<`Game`> | [`GameName`](#gamename) | `get, set` | +| `string` | [`HostName`](#hostname) | `get, set` | +| `long` | [`Id`](#id) | `get` | +| `bool` | [`IsPasswordProtected`](#ispasswordprotected) | `get, set` | +| `string` | [`PerformanceBucket`](#performancebucket) | `get, set` | +| `int` | [`Port`](#port) | `get, set` | +| `long` | [`ServerId`](#serverid) | `get, set` | +| `string` | [`Value`](#value) | `get` | + +## Details +### Inheritance + - [ +`IUniqueId` +](../../abstractions/IUniqueId.md) + - [ +`SharedEntity` +](../SharedEntity.md) + +### Constructors +#### EFServer +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/OfflineMessageCommand.cs#L16707566) +```csharp +public EFServer() +``` + +### Properties +#### ServerId +```csharp +public long ServerId { get; set; } +``` + +#### Port +```csharp +public int Port { get; set; } +``` + +#### EndPoint +```csharp +public string EndPoint { get; set; } +``` + +#### GameName +```csharp +public Nullable GameName { get; set; } +``` + +#### HostName +```csharp +public string HostName { get; set; } +``` + +#### IsPasswordProtected +```csharp +public bool IsPasswordProtected { get; set; } +``` + +#### PerformanceBucket +```csharp +public string PerformanceBucket { get; set; } +``` + +#### Id +```csharp +public virtual long Id { get; } +``` + +#### Value +```csharp +public virtual string Value { get; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/models/server/EFServerSnapshot.md b/CodeDocumentation/data/models/server/EFServerSnapshot.md new file mode 100644 index 0000000..8c724de --- /dev/null +++ b/CodeDocumentation/data/models/server/EFServerSnapshot.md @@ -0,0 +1,95 @@ +# EFServerSnapshot `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Models.Server + Data.Models.Server.EFServerSnapshot[[EFServerSnapshot]] + end + subgraph Data.Models + Data.Models.SharedEntity[[SharedEntity]] + end +Data.Models.SharedEntity --> Data.Models.Server.EFServerSnapshot +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `DateTime` | [`CapturedAt`](#capturedat) | `get, set` | +| `int` | [`ClientCount`](#clientcount) | `get, set` | +| `Nullable`<`bool`> | [`ConnectionInterrupted`](#connectioninterrupted) | `get, set` | +| [`EFMap`](../client/stats/reference/EFMap.md) | [`Map`](#map) | `get, set` | +| `int` | [`MapId`](#mapid) | `get, set` | +| `int` | [`PeriodBlock`](#periodblock)
Specifies at which time block during a period the snapshot occured
| 1:00 | 1:05 | 1:10 |
| 5 minutes | 5 minutes | 5 minutes |
| 0 | 1 | 2 | | `get, set` | +| [`EFServer`](./EFServer.md) | [`Server`](#server) | `get, set` | +| `long` | [`ServerId`](#serverid) | `get, set` | +| `long` | [`ServerSnapshotId`](#serversnapshotid) | `get, set` | + +## Details +### Inheritance + - [ +`SharedEntity` +](../SharedEntity.md) + +### Constructors +#### EFServerSnapshot +```csharp +public EFServerSnapshot() +``` + +### Properties +#### ServerSnapshotId +```csharp +public long ServerSnapshotId { get; set; } +``` + +#### CapturedAt +```csharp +public DateTime CapturedAt { get; set; } +``` + +#### PeriodBlock +```csharp +public int PeriodBlock { get; set; } +``` +##### Summary +Specifies at which time block during a period the snapshot occured + | 1:00 | 1:05 | 1:10 | + | 5 minutes | 5 minutes | 5 minutes | + | 0 | 1 | 2 | + +#### ServerId +```csharp +public long ServerId { get; set; } +``` + +#### Server +```csharp +public EFServer Server { get; set; } +``` + +#### MapId +```csharp +public int MapId { get; set; } +``` + +#### Map +```csharp +public EFMap Map { get; set; } +``` + +#### ClientCount +```csharp +public int ClientCount { get; set; } +``` + +#### ConnectionInterrupted +```csharp +public Nullable ConnectionInterrupted { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/models/server/EFServerStatistics.md b/CodeDocumentation/data/models/server/EFServerStatistics.md new file mode 100644 index 0000000..8c19bbe --- /dev/null +++ b/CodeDocumentation/data/models/server/EFServerStatistics.md @@ -0,0 +1,66 @@ +# EFServerStatistics `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Models.Server + Data.Models.Server.EFServerStatistics[[EFServerStatistics]] + end + subgraph Data.Models + Data.Models.SharedEntity[[SharedEntity]] + end +Data.Models.SharedEntity --> Data.Models.Server.EFServerStatistics +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| [`EFServer`](./EFServer.md) | [`Server`](#server) | `get, set` | +| `long` | [`ServerId`](#serverid) | `get, set` | +| `int` | [`StatisticId`](#statisticid) | `get, set` | +| `long` | [`TotalKills`](#totalkills) | `get, set` | +| `long` | [`TotalPlayTime`](#totalplaytime) | `get, set` | + +## Details +### Inheritance + - [ +`SharedEntity` +](../SharedEntity.md) + +### Constructors +#### EFServerStatistics +```csharp +public EFServerStatistics() +``` + +### Properties +#### StatisticId +```csharp +public int StatisticId { get; set; } +``` + +#### ServerId +```csharp +public long ServerId { get; set; } +``` + +#### Server +```csharp +public virtual EFServer Server { get; set; } +``` + +#### TotalKills +```csharp +public long TotalKills { get; set; } +``` + +#### TotalPlayTime +```csharp +public long TotalPlayTime { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/models/zombie/RecordType.md b/CodeDocumentation/data/models/zombie/RecordType.md new file mode 100644 index 0000000..3ee4567 --- /dev/null +++ b/CodeDocumentation/data/models/zombie/RecordType.md @@ -0,0 +1,21 @@ +# RecordType `Public enum` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Models.Zombie + Data.Models.Zombie.RecordType[[RecordType]] + end +``` + +## Details +### Fields +#### Maximum + + +#### Minimum + + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/models/zombie/ZombieAggregateClientStat.md b/CodeDocumentation/data/models/zombie/ZombieAggregateClientStat.md new file mode 100644 index 0000000..eb95285 --- /dev/null +++ b/CodeDocumentation/data/models/zombie/ZombieAggregateClientStat.md @@ -0,0 +1,107 @@ +# ZombieAggregateClientStat `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Models.Zombie + Data.Models.Zombie.ZombieAggregateClientStat[[ZombieAggregateClientStat]] + Data.Models.Zombie.ZombieClientStat[[ZombieClientStat]] + class Data.Models.Zombie.ZombieClientStat abstractStyle; + end +Data.Models.Zombie.ZombieClientStat --> Data.Models.Zombie.ZombieAggregateClientStat +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `double` | [`AlivePercentage`](#alivepercentage) | `get, set` | +| `double` | [`AverageDowns`](#averagedowns) | `get, set` | +| `double` | [`AverageKillsPerDown`](#averagekillsperdown) | `get, set` | +| `double` | [`AverageMelees`](#averagemelees) | `get, set` | +| `double` | [`AveragePoints`](#averagepoints) | `get, set` | +| `double` | [`AverageRevives`](#averagerevives) | `get, set` | +| `double` | [`AverageRoundReached`](#averageroundreached) | `get, set` | +| `double` | [`HeadshotPercentage`](#headshotpercentage) | `get, set` | +| `int` | [`HighestRound`](#highestround) | `get, set` | +| `int` | [`TotalMatchesCompleted`](#totalmatchescompleted) | `get, set` | +| `int` | [`TotalMatchesPlayed`](#totalmatchesplayed) | `get, set` | +| `int` | [`TotalRoundsPlayed`](#totalroundsplayed) | `get, set` | + +## Details +### Inheritance + - [ +`ZombieClientStat` +](./ZombieClientStat.md) + +### Constructors +#### ZombieAggregateClientStat +```csharp +public ZombieAggregateClientStat() +``` + +### Properties +#### AverageKillsPerDown +```csharp +public double AverageKillsPerDown { get; set; } +``` + +#### AverageDowns +```csharp +public double AverageDowns { get; set; } +``` + +#### AverageRevives +```csharp +public double AverageRevives { get; set; } +``` + +#### HeadshotPercentage +```csharp +public double HeadshotPercentage { get; set; } +``` + +#### AlivePercentage +```csharp +public double AlivePercentage { get; set; } +``` + +#### AverageMelees +```csharp +public double AverageMelees { get; set; } +``` + +#### AverageRoundReached +```csharp +public double AverageRoundReached { get; set; } +``` + +#### AveragePoints +```csharp +public double AveragePoints { get; set; } +``` + +#### HighestRound +```csharp +public int HighestRound { get; set; } +``` + +#### TotalRoundsPlayed +```csharp +public int TotalRoundsPlayed { get; set; } +``` + +#### TotalMatchesPlayed +```csharp +public int TotalMatchesPlayed { get; set; } +``` + +#### TotalMatchesCompleted +```csharp +public int TotalMatchesCompleted { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/models/zombie/ZombieClientStat.md b/CodeDocumentation/data/models/zombie/ZombieClientStat.md new file mode 100644 index 0000000..5c92942 --- /dev/null +++ b/CodeDocumentation/data/models/zombie/ZombieClientStat.md @@ -0,0 +1,140 @@ +# ZombieClientStat `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Models.Zombie + Data.Models.Zombie.ZombieClientStat[[ZombieClientStat]] + class Data.Models.Zombie.ZombieClientStat abstractStyle; + end + subgraph Data.Models + Data.Models.DatedRecord[[DatedRecord]] + end +Data.Models.DatedRecord --> Data.Models.Zombie.ZombieClientStat +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| [`EFClient`](../client/EFClient.md) | [`Client`](#client) | `get, set` | +| `int` | [`ClientId`](#clientid) | `get, set` | +| `long` | [`DamageDealt`](#damagedealt) | `get, set` | +| `int` | [`DamageReceived`](#damagereceived) | `get, set` | +| `int` | [`Deaths`](#deaths) | `get, set` | +| `int` | [`Downs`](#downs) | `get, set` | +| `int` | [`Headshots`](#headshots) | `get, set` | +| `int` | [`Kills`](#kills) | `get, set` | +| [`ZombieMatch`](./ZombieMatch.md) | [`Match`](#match) | `get, set` | +| `Nullable`<`int`> | [`MatchId`](#matchid) | `get, set` | +| `int` | [`Melees`](#melees) | `get, set` | +| `int` | [`PerksConsumed`](#perksconsumed) | `get, set` | +| `long` | [`PointsEarned`](#pointsearned) | `get, set` | +| `long` | [`PointsSpent`](#pointsspent) | `get, set` | +| `int` | [`PowerupsGrabbed`](#powerupsgrabbed) | `get, set` | +| `int` | [`Revives`](#revives) | `get, set` | +| `long` | [`ZombieClientStatId`](#zombieclientstatid) | `get, set` | + +## Details +### Inheritance + - [ +`DatedRecord` +](../DatedRecord.md) + +### Constructors +#### ZombieClientStat +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/BaseEventParser.cs#L236) +```csharp +protected ZombieClientStat() +``` + +### Properties +#### ZombieClientStatId +```csharp +public long ZombieClientStatId { get; set; } +``` + +#### MatchId +```csharp +public Nullable MatchId { get; set; } +``` + +#### Match +```csharp +public virtual ZombieMatch Match { get; set; } +``` + +#### ClientId +```csharp +public int ClientId { get; set; } +``` + +#### Client +```csharp +public virtual EFClient Client { get; set; } +``` + +#### Kills +```csharp +public int Kills { get; set; } +``` + +#### Deaths +```csharp +public int Deaths { get; set; } +``` + +#### DamageDealt +```csharp +public long DamageDealt { get; set; } +``` + +#### DamageReceived +```csharp +public int DamageReceived { get; set; } +``` + +#### Headshots +```csharp +public int Headshots { get; set; } +``` + +#### Melees +```csharp +public int Melees { get; set; } +``` + +#### Downs +```csharp +public int Downs { get; set; } +``` + +#### Revives +```csharp +public int Revives { get; set; } +``` + +#### PointsEarned +```csharp +public long PointsEarned { get; set; } +``` + +#### PointsSpent +```csharp +public long PointsSpent { get; set; } +``` + +#### PerksConsumed +```csharp +public int PerksConsumed { get; set; } +``` + +#### PowerupsGrabbed +```csharp +public int PowerupsGrabbed { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/models/zombie/ZombieClientStatRecord.md b/CodeDocumentation/data/models/zombie/ZombieClientStatRecord.md new file mode 100644 index 0000000..98d18ca --- /dev/null +++ b/CodeDocumentation/data/models/zombie/ZombieClientStatRecord.md @@ -0,0 +1,85 @@ +# ZombieClientStatRecord `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Models.Zombie + Data.Models.Zombie.ZombieClientStatRecord[[ZombieClientStatRecord]] + end + subgraph Data.Models + Data.Models.DatedRecord[[DatedRecord]] + end +Data.Models.DatedRecord --> Data.Models.Zombie.ZombieClientStatRecord +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| [`EFClient`](../client/EFClient.md) | [`Client`](#client) | `get, set` | +| `Nullable`<`int`> | [`ClientId`](#clientid) | `get, set` | +| `string` | [`Name`](#name) | `get, set` | +| [`ZombieRoundClientStat`](./ZombieRoundClientStat.md) | [`Round`](#round) | `get, set` | +| `Nullable`<`long`> | [`RoundId`](#roundid) | `get, set` | +| `string` | [`Type`](#type) | `get, set` | +| `string` | [`Value`](#value) | `get, set` | +| `int` | [`ZombieClientStatRecordId`](#zombieclientstatrecordid) | `get, set` | + +## Details +### Inheritance + - [ +`DatedRecord` +](../DatedRecord.md) + +### Constructors +#### ZombieClientStatRecord +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/DynamicEventParserConfiguration.cs#L18) +```csharp +public ZombieClientStatRecord() +``` + +### Properties +#### ZombieClientStatRecordId +```csharp +public int ZombieClientStatRecordId { get; set; } +``` + +#### Name +```csharp +public string Name { get; set; } +``` + +#### Type +```csharp +public string Type { get; set; } +``` + +#### Value +```csharp +public string Value { get; set; } +``` + +#### ClientId +```csharp +public Nullable ClientId { get; set; } +``` + +#### Client +```csharp +public virtual EFClient Client { get; set; } +``` + +#### RoundId +```csharp +public Nullable RoundId { get; set; } +``` + +#### Round +```csharp +public virtual ZombieRoundClientStat Round { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/models/zombie/ZombieMatch.md b/CodeDocumentation/data/models/zombie/ZombieMatch.md new file mode 100644 index 0000000..e0c1b2f --- /dev/null +++ b/CodeDocumentation/data/models/zombie/ZombieMatch.md @@ -0,0 +1,85 @@ +# ZombieMatch `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Models.Zombie + Data.Models.Zombie.ZombieMatch[[ZombieMatch]] + end + subgraph Data.Models + Data.Models.DatedRecord[[DatedRecord]] + end +Data.Models.DatedRecord --> Data.Models.Zombie.ZombieMatch +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `int` | [`ClientsCompleted`](#clientscompleted) | `get, set` | +| [`EFMap`](../client/stats/reference/EFMap.md) | [`Map`](#map) | `get, set` | +| `Nullable`<`int`> | [`MapId`](#mapid) | `get, set` | +| `Nullable`<`DateTimeOffset`> | [`MatchEndDate`](#matchenddate) | `get, set` | +| `DateTimeOffset` | [`MatchStartDate`](#matchstartdate) | `get, set` | +| [`EFServer`](../server/EFServer.md) | [`Server`](#server) | `get, set` | +| `Nullable`<`long`> | [`ServerId`](#serverid) | `get, set` | +| `int` | [`ZombieMatchId`](#zombiematchid) | `get, set` | + +## Details +### Inheritance + - [ +`DatedRecord` +](../DatedRecord.md) + +### Constructors +#### ZombieMatch +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/DynamicEventParserConfiguration.cs#L26) +```csharp +public ZombieMatch() +``` + +### Properties +#### ZombieMatchId +```csharp +public int ZombieMatchId { get; set; } +``` + +#### MapId +```csharp +public Nullable MapId { get; set; } +``` + +#### Map +```csharp +public virtual EFMap Map { get; set; } +``` + +#### ServerId +```csharp +public Nullable ServerId { get; set; } +``` + +#### Server +```csharp +public virtual EFServer Server { get; set; } +``` + +#### ClientsCompleted +```csharp +public int ClientsCompleted { get; set; } +``` + +#### MatchStartDate +```csharp +public DateTimeOffset MatchStartDate { get; set; } +``` + +#### MatchEndDate +```csharp +public Nullable MatchEndDate { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/models/zombie/ZombieMatchClientStat.md b/CodeDocumentation/data/models/zombie/ZombieMatchClientStat.md new file mode 100644 index 0000000..6215f79 --- /dev/null +++ b/CodeDocumentation/data/models/zombie/ZombieMatchClientStat.md @@ -0,0 +1,29 @@ +# ZombieMatchClientStat `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Models.Zombie + Data.Models.Zombie.ZombieMatchClientStat[[ZombieMatchClientStat]] + Data.Models.Zombie.ZombieClientStat[[ZombieClientStat]] + class Data.Models.Zombie.ZombieClientStat abstractStyle; + end +Data.Models.Zombie.ZombieClientStat --> Data.Models.Zombie.ZombieMatchClientStat +``` + +## Details +### Inheritance + - [ +`ZombieClientStat` +](./ZombieClientStat.md) + +### Constructors +#### ZombieMatchClientStat +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/DynamicEventParserConfiguration.cs#L27) +```csharp +public ZombieMatchClientStat() +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/data/models/zombie/ZombieRoundClientStat.md b/CodeDocumentation/data/models/zombie/ZombieRoundClientStat.md new file mode 100644 index 0000000..2bf05c8 --- /dev/null +++ b/CodeDocumentation/data/models/zombie/ZombieRoundClientStat.md @@ -0,0 +1,72 @@ +# ZombieRoundClientStat `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Data.Models.Zombie + Data.Models.Zombie.ZombieRoundClientStat[[ZombieRoundClientStat]] + Data.Models.Zombie.ZombieClientStat[[ZombieClientStat]] + class Data.Models.Zombie.ZombieClientStat abstractStyle; + end +Data.Models.Zombie.ZombieClientStat --> Data.Models.Zombie.ZombieRoundClientStat +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `Nullable`<`TimeSpan`> | [`Duration`](#duration) | `get, set` | +| `Nullable`<`DateTimeOffset`> | [`EndTime`](#endtime) | `get, set` | +| `int` | [`Points`](#points) | `get, set` | +| `int` | [`RoundNumber`](#roundnumber) | `get, set` | +| `DateTimeOffset` | [`StartTime`](#starttime) | `get, set` | +| `Nullable`<`TimeSpan`> | [`TimeAlive`](#timealive) | `get, set` | + +## Details +### Inheritance + - [ +`ZombieClientStat` +](./ZombieClientStat.md) + +### Constructors +#### ZombieRoundClientStat +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/FindPlayerCommand.cs#L17) +```csharp +public ZombieRoundClientStat() +``` + +### Properties +#### StartTime +```csharp +public DateTimeOffset StartTime { get; set; } +``` + +#### EndTime +```csharp +public Nullable EndTime { get; set; } +``` + +#### Duration +```csharp +public Nullable Duration { get; set; } +``` + +#### TimeAlive +```csharp +public Nullable TimeAlive { get; set; } +``` + +#### RoundNumber +```csharp +public int RoundNumber { get; set; } +``` + +#### Points +```csharp +public int Points { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/IW4MServer.md b/CodeDocumentation/iw4madmin/IW4MServer.md new file mode 100644 index 0000000..cf5c215 --- /dev/null +++ b/CodeDocumentation/iw4madmin/IW4MServer.md @@ -0,0 +1,292 @@ +# IW4MServer `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin + IW4MAdmin.IW4MServer[[IW4MServer]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Server[[Server]] + class SharedLibraryCore.Server abstractStyle; + end +SharedLibraryCore.Server --> IW4MAdmin.IW4MServer +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `long` | [`LegacyDatabaseId`](#legacydatabaseid) | `get` | + +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`Ban`](#ban)(`string` reason, [`EFClient`](../sharedlibrarycore/database/models/EFClient.md) targetClient, [`EFClient`](../sharedlibrarycore/database/models/EFClient.md) originClient, `bool` isEvade) | +| `Task` | [`EnsureServerAdded`](#ensureserveradded)() | +| `Task`<`string``[]`> | [`ExecuteCommandAsync`](#executecommandasync)(`string` command, `CancellationToken` token) | +| `Task` | [`ExecuteEvent`](#executeevent)([`GameEvent`](../sharedlibrarycore/GameEvent.md) E) | +| `Uri``[]` | [`GenerateUriForLog`](#generateuriforlog)(`string` logPath, `string` gameLogServerUrl) | +| `Task`<`long`> | [`GetIdForServer`](#getidforserver)([`Server`](../sharedlibrarycore/Server.md) server) | +| `Task` | [`Initialize`](#initialize)() | +| `void` | [`InitializeTokens`](#initializetokens)() | +| `Task` | [`Kick`](#kick)(`string` reason, [`EFClient`](../sharedlibrarycore/database/models/EFClient.md) targetClient, [`EFClient`](../sharedlibrarycore/database/models/EFClient.md) originClient, [`EFPenalty`](../data/models/EFPenalty.md) previousPenalty) | +| `Task`<[`EFClient`](../sharedlibrarycore/database/models/EFClient.md)> | [`OnClientConnected`](#onclientconnected)([`EFClient`](../sharedlibrarycore/database/models/EFClient.md) clientFromLog) | +| `Task` | [`OnClientDisconnected`](#onclientdisconnected)([`EFClient`](../sharedlibrarycore/database/models/EFClient.md) client) | +| `Task`<`bool`> | [`ProcessUpdatesAsync`](#processupdatesasync)(`CancellationToken` token) | +| `Task` | [`SetDvarAsync`](#setdvarasync)(`string` name, `object` value, `CancellationToken` token) | +| `Task` | [`TempBan`](#tempban)(`string` reason, `TimeSpan` length, [`EFClient`](../sharedlibrarycore/database/models/EFClient.md) targetClient, [`EFClient`](../sharedlibrarycore/database/models/EFClient.md) originClient) | +| `Task` | [`Unban`](#unban)(`string` reason, [`EFClient`](../sharedlibrarycore/database/models/EFClient.md) targetClient, [`EFClient`](../sharedlibrarycore/database/models/EFClient.md) originClient) | +| `Task` | [`Warn`](#warn)(`string` reason, [`EFClient`](../sharedlibrarycore/database/models/EFClient.md) targetClient, [`EFClient`](../sharedlibrarycore/database/models/EFClient.md) targetOrigin) | + +#### Protected methods +| Returns | Name | +| --- | --- | +| `Task`<`bool`> | [`ProcessEvent`](#processevent)([`GameEvent`](../sharedlibrarycore/GameEvent.md) E)
Perform the server specific tasks when an event occurs | + +#### Public Static methods +| Returns | Name | +| --- | --- | +| `string` | [`GenerateLogPath`](#generatelogpath)([`LogPathGeneratorInfo`](application/misc/LogPathGeneratorInfo.md) logInfo) | + +#### Internal Static methods +| Returns | Name | +| --- | --- | +| `bool` | [`g__IsValidGamePath|35_0`](#generatelogpathgisvalidgamepath350)(`string` path) | + +## Details +### Inheritance + - [ +`Server` +](../sharedlibrarycore/Server.md) + +### Constructors +#### IW4MServer +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IW4MServer.cs#L48) +```csharp +public IW4MServer(ServerConfiguration serverConfiguration, CommandConfiguration commandConfiguration, ITranslationLookup lookup, IMetaServiceV2 metaService, IServiceProvider serviceProvider, IClientNoticeMessageFormatter messageFormatter, ILookupCache serverCache) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`ServerConfiguration`](../sharedlibrarycore/configuration/ServerConfiguration.md) | serverConfiguration | | +| [`CommandConfiguration`](../sharedlibrarycore/configuration/CommandConfiguration.md) | commandConfiguration | | +| [`ITranslationLookup`](../sharedlibrarycore/interfaces/ITranslationLookup.md) | lookup | | +| [`IMetaServiceV2`](../sharedlibrarycore/interfaces/IMetaServiceV2.md) | metaService | | +| `IServiceProvider` | serviceProvider | | +| [`IClientNoticeMessageFormatter`](../sharedlibrarycore/interfaces/IClientNoticeMessageFormatter.md) | messageFormatter | | +| [`ILookupCache`](../data/abstractions/ILookupCacheT.md)<[`EFServer`](../data/models/server/EFServer.md)> | serverCache | | + +### Methods +#### OnClientConnected +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dvar.cs#L5) +```csharp +public override async Task OnClientConnected(EFClient clientFromLog) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`EFClient`](../sharedlibrarycore/database/models/EFClient.md) | clientFromLog | | + +#### OnClientDisconnected +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dvar.cs#L6) +```csharp +public override async Task OnClientDisconnected(EFClient client) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`EFClient`](../sharedlibrarycore/database/models/EFClient.md) | client | | + +#### ExecuteEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dvar.cs#L6) +```csharp +public override async Task ExecuteEvent(GameEvent E) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](../sharedlibrarycore/GameEvent.md) | E | | + +#### ProcessEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dvar.cs#L7) +```csharp +protected override async Task ProcessEvent(GameEvent E) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](../sharedlibrarycore/GameEvent.md) | E | | + +##### Summary +Perform the server specific tasks when an event occurs + +##### Returns + + +#### EnsureServerAdded +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dvar.cs#L8) +```csharp +public async Task EnsureServerAdded() +``` + +#### GetIdForServer +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dvar.cs#L9) +```csharp +public override async Task GetIdForServer(Server server) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`Server`](../sharedlibrarycore/Server.md) | server | | + +#### ProcessUpdatesAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Events/GameEvent.cs#L286) +```csharp +public override async Task ProcessUpdatesAsync(CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `CancellationToken` | token | | + +#### Initialize +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Events/GameEvent.cs#L291) +```csharp +public async Task Initialize() +``` + +#### GenerateUriForLog +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IW4MServer.cs#L1495) +```csharp +public Uri GenerateUriForLog(string logPath, string gameLogServerUrl) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | logPath | | +| `string` | gameLogServerUrl | | + +#### GenerateLogPath +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IW4MServer.cs#L16707566) +```csharp +public static string GenerateLogPath(LogPathGeneratorInfo logInfo) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`LogPathGeneratorInfo`](application/misc/LogPathGeneratorInfo.md) | logInfo | | + +#### Warn +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Events/GameEvent.cs#L293) +```csharp +public override async Task Warn(string reason, EFClient targetClient, EFClient targetOrigin) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | reason | | +| [`EFClient`](../sharedlibrarycore/database/models/EFClient.md) | targetClient | | +| [`EFClient`](../sharedlibrarycore/database/models/EFClient.md) | targetOrigin | | + +#### Kick +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Events/GameEvent.cs#L294) +```csharp +public override async Task Kick(string reason, EFClient targetClient, EFClient originClient, EFPenalty previousPenalty) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | reason | | +| [`EFClient`](../sharedlibrarycore/database/models/EFClient.md) | targetClient | | +| [`EFClient`](../sharedlibrarycore/database/models/EFClient.md) | originClient | | +| [`EFPenalty`](../data/models/EFPenalty.md) | previousPenalty | | + +#### ExecuteCommandAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IW4MServer.cs#L1638) +```csharp +public override Task ExecuteCommandAsync(string command, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | command | | +| `CancellationToken` | token | | + +#### SetDvarAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IW4MServer.cs#L1641) +```csharp +public override Task SetDvarAsync(string name, object value, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | name | | +| `object` | value | | +| `CancellationToken` | token | | + +#### TempBan +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Events/GameEvent.cs#L295) +```csharp +public override async Task TempBan(string reason, TimeSpan length, EFClient targetClient, EFClient originClient) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | reason | | +| `TimeSpan` | length | | +| [`EFClient`](../sharedlibrarycore/database/models/EFClient.md) | targetClient | | +| [`EFClient`](../sharedlibrarycore/database/models/EFClient.md) | originClient | | + +#### Ban +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Events/GameEvent.cs#L296) +```csharp +public override async Task Ban(string reason, EFClient targetClient, EFClient originClient, bool isEvade) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | reason | | +| [`EFClient`](../sharedlibrarycore/database/models/EFClient.md) | targetClient | | +| [`EFClient`](../sharedlibrarycore/database/models/EFClient.md) | originClient | | +| `bool` | isEvade | | + +#### Unban +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Events/GameEvent.cs#L296) +```csharp +public override async Task Unban(string reason, EFClient targetClient, EFClient originClient) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | reason | | +| [`EFClient`](../sharedlibrarycore/database/models/EFClient.md) | targetClient | | +| [`EFClient`](../sharedlibrarycore/database/models/EFClient.md) | originClient | | + +#### InitializeTokens +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IW4MServer.cs#L1751) +```csharp +public override void InitializeTokens() +``` + +#### g__IsValidGamePath|35_0 +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IW4MServer.cs#L1515) +```csharp +internal static bool g__IsValidGamePath|35_0(string path) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | path | | + +### Properties +#### LegacyDatabaseId +```csharp +public override long LegacyDatabaseId { get; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/ApplicationManager.md b/CodeDocumentation/iw4madmin/application/ApplicationManager.md new file mode 100644 index 0000000..790db3d --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/ApplicationManager.md @@ -0,0 +1,397 @@ +# ApplicationManager `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application + IW4MAdmin.Application.ApplicationManager[[ApplicationManager]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IManager[[IManager]] + class SharedLibraryCore.Interfaces.IManager interfaceStyle; + end +SharedLibraryCore.Interfaces.IManager --> IW4MAdmin.Application.ApplicationManager +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `IList`<[`IEventParser`](../../sharedlibrarycore/interfaces/IEventParser.md)> | [`AdditionalEventParsers`](#additionaleventparsers) | `get` | +| `IList`<[`IRConParser`](../../sharedlibrarycore/interfaces/IRConParser.md)> | [`AdditionalRConParsers`](#additionalrconparsers) | `get` | +| [`IAlertManager`](../../sharedlibrarycore/interfaces/IAlertManager.md) | [`AlertManager`](#alertmanager) | `get` | +| `CancellationToken` | [`CancellationToken`](#cancellationtoken) | `get` | +| `IList`<`Func`<[`GameEvent`](../../sharedlibrarycore/GameEvent.md), `bool`>> | [`CommandInterceptors`](#commandinterceptors) | `get, set` | +| `IReadOnlyList`<[`IManagerCommand`](../../sharedlibrarycore/interfaces/IManagerCommand.md)> | [`Commands`](#commands) | `get` | +| `string` | [`ExternalIPAddress`](#externalipaddress) | `get, private set` | +| [`IInteractionRegistration`](../../sharedlibrarycore/interfaces/IInteractionRegistration.md) | [`InteractionRegistration`](#interactionregistration) | `get` | +| `bool` | [`IsInitialized`](#isinitialized) | `get, private set` | +| `bool` | [`IsRestartRequested`](#isrestartrequested) | `get, private set` | +| `bool` | [`IsRunning`](#isrunning) | `get, private set` | +| [`ILogger`](../../sharedlibrarycore/interfaces/ILogger.md) | [`Logger`](#logger) | `get` | +| [`IMiddlewareActionHandler`](../../sharedlibrarycore/interfaces/IMiddlewareActionHandler.md) | [`MiddlewareActionHandler`](#middlewareactionhandler) | `get` | +| `IEnumerable`<[`IPlugin`](../../sharedlibrarycore/interfaces/IPlugin.md)> | [`Plugins`](#plugins) | `get` | +| `ConcurrentDictionary`<`long`, [`GameEvent`](../../sharedlibrarycore/GameEvent.md)> | [`ProcessingEvents`](#processingevents) | `get` | +| `List`<[`Server`](../../sharedlibrarycore/Server.md)> | [`Servers`](#servers) | `get` | +| `DateTime` | [`StartTime`](#starttime) | `get, private set` | +| [`ITokenAuthentication`](../../sharedlibrarycore/interfaces/ITokenAuthentication.md) | [`TokenAuthenticator`](#tokenauthenticator) | `get` | +| `string` | [`Version`](#version) | `get` | + +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `void` | [`AddAdditionalCommand`](#addadditionalcommand)([`IManagerCommand`](../../sharedlibrarycore/interfaces/IManagerCommand.md) command) | +| `void` | [`AddEvent`](#addevent)([`GameEvent`](../../sharedlibrarycore/GameEvent.md) gameEvent) | +| `Task` | [`ExecuteEvent`](#executeevent)([`GameEvent`](../../sharedlibrarycore/GameEvent.md) newEvent) | +| `Task`<`IList`<`T`>> | [`ExecuteSharedDatabaseOperation`](#executeshareddatabaseoperation)(`string` operationName) | +| [`EFClient`](../../sharedlibrarycore/database/models/EFClient.md) | [`FindActiveClient`](#findactiveclient)([`EFClient`](../../sharedlibrarycore/database/models/EFClient.md) client) | +| [`IEventParser`](../../sharedlibrarycore/interfaces/IEventParser.md) | [`GenerateDynamicEventParser`](#generatedynamiceventparser)(`string` name) | +| [`IRConParser`](../../sharedlibrarycore/interfaces/IRConParser.md) | [`GenerateDynamicRConParser`](#generatedynamicrconparser)(`string` name) | +| `IList`<[`EFClient`](../../sharedlibrarycore/database/models/EFClient.md)> | [`GetActiveClients`](#getactiveclients)() | +| [`IConfigurationHandler`](../../sharedlibrarycore/interfaces/IConfigurationHandlerT.md)<[`ApplicationConfiguration`](../../sharedlibrarycore/configuration/ApplicationConfiguration.md)> | [`GetApplicationSettings`](#getapplicationsettings)() | +| [`ClientService`](../../sharedlibrarycore/services/ClientService.md) | [`GetClientService`](#getclientservice)() | +| `IList`<[`IManagerCommand`](../../sharedlibrarycore/interfaces/IManagerCommand.md)> | [`GetCommands`](#getcommands)() | +| [`ILogger`](../../sharedlibrarycore/interfaces/ILogger.md) | [`GetLogger`](#getlogger)(`long` serverId) | +| `IList`<[`MessageToken`](../../sharedlibrarycore/helpers/MessageToken.md)> | [`GetMessageTokens`](#getmessagetokens)() | +| [`IPageList`](../../sharedlibrarycore/interfaces/IPageList.md) | [`GetPageList`](#getpagelist)() | +| [`PenaltyService`](../../sharedlibrarycore/services/PenaltyService.md) | [`GetPenaltyService`](#getpenaltyservice)() | +| `IList`<[`Server`](../../sharedlibrarycore/Server.md)> | [`GetServers`](#getservers)() | +| `Task` | [`Init`](#init)() | +| `void` | [`QueueEvent`](#queueevent)([`CoreEvent`](../../sharedlibrarycore/events/CoreEvent.md) coreEvent) | +| `void` | [`RegisterSharedDatabaseOperation`](#registershareddatabaseoperation)(`Task`<`IList`> operation, `string` operationName) | +| `void` | [`RemoveCommandByName`](#removecommandbyname)(`string` commandName) | +| `Task` | [`Restart`](#restart)() | +| `Task` | [`Start`](#start)() | +| `Task` | [`Stop`](#stop)() | + +## Details +### Inheritance + - [ +`IManager` +](../../sharedlibrarycore/interfaces/IManager.md) + +### Constructors +#### ApplicationManager +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/ApplicationManager.cs#L58) +```csharp +public ApplicationManager(ILogger logger, IMiddlewareActionHandler actionHandler, IEnumerable commands, ITranslationLookup translationLookup, IConfigurationHandler commandConfiguration, IConfigurationHandler appConfigHandler, IGameServerInstanceFactory serverInstanceFactory, IEnumerable plugins, IParserRegexFactory parserRegexFactory, IEnumerable customParserEvents, ICoreEventHandler coreEventHandler, IScriptCommandFactory scriptCommandFactory, IDatabaseContextFactory contextFactory, IMetaRegistration metaRegistration, IScriptPluginServiceResolver scriptPluginServiceResolver, ClientService clientService, IServiceProvider serviceProvider, ChangeHistoryService changeHistoryService, ApplicationConfiguration appConfig, PenaltyService penaltyService, IAlertManager alertManager, IInteractionRegistration interactionRegistration, IEnumerable v2PLugins) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ILogger`<[`ApplicationManager`](iw4madmin/application/ApplicationManager.md)> | logger | | +| [`IMiddlewareActionHandler`](../../sharedlibrarycore/interfaces/IMiddlewareActionHandler.md) | actionHandler | | +| `IEnumerable`<[`IManagerCommand`](../../sharedlibrarycore/interfaces/IManagerCommand.md)> | commands | | +| [`ITranslationLookup`](../../sharedlibrarycore/interfaces/ITranslationLookup.md) | translationLookup | | +| [`IConfigurationHandler`](../../sharedlibrarycore/interfaces/IConfigurationHandlerT.md)<[`CommandConfiguration`](../../sharedlibrarycore/configuration/CommandConfiguration.md)> | commandConfiguration | | +| [`IConfigurationHandler`](../../sharedlibrarycore/interfaces/IConfigurationHandlerT.md)<[`ApplicationConfiguration`](../../sharedlibrarycore/configuration/ApplicationConfiguration.md)> | appConfigHandler | | +| [`IGameServerInstanceFactory`](../../sharedlibrarycore/interfaces/IGameServerInstanceFactory.md) | serverInstanceFactory | | +| `IEnumerable`<[`IPlugin`](../../sharedlibrarycore/interfaces/IPlugin.md)> | plugins | | +| [`IParserRegexFactory`](../../sharedlibrarycore/interfaces/IParserRegexFactory.md) | parserRegexFactory | | +| `IEnumerable`<[`IRegisterEvent`](../../sharedlibrarycore/interfaces/IRegisterEvent.md)> | customParserEvents | | +| [`ICoreEventHandler`](../../sharedlibrarycore/interfaces/ICoreEventHandler.md) | coreEventHandler | | +| [`IScriptCommandFactory`](../../sharedlibrarycore/interfaces/IScriptCommandFactory.md) | scriptCommandFactory | | +| [`IDatabaseContextFactory`](../../data/abstractions/IDatabaseContextFactory.md) | contextFactory | | +| [`IMetaRegistration`](../../sharedlibrarycore/interfaces/IMetaRegistration.md) | metaRegistration | | +| [`IScriptPluginServiceResolver`](../../sharedlibrarycore/interfaces/IScriptPluginServiceResolver.md) | scriptPluginServiceResolver | | +| [`ClientService`](../../sharedlibrarycore/services/ClientService.md) | clientService | | +| `IServiceProvider` | serviceProvider | | +| [`ChangeHistoryService`](../../sharedlibrarycore/services/ChangeHistoryService.md) | changeHistoryService | | +| [`ApplicationConfiguration`](../../sharedlibrarycore/configuration/ApplicationConfiguration.md) | appConfig | | +| [`PenaltyService`](../../sharedlibrarycore/services/PenaltyService.md) | penaltyService | | +| [`IAlertManager`](../../sharedlibrarycore/interfaces/IAlertManager.md) | alertManager | | +| [`IInteractionRegistration`](../../sharedlibrarycore/interfaces/IInteractionRegistration.md) | interactionRegistration | | +| `IEnumerable`<[`IPluginV2`](../../sharedlibrarycore/interfaces/IPluginV2.md)> | v2PLugins | | + +### Methods +#### ExecuteEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L106) +```csharp +public virtual async Task ExecuteEvent(GameEvent newEvent) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](../../sharedlibrarycore/GameEvent.md) | newEvent | | + +#### GetServers +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/ApplicationManager.cs#L230) +```csharp +public virtual IList GetServers() +``` + +#### GetCommands +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/ApplicationManager.cs#L235) +```csharp +public virtual IList GetCommands() +``` + +#### Init +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L110) +```csharp +public virtual async Task Init() +``` + +#### Start +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L114) +```csharp +public virtual async Task Start() +``` + +#### Stop +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L115) +```csharp +public virtual async Task Stop() +``` + +#### Restart +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L118) +```csharp +public virtual async Task Restart() +``` + +#### GetLogger +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/ApplicationManager.cs#L653) +```csharp +public virtual ILogger GetLogger(long serverId) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `long` | serverId | | + +#### GetMessageTokens +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/ApplicationManager.cs#L658) +```csharp +public virtual IList GetMessageTokens() +``` + +#### GetActiveClients +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/ApplicationManager.cs#L663) +```csharp +public virtual IList GetActiveClients() +``` + +#### FindActiveClient +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/ApplicationManager.cs#L16707566) +```csharp +public virtual EFClient FindActiveClient(EFClient client) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`EFClient`](../../sharedlibrarycore/database/models/EFClient.md) | client | | + +#### GetClientService +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/ApplicationManager.cs#L674) +```csharp +public virtual ClientService GetClientService() +``` + +#### GetPenaltyService +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/ApplicationManager.cs#L679) +```csharp +public virtual PenaltyService GetPenaltyService() +``` + +#### GetApplicationSettings +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/ApplicationManager.cs#L684) +```csharp +public virtual IConfigurationHandler GetApplicationSettings() +``` + +#### AddEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/ApplicationManager.cs#L689) +```csharp +public virtual void AddEvent(GameEvent gameEvent) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](../../sharedlibrarycore/GameEvent.md) | gameEvent | | + +#### QueueEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/ApplicationManager.cs#L694) +```csharp +public virtual void QueueEvent(CoreEvent coreEvent) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CoreEvent`](../../sharedlibrarycore/events/CoreEvent.md) | coreEvent | | + +#### GetPageList +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/ApplicationManager.cs#L699) +```csharp +public virtual IPageList GetPageList() +``` + +#### GenerateDynamicRConParser +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/ApplicationManager.cs#L704) +```csharp +public virtual IRConParser GenerateDynamicRConParser(string name) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | name | | + +#### GenerateDynamicEventParser +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/ApplicationManager.cs#L712) +```csharp +public virtual IEventParser GenerateDynamicEventParser(string name) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | name | | + +#### ExecuteSharedDatabaseOperation +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L133) +```csharp +public virtual async Task> ExecuteSharedDatabaseOperation(string operationName) +where T : +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | operationName | | + +#### RegisterSharedDatabaseOperation +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/ApplicationManager.cs#L726) +```csharp +public virtual void RegisterSharedDatabaseOperation(Task operation, string operationName) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Task`<`IList`> | operation | | +| `string` | operationName | | + +#### AddAdditionalCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/ApplicationManager.cs#L16707566) +```csharp +public virtual void AddAdditionalCommand(IManagerCommand command) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`IManagerCommand`](../../sharedlibrarycore/interfaces/IManagerCommand.md) | command | | + +#### RemoveCommandByName +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/ApplicationManager.cs#L16707566) +```csharp +public virtual void RemoveCommandByName(string commandName) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | commandName | | + +### Properties +#### Servers +```csharp +public List Servers { get; } +``` + +#### Logger +```csharp +public ILogger Logger { get; } +``` + +#### IsRunning +```csharp +public virtual bool IsRunning { get; private set; } +``` + +#### IsInitialized +```csharp +public bool IsInitialized { get; private set; } +``` + +#### StartTime +```csharp +public DateTime StartTime { get; private set; } +``` + +#### Version +```csharp +public virtual string Version { get; } +``` + +#### AdditionalRConParsers +```csharp +public virtual IList AdditionalRConParsers { get; } +``` + +#### AdditionalEventParsers +```csharp +public virtual IList AdditionalEventParsers { get; } +``` + +#### CommandInterceptors +```csharp +public IList> CommandInterceptors { get; set; } +``` + +#### TokenAuthenticator +```csharp +public virtual ITokenAuthentication TokenAuthenticator { get; } +``` + +#### CancellationToken +```csharp +public virtual CancellationToken CancellationToken { get; } +``` + +#### ExternalIPAddress +```csharp +public virtual string ExternalIPAddress { get; private set; } +``` + +#### IsRestartRequested +```csharp +public virtual bool IsRestartRequested { get; private set; } +``` + +#### MiddlewareActionHandler +```csharp +public virtual IMiddlewareActionHandler MiddlewareActionHandler { get; } +``` + +#### ProcessingEvents +```csharp +public virtual ConcurrentDictionary ProcessingEvents { get; } +``` + +#### Plugins +```csharp +public virtual IEnumerable Plugins { get; } +``` + +#### InteractionRegistration +```csharp +public virtual IInteractionRegistration InteractionRegistration { get; } +``` + +#### Commands +```csharp +public virtual IReadOnlyList Commands { get; } +``` + +#### AlertManager +```csharp +public virtual IAlertManager AlertManager { get; } +``` + +### Events +#### OnGameEventExecuted +```csharp +public event EventHandler OnGameEventExecuted +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/CoreEventHandler.md b/CodeDocumentation/iw4madmin/application/CoreEventHandler.md new file mode 100644 index 0000000..1dbaf55 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/CoreEventHandler.md @@ -0,0 +1,65 @@ +# CoreEventHandler `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application + IW4MAdmin.Application.CoreEventHandler[[CoreEventHandler]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.ICoreEventHandler[[ICoreEventHandler]] + class SharedLibraryCore.Interfaces.ICoreEventHandler interfaceStyle; + end +SharedLibraryCore.Interfaces.ICoreEventHandler --> IW4MAdmin.Application.CoreEventHandler +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `void` | [`QueueEvent`](#queueevent)([`IManager`](../../sharedlibrarycore/interfaces/IManager.md) manager, [`CoreEvent`](../../sharedlibrarycore/events/CoreEvent.md) coreEvent) | +| `void` | [`StartProcessing`](#startprocessing)(`CancellationToken` token) | + +## Details +### Inheritance + - [ +`ICoreEventHandler` +](../../sharedlibrarycore/interfaces/ICoreEventHandler.md) + +### Constructors +#### CoreEventHandler +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/CoreEventHandler.cs#L21) +```csharp +public CoreEventHandler(ILogger logger) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ILogger`<[`CoreEventHandler`](iw4madmin/application/CoreEventHandler.md)> | logger | | + +### Methods +#### QueueEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/CoreEventHandler.cs#L41) +```csharp +public virtual void QueueEvent(IManager manager, CoreEvent coreEvent) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`IManager`](../../sharedlibrarycore/interfaces/IManager.md) | manager | | +| [`CoreEvent`](../../sharedlibrarycore/events/CoreEvent.md) | coreEvent | | + +#### StartProcessing +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/CoreEventHandler.cs#L47) +```csharp +public virtual void StartProcessing(CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `CancellationToken` | token | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/Logger.md b/CodeDocumentation/iw4madmin/application/Logger.md new file mode 100644 index 0000000..1e57f99 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/Logger.md @@ -0,0 +1,109 @@ +# Logger `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application + IW4MAdmin.Application.Logger[[Logger]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.ILogger[[ILogger]] + class SharedLibraryCore.Interfaces.ILogger interfaceStyle; + end +SharedLibraryCore.Interfaces.ILogger --> IW4MAdmin.Application.Logger +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `void` | [`WriteAssert`](#writeassert)(`bool` condition, `string` msg) | +| `void` | [`WriteDebug`](#writedebug)(`string` msg) | +| `void` | [`WriteError`](#writeerror)(`string` msg) | +| `void` | [`WriteInfo`](#writeinfo)(`string` msg) | +| `void` | [`WriteVerbose`](#writeverbose)(`string` msg) | +| `void` | [`WriteWarning`](#writewarning)(`string` msg) | + +## Details +### Inheritance + - [ +`ILogger` +](../../sharedlibrarycore/interfaces/ILogger.md) + +### Constructors +#### Logger +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/Logger.cs#L12) +```csharp +public Logger(ILogger logger) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ILogger`<[`Logger`](iw4madmin/application/Logger.md)> | logger | | + +### Methods +#### WriteVerbose +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/Logger.cs#L18) +```csharp +public virtual void WriteVerbose(string msg) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | msg | | + +#### WriteDebug +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/Logger.cs#L23) +```csharp +public virtual void WriteDebug(string msg) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | msg | | + +#### WriteError +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/Logger.cs#L28) +```csharp +public virtual void WriteError(string msg) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | msg | | + +#### WriteInfo +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/Logger.cs#L33) +```csharp +public virtual void WriteInfo(string msg) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | msg | | + +#### WriteWarning +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/Logger.cs#L38) +```csharp +public virtual void WriteWarning(string msg) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | msg | | + +#### WriteAssert +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/Logger.cs#L43) +```csharp +public virtual void WriteAssert(bool condition, string msg) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `bool` | condition | | +| `string` | msg | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/PageList.md b/CodeDocumentation/iw4madmin/application/PageList.md new file mode 100644 index 0000000..3102c9a --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/PageList.md @@ -0,0 +1,56 @@ +# PageList `Internal class` + +## Description +implementatin of IPageList that supports basic + pages title and page location for webfront + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application + IW4MAdmin.Application.PageList[[PageList]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IPageList[[IPageList]] + class SharedLibraryCore.Interfaces.IPageList interfaceStyle; + end +SharedLibraryCore.Interfaces.IPageList --> IW4MAdmin.Application.PageList +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `IDictionary`<`string`, `string`> | [`Pages`](#pages)
Pages dictionary
Key = page name
Value = page location (url) | `get, set` | + +## Details +### Summary +implementatin of IPageList that supports basic + pages title and page location for webfront + +### Inheritance + - [ +`IPageList` +](../../sharedlibrarycore/interfaces/IPageList.md) + +### Constructors +#### PageList +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/PageList.cs#L21) +```csharp +public PageList() +``` + +### Properties +#### Pages +```csharp +public virtual IDictionary Pages { get; set; } +``` +##### Summary +Pages dictionary + Key = page name + Value = page location (url) + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/Program.md b/CodeDocumentation/iw4madmin/application/Program.md new file mode 100644 index 0000000..59e5949 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/Program.md @@ -0,0 +1,57 @@ +# Program `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application + IW4MAdmin.Application.Program[[Program]] + end +``` + +## Members +### Properties +#### Public Static properties +| Type | Name | Methods | +| --- | --- | --- | +| [`BuildNumber`](../../sharedlibrarycore/helpers/BuildNumber.md) | [`Version`](#version) | `get` | + +### Methods +#### Public Static methods +| Returns | Name | +| --- | --- | +| `Task` | [`Main`](#main)(`string``[]` args)
entrypoint of the application | + +## Details +### Constructors +#### Program +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L159) +```csharp +public Program() +``` + +### Methods +#### Main +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L148) +```csharp +public static async Task Main(string[] args) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string``[]` | args | | + +##### Summary +entrypoint of the application + +##### Returns + + +### Properties +#### Version +```csharp +public static BuildNumber Version { get; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/alerts/AlertExtensions.md b/CodeDocumentation/iw4madmin/application/alerts/AlertExtensions.md new file mode 100644 index 0000000..51f5397 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/alerts/AlertExtensions.md @@ -0,0 +1,105 @@ +# AlertExtensions `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Alerts + IW4MAdmin.Application.Alerts.AlertExtensions[[AlertExtensions]] + end +``` + +## Members +### Methods +#### Public Static methods +| Returns | Name | +| --- | --- | +| `AlertState` | [`BuildAlert`](#buildalert)([`EFClient`](../../../sharedlibrarycore/database/models/EFClient.md) client, `Nullable`<`AlertCategory`> type) | +| `AlertState` | [`ExpiresIn`](#expiresin)(`AlertState` state, `TimeSpan` expiration) | +| `AlertState` | [`FromClient`](#fromclient)(`AlertState` state, [`EFClient`](../../../sharedlibrarycore/database/models/EFClient.md) client) | +| `AlertState` | [`FromSource`](#fromsource)(`AlertState` state, `string` source) | +| `AlertState` | [`OfType`](#oftype)(`AlertState` state, `string` type) | +| `AlertState` | [`WithCategory`](#withcategory)(`AlertState` state, `AlertCategory` category) | +| `AlertState` | [`WithMessage`](#withmessage)(`AlertState` state, `string` message) | + +## Details +### Methods +#### BuildAlert +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Alerts/AlertExtensions.cs#L11) +```csharp +public static AlertState BuildAlert(EFClient client, Nullable type) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`EFClient`](../../../sharedlibrarycore/database/models/EFClient.md) | client | | +| `Nullable`<`AlertCategory`> | type | | + +#### WithCategory +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Alerts/AlertExtensions.cs#L20) +```csharp +public static AlertState WithCategory(AlertState state, AlertCategory category) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `AlertState` | state | | +| `AlertCategory` | category | | + +#### OfType +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Alerts/AlertExtensions.cs#L26) +```csharp +public static AlertState OfType(AlertState state, string type) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `AlertState` | state | | +| `string` | type | | + +#### WithMessage +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Interfaces/Events/IGameEventSubscriptions.cs#L90) +```csharp +public static AlertState WithMessage(AlertState state, string message) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `AlertState` | state | | +| `string` | message | | + +#### ExpiresIn +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Interfaces/Events/IGameEventSubscriptions.cs#L108) +```csharp +public static AlertState ExpiresIn(AlertState state, TimeSpan expiration) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `AlertState` | state | | +| `TimeSpan` | expiration | | + +#### FromSource +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Alerts/AlertExtensions.cs#L44) +```csharp +public static AlertState FromSource(AlertState state, string source) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `AlertState` | state | | +| `string` | source | | + +#### FromClient +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Alerts/AlertExtensions.cs#L50) +```csharp +public static AlertState FromClient(AlertState state, EFClient client) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `AlertState` | state | | +| [`EFClient`](../../../sharedlibrarycore/database/models/EFClient.md) | client | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/alerts/AlertManager.md b/CodeDocumentation/iw4madmin/application/alerts/AlertManager.md new file mode 100644 index 0000000..2fe888d --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/alerts/AlertManager.md @@ -0,0 +1,116 @@ +# AlertManager `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Alerts + IW4MAdmin.Application.Alerts.AlertManager[[AlertManager]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IAlertManager[[IAlertManager]] + class SharedLibraryCore.Interfaces.IAlertManager interfaceStyle; + end +SharedLibraryCore.Interfaces.IAlertManager --> IW4MAdmin.Application.Alerts.AlertManager +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `EventHandler`<`AlertState`> | [`OnAlertConsumed`](#onalertconsumed) | `get, set` | + +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `void` | [`AddAlert`](#addalert)(`AlertState` alert) | +| `Task` | [`Initialize`](#initialize)() | +| `void` | [`MarkAlertAsRead`](#markalertasread)(`Guid` alertId) | +| `void` | [`MarkAllAlertsAsRead`](#markallalertsasread)(`int` recipientId) | +| `void` | [`RegisterStaticAlertSource`](#registerstaticalertsource)(`Func`<`Task`<`IEnumerable`<`AlertState`>>> alertSource) | +| `IEnumerable`<`AlertState`> | [`RetrieveAlerts`](#retrievealerts)([`EFClient`](../../../sharedlibrarycore/database/models/EFClient.md) client) | + +## Details +### Inheritance + - [ +`IAlertManager` +](../../../sharedlibrarycore/interfaces/IAlertManager.md) + +### Constructors +#### AlertManager +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Alerts/AlertManager.cs#L17) +```csharp +public AlertManager(ApplicationConfiguration appConfig) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`ApplicationConfiguration`](../../../sharedlibrarycore/configuration/ApplicationConfiguration.md) | appConfig | | + +### Methods +#### Initialize +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Client/EFClientConnectionHistory.cs#L11) +```csharp +public virtual async Task Initialize() +``` + +#### RetrieveAlerts +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Alerts/AlertManager.cs#L16707566) +```csharp +public virtual IEnumerable RetrieveAlerts(EFClient client) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`EFClient`](../../../sharedlibrarycore/database/models/EFClient.md) | client | | + +#### MarkAlertAsRead +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Alerts/AlertManager.cs#L16707566) +```csharp +public virtual void MarkAlertAsRead(Guid alertId) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Guid` | alertId | | + +#### MarkAllAlertsAsRead +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Alerts/AlertManager.cs#L16707566) +```csharp +public virtual void MarkAllAlertsAsRead(int recipientId) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `int` | recipientId | | + +#### AddAlert +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Alerts/AlertManager.cs#L125) +```csharp +public virtual void AddAlert(AlertState alert) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `AlertState` | alert | | + +#### RegisterStaticAlertSource +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Alerts/AlertManager.cs#L160) +```csharp +public virtual void RegisterStaticAlertSource(Func>> alertSource) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Func`<`Task`<`IEnumerable`<`AlertState`>>> | alertSource | | + +### Properties +#### OnAlertConsumed +```csharp +public virtual EventHandler OnAlertConsumed { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/api/gamelogserver/IGameLogServer.md b/CodeDocumentation/iw4madmin/application/api/gamelogserver/IGameLogServer.md new file mode 100644 index 0000000..df9b9d4 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/api/gamelogserver/IGameLogServer.md @@ -0,0 +1,34 @@ +# IGameLogServer `Public interface` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.API.GameLogServer + IW4MAdmin.Application.API.GameLogServer.IGameLogServer[[IGameLogServer]] + class IW4MAdmin.Application.API.GameLogServer.IGameLogServer interfaceStyle; + end +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task`<[`LogInfo`](./LogInfo.md)> | [`Log`](#log)(`string` path, `string` key) | + +## Details +### Methods +#### Log +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Client/EFClient.cs#L82) +```csharp +public Task Log(string path, string key) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | path | | +| `string` | key | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/api/gamelogserver/LogInfo.md b/CodeDocumentation/iw4madmin/application/api/gamelogserver/LogInfo.md new file mode 100644 index 0000000..7f4c2ad --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/api/gamelogserver/LogInfo.md @@ -0,0 +1,52 @@ +# LogInfo `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.API.GameLogServer + IW4MAdmin.Application.API.GameLogServer.LogInfo[[LogInfo]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`Data`](#data) | `get, set` | +| `int` | [`Length`](#length) | `get, set` | +| `string` | [`NextKey`](#nextkey) | `get, set` | +| `bool` | [`Success`](#success) | `get, set` | + +## Details +### Constructors +#### LogInfo +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Client/EFClient.cs#L87) +```csharp +public LogInfo() +``` + +### Properties +#### Success +```csharp +public bool Success { get; set; } +``` + +#### Length +```csharp +public int Length { get; set; } +``` + +#### Data +```csharp +public string Data { get; set; } +``` + +#### NextKey +```csharp +public string NextKey { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/api/master/ApiInstance.md b/CodeDocumentation/iw4madmin/application/api/master/ApiInstance.md new file mode 100644 index 0000000..d05009b --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/api/master/ApiInstance.md @@ -0,0 +1,74 @@ +# ApiInstance `Public class` + +## Description +Defines the structure of the IW4MAdmin instance for the master API + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.API.Master + IW4MAdmin.Application.API.Master.ApiInstance[[ApiInstance]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`Id`](#id)
Unique ID of the instance | `get, set` | +| `List`<[`ApiServer`](./ApiServer.md)> | [`Servers`](#servers)
List of servers the instance is monitoring | `get, set` | +| `int` | [`Uptime`](#uptime)
Indicates how long the instance has been running | `get, set` | +| [`BuildNumber`](../../../../sharedlibrarycore/helpers/BuildNumber.md) | [`Version`](#version)
Specifies the version of the instance | `get, set` | +| `string` | [`WebfrontUrl`](#webfronturl)
Url IW4MAdmin is listening on | `get, set` | + +## Details +### Summary +Defines the structure of the IW4MAdmin instance for the master API + +### Constructors +#### ApiInstance +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Misc/EFInboxMessage.cs#L26) +```csharp +public ApiInstance() +``` + +### Properties +#### Id +```csharp +public string Id { get; set; } +``` +##### Summary +Unique ID of the instance + +#### Uptime +```csharp +public int Uptime { get; set; } +``` +##### Summary +Indicates how long the instance has been running + +#### Version +```csharp +public BuildNumber Version { get; set; } +``` +##### Summary +Specifies the version of the instance + +#### Servers +```csharp +public List Servers { get; set; } +``` +##### Summary +List of servers the instance is monitoring + +#### WebfrontUrl +```csharp +public string WebfrontUrl { get; set; } +``` +##### Summary +Url IW4MAdmin is listening on + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/api/master/ApiServer.md b/CodeDocumentation/iw4madmin/application/api/master/ApiServer.md new file mode 100644 index 0000000..b897caa --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/api/master/ApiServer.md @@ -0,0 +1,87 @@ +# ApiServer `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.API.Master + IW4MAdmin.Application.API.Master.ApiServer[[ApiServer]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `int` | [`ClientNum`](#clientnum) | `get, set` | +| `string` | [`Game`](#game) | `get, set` | +| `string` | [`Gametype`](#gametype) | `get, set` | +| `string` | [`Hostname`](#hostname) | `get, set` | +| `string` | [`IPAddress`](#ipaddress) | `get, set` | +| `long` | [`Id`](#id) | `get, set` | +| `string` | [`Map`](#map) | `get, set` | +| `int` | [`MaxClientNum`](#maxclientnum) | `get, set` | +| `short` | [`Port`](#port) | `get, set` | +| `string` | [`Version`](#version) | `get, set` | + +## Details +### Constructors +#### ApiServer +```csharp +public ApiServer() +``` + +### Properties +#### Id +```csharp +public long Id { get; set; } +``` + +#### IPAddress +```csharp +public string IPAddress { get; set; } +``` + +#### Port +```csharp +public short Port { get; set; } +``` + +#### Version +```csharp +public string Version { get; set; } +``` + +#### Gametype +```csharp +public string Gametype { get; set; } +``` + +#### Map +```csharp +public string Map { get; set; } +``` + +#### Game +```csharp +public string Game { get; set; } +``` + +#### Hostname +```csharp +public string Hostname { get; set; } +``` + +#### ClientNum +```csharp +public int ClientNum { get; set; } +``` + +#### MaxClientNum +```csharp +public int MaxClientNum { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/api/master/AuthenticationId.md b/CodeDocumentation/iw4madmin/application/api/master/AuthenticationId.md new file mode 100644 index 0000000..b4f2dc4 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/api/master/AuthenticationId.md @@ -0,0 +1,34 @@ +# AuthenticationId `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.API.Master + IW4MAdmin.Application.API.Master.AuthenticationId[[AuthenticationId]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`Id`](#id) | `get, set` | + +## Details +### Constructors +#### AuthenticationId +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Client/EFClient.cs#L57) +```csharp +public AuthenticationId() +``` + +### Properties +#### Id +```csharp +public string Id { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/api/master/IMasterApi.md b/CodeDocumentation/iw4madmin/application/api/master/IMasterApi.md new file mode 100644 index 0000000..5d1e611 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/api/master/IMasterApi.md @@ -0,0 +1,114 @@ +# IMasterApi `Public interface` + +## Description +Defines the capabilities of the master API + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.API.Master + IW4MAdmin.Application.API.Master.IMasterApi[[IMasterApi]] + class IW4MAdmin.Application.API.Master.IMasterApi interfaceStyle; + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`AuthorizationToken`](#authorizationtoken) | `get, set` | + +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task`<`Response`<[`ResultMessage`](./ResultMessage.md)>> | [`AddInstance`](#addinstance)([`ApiInstance`](./ApiInstance.md) instance) | +| `Task`<[`TokenId`](./TokenId.md)> | [`Authenticate`](#authenticate)([`AuthenticationId`](./AuthenticationId.md) Id) | +| `Task`<`List`<[`Layout`](../../../../sharedlibrarycore/localization/Layout.md)>> | [`GetLocalization`](#getlocalization-12)(`...`) | +| `Task`<`IEnumerable`<[`PluginSubscriptionContent`](./PluginSubscriptionContent.md)>> | [`GetPluginSubscription`](#getpluginsubscription)(`Guid` instanceId, `string` subscription_id) | +| `Task`<[`VersionInfo`](./VersionInfo.md)> | [`GetVersion`](#getversion)(`int` apiVersion) | +| `Task`<`Response`<[`ResultMessage`](./ResultMessage.md)>> | [`UpdateInstance`](#updateinstance)(`string` id, [`ApiInstance`](./ApiInstance.md) instance) | + +## Details +### Summary +Defines the capabilities of the master API + +### Methods +#### Authenticate +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Client/EFClient.cs#L74) +```csharp +public Task Authenticate(AuthenticationId Id) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`AuthenticationId`](./AuthenticationId.md) | Id | | + +#### AddInstance +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Client/EFClient.cs#L77) +```csharp +public Task> AddInstance(ApiInstance instance) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`ApiInstance`](./ApiInstance.md) | instance | | + +#### UpdateInstance +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Client/EFClient.cs#L77) +```csharp +public Task> UpdateInstance(string id, ApiInstance instance) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | id | | +| [`ApiInstance`](./ApiInstance.md) | instance | | + +#### GetVersion +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Client/EFClient.cs#L79) +```csharp +public Task GetVersion(int apiVersion) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `int` | apiVersion | | + +#### GetLocalization [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Client/EFClient.cs#L79) +```csharp +public Task> GetLocalization() +``` + +#### GetLocalization [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Client/EFClient.cs#L81) +```csharp +public Task GetLocalization(string languageTag) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | languageTag | | + +#### GetPluginSubscription +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Client/EFClient.cs#L81) +```csharp +public Task> GetPluginSubscription(Guid instanceId, string subscription_id) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Guid` | instanceId | | +| `string` | subscription_id | | + +### Properties +#### AuthorizationToken +```csharp +public string AuthorizationToken { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/api/master/PluginSubscriptionContent.md b/CodeDocumentation/iw4madmin/application/api/master/PluginSubscriptionContent.md new file mode 100644 index 0000000..7973e52 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/api/master/PluginSubscriptionContent.md @@ -0,0 +1,40 @@ +# PluginSubscriptionContent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.API.Master + IW4MAdmin.Application.API.Master.PluginSubscriptionContent[[PluginSubscriptionContent]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`Content`](#content) | `get, set` | +| [`PluginType`](../../plugin/PluginType.md) | [`Type`](#type) | `get, set` | + +## Details +### Constructors +#### PluginSubscriptionContent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Client/EFClient.cs#L72) +```csharp +public PluginSubscriptionContent() +``` + +### Properties +#### Content +```csharp +public string Content { get; set; } +``` + +#### Type +```csharp +public PluginType Type { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/api/master/ResultMessage.md b/CodeDocumentation/iw4madmin/application/api/master/ResultMessage.md new file mode 100644 index 0000000..551a20d --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/api/master/ResultMessage.md @@ -0,0 +1,34 @@ +# ResultMessage `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.API.Master + IW4MAdmin.Application.API.Master.ResultMessage[[ResultMessage]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`Message`](#message) | `get, set` | + +## Details +### Constructors +#### ResultMessage +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Client/EFClient.cs#L67) +```csharp +public ResultMessage() +``` + +### Properties +#### Message +```csharp +public string Message { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/api/master/TokenId.md b/CodeDocumentation/iw4madmin/application/api/master/TokenId.md new file mode 100644 index 0000000..d70926a --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/api/master/TokenId.md @@ -0,0 +1,34 @@ +# TokenId `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.API.Master + IW4MAdmin.Application.API.Master.TokenId[[TokenId]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`AccessToken`](#accesstoken) | `get, set` | + +## Details +### Constructors +#### TokenId +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Client/EFClient.cs#L59) +```csharp +public TokenId() +``` + +### Properties +#### AccessToken +```csharp +public string AccessToken { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/api/master/VersionInfo.md b/CodeDocumentation/iw4madmin/application/api/master/VersionInfo.md new file mode 100644 index 0000000..5358744 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/api/master/VersionInfo.md @@ -0,0 +1,40 @@ +# VersionInfo `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.API.Master + IW4MAdmin.Application.API.Master.VersionInfo[[VersionInfo]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| [`BuildNumber`](../../../../sharedlibrarycore/helpers/BuildNumber.md) | [`CurrentVersionPrerelease`](#currentversionprerelease) | `get, set` | +| [`BuildNumber`](../../../../sharedlibrarycore/helpers/BuildNumber.md) | [`CurrentVersionStable`](#currentversionstable) | `get, set` | + +## Details +### Constructors +#### VersionInfo +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Client/EFClient.cs#L66) +```csharp +public VersionInfo() +``` + +### Properties +#### CurrentVersionStable +```csharp +public BuildNumber CurrentVersionStable { get; set; } +``` + +#### CurrentVersionPrerelease +```csharp +public BuildNumber CurrentVersionPrerelease { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/commands/AddClientNoteCommand.md b/CodeDocumentation/iw4madmin/application/commands/AddClientNoteCommand.md new file mode 100644 index 0000000..084a423 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/commands/AddClientNoteCommand.md @@ -0,0 +1,55 @@ +# AddClientNoteCommand `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Commands + IW4MAdmin.Application.Commands.AddClientNoteCommand[[AddClientNoteCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> IW4MAdmin.Application.Commands.AddClientNoteCommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../../../sharedlibrarycore/GameEvent.md) gameEvent) | + +## Details +### Inheritance + - [ +`Command` +](../../../sharedlibrarycore/Command.md) + +### Constructors +#### AddClientNoteCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/AddClientNoteCommand.cs#L17) +```csharp +public AddClientNoteCommand(CommandConfiguration config, ITranslationLookup layout, IMetaServiceV2 metaService) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](../../../sharedlibrarycore/configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../../../sharedlibrarycore/interfaces/ITranslationLookup.md) | layout | | +| [`IMetaServiceV2`](../../../sharedlibrarycore/interfaces/IMetaServiceV2.md) | metaService | | + +### Methods +#### ExecuteAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Zombie/ZombieRoundClientStat.cs#L12) +```csharp +public override async Task ExecuteAsync(GameEvent gameEvent) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](../../../sharedlibrarycore/GameEvent.md) | gameEvent | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/commands/FindPlayerCommand.md b/CodeDocumentation/iw4madmin/application/commands/FindPlayerCommand.md new file mode 100644 index 0000000..9ddec2b --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/commands/FindPlayerCommand.md @@ -0,0 +1,60 @@ +# FindPlayerCommand `Public class` + +## Description +Finds player by name + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Commands + IW4MAdmin.Application.Commands.FindPlayerCommand[[FindPlayerCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> IW4MAdmin.Application.Commands.FindPlayerCommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../../../sharedlibrarycore/GameEvent.md) gameEvent) | + +## Details +### Summary +Finds player by name + +### Inheritance + - [ +`Command` +](../../../sharedlibrarycore/Command.md) + +### Constructors +#### FindPlayerCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/FindPlayerCommand.cs#L17) +```csharp +public FindPlayerCommand(CommandConfiguration config, ITranslationLookup translationLookup) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](../../../sharedlibrarycore/configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../../../sharedlibrarycore/interfaces/ITranslationLookup.md) | translationLookup | | + +### Methods +#### ExecuteAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Server/EFServer.cs#L11) +```csharp +public override async Task ExecuteAsync(GameEvent gameEvent) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](../../../sharedlibrarycore/GameEvent.md) | gameEvent | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/commands/HelpCommand.md b/CodeDocumentation/iw4madmin/application/commands/HelpCommand.md new file mode 100644 index 0000000..d3302af --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/commands/HelpCommand.md @@ -0,0 +1,60 @@ +# HelpCommand `Public class` + +## Description +Prints help information + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Commands + IW4MAdmin.Application.Commands.HelpCommand[[HelpCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> IW4MAdmin.Application.Commands.HelpCommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../../../sharedlibrarycore/GameEvent.md) gameEvent) | + +## Details +### Summary +Prints help information + +### Inheritance + - [ +`Command` +](../../../sharedlibrarycore/Command.md) + +### Constructors +#### HelpCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/HelpCommand.cs#L20) +```csharp +public HelpCommand(CommandConfiguration config, ITranslationLookup translationLookup) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](../../../sharedlibrarycore/configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../../../sharedlibrarycore/interfaces/ITranslationLookup.md) | translationLookup | | + +### Methods +#### ExecuteAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Server/EFServer.cs#L13) +```csharp +public override async Task ExecuteAsync(GameEvent gameEvent) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](../../../sharedlibrarycore/GameEvent.md) | gameEvent | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/commands/ListAdminsCommand.md b/CodeDocumentation/iw4madmin/application/commands/ListAdminsCommand.md new file mode 100644 index 0000000..67b9557 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/commands/ListAdminsCommand.md @@ -0,0 +1,76 @@ +# ListAdminsCommand `Public class` + +## Description +Lists all unmasked admins + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Commands + IW4MAdmin.Application.Commands.ListAdminsCommand[[ListAdminsCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> IW4MAdmin.Application.Commands.ListAdminsCommand +``` + +## Members +### Methods +#### Public Static methods +| Returns | Name | +| --- | --- | +| `string` | [`OnlineAdmins`](#onlineadmins)([`Server`](../../../sharedlibrarycore/Server.md) server, [`ITranslationLookup`](../../../sharedlibrarycore/interfaces/ITranslationLookup.md) lookup) | + +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../../../sharedlibrarycore/GameEvent.md) gameEvent) | + +## Details +### Summary +Lists all unmasked admins + +### Inheritance + - [ +`Command` +](../../../sharedlibrarycore/Command.md) + +### Constructors +#### ListAdminsCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/ListAdminsCommand.cs#L16) +```csharp +public ListAdminsCommand(CommandConfiguration config, ITranslationLookup translationLookup) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](../../../sharedlibrarycore/configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../../../sharedlibrarycore/interfaces/ITranslationLookup.md) | translationLookup | | + +### Methods +#### OnlineAdmins +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/ListAdminsCommand.cs#L27) +```csharp +public static string OnlineAdmins(Server server, ITranslationLookup lookup) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`Server`](../../../sharedlibrarycore/Server.md) | server | | +| [`ITranslationLookup`](../../../sharedlibrarycore/interfaces/ITranslationLookup.md) | lookup | | + +#### ExecuteAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/ListAdminsCommand.cs#L39) +```csharp +public override Task ExecuteAsync(GameEvent gameEvent) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](../../../sharedlibrarycore/GameEvent.md) | gameEvent | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/commands/ListAliasesCommand.md b/CodeDocumentation/iw4madmin/application/commands/ListAliasesCommand.md new file mode 100644 index 0000000..f089b93 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/commands/ListAliasesCommand.md @@ -0,0 +1,60 @@ +# ListAliasesCommand `Public class` + +## Description +Lists alises of specified client + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Commands + IW4MAdmin.Application.Commands.ListAliasesCommand[[ListAliasesCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> IW4MAdmin.Application.Commands.ListAliasesCommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../../../sharedlibrarycore/GameEvent.md) gameEvent) | + +## Details +### Summary +Lists alises of specified client + +### Inheritance + - [ +`Command` +](../../../sharedlibrarycore/Command.md) + +### Constructors +#### ListAliasesCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/ListAliasesCommand.cs#L18) +```csharp +public ListAliasesCommand(CommandConfiguration config, ITranslationLookup translationLookup) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](../../../sharedlibrarycore/configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../../../sharedlibrarycore/interfaces/ITranslationLookup.md) | translationLookup | | + +### Methods +#### ExecuteAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/ListAliasesCommand.cs#L37) +```csharp +public override Task ExecuteAsync(GameEvent gameEvent) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](../../../sharedlibrarycore/GameEvent.md) | gameEvent | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/commands/ListClientsCommand.md b/CodeDocumentation/iw4madmin/application/commands/ListClientsCommand.md new file mode 100644 index 0000000..a66218d --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/commands/ListClientsCommand.md @@ -0,0 +1,60 @@ +# ListClientsCommand `Public class` + +## Description +List online clients + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Commands + IW4MAdmin.Application.Commands.ListClientsCommand[[ListClientsCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> IW4MAdmin.Application.Commands.ListClientsCommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../../../sharedlibrarycore/GameEvent.md) gameEvent) | + +## Details +### Summary +List online clients + +### Inheritance + - [ +`Command` +](../../../sharedlibrarycore/Command.md) + +### Constructors +#### ListClientsCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Interfaces/IModularAssembly.cs#L8) +```csharp +public ListClientsCommand(CommandConfiguration config, ITranslationLookup translationLookup) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](../../../sharedlibrarycore/configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../../../sharedlibrarycore/interfaces/ITranslationLookup.md) | translationLookup | | + +### Methods +#### ExecuteAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Interfaces/IModularAssembly.cs#L9) +```csharp +public override Task ExecuteAsync(GameEvent gameEvent) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](../../../sharedlibrarycore/GameEvent.md) | gameEvent | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/commands/ListPluginsCommand.md b/CodeDocumentation/iw4madmin/application/commands/ListPluginsCommand.md new file mode 100644 index 0000000..561d044 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/commands/ListPluginsCommand.md @@ -0,0 +1,61 @@ +# ListPluginsCommand `Public class` + +## Description +Lists the loaded plugins + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Commands + IW4MAdmin.Application.Commands.ListPluginsCommand[[ListPluginsCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> IW4MAdmin.Application.Commands.ListPluginsCommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../../../sharedlibrarycore/GameEvent.md) gameEvent) | + +## Details +### Summary +Lists the loaded plugins + +### Inheritance + - [ +`Command` +](../../../sharedlibrarycore/Command.md) + +### Constructors +#### ListPluginsCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Interfaces/IModularAssembly.cs#L10) +```csharp +public ListPluginsCommand(CommandConfiguration config, ITranslationLookup translationLookup, IEnumerable plugins) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](../../../sharedlibrarycore/configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../../../sharedlibrarycore/interfaces/ITranslationLookup.md) | translationLookup | | +| `IEnumerable`<[`IPlugin`](../../../sharedlibrarycore/interfaces/IPlugin.md)> | plugins | | + +### Methods +#### ExecuteAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/ListPluginsCommand.cs#L30) +```csharp +public override Task ExecuteAsync(GameEvent gameEvent) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](../../../sharedlibrarycore/GameEvent.md) | gameEvent | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/commands/ListReportsCommand.md b/CodeDocumentation/iw4madmin/application/commands/ListReportsCommand.md new file mode 100644 index 0000000..d997719 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/commands/ListReportsCommand.md @@ -0,0 +1,60 @@ +# ListReportsCommand `Public class` + +## Description +List all reports on the server + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Commands + IW4MAdmin.Application.Commands.ListReportsCommand[[ListReportsCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> IW4MAdmin.Application.Commands.ListReportsCommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../../../sharedlibrarycore/GameEvent.md) gameEvent) | + +## Details +### Summary +List all reports on the server + +### Inheritance + - [ +`Command` +](../../../sharedlibrarycore/Command.md) + +### Constructors +#### ListReportsCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/ListReportsCommand.cs#L17) +```csharp +public ListReportsCommand(CommandConfiguration config, ITranslationLookup translationLookup) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](../../../sharedlibrarycore/configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../../../sharedlibrarycore/interfaces/ITranslationLookup.md) | translationLookup | | + +### Methods +#### ExecuteAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/ListReportsCommand.cs#L36) +```csharp +public override Task ExecuteAsync(GameEvent gameEvent) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](../../../sharedlibrarycore/GameEvent.md) | gameEvent | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/commands/MapAndGameTypeCommand.md b/CodeDocumentation/iw4madmin/application/commands/MapAndGameTypeCommand.md new file mode 100644 index 0000000..4203282 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/commands/MapAndGameTypeCommand.md @@ -0,0 +1,56 @@ +# MapAndGameTypeCommand `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Commands + IW4MAdmin.Application.Commands.MapAndGameTypeCommand[[MapAndGameTypeCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> IW4MAdmin.Application.Commands.MapAndGameTypeCommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../../../sharedlibrarycore/GameEvent.md) gameEvent) | + +## Details +### Inheritance + - [ +`Command` +](../../../sharedlibrarycore/Command.md) + +### Constructors +#### MapAndGameTypeCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/MapAndGameTypeCommand.cs#L22) +```csharp +public MapAndGameTypeCommand(ILogger logger, CommandConfiguration config, DefaultSettings defaultSettings, ITranslationLookup layout) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ILogger`<[`MapAndGameTypeCommand`](iw4madmin/application/commands/MapAndGameTypeCommand.md)> | logger | | +| [`CommandConfiguration`](../../../sharedlibrarycore/configuration/CommandConfiguration.md) | config | | +| [`DefaultSettings`](../../../sharedlibrarycore/configuration/DefaultSettings.md) | defaultSettings | | +| [`ITranslationLookup`](../../../sharedlibrarycore/interfaces/ITranslationLookup.md) | layout | | + +### Methods +#### ExecuteAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Server/EFServer.cs#L20) +```csharp +public override async Task ExecuteAsync(GameEvent gameEvent) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](../../../sharedlibrarycore/GameEvent.md) | gameEvent | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/commands/OfflineMessageCommand.md b/CodeDocumentation/iw4madmin/application/commands/OfflineMessageCommand.md new file mode 100644 index 0000000..9e0df25 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/commands/OfflineMessageCommand.md @@ -0,0 +1,57 @@ +# OfflineMessageCommand `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Commands + IW4MAdmin.Application.Commands.OfflineMessageCommand[[OfflineMessageCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> IW4MAdmin.Application.Commands.OfflineMessageCommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../../../sharedlibrarycore/GameEvent.md) gameEvent) | + +## Details +### Inheritance + - [ +`Command` +](../../../sharedlibrarycore/Command.md) + +### Constructors +#### OfflineMessageCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/OfflineMessageCommand.cs#L16707566) +```csharp +public OfflineMessageCommand(CommandConfiguration config, ITranslationLookup layout, IDatabaseContextFactory contextFactory, ILogger logger, IAlertManager alertManager) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](../../../sharedlibrarycore/configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../../../sharedlibrarycore/interfaces/ITranslationLookup.md) | layout | | +| [`IDatabaseContextFactory`](../../../data/abstractions/IDatabaseContextFactory.md) | contextFactory | | +| `ILogger`<[`IDatabaseContextFactory`](../../../data/abstractions/IDatabaseContextFactory.md)> | logger | | +| [`IAlertManager`](../../../sharedlibrarycore/interfaces/IAlertManager.md) | alertManager | | + +### Methods +#### ExecuteAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Server/EFServerSnapshot.cs#L11) +```csharp +public override async Task ExecuteAsync(GameEvent gameEvent) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](../../../sharedlibrarycore/GameEvent.md) | gameEvent | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/commands/PrivateMessageCommand.md b/CodeDocumentation/iw4madmin/application/commands/PrivateMessageCommand.md new file mode 100644 index 0000000..268db12 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/commands/PrivateMessageCommand.md @@ -0,0 +1,60 @@ +# PrivateMessageCommand `Public class` + +## Description +Sends a private message to another player + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Commands + IW4MAdmin.Application.Commands.PrivateMessageCommand[[PrivateMessageCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> IW4MAdmin.Application.Commands.PrivateMessageCommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../../../sharedlibrarycore/GameEvent.md) gameEvent) | + +## Details +### Summary +Sends a private message to another player + +### Inheritance + - [ +`Command` +](../../../sharedlibrarycore/Command.md) + +### Constructors +#### PrivateMessageCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/PrivateMessageCommand.cs#L15) +```csharp +public PrivateMessageCommand(CommandConfiguration config, ITranslationLookup translationLookup) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](../../../sharedlibrarycore/configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../../../sharedlibrarycore/interfaces/ITranslationLookup.md) | translationLookup | | + +### Methods +#### ExecuteAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Interfaces/IPlugin.cs#L10) +```csharp +public override Task ExecuteAsync(GameEvent gameEvent) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](../../../sharedlibrarycore/GameEvent.md) | gameEvent | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/commands/ReadMessageCommand.md b/CodeDocumentation/iw4madmin/application/commands/ReadMessageCommand.md new file mode 100644 index 0000000..c1ae20d --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/commands/ReadMessageCommand.md @@ -0,0 +1,56 @@ +# ReadMessageCommand `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Commands + IW4MAdmin.Application.Commands.ReadMessageCommand[[ReadMessageCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> IW4MAdmin.Application.Commands.ReadMessageCommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../../../sharedlibrarycore/GameEvent.md) gameEvent) | + +## Details +### Inheritance + - [ +`Command` +](../../../sharedlibrarycore/Command.md) + +### Constructors +#### ReadMessageCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/ReadMessageCommand.cs#L22) +```csharp +public ReadMessageCommand(CommandConfiguration config, ITranslationLookup layout, IDatabaseContextFactory contextFactory, ILogger logger) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](../../../sharedlibrarycore/configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../../../sharedlibrarycore/interfaces/ITranslationLookup.md) | layout | | +| [`IDatabaseContextFactory`](../../../data/abstractions/IDatabaseContextFactory.md) | contextFactory | | +| `ILogger`<[`IDatabaseContextFactory`](../../../data/abstractions/IDatabaseContextFactory.md)> | logger | | + +### Methods +#### ExecuteAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Server/EFServerSnapshot.cs#L21) +```csharp +public override async Task ExecuteAsync(GameEvent gameEvent) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](../../../sharedlibrarycore/GameEvent.md) | gameEvent | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/commands/ReportClientCommand.md b/CodeDocumentation/iw4madmin/application/commands/ReportClientCommand.md new file mode 100644 index 0000000..74410c9 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/commands/ReportClientCommand.md @@ -0,0 +1,60 @@ +# ReportClientCommand `Public class` + +## Description +Report client for given reason + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Commands + IW4MAdmin.Application.Commands.ReportClientCommand[[ReportClientCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> IW4MAdmin.Application.Commands.ReportClientCommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../../../sharedlibrarycore/GameEvent.md) commandEvent) | + +## Details +### Summary +Report client for given reason + +### Inheritance + - [ +`Command` +](../../../sharedlibrarycore/Command.md) + +### Constructors +#### ReportClientCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/ReportClientCommand.cs#L15) +```csharp +public ReportClientCommand(CommandConfiguration config, ITranslationLookup translationLookup) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](../../../sharedlibrarycore/configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../../../sharedlibrarycore/interfaces/ITranslationLookup.md) | translationLookup | | + +### Methods +#### ExecuteAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Server/EFServerSnapshot.cs#L24) +```csharp +public override async Task ExecuteAsync(GameEvent commandEvent) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](../../../sharedlibrarycore/GameEvent.md) | commandEvent | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/commands/SayAllCommand.md b/CodeDocumentation/iw4madmin/application/commands/SayAllCommand.md new file mode 100644 index 0000000..12a3ed3 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/commands/SayAllCommand.md @@ -0,0 +1,60 @@ +# SayAllCommand `Public class` + +## Description +Prints out a message to all clients on all servers + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Commands + IW4MAdmin.Application.Commands.SayAllCommand[[SayAllCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> IW4MAdmin.Application.Commands.SayAllCommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../../../sharedlibrarycore/GameEvent.md) gameEvent) | + +## Details +### Summary +Prints out a message to all clients on all servers + +### Inheritance + - [ +`Command` +](../../../sharedlibrarycore/Command.md) + +### Constructors +#### SayAllCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/SayAllCommand.cs#L15) +```csharp +public SayAllCommand(CommandConfiguration config, ITranslationLookup translationLookup) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](../../../sharedlibrarycore/configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../../../sharedlibrarycore/interfaces/ITranslationLookup.md) | translationLookup | | + +### Methods +#### ExecuteAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/SayAllCommand.cs#L34) +```csharp +public override Task ExecuteAsync(GameEvent gameEvent) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](../../../sharedlibrarycore/GameEvent.md) | gameEvent | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/commands/SayCommand.md b/CodeDocumentation/iw4madmin/application/commands/SayCommand.md new file mode 100644 index 0000000..7a9f754 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/commands/SayCommand.md @@ -0,0 +1,60 @@ +# SayCommand `Public class` + +## Description +Prints out a message to all clients on the server + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Commands + IW4MAdmin.Application.Commands.SayCommand[[SayCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> IW4MAdmin.Application.Commands.SayCommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../../../sharedlibrarycore/GameEvent.md) gameEvent) | + +## Details +### Summary +Prints out a message to all clients on the server + +### Inheritance + - [ +`Command` +](../../../sharedlibrarycore/Command.md) + +### Constructors +#### SayCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Interfaces/IPluginV2.cs#L9) +```csharp +public SayCommand(CommandConfiguration config, ITranslationLookup translationLookup) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](../../../sharedlibrarycore/configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../../../sharedlibrarycore/interfaces/ITranslationLookup.md) | translationLookup | | + +### Methods +#### ExecuteAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/SayCommand.cs#L34) +```csharp +public override Task ExecuteAsync(GameEvent gameEvent) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](../../../sharedlibrarycore/GameEvent.md) | gameEvent | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/commands/WhoAmICommand.md b/CodeDocumentation/iw4madmin/application/commands/WhoAmICommand.md new file mode 100644 index 0000000..2560b62 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/commands/WhoAmICommand.md @@ -0,0 +1,60 @@ +# WhoAmICommand `Public class` + +## Description +Prints client information + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Commands + IW4MAdmin.Application.Commands.WhoAmICommand[[WhoAmICommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> IW4MAdmin.Application.Commands.WhoAmICommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../../../sharedlibrarycore/GameEvent.md) gameEvent) | + +## Details +### Summary +Prints client information + +### Inheritance + - [ +`Command` +](../../../sharedlibrarycore/Command.md) + +### Constructors +#### WhoAmICommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/WhoAmICommand.cs#L14) +```csharp +public WhoAmICommand(CommandConfiguration config, ITranslationLookup translationLookup) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](../../../sharedlibrarycore/configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../../../sharedlibrarycore/interfaces/ITranslationLookup.md) | translationLookup | | + +### Methods +#### ExecuteAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/WhoAmICommand.cs#L25) +```csharp +public override Task ExecuteAsync(GameEvent gameEvent) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](../../../sharedlibrarycore/GameEvent.md) | gameEvent | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/commands/clienttags/AddClientTagCommand.md b/CodeDocumentation/iw4madmin/application/commands/clienttags/AddClientTagCommand.md new file mode 100644 index 0000000..f10f33d --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/commands/clienttags/AddClientTagCommand.md @@ -0,0 +1,56 @@ +# AddClientTagCommand `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Commands.ClientTags + IW4MAdmin.Application.Commands.ClientTags.AddClientTagCommand[[AddClientTagCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> IW4MAdmin.Application.Commands.ClientTags.AddClientTagCommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../../../../sharedlibrarycore/GameEvent.md) gameEvent) | + +## Details +### Inheritance + - [ +`Command` +](../../../../sharedlibrarycore/Command.md) + +### Constructors +#### AddClientTagCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/ClientTags/AddClientTagCommand.cs#L20) +```csharp +public AddClientTagCommand(ILogger commandLogger, CommandConfiguration config, ITranslationLookup layout, IMetaServiceV2 metaService) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ILogger`<[`AddClientTagCommand`](iw4madmin/application/commands/clienttags/AddClientTagCommand.md)> | commandLogger | | +| [`CommandConfiguration`](../../../../sharedlibrarycore/configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../../../../sharedlibrarycore/interfaces/ITranslationLookup.md) | layout | | +| [`IMetaServiceV2`](../../../../sharedlibrarycore/interfaces/IMetaServiceV2.md) | metaService | | + +### Methods +#### ExecuteAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Server/EFServerSnapshot.cs#L34) +```csharp +public override async Task ExecuteAsync(GameEvent gameEvent) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](../../../../sharedlibrarycore/GameEvent.md) | gameEvent | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/commands/clienttags/ListClientTags.md b/CodeDocumentation/iw4madmin/application/commands/clienttags/ListClientTags.md new file mode 100644 index 0000000..18168de --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/commands/clienttags/ListClientTags.md @@ -0,0 +1,55 @@ +# ListClientTags `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Commands.ClientTags + IW4MAdmin.Application.Commands.ClientTags.ListClientTags[[ListClientTags]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> IW4MAdmin.Application.Commands.ClientTags.ListClientTags +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../../../../sharedlibrarycore/GameEvent.md) gameEvent) | + +## Details +### Inheritance + - [ +`Command` +](../../../../sharedlibrarycore/Command.md) + +### Constructors +#### ListClientTags +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/ClientTags/ListClientTags.cs#L16) +```csharp +public ListClientTags(CommandConfiguration config, ITranslationLookup layout, IMetaServiceV2 metaService) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](../../../../sharedlibrarycore/configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../../../../sharedlibrarycore/interfaces/ITranslationLookup.md) | layout | | +| [`IMetaServiceV2`](../../../../sharedlibrarycore/interfaces/IMetaServiceV2.md) | metaService | | + +### Methods +#### ExecuteAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Server/EFServerSnapshot.cs#L36) +```csharp +public override async Task ExecuteAsync(GameEvent gameEvent) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](../../../../sharedlibrarycore/GameEvent.md) | gameEvent | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/commands/clienttags/RemoveClientTag.md b/CodeDocumentation/iw4madmin/application/commands/clienttags/RemoveClientTag.md new file mode 100644 index 0000000..09f15e2 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/commands/clienttags/RemoveClientTag.md @@ -0,0 +1,54 @@ +# RemoveClientTag `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Commands.ClientTags + IW4MAdmin.Application.Commands.ClientTags.RemoveClientTag[[RemoveClientTag]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> IW4MAdmin.Application.Commands.ClientTags.RemoveClientTag +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../../../../sharedlibrarycore/GameEvent.md) gameEvent) | + +## Details +### Inheritance + - [ +`Command` +](../../../../sharedlibrarycore/Command.md) + +### Constructors +#### RemoveClientTag +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/ClientTags/RemoveClientTagCommand.cs#L17) +```csharp +public RemoveClientTag(CommandConfiguration config, ITranslationLookup layout, IMetaServiceV2 metaService) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](../../../../sharedlibrarycore/configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../../../../sharedlibrarycore/interfaces/ITranslationLookup.md) | layout | | +| [`IMetaServiceV2`](../../../../sharedlibrarycore/interfaces/IMetaServiceV2.md) | metaService | | + +### Methods +#### ExecuteAsync +```csharp +public override async Task ExecuteAsync(GameEvent gameEvent) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](../../../../sharedlibrarycore/GameEvent.md) | gameEvent | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/commands/clienttags/SetClientTagCommand.md b/CodeDocumentation/iw4madmin/application/commands/clienttags/SetClientTagCommand.md new file mode 100644 index 0000000..b6dd11d --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/commands/clienttags/SetClientTagCommand.md @@ -0,0 +1,55 @@ +# SetClientTagCommand `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Commands.ClientTags + IW4MAdmin.Application.Commands.ClientTags.SetClientTagCommand[[SetClientTagCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> IW4MAdmin.Application.Commands.ClientTags.SetClientTagCommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../../../../sharedlibrarycore/GameEvent.md) gameEvent) | + +## Details +### Inheritance + - [ +`Command` +](../../../../sharedlibrarycore/Command.md) + +### Constructors +#### SetClientTagCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/ClientTags/SetClientTagCommand.cs#L20) +```csharp +public SetClientTagCommand(CommandConfiguration config, ITranslationLookup layout, IMetaServiceV2 metaService) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](../../../../sharedlibrarycore/configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../../../../sharedlibrarycore/interfaces/ITranslationLookup.md) | layout | | +| [`IMetaServiceV2`](../../../../sharedlibrarycore/interfaces/IMetaServiceV2.md) | metaService | | + +### Methods +#### ExecuteAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Server/EFServerStatistics.cs#L9) +```csharp +public override async Task ExecuteAsync(GameEvent gameEvent) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](../../../../sharedlibrarycore/GameEvent.md) | gameEvent | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/commands/clienttags/TagMeta.md b/CodeDocumentation/iw4madmin/application/commands/clienttags/TagMeta.md new file mode 100644 index 0000000..fad4cf9 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/commands/clienttags/TagMeta.md @@ -0,0 +1,61 @@ +# TagMeta `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Commands.ClientTags + IW4MAdmin.Application.Commands.ClientTags.TagMeta[[TagMeta]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.ILookupValue_1[[ILookupValue< TObject >]] + class SharedLibraryCore.Interfaces.ILookupValue_1 interfaceStyle; + + end +SharedLibraryCore.Interfaces.ILookupValue_1 --> IW4MAdmin.Application.Commands.ClientTags.TagMeta +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `int` | [`Id`](#id) | `get, set` | +| `int` | [`TagId`](#tagid) | `get` | +| `string` | [`TagName`](#tagname) | `get` | +| `string` | [`Value`](#value) | `get, set` | + +## Details +### Inheritance + - [`ILookupValue`](../../../../sharedlibrarycore/interfaces/ILookupValueT.md)<`string`> + +### Constructors +#### TagMeta +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Server/EFServerStatistics.cs#L14) +```csharp +public TagMeta() +``` + +### Properties +#### TagId +```csharp +public int TagId { get; } +``` + +#### TagName +```csharp +public string TagName { get; } +``` + +#### Id +```csharp +public int Id { get; set; } +``` + +#### Value +```csharp +public string Value { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/commands/clienttags/UnsetClientTagCommand.md b/CodeDocumentation/iw4madmin/application/commands/clienttags/UnsetClientTagCommand.md new file mode 100644 index 0000000..dafaf4e --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/commands/clienttags/UnsetClientTagCommand.md @@ -0,0 +1,54 @@ +# UnsetClientTagCommand `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Commands.ClientTags + IW4MAdmin.Application.Commands.ClientTags.UnsetClientTagCommand[[UnsetClientTagCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> IW4MAdmin.Application.Commands.ClientTags.UnsetClientTagCommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../../../../sharedlibrarycore/GameEvent.md) gameEvent) | + +## Details +### Inheritance + - [ +`Command` +](../../../../sharedlibrarycore/Command.md) + +### Constructors +#### UnsetClientTagCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Commands/ClientTags/UnsetClientTagCommand.cs#L16) +```csharp +public UnsetClientTagCommand(CommandConfiguration config, ITranslationLookup layout, IMetaServiceV2 metaService) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](../../../../sharedlibrarycore/configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../../../../sharedlibrarycore/interfaces/ITranslationLookup.md) | layout | | +| [`IMetaServiceV2`](../../../../sharedlibrarycore/interfaces/IMetaServiceV2.md) | metaService | | + +### Methods +#### ExecuteAsync +```csharp +public override async Task ExecuteAsync(GameEvent gameEvent) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](../../../../sharedlibrarycore/GameEvent.md) | gameEvent | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/configuration/ScriptPluginConfiguration.md b/CodeDocumentation/iw4madmin/application/configuration/ScriptPluginConfiguration.md new file mode 100644 index 0000000..1d3e6a8 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/configuration/ScriptPluginConfiguration.md @@ -0,0 +1,57 @@ +# ScriptPluginConfiguration `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Configuration + IW4MAdmin.Application.Configuration.ScriptPluginConfiguration[[ScriptPluginConfiguration]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IBaseConfiguration[[IBaseConfiguration]] + class SharedLibraryCore.Interfaces.IBaseConfiguration interfaceStyle; + end + subgraph System.Collections.Generic +System.Collections.Generic.Dictionary_2[[Dictionary]] + end +SharedLibraryCore.Interfaces.IBaseConfiguration --> IW4MAdmin.Application.Configuration.ScriptPluginConfiguration +System.Collections.Generic.Dictionary_2 --> IW4MAdmin.Application.Configuration.ScriptPluginConfiguration +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| [`IBaseConfiguration`](../../../sharedlibrarycore/interfaces/IBaseConfiguration.md) | [`Generate`](#generate)() | +| `string` | [`Name`](#name)() | + +## Details +### Inheritance + - [ +`IBaseConfiguration` +](../../../sharedlibrarycore/interfaces/IBaseConfiguration.md) + - `Dictionary`<`string`, `Dictionary`<`string`, `object`>> + +### Constructors +#### ScriptPluginConfiguration +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Zombie/ZombieRoundClientStat.cs#L11) +```csharp +public ScriptPluginConfiguration() +``` + +### Methods +#### Name +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Configuration/ScriptPluginConfiguration.cs#L8) +```csharp +public virtual string Name() +``` + +#### Generate +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Configuration/ScriptPluginConfiguration.cs#L11) +```csharp +public virtual IBaseConfiguration Generate() +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/eventparsers/BaseEventParser.md b/CodeDocumentation/iw4madmin/application/eventparsers/BaseEventParser.md new file mode 100644 index 0000000..4483495 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/eventparsers/BaseEventParser.md @@ -0,0 +1,104 @@ +# BaseEventParser `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.EventParsers + IW4MAdmin.Application.EventParsers.BaseEventParser[[BaseEventParser]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IEventParser[[IEventParser]] + class SharedLibraryCore.Interfaces.IEventParser interfaceStyle; + end +SharedLibraryCore.Interfaces.IEventParser --> IW4MAdmin.Application.EventParsers.BaseEventParser +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| [`IEventParserConfiguration`](../../../sharedlibrarycore/interfaces/IEventParserConfiguration.md) | [`Configuration`](#configuration) | `get, set` | +| `Game` | [`GameName`](#gamename) | `get, set` | +| `string` | [`Name`](#name) | `get, set` | +| `string` | [`URLProtocolFormat`](#urlprotocolformat) | `get, set` | +| `string` | [`Version`](#version) | `get, set` | + +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| [`GameEvent`](../../../sharedlibrarycore/GameEvent.md) | [`GenerateGameEvent`](#generategameevent)(`string` logLine) | +| `void` | [`RegisterCustomEvent`](#registercustomevent)(`string` eventSubtype, `string` eventTriggerValue, `Func`<`string`, [`IEventParserConfiguration`](../../../sharedlibrarycore/interfaces/IEventParserConfiguration.md), [`GameEvent`](../../../sharedlibrarycore/GameEvent.md), [`GameEvent`](../../../sharedlibrarycore/GameEvent.md)> eventModifier) | + +## Details +### Inheritance + - [ +`IEventParser` +](../../../sharedlibrarycore/interfaces/IEventParser.md) + +### Constructors +#### BaseEventParser +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/BaseEventParser.cs#L129) +```csharp +public BaseEventParser(IParserRegexFactory parserRegexFactory, ILogger logger, ApplicationConfiguration appConfig) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`IParserRegexFactory`](../../../sharedlibrarycore/interfaces/IParserRegexFactory.md) | parserRegexFactory | | +| `ILogger` | logger | | +| [`ApplicationConfiguration`](../../../sharedlibrarycore/configuration/ApplicationConfiguration.md) | appConfig | | + +### Methods +#### GenerateGameEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/BaseEventParser.cs#L138) +```csharp +public virtual GameEvent GenerateGameEvent(string logLine) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | logLine | | + +#### RegisterCustomEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/BaseEventParser.cs#L684) +```csharp +public virtual void RegisterCustomEvent(string eventSubtype, string eventTriggerValue, Func eventModifier) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | eventSubtype | | +| `string` | eventTriggerValue | | +| `Func`<`string`, [`IEventParserConfiguration`](../../../sharedlibrarycore/interfaces/IEventParserConfiguration.md), [`GameEvent`](../../../sharedlibrarycore/GameEvent.md), [`GameEvent`](../../../sharedlibrarycore/GameEvent.md)> | eventModifier | | + +### Properties +#### Configuration +```csharp +public virtual IEventParserConfiguration Configuration { get; set; } +``` + +#### Version +```csharp +public virtual string Version { get; set; } +``` + +#### GameName +```csharp +public virtual Game GameName { get; set; } +``` + +#### URLProtocolFormat +```csharp +public virtual string URLProtocolFormat { get; set; } +``` + +#### Name +```csharp +public virtual string Name { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/eventparsers/DynamicEventParser.md b/CodeDocumentation/iw4madmin/application/eventparsers/DynamicEventParser.md new file mode 100644 index 0000000..c677058 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/eventparsers/DynamicEventParser.md @@ -0,0 +1,42 @@ +# DynamicEventParser `Internal class` + +## Description +empty generic implementation of the IEventParserConfiguration + allows script plugins to generate dynamic event parsers + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.EventParsers + IW4MAdmin.Application.EventParsers.DynamicEventParser[[DynamicEventParser]] + IW4MAdmin.Application.EventParsers.BaseEventParser[[BaseEventParser]] + end +IW4MAdmin.Application.EventParsers.BaseEventParser --> IW4MAdmin.Application.EventParsers.DynamicEventParser +``` + +## Details +### Summary +empty generic implementation of the IEventParserConfiguration + allows script plugins to generate dynamic event parsers + +### Inheritance + - [ +`BaseEventParser` +](./BaseEventParser.md) + +### Constructors +#### DynamicEventParser +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/DynamicEventParser.cs#L13) +```csharp +public DynamicEventParser(IParserRegexFactory parserRegexFactory, ILogger logger, ApplicationConfiguration appConfig) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`IParserRegexFactory`](../../../sharedlibrarycore/interfaces/IParserRegexFactory.md) | parserRegexFactory | | +| `ILogger` | logger | | +| [`ApplicationConfiguration`](../../../sharedlibrarycore/configuration/ApplicationConfiguration.md) | appConfig | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/eventparsers/DynamicEventParserConfiguration.md b/CodeDocumentation/iw4madmin/application/eventparsers/DynamicEventParserConfiguration.md new file mode 100644 index 0000000..74ffe6a --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/eventparsers/DynamicEventParserConfiguration.md @@ -0,0 +1,134 @@ +# DynamicEventParserConfiguration `Internal class` + +## Description +generic implementation of the IEventParserConfiguration + allows script plugins to generate dynamic configurations + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.EventParsers + IW4MAdmin.Application.EventParsers.DynamicEventParserConfiguration[[DynamicEventParserConfiguration]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IEventParserConfiguration[[IEventParserConfiguration]] + class SharedLibraryCore.Interfaces.IEventParserConfiguration interfaceStyle; + end +SharedLibraryCore.Interfaces.IEventParserConfiguration --> IW4MAdmin.Application.EventParsers.DynamicEventParserConfiguration +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| [`ParserRegex`](../../../sharedlibrarycore/interfaces/ParserRegex.md) | [`Action`](#action) | `get, set` | +| [`ParserRegex`](../../../sharedlibrarycore/interfaces/ParserRegex.md) | [`Damage`](#damage) | `get, set` | +| `string` | [`GameDirectory`](#gamedirectory) | `get, set` | +| `NumberStyles` | [`GuidNumberStyle`](#guidnumberstyle) | `get, set` | +| [`ParserRegex`](../../../sharedlibrarycore/interfaces/ParserRegex.md) | [`Join`](#join) | `get, set` | +| [`ParserRegex`](../../../sharedlibrarycore/interfaces/ParserRegex.md) | [`JoinTeam`](#jointeam) | `get, set` | +| [`ParserRegex`](../../../sharedlibrarycore/interfaces/ParserRegex.md) | [`Kill`](#kill) | `get, set` | +| `string` | [`LocalizeText`](#localizetext) | `get, set` | +| [`ParserRegex`](../../../sharedlibrarycore/interfaces/ParserRegex.md) | [`MapChange`](#mapchange) | `get, set` | +| [`ParserRegex`](../../../sharedlibrarycore/interfaces/ParserRegex.md) | [`MapEnd`](#mapend) | `get, set` | +| [`ParserRegex`](../../../sharedlibrarycore/interfaces/ParserRegex.md) | [`Quit`](#quit) | `get, set` | +| [`ParserRegex`](../../../sharedlibrarycore/interfaces/ParserRegex.md) | [`Say`](#say) | `get, set` | +| `Dictionary`<`string`, `TeamType`> | [`TeamMapping`](#teammapping) | `get, set` | +| [`ParserRegex`](../../../sharedlibrarycore/interfaces/ParserRegex.md) | [`Time`](#time) | `get, set` | + +## Details +### Summary +generic implementation of the IEventParserConfiguration + allows script plugins to generate dynamic configurations + +### Inheritance + - [ +`IEventParserConfiguration` +](../../../sharedlibrarycore/interfaces/IEventParserConfiguration.md) + +### Constructors +#### DynamicEventParserConfiguration +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/DynamicEventParserConfiguration.cs#L27) +```csharp +public DynamicEventParserConfiguration(IParserRegexFactory parserRegexFactory) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`IParserRegexFactory`](../../../sharedlibrarycore/interfaces/IParserRegexFactory.md) | parserRegexFactory | | + +### Properties +#### GameDirectory +```csharp +public virtual string GameDirectory { get; set; } +``` + +#### Say +```csharp +public virtual ParserRegex Say { get; set; } +``` + +#### LocalizeText +```csharp +public virtual string LocalizeText { get; set; } +``` + +#### Join +```csharp +public virtual ParserRegex Join { get; set; } +``` + +#### JoinTeam +```csharp +public virtual ParserRegex JoinTeam { get; set; } +``` + +#### Quit +```csharp +public virtual ParserRegex Quit { get; set; } +``` + +#### Kill +```csharp +public virtual ParserRegex Kill { get; set; } +``` + +#### Damage +```csharp +public virtual ParserRegex Damage { get; set; } +``` + +#### Action +```csharp +public virtual ParserRegex Action { get; set; } +``` + +#### Time +```csharp +public virtual ParserRegex Time { get; set; } +``` + +#### MapChange +```csharp +public ParserRegex MapChange { get; set; } +``` + +#### MapEnd +```csharp +public ParserRegex MapEnd { get; set; } +``` + +#### GuidNumberStyle +```csharp +public virtual NumberStyles GuidNumberStyle { get; set; } +``` + +#### TeamMapping +```csharp +public Dictionary TeamMapping { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/eventparsers/ParserPatternMatcher.md b/CodeDocumentation/iw4madmin/application/eventparsers/ParserPatternMatcher.md new file mode 100644 index 0000000..e4de714 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/eventparsers/ParserPatternMatcher.md @@ -0,0 +1,75 @@ +# ParserPatternMatcher `Public class` + +## Description +implementation of the IParserPatternMatcher for windows (really it's the only implementation) + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.EventParsers + IW4MAdmin.Application.EventParsers.ParserPatternMatcher[[ParserPatternMatcher]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IParserPatternMatcher[[IParserPatternMatcher]] + class SharedLibraryCore.Interfaces.IParserPatternMatcher interfaceStyle; + end +SharedLibraryCore.Interfaces.IParserPatternMatcher --> IW4MAdmin.Application.EventParsers.ParserPatternMatcher +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `void` | [`Compile`](#compile)(`string` pattern)
compiles the pattern to be used for matching | +| [`IMatchResult`](../../../sharedlibrarycore/interfaces/IMatchResult.md) | [`Match`](#match)(`string` input)
converts input string into pattern groups | + +## Details +### Summary +implementation of the IParserPatternMatcher for windows (really it's the only implementation) + +### Inheritance + - [ +`IParserPatternMatcher` +](../../../sharedlibrarycore/interfaces/IParserPatternMatcher.md) + +### Constructors +#### ParserPatternMatcher +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Zombie/ZombieRoundClientStat.cs#L10) +```csharp +public ParserPatternMatcher() +``` + +### Methods +#### Compile +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/ParserPatternMatcher.cs#L18) +```csharp +public virtual void Compile(string pattern) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | pattern | | + +##### Summary +compiles the pattern to be used for matching + +#### Match +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/EventParsers/ParserPatternMatcher.cs#L24) +```csharp +public virtual IMatchResult Match(string input) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | input | input string | + +##### Summary +converts input string into pattern groups + +##### Returns +group matches + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/extensions/CommandExtensions.md b/CodeDocumentation/iw4madmin/application/extensions/CommandExtensions.md new file mode 100644 index 0000000..f94a10c --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/extensions/CommandExtensions.md @@ -0,0 +1,63 @@ +# CommandExtensions `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Extensions + IW4MAdmin.Application.Extensions.CommandExtensions[[CommandExtensions]] + end +``` + +## Members +### Methods +#### Public Static methods +| Returns | Name | +| --- | --- | +| `string` | [`CommandConfigNameForType`](#commandconfignamefortype)([`IManagerCommand`](../../../sharedlibrarycore/interfaces/IManagerCommand.md) command)
determines the command configuration name for given manager command | +| `IList`<[`Gametype`](../../../sharedlibrarycore/Gametype.md)> | [`FindGametype`](#findgametype)([`DefaultSettings`](../../../sharedlibrarycore/configuration/DefaultSettings.md) settings, `string` gameType, `Nullable`<`Game`> game) | +| `IList`<[`Map`](../../../sharedlibrarycore/Map.md)> | [`FindMap`](#findmap)([`Server`](../../../sharedlibrarycore/Server.md) server, `string` mapName) | + +## Details +### Methods +#### CommandConfigNameForType +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Extensions/CommandExtensions.cs#L19) +```csharp +public static string CommandConfigNameForType(IManagerCommand command) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`IManagerCommand`](../../../sharedlibrarycore/interfaces/IManagerCommand.md) | command | command to determine config name for | + +##### Summary +determines the command configuration name for given manager command + +##### Returns + + +#### FindMap +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Extensions/CommandExtensions.cs#L16707566) +```csharp +public static IList FindMap(Server server, string mapName) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`Server`](../../../sharedlibrarycore/Server.md) | server | | +| `string` | mapName | | + +#### FindGametype +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Extensions/CommandExtensions.cs#L16707566) +```csharp +public static IList FindGametype(DefaultSettings settings, string gameType, Nullable game) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`DefaultSettings`](../../../sharedlibrarycore/configuration/DefaultSettings.md) | settings | | +| `string` | gameType | | +| `Nullable`<`Game`> | game | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/extensions/ScriptPluginExtensions.md b/CodeDocumentation/iw4madmin/application/extensions/ScriptPluginExtensions.md new file mode 100644 index 0000000..cea309e --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/extensions/ScriptPluginExtensions.md @@ -0,0 +1,46 @@ +# ScriptPluginExtensions `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Extensions + IW4MAdmin.Application.Extensions.ScriptPluginExtensions[[ScriptPluginExtensions]] + end +``` + +## Members +### Methods +#### Public Static methods +| Returns | Name | +| --- | --- | +| `IEnumerable`<`object`> | [`GetClientsBasicData`](#getclientsbasicdata)(`DbSet`<[`EFClient`](../../../data/models/client/EFClient.md)> set, `int``[]` clientIds) | +| `IEnumerable`<`object`> | [`GetClientsStatData`](#getclientsstatdata)(`DbSet`<[`EFClientStatistics`](../../../data/models/client/stats/EFClientStatistics.md)> set, `int``[]` clientIds, `double` serverId) | + +## Details +### Methods +#### GetClientsBasicData +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Extensions/ScriptPluginExtensions.cs#L16707566) +```csharp +public static IEnumerable GetClientsBasicData(DbSet set, int[] clientIds) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `DbSet`<[`EFClient`](../../../data/models/client/EFClient.md)> | set | | +| `int``[]` | clientIds | | + +#### GetClientsStatData +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Extensions/ScriptPluginExtensions.cs#L16707566) +```csharp +public static IEnumerable GetClientsStatData(DbSet set, int[] clientIds, double serverId) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `DbSet`<[`EFClientStatistics`](../../../data/models/client/stats/EFClientStatistics.md)> | set | | +| `int``[]` | clientIds | | +| `double` | serverId | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/extensions/StartupExtensions.md b/CodeDocumentation/iw4madmin/application/extensions/StartupExtensions.md new file mode 100644 index 0000000..087fe48 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/extensions/StartupExtensions.md @@ -0,0 +1,45 @@ +# StartupExtensions `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Extensions + IW4MAdmin.Application.Extensions.StartupExtensions[[StartupExtensions]] + end +``` + +## Members +### Methods +#### Public Static methods +| Returns | Name | +| --- | --- | +| `IServiceCollection` | [`AddBaseLogger`](#addbaselogger)(`IServiceCollection` services, [`ApplicationConfiguration`](../../../sharedlibrarycore/configuration/ApplicationConfiguration.md) appConfig) | +| `IServiceCollection` | [`AddDatabaseContextOptions`](#adddatabasecontextoptions)(`IServiceCollection` services, [`ApplicationConfiguration`](../../../sharedlibrarycore/configuration/ApplicationConfiguration.md) appConfig) | + +## Details +### Methods +#### AddBaseLogger +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Extensions/StartupExtensions.cs#L24) +```csharp +public static IServiceCollection AddBaseLogger(IServiceCollection services, ApplicationConfiguration appConfig) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `IServiceCollection` | services | | +| [`ApplicationConfiguration`](../../../sharedlibrarycore/configuration/ApplicationConfiguration.md) | appConfig | | + +#### AddDatabaseContextOptions +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Extensions/StartupExtensions.cs#L16707566) +```csharp +public static IServiceCollection AddDatabaseContextOptions(IServiceCollection services, ApplicationConfiguration appConfig) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `IServiceCollection` | services | | +| [`ApplicationConfiguration`](../../../sharedlibrarycore/configuration/ApplicationConfiguration.md) | appConfig | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/factories/ConfigurationHandlerFactory.md b/CodeDocumentation/iw4madmin/application/factories/ConfigurationHandlerFactory.md new file mode 100644 index 0000000..40bb0ca --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/factories/ConfigurationHandlerFactory.md @@ -0,0 +1,69 @@ +# ConfigurationHandlerFactory `Public class` + +## Description +implementation of IConfigurationHandlerFactory + provides base functionality to create configuration handlers + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Factories + IW4MAdmin.Application.Factories.ConfigurationHandlerFactory[[ConfigurationHandlerFactory]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IConfigurationHandlerFactory[[IConfigurationHandlerFactory]] + class SharedLibraryCore.Interfaces.IConfigurationHandlerFactory interfaceStyle; + end +SharedLibraryCore.Interfaces.IConfigurationHandlerFactory --> IW4MAdmin.Application.Factories.ConfigurationHandlerFactory +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| [`IConfigurationHandler`](../../../sharedlibrarycore/interfaces/IConfigurationHandlerT.md)<`T`> | [`GetConfigurationHandler`](#getconfigurationhandler)(`string` name) | +| `Task`<[`IConfigurationHandler`](../../../sharedlibrarycore/interfaces/IConfigurationHandlerT.md)<`T`>> | [`GetConfigurationHandlerAsync`](#getconfigurationhandlerasync)(`string` name) | + +## Details +### Summary +implementation of IConfigurationHandlerFactory + provides base functionality to create configuration handlers + +### Inheritance + - [ +`IConfigurationHandlerFactory` +](../../../sharedlibrarycore/interfaces/IConfigurationHandlerFactory.md) + +### Constructors +#### ConfigurationHandlerFactory +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Zombie/ZombieAggregateClientStat.cs#L31) +```csharp +public ConfigurationHandlerFactory() +``` + +### Methods +#### GetConfigurationHandler +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Factories/ConfigurationHandlerFactory.cs#L20) +```csharp +public virtual IConfigurationHandler GetConfigurationHandler(string name) +where T : IBaseConfiguration +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | name | | + +#### GetConfigurationHandlerAsync +```csharp +public virtual async Task> GetConfigurationHandlerAsync(string name) +where T : IBaseConfiguration +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | name | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/factories/DatabaseContextFactory.md b/CodeDocumentation/iw4madmin/application/factories/DatabaseContextFactory.md new file mode 100644 index 0000000..deeb63b --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/factories/DatabaseContextFactory.md @@ -0,0 +1,60 @@ +# DatabaseContextFactory `Public class` + +## Description +implementation of the IDatabaseContextFactory interface + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Factories + IW4MAdmin.Application.Factories.DatabaseContextFactory[[DatabaseContextFactory]] + end + subgraph Data.Abstractions + Data.Abstractions.IDatabaseContextFactory[[IDatabaseContextFactory]] + class Data.Abstractions.IDatabaseContextFactory interfaceStyle; + end +Data.Abstractions.IDatabaseContextFactory --> IW4MAdmin.Application.Factories.DatabaseContextFactory +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| [`DatabaseContext`](../../../data/context/DatabaseContext.md) | [`CreateContext`](#createcontext)(`Nullable`<`bool`> enableTracking) | + +## Details +### Summary +implementation of the IDatabaseContextFactory interface + +### Inheritance + - [ +`IDatabaseContextFactory` +](../../../data/abstractions/IDatabaseContextFactory.md) + +### Constructors +#### DatabaseContextFactory +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Factories/DatabaseContextFactory.cs#L18) +```csharp +public DatabaseContextFactory(ApplicationConfiguration appConfig, DbContextOptions contextOptions) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`ApplicationConfiguration`](../../../sharedlibrarycore/configuration/ApplicationConfiguration.md) | appConfig | | +| `DbContextOptions` | contextOptions | | + +### Methods +#### CreateContext +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Factories/DatabaseContextFactory.cs#L30) +```csharp +public virtual DatabaseContext CreateContext(Nullable enableTracking) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Nullable`<`bool`> | enableTracking | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/factories/GameLogReaderFactory.md b/CodeDocumentation/iw4madmin/application/factories/GameLogReaderFactory.md new file mode 100644 index 0000000..4d6d5b3 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/factories/GameLogReaderFactory.md @@ -0,0 +1,54 @@ +# GameLogReaderFactory `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Factories + IW4MAdmin.Application.Factories.GameLogReaderFactory[[GameLogReaderFactory]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IGameLogReaderFactory[[IGameLogReaderFactory]] + class SharedLibraryCore.Interfaces.IGameLogReaderFactory interfaceStyle; + end +SharedLibraryCore.Interfaces.IGameLogReaderFactory --> IW4MAdmin.Application.Factories.GameLogReaderFactory +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| [`IGameLogReader`](../../../sharedlibrarycore/interfaces/IGameLogReader.md) | [`CreateGameLogReader`](#creategamelogreader)(`Uri``[]` logUris, [`IEventParser`](../../../sharedlibrarycore/interfaces/IEventParser.md) eventParser) | + +## Details +### Inheritance + - [ +`IGameLogReaderFactory` +](../../../sharedlibrarycore/interfaces/IGameLogReaderFactory.md) + +### Constructors +#### GameLogReaderFactory +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Factories/GameLogReaderFactory.cs#L13) +```csharp +public GameLogReaderFactory(IServiceProvider serviceProvider) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `IServiceProvider` | serviceProvider | | + +### Methods +#### CreateGameLogReader +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Factories/GameLogReaderFactory.cs#L19) +```csharp +public virtual IGameLogReader CreateGameLogReader(Uri[] logUris, IEventParser eventParser) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Uri``[]` | logUris | | +| [`IEventParser`](../../../sharedlibrarycore/interfaces/IEventParser.md) | eventParser | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/factories/GameServerInstanceFactory.md b/CodeDocumentation/iw4madmin/application/factories/GameServerInstanceFactory.md new file mode 100644 index 0000000..6705f7b --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/factories/GameServerInstanceFactory.md @@ -0,0 +1,71 @@ +# GameServerInstanceFactory `Internal class` + +## Description +implementation of IGameServerInstanceFactory + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Factories + IW4MAdmin.Application.Factories.GameServerInstanceFactory[[GameServerInstanceFactory]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IGameServerInstanceFactory[[IGameServerInstanceFactory]] + class SharedLibraryCore.Interfaces.IGameServerInstanceFactory interfaceStyle; + end +SharedLibraryCore.Interfaces.IGameServerInstanceFactory --> IW4MAdmin.Application.Factories.GameServerInstanceFactory +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| [`Server`](../../../sharedlibrarycore/Server.md) | [`CreateServer`](#createserver)([`ServerConfiguration`](../../../sharedlibrarycore/configuration/ServerConfiguration.md) config, [`IManager`](../../../sharedlibrarycore/interfaces/IManager.md) manager)
creates an IW4MServer instance | + +## Details +### Summary +implementation of IGameServerInstanceFactory + +### Inheritance + - [ +`IGameServerInstanceFactory` +](../../../sharedlibrarycore/interfaces/IGameServerInstanceFactory.md) + +### Constructors +#### GameServerInstanceFactory +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Factories/GameServerInstanceFactory.cs#L25) +```csharp +public GameServerInstanceFactory(ITranslationLookup translationLookup, IMetaServiceV2 metaService, IServiceProvider serviceProvider) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`ITranslationLookup`](../../../sharedlibrarycore/interfaces/ITranslationLookup.md) | translationLookup | | +| [`IMetaServiceV2`](../../../sharedlibrarycore/interfaces/IMetaServiceV2.md) | metaService | | +| `IServiceProvider` | serviceProvider | | + +##### Summary +base constructor + +### Methods +#### CreateServer +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Factories/GameServerInstanceFactory.cs#L41) +```csharp +public virtual Server CreateServer(ServerConfiguration config, IManager manager) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`ServerConfiguration`](../../../sharedlibrarycore/configuration/ServerConfiguration.md) | config | server configuration | +| [`IManager`](../../../sharedlibrarycore/interfaces/IManager.md) | manager | application manager | + +##### Summary +creates an IW4MServer instance + +##### Returns + + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/factories/ParserRegexFactory.md b/CodeDocumentation/iw4madmin/application/factories/ParserRegexFactory.md new file mode 100644 index 0000000..4372216 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/factories/ParserRegexFactory.md @@ -0,0 +1,60 @@ +# ParserRegexFactory `Public class` + +## Description +Implementation of the IParserRegexFactory + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Factories + IW4MAdmin.Application.Factories.ParserRegexFactory[[ParserRegexFactory]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IParserRegexFactory[[IParserRegexFactory]] + class SharedLibraryCore.Interfaces.IParserRegexFactory interfaceStyle; + end +SharedLibraryCore.Interfaces.IParserRegexFactory --> IW4MAdmin.Application.Factories.ParserRegexFactory +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| [`ParserRegex`](../../../sharedlibrarycore/interfaces/ParserRegex.md) | [`CreateParserRegex`](#createparserregex)()
creates a new ParserRegex instance | + +## Details +### Summary +Implementation of the IParserRegexFactory + +### Inheritance + - [ +`IParserRegexFactory` +](../../../sharedlibrarycore/interfaces/IParserRegexFactory.md) + +### Constructors +#### ParserRegexFactory +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Factories/ParserRegexFactory.cs#L15) +```csharp +public ParserRegexFactory(IServiceProvider serviceProvider) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `IServiceProvider` | serviceProvider | | + +### Methods +#### CreateParserRegex +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Factories/ParserRegexFactory.cs#L22) +```csharp +public virtual ParserRegex CreateParserRegex() +``` +##### Summary +creates a new ParserRegex instance + +##### Returns +ParserRegex instance + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/factories/RConConnectionFactory.md b/CodeDocumentation/iw4madmin/application/factories/RConConnectionFactory.md new file mode 100644 index 0000000..0cf4bcc --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/factories/RConConnectionFactory.md @@ -0,0 +1,70 @@ +# RConConnectionFactory `Internal class` + +## Description +implementation of IRConConnectionFactory + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Factories + IW4MAdmin.Application.Factories.RConConnectionFactory[[RConConnectionFactory]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IRConConnectionFactory[[IRConConnectionFactory]] + class SharedLibraryCore.Interfaces.IRConConnectionFactory interfaceStyle; + end +SharedLibraryCore.Interfaces.IRConConnectionFactory --> IW4MAdmin.Application.Factories.RConConnectionFactory +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| [`IRConConnection`](../../../sharedlibrarycore/interfaces/IRConConnection.md) | [`CreateConnection`](#createconnection)(`IPEndPoint` ipEndpoint, `string` password, `string` rconEngine)
creates an rcon connection instance | + +## Details +### Summary +implementation of IRConConnectionFactory + +### Inheritance + - [ +`IRConConnectionFactory` +](../../../sharedlibrarycore/interfaces/IRConConnectionFactory.md) + +### Constructors +#### RConConnectionFactory +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Factories/RConConnectionFactory.cs#L26) +```csharp +public RConConnectionFactory(IServiceProvider serviceProvider) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `IServiceProvider` | serviceProvider | | + +##### Summary +Base constructor + +### Methods +#### CreateConnection +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Factories/RConConnectionFactory.cs#L33) +```csharp +public virtual IRConConnection CreateConnection(IPEndPoint ipEndpoint, string password, string rconEngine) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `IPEndPoint` | ipEndpoint | ip address and port of the server | +| `string` | password | password of the server | +| `string` | rconEngine | engine to create the rcon connection to | + +##### Summary +creates an rcon connection instance + +##### Returns +instance of rcon connection + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/factories/ScriptCommandFactory.md b/CodeDocumentation/iw4madmin/application/factories/ScriptCommandFactory.md new file mode 100644 index 0000000..6a7bdf4 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/factories/ScriptCommandFactory.md @@ -0,0 +1,68 @@ +# ScriptCommandFactory `Public class` + +## Description +implementation of IScriptCommandFactory + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Factories + IW4MAdmin.Application.Factories.ScriptCommandFactory[[ScriptCommandFactory]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IScriptCommandFactory[[IScriptCommandFactory]] + class SharedLibraryCore.Interfaces.IScriptCommandFactory interfaceStyle; + end +SharedLibraryCore.Interfaces.IScriptCommandFactory --> IW4MAdmin.Application.Factories.ScriptCommandFactory +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| [`IManagerCommand`](../../../sharedlibrarycore/interfaces/IManagerCommand.md) | [`CreateScriptCommand`](#createscriptcommand)(`string` name, `string` alias, `string` description, `string` permission, `bool` isTargetRequired, `IEnumerable`<[`CommandArgument`](../../../sharedlibrarycore/commands/CommandArgument.md)> args, `Func`<[`GameEvent`](../../../sharedlibrarycore/GameEvent.md), `Task`> executeAction, `IEnumerable`<`Game`> supportedGames) | + +## Details +### Summary +implementation of IScriptCommandFactory + +### Inheritance + - [ +`IScriptCommandFactory` +](../../../sharedlibrarycore/interfaces/IScriptCommandFactory.md) + +### Constructors +#### ScriptCommandFactory +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Factories/ScriptCommandFactory.cs#L25) +```csharp +public ScriptCommandFactory(CommandConfiguration config, ITranslationLookup transLookup, IServiceProvider serviceProvider) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](../../../sharedlibrarycore/configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../../../sharedlibrarycore/interfaces/ITranslationLookup.md) | transLookup | | +| `IServiceProvider` | serviceProvider | | + +### Methods +#### CreateScriptCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Factories/ScriptCommandFactory.cs#L35) +```csharp +public virtual IManagerCommand CreateScriptCommand(string name, string alias, string description, string permission, bool isTargetRequired, IEnumerable args, Func executeAction, IEnumerable supportedGames) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | name | | +| `string` | alias | | +| `string` | description | | +| `string` | permission | | +| `bool` | isTargetRequired | | +| `IEnumerable`<[`CommandArgument`](../../../sharedlibrarycore/commands/CommandArgument.md)> | args | | +| `Func`<[`GameEvent`](../../../sharedlibrarycore/GameEvent.md), `Task`> | executeAction | | +| `IEnumerable`<`Game`> | supportedGames | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/io/BaseConfigurationHandlerV2T.md b/CodeDocumentation/iw4madmin/application/io/BaseConfigurationHandlerV2T.md new file mode 100644 index 0000000..2c388c0 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/io/BaseConfigurationHandlerV2T.md @@ -0,0 +1,94 @@ +# BaseConfigurationHandlerV2<TConfigurationType> `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.IO + IW4MAdmin.Application.IO.BaseConfigurationHandlerV2_1[[BaseConfigurationHandlerV2< TConfigurationType >]] + + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IConfigurationHandlerV2_1[[IConfigurationHandlerV2< TConfigurationType >]] + class SharedLibraryCore.Interfaces.IConfigurationHandlerV2_1 interfaceStyle; + + end +SharedLibraryCore.Interfaces.IConfigurationHandlerV2_1 --> IW4MAdmin.Application.IO.BaseConfigurationHandlerV2_1 +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`Finalize`](#finalize)() | + +#### Public methods +| Returns | Name | +| --- | --- | +| `Task`<`TConfigurationType`> | [`Get`](#get)(`string` configurationName, `TConfigurationType` defaultConfiguration) | +| `Task` | [`Set`](#set-12)(`...`) | + +## Details +### Inheritance + - [`IConfigurationHandlerV2`](../../../sharedlibrarycore/interfaces/IConfigurationHandlerV2T.md)<`TConfigurationType`> + +### Constructors +#### BaseConfigurationHandlerV2 +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IO/BaseConfigurationHandlerV2.cs#L21) +```csharp +public BaseConfigurationHandlerV2(ILogger> logger, ConfigurationWatcher watcher) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ILogger`<[`BaseConfigurationHandlerV2`](iw4madmin/application/io/BaseConfigurationHandlerV2T.md)<`TConfigurationType`>> | logger | | +| [`ConfigurationWatcher`](./ConfigurationWatcher.md) | watcher | | + +### Methods +#### Finalize +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IO/BaseConfigurationHandlerV2.cs#L45) +```csharp +protected override void Finalize() +``` + +#### Get +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Vector3.cs#L11) +```csharp +public virtual async Task Get(string configurationName, TConfigurationType defaultConfiguration) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | configurationName | | +| `TConfigurationType` | defaultConfiguration | | + +#### Set [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Vector3.cs#L11) +```csharp +public virtual async Task Set(TConfigurationType configuration) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `TConfigurationType` | configuration | | + +#### Set [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Vector3.cs#L12) +```csharp +public virtual async Task Set() +``` + +### Events +#### FileUpdated +```csharp +private event Action FileUpdated +``` + +#### Updated +```csharp +public event Action Updated +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/io/ConfigurationWatcher.md b/CodeDocumentation/iw4madmin/application/io/ConfigurationWatcher.md new file mode 100644 index 0000000..86a7539 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/io/ConfigurationWatcher.md @@ -0,0 +1,65 @@ +# ConfigurationWatcher `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.IO + IW4MAdmin.Application.IO.ConfigurationWatcher[[ConfigurationWatcher]] + end + subgraph System +System.IDisposable[[IDisposable]] + end +System.IDisposable --> IW4MAdmin.Application.IO.ConfigurationWatcher +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `void` | [`Dispose`](#dispose)() | +| `void` | [`Register`](#register)(`string` fileName, `Action`<`string`> fileUpdated) | +| `void` | [`Unregister`](#unregister)(`string` fileName) | + +## Details +### Inheritance + - `IDisposable` + +### Constructors +#### ConfigurationWatcher +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IO/ConfigurationWatcher.cs#L11) +```csharp +public ConfigurationWatcher() +``` + +### Methods +#### Dispose +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IO/ConfigurationWatcher.cs#L27) +```csharp +public virtual void Dispose() +``` + +#### Register +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IO/ConfigurationWatcher.cs#L33) +```csharp +public void Register(string fileName, Action fileUpdated) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | fileName | | +| `Action`<`string`> | fileUpdated | | + +#### Unregister +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IO/ConfigurationWatcher.cs#L43) +```csharp +public void Unregister(string fileName) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | fileName | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/io/GameLogEventDetection.md b/CodeDocumentation/iw4madmin/application/io/GameLogEventDetection.md new file mode 100644 index 0000000..66c7d8f --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/io/GameLogEventDetection.md @@ -0,0 +1,49 @@ +# GameLogEventDetection `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.IO + IW4MAdmin.Application.IO.GameLogEventDetection[[GameLogEventDetection]] + end +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`PollForChanges`](#pollforchanges)() | +| `Task` | [`UpdateLogEvents`](#updatelogevents)() | + +## Details +### Constructors +#### GameLogEventDetection +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IO/GameLogEventDetection.cs#L20) +```csharp +public GameLogEventDetection(ILogger logger, IW4MServer server, Uri[] gameLogUris, IGameLogReaderFactory gameLogReaderFactory) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ILogger`<[`GameLogEventDetection`](iw4madmin/application/io/GameLogEventDetection.md)> | logger | | +| [`IW4MServer`](../../IW4MServer.md) | server | | +| `Uri``[]` | gameLogUris | | +| [`IGameLogReaderFactory`](../../../sharedlibrarycore/interfaces/IGameLogReaderFactory.md) | gameLogReaderFactory | | + +### Methods +#### PollForChanges +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Vector3.cs#L71) +```csharp +public async Task PollForChanges() +``` + +#### UpdateLogEvents +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Vector3.cs#L83) +```csharp +public async Task UpdateLogEvents() +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/io/GameLogReader.md b/CodeDocumentation/iw4madmin/application/io/GameLogReader.md new file mode 100644 index 0000000..d032ce7 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/io/GameLogReader.md @@ -0,0 +1,75 @@ +# GameLogReader `Internal class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.IO + IW4MAdmin.Application.IO.GameLogReader[[GameLogReader]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IGameLogReader[[IGameLogReader]] + class SharedLibraryCore.Interfaces.IGameLogReader interfaceStyle; + end +SharedLibraryCore.Interfaces.IGameLogReader --> IW4MAdmin.Application.IO.GameLogReader +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `long` | [`Length`](#length) | `get` | +| `int` | [`UpdateInterval`](#updateinterval) | `get` | + +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task`<`IEnumerable`<[`GameEvent`](../../../sharedlibrarycore/GameEvent.md)>> | [`ReadEventsFromLog`](#readeventsfromlog)(`long` fileSizeDiff, `long` startPosition, [`Server`](../../../sharedlibrarycore/Server.md) server) | + +## Details +### Inheritance + - [ +`IGameLogReader` +](../../../sharedlibrarycore/interfaces/IGameLogReader.md) + +### Constructors +#### GameLogReader +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IO/GameLogReader.cs#L24) +```csharp +public GameLogReader(string logFile, IEventParser parser, ILogger logger) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | logFile | | +| [`IEventParser`](../../../sharedlibrarycore/interfaces/IEventParser.md) | parser | | +| `ILogger`<[`GameLogReader`](iw4madmin/application/io/GameLogReader.md)> | logger | | + +### Methods +#### ReadEventsFromLog +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Vector3.cs#L113) +```csharp +public virtual async Task> ReadEventsFromLog(long fileSizeDiff, long startPosition, Server server) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `long` | fileSizeDiff | | +| `long` | startPosition | | +| [`Server`](../../../sharedlibrarycore/Server.md) | server | | + +### Properties +#### Length +```csharp +public virtual long Length { get; } +``` + +#### UpdateInterval +```csharp +public virtual int UpdateInterval { get; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/io/GameLogReaderHttp.md b/CodeDocumentation/iw4madmin/application/io/GameLogReaderHttp.md new file mode 100644 index 0000000..00fc0fc --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/io/GameLogReaderHttp.md @@ -0,0 +1,81 @@ +# GameLogReaderHttp `Internal class` + +## Description +provides capability of reading log files over HTTP + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.IO + IW4MAdmin.Application.IO.GameLogReaderHttp[[GameLogReaderHttp]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IGameLogReader[[IGameLogReader]] + class SharedLibraryCore.Interfaces.IGameLogReader interfaceStyle; + end +SharedLibraryCore.Interfaces.IGameLogReader --> IW4MAdmin.Application.IO.GameLogReaderHttp +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `long` | [`Length`](#length) | `get` | +| `int` | [`UpdateInterval`](#updateinterval) | `get` | + +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task`<`IEnumerable`<[`GameEvent`](../../../sharedlibrarycore/GameEvent.md)>> | [`ReadEventsFromLog`](#readeventsfromlog)(`long` fileSizeDiff, `long` startPosition, [`Server`](../../../sharedlibrarycore/Server.md) server) | + +## Details +### Summary +provides capability of reading log files over HTTP + +### Inheritance + - [ +`IGameLogReader` +](../../../sharedlibrarycore/interfaces/IGameLogReader.md) + +### Constructors +#### GameLogReaderHttp +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IO/GameLogReaderHttp.cs#L23) +```csharp +public GameLogReaderHttp(Uri[] gameLogServerUris, IEventParser parser, ILogger logger) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Uri``[]` | gameLogServerUris | | +| [`IEventParser`](../../../sharedlibrarycore/interfaces/IEventParser.md) | parser | | +| `ILogger`<[`GameLogReaderHttp`](iw4madmin/application/io/GameLogReaderHttp.md)> | logger | | + +### Methods +#### ReadEventsFromLog +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Zombie/ZombieAggregateClientStat.cs#L11) +```csharp +public virtual async Task> ReadEventsFromLog(long fileSizeDiff, long startPosition, Server server) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `long` | fileSizeDiff | | +| `long` | startPosition | | +| [`Server`](../../../sharedlibrarycore/Server.md) | server | | + +### Properties +#### Length +```csharp +public virtual long Length { get; } +``` + +#### UpdateInterval +```csharp +public virtual int UpdateInterval { get; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/io/NetworkGameLogReader.md b/CodeDocumentation/iw4madmin/application/io/NetworkGameLogReader.md new file mode 100644 index 0000000..50fa4f4 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/io/NetworkGameLogReader.md @@ -0,0 +1,81 @@ +# NetworkGameLogReader `Internal class` + +## Description +provides capability of reading log files over udp + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.IO + IW4MAdmin.Application.IO.NetworkGameLogReader[[NetworkGameLogReader]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IGameLogReader[[IGameLogReader]] + class SharedLibraryCore.Interfaces.IGameLogReader interfaceStyle; + end +SharedLibraryCore.Interfaces.IGameLogReader --> IW4MAdmin.Application.IO.NetworkGameLogReader +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `long` | [`Length`](#length) | `get` | +| `int` | [`UpdateInterval`](#updateinterval) | `get` | + +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task`<`IEnumerable`<[`GameEvent`](../../../sharedlibrarycore/GameEvent.md)>> | [`ReadEventsFromLog`](#readeventsfromlog)(`long` fileSizeDiff, `long` startPosition, [`Server`](../../../sharedlibrarycore/Server.md) server) | + +## Details +### Summary +provides capability of reading log files over udp + +### Inheritance + - [ +`IGameLogReader` +](../../../sharedlibrarycore/interfaces/IGameLogReader.md) + +### Constructors +#### NetworkGameLogReader +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IO/NetworkGameLogReader.cs#L29) +```csharp +public NetworkGameLogReader(IReadOnlyList uris, IEventParser parser, ILogger logger) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `IReadOnlyList`<`Uri`> | uris | | +| [`IEventParser`](../../../sharedlibrarycore/interfaces/IEventParser.md) | parser | | +| `ILogger`<[`NetworkGameLogReader`](iw4madmin/application/io/NetworkGameLogReader.md)> | logger | | + +### Methods +#### ReadEventsFromLog +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IO/NetworkGameLogReader.cs#L42) +```csharp +public virtual Task> ReadEventsFromLog(long fileSizeDiff, long startPosition, Server server) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `long` | fileSizeDiff | | +| `long` | startPosition | | +| [`Server`](../../../sharedlibrarycore/Server.md) | server | | + +### Properties +#### Length +```csharp +public virtual long Length { get; } +``` + +#### UpdateInterval +```csharp +public virtual int UpdateInterval { get; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/io/NetworkLogState.md b/CodeDocumentation/iw4madmin/application/io/NetworkLogState.md new file mode 100644 index 0000000..b4ee470 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/io/NetworkLogState.md @@ -0,0 +1,81 @@ +# NetworkLogState `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.IO + IW4MAdmin.Application.IO.NetworkLogState[[NetworkLogState]] + end + subgraph System.Collections.Generic +System.Collections.Generic.Dictionary_2[[Dictionary]] + end +System.Collections.Generic.Dictionary_2 --> IW4MAdmin.Application.IO.NetworkLogState +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `bool` | [`EndPointExists`](#endpointexists)(`IPEndPoint` serverEndpoint) | +| `List`<`byte``[]`> | [`GetServerLogData`](#getserverlogdata)(`IPEndPoint` serverEndpoint) | +| `void` | [`QueueServerLogData`](#queueserverlogdata)(`IPEndPoint` serverEndpoint, `byte``[]` data) | +| [`UdpClientState`](./UdpClientState.md) | [`RegisterEndpoint`](#registerendpoint)(`IPEndPoint` serverEndpoint, `IPEndPoint` localEndpoint) | + +## Details +### Inheritance + - `Dictionary`<`IPEndPoint`, [`UdpClientState`](./UdpClientState.md)> + +### Constructors +#### NetworkLogState +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/Zombie/ZombieAggregateClientStat.cs#L23) +```csharp +public NetworkLogState() +``` + +### Methods +#### RegisterEndpoint +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IO/NetworkLogState.cs#L12) +```csharp +public UdpClientState RegisterEndpoint(IPEndPoint serverEndpoint, IPEndPoint localEndpoint) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `IPEndPoint` | serverEndpoint | | +| `IPEndPoint` | localEndpoint | | + +#### GetServerLogData +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IO/NetworkLogState.cs#L37) +```csharp +public List GetServerLogData(IPEndPoint serverEndpoint) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `IPEndPoint` | serverEndpoint | | + +#### QueueServerLogData +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IO/NetworkLogState.cs#L16707566) +```csharp +public void QueueServerLogData(IPEndPoint serverEndpoint, byte[] data) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `IPEndPoint` | serverEndpoint | | +| `byte``[]` | data | | + +#### EndPointExists +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IO/NetworkLogState.cs#L104) +```csharp +public bool EndPointExists(IPEndPoint serverEndpoint) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `IPEndPoint` | serverEndpoint | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/io/UdpClientState.md b/CodeDocumentation/iw4madmin/application/io/UdpClientState.md new file mode 100644 index 0000000..168ae61 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/io/UdpClientState.md @@ -0,0 +1,59 @@ +# UdpClientState `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.IO + IW4MAdmin.Application.IO.UdpClientState[[UdpClientState]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `Queue`<`byte``[]`> | [`AvailableLogData`](#availablelogdata) | `get` | +| `UdpClient` | [`Client`](#client) | `get, set` | +| `SemaphoreSlim` | [`OnAction`](#onaction) | `get` | + +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`Finalize`](#finalize)() | + +## Details +### Constructors +#### UdpClientState +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IO/NetworkLogState.cs#L130) +```csharp +public UdpClientState() +``` + +### Methods +#### Finalize +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/IO/NetworkLogState.cs#L134) +```csharp +protected override void Finalize() +``` + +### Properties +#### Client +```csharp +public UdpClient Client { get; set; } +``` + +#### AvailableLogData +```csharp +public Queue AvailableLogData { get; } +``` + +#### OnAction +```csharp +public SemaphoreSlim OnAction { get; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/localization/Configure.md b/CodeDocumentation/iw4madmin/application/localization/Configure.md new file mode 100644 index 0000000..b982112 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/localization/Configure.md @@ -0,0 +1,34 @@ +# Configure `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Localization + IW4MAdmin.Application.Localization.Configure[[Configure]] + end +``` + +## Members +### Methods +#### Public Static methods +| Returns | Name | +| --- | --- | +| [`ITranslationLookup`](../../../sharedlibrarycore/interfaces/ITranslationLookup.md) | [`Initialize`](#initialize)(`ILogger` logger, [`IMasterApi`](../api/master/IMasterApi.md) apiInstance, [`ApplicationConfiguration`](../../../sharedlibrarycore/configuration/ApplicationConfiguration.md) applicationConfiguration) | + +## Details +### Methods +#### Initialize +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Localization/Configure.cs#L18) +```csharp +public static ITranslationLookup Initialize(ILogger logger, IMasterApi apiInstance, ApplicationConfiguration applicationConfiguration) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ILogger` | logger | | +| [`IMasterApi`](../api/master/IMasterApi.md) | apiInstance | | +| [`ApplicationConfiguration`](../../../sharedlibrarycore/configuration/ApplicationConfiguration.md) | applicationConfiguration | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/meta/AdministeredPenaltyResourceQueryHelper.md b/CodeDocumentation/iw4madmin/application/meta/AdministeredPenaltyResourceQueryHelper.md new file mode 100644 index 0000000..000cf4b --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/meta/AdministeredPenaltyResourceQueryHelper.md @@ -0,0 +1,61 @@ +# AdministeredPenaltyResourceQueryHelper `Public class` + +## Description +implementation of IResourceQueryHelper + query helper that retrieves administered penalties for provided client id + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Meta + IW4MAdmin.Application.Meta.AdministeredPenaltyResourceQueryHelper[[AdministeredPenaltyResourceQueryHelper]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IResourceQueryHelper_2[[IResourceQueryHelper< QueryType,ResultType >]] + class SharedLibraryCore.Interfaces.IResourceQueryHelper_2 interfaceStyle; + + end +SharedLibraryCore.Interfaces.IResourceQueryHelper_2 --> IW4MAdmin.Application.Meta.AdministeredPenaltyResourceQueryHelper +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task`<[`ResourceQueryHelperResult`](../../../sharedlibrarycore/helpers/ResourceQueryHelperResultT.md)<[`AdministeredPenaltyResponse`](../../../sharedlibrarycore/dtos/meta/responses/AdministeredPenaltyResponse.md)>> | [`QueryResource`](#queryresource)([`ClientPaginationRequest`](../../../sharedlibrarycore/queryhelper/ClientPaginationRequest.md) query) | + +## Details +### Summary +implementation of IResourceQueryHelper + query helper that retrieves administered penalties for provided client id + +### Inheritance + - [`IResourceQueryHelper`](../../../sharedlibrarycore/interfaces/IResourceQueryHelperTT.md)<[`ClientPaginationRequest`](../../../sharedlibrarycore/queryhelper/ClientPaginationRequest.md), [`AdministeredPenaltyResponse`](../../../sharedlibrarycore/dtos/meta/responses/AdministeredPenaltyResponse.md)> + +### Constructors +#### AdministeredPenaltyResourceQueryHelper +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Meta/AdministeredPenaltyResourceQueryHelper.cs#L24) +```csharp +public AdministeredPenaltyResourceQueryHelper(ILogger logger, IDatabaseContextFactory contextFactory) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ILogger`<[`AdministeredPenaltyResourceQueryHelper`](iw4madmin/application/meta/AdministeredPenaltyResourceQueryHelper.md)> | logger | | +| [`IDatabaseContextFactory`](../../../data/abstractions/IDatabaseContextFactory.md) | contextFactory | | + +### Methods +#### QueryResource +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFPenalty.cs#L48) +```csharp +public virtual async Task> QueryResource(ClientPaginationRequest query) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`ClientPaginationRequest`](../../../sharedlibrarycore/queryhelper/ClientPaginationRequest.md) | query | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/meta/ConnectionsResourceQueryHelper.md b/CodeDocumentation/iw4madmin/application/meta/ConnectionsResourceQueryHelper.md new file mode 100644 index 0000000..e6ebcc6 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/meta/ConnectionsResourceQueryHelper.md @@ -0,0 +1,53 @@ +# ConnectionsResourceQueryHelper `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Meta + IW4MAdmin.Application.Meta.ConnectionsResourceQueryHelper[[ConnectionsResourceQueryHelper]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IResourceQueryHelper_2[[IResourceQueryHelper< QueryType,ResultType >]] + class SharedLibraryCore.Interfaces.IResourceQueryHelper_2 interfaceStyle; + + end +SharedLibraryCore.Interfaces.IResourceQueryHelper_2 --> IW4MAdmin.Application.Meta.ConnectionsResourceQueryHelper +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task`<[`ResourceQueryHelperResult`](../../../sharedlibrarycore/helpers/ResourceQueryHelperResultT.md)<[`ConnectionHistoryResponse`](../../../sharedlibrarycore/dtos/meta/responses/ConnectionHistoryResponse.md)>> | [`QueryResource`](#queryresource)([`ClientPaginationRequest`](../../../sharedlibrarycore/queryhelper/ClientPaginationRequest.md) query) | + +## Details +### Inheritance + - [`IResourceQueryHelper`](../../../sharedlibrarycore/interfaces/IResourceQueryHelperTT.md)<[`ClientPaginationRequest`](../../../sharedlibrarycore/queryhelper/ClientPaginationRequest.md), [`ConnectionHistoryResponse`](../../../sharedlibrarycore/dtos/meta/responses/ConnectionHistoryResponse.md)> + +### Constructors +#### ConnectionsResourceQueryHelper +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Meta/ConnectionsResourceQueryHelper.cs#L20) +```csharp +public ConnectionsResourceQueryHelper(ILogger logger, IDatabaseContextFactory contextFactory) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ILogger`<[`ConnectionsResourceQueryHelper`](iw4madmin/application/meta/ConnectionsResourceQueryHelper.md)> | logger | | +| [`IDatabaseContextFactory`](../../../data/abstractions/IDatabaseContextFactory.md) | contextFactory | | + +### Methods +#### QueryResource +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFPenalty.cs#L49) +```csharp +public virtual async Task> QueryResource(ClientPaginationRequest query) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`ClientPaginationRequest`](../../../sharedlibrarycore/queryhelper/ClientPaginationRequest.md) | query | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/meta/MetaRegistration.md b/CodeDocumentation/iw4madmin/application/meta/MetaRegistration.md new file mode 100644 index 0000000..b80e0fd --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/meta/MetaRegistration.md @@ -0,0 +1,57 @@ +# MetaRegistration `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Meta + IW4MAdmin.Application.Meta.MetaRegistration[[MetaRegistration]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IMetaRegistration[[IMetaRegistration]] + class SharedLibraryCore.Interfaces.IMetaRegistration interfaceStyle; + end +SharedLibraryCore.Interfaces.IMetaRegistration --> IW4MAdmin.Application.Meta.MetaRegistration +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `void` | [`Register`](#register)() | + +## Details +### Inheritance + - [ +`IMetaRegistration` +](../../../sharedlibrarycore/interfaces/IMetaRegistration.md) + +### Constructors +#### MetaRegistration +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Meta/MetaRegistration.cs#L34) +```csharp +public MetaRegistration(ILogger logger, IMetaServiceV2 metaService, ITranslationLookup transLookup, IEntityService clientEntityService, IResourceQueryHelper receivedPenaltyHelper, IResourceQueryHelper administeredPenaltyHelper, IResourceQueryHelper updatedAliasHelper, IResourceQueryHelper connectionHistoryHelper, IResourceQueryHelper permissionLevelHelper) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ILogger`<[`MetaRegistration`](iw4madmin/application/meta/MetaRegistration.md)> | logger | | +| [`IMetaServiceV2`](../../../sharedlibrarycore/interfaces/IMetaServiceV2.md) | metaService | | +| [`ITranslationLookup`](../../../sharedlibrarycore/interfaces/ITranslationLookup.md) | transLookup | | +| [`IEntityService`](../../../sharedlibrarycore/interfaces/IEntityServiceT.md)<[`EFClient`](../../../sharedlibrarycore/database/models/EFClient.md)> | clientEntityService | | +| [`IResourceQueryHelper`](../../../sharedlibrarycore/interfaces/IResourceQueryHelperTT.md)<[`ClientPaginationRequest`](../../../sharedlibrarycore/queryhelper/ClientPaginationRequest.md), [`ReceivedPenaltyResponse`](../../../sharedlibrarycore/dtos/meta/responses/ReceivedPenaltyResponse.md)> | receivedPenaltyHelper | | +| [`IResourceQueryHelper`](../../../sharedlibrarycore/interfaces/IResourceQueryHelperTT.md)<[`ClientPaginationRequest`](../../../sharedlibrarycore/queryhelper/ClientPaginationRequest.md), [`AdministeredPenaltyResponse`](../../../sharedlibrarycore/dtos/meta/responses/AdministeredPenaltyResponse.md)> | administeredPenaltyHelper | | +| [`IResourceQueryHelper`](../../../sharedlibrarycore/interfaces/IResourceQueryHelperTT.md)<[`ClientPaginationRequest`](../../../sharedlibrarycore/queryhelper/ClientPaginationRequest.md), [`UpdatedAliasResponse`](../../../sharedlibrarycore/dtos/meta/responses/UpdatedAliasResponse.md)> | updatedAliasHelper | | +| [`IResourceQueryHelper`](../../../sharedlibrarycore/interfaces/IResourceQueryHelperTT.md)<[`ClientPaginationRequest`](../../../sharedlibrarycore/queryhelper/ClientPaginationRequest.md), [`ConnectionHistoryResponse`](../../../sharedlibrarycore/dtos/meta/responses/ConnectionHistoryResponse.md)> | connectionHistoryHelper | | +| [`IResourceQueryHelper`](../../../sharedlibrarycore/interfaces/IResourceQueryHelperTT.md)<[`ClientPaginationRequest`](../../../sharedlibrarycore/queryhelper/ClientPaginationRequest.md), [`PermissionLevelChangedResponse`](../../../sharedlibrarycore/dtos/meta/responses/PermissionLevelChangedResponse.md)> | permissionLevelHelper | | + +### Methods +#### Register +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Meta/MetaRegistration.cs#L54) +```csharp +public virtual void Register() +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/meta/PermissionLevelChangedResourceQueryHelper.md b/CodeDocumentation/iw4madmin/application/meta/PermissionLevelChangedResourceQueryHelper.md new file mode 100644 index 0000000..7cc4df5 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/meta/PermissionLevelChangedResourceQueryHelper.md @@ -0,0 +1,52 @@ +# PermissionLevelChangedResourceQueryHelper `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Meta + IW4MAdmin.Application.Meta.PermissionLevelChangedResourceQueryHelper[[PermissionLevelChangedResourceQueryHelper]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IResourceQueryHelper_2[[IResourceQueryHelper< QueryType,ResultType >]] + class SharedLibraryCore.Interfaces.IResourceQueryHelper_2 interfaceStyle; + + end +SharedLibraryCore.Interfaces.IResourceQueryHelper_2 --> IW4MAdmin.Application.Meta.PermissionLevelChangedResourceQueryHelper +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task`<[`ResourceQueryHelperResult`](../../../sharedlibrarycore/helpers/ResourceQueryHelperResultT.md)<[`PermissionLevelChangedResponse`](../../../sharedlibrarycore/dtos/meta/responses/PermissionLevelChangedResponse.md)>> | [`QueryResource`](#queryresource)([`ClientPaginationRequest`](../../../sharedlibrarycore/queryhelper/ClientPaginationRequest.md) query) | + +## Details +### Inheritance + - [`IResourceQueryHelper`](../../../sharedlibrarycore/interfaces/IResourceQueryHelperTT.md)<[`ClientPaginationRequest`](../../../sharedlibrarycore/queryhelper/ClientPaginationRequest.md), [`PermissionLevelChangedResponse`](../../../sharedlibrarycore/dtos/meta/responses/PermissionLevelChangedResponse.md)> + +### Constructors +#### PermissionLevelChangedResourceQueryHelper +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Meta/PermissionLevelChangedResourceQueryHelper.cs#L19) +```csharp +public PermissionLevelChangedResourceQueryHelper(IDatabaseContextFactory contextFactory) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`IDatabaseContextFactory`](../../../data/abstractions/IDatabaseContextFactory.md) | contextFactory | | + +### Methods +#### QueryResource +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFPenaltyIdentifier.cs#L21) +```csharp +public virtual async Task> QueryResource(ClientPaginationRequest query) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`ClientPaginationRequest`](../../../sharedlibrarycore/queryhelper/ClientPaginationRequest.md) | query | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/meta/ReceivedPenaltyResourceQueryHelper.md b/CodeDocumentation/iw4madmin/application/meta/ReceivedPenaltyResourceQueryHelper.md new file mode 100644 index 0000000..bb84cd8 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/meta/ReceivedPenaltyResourceQueryHelper.md @@ -0,0 +1,61 @@ +# ReceivedPenaltyResourceQueryHelper `Public class` + +## Description +implementation of IResourceQueryHelper + used to pull in penalties applied to a given client id + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Meta + IW4MAdmin.Application.Meta.ReceivedPenaltyResourceQueryHelper[[ReceivedPenaltyResourceQueryHelper]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IResourceQueryHelper_2[[IResourceQueryHelper< QueryType,ResultType >]] + class SharedLibraryCore.Interfaces.IResourceQueryHelper_2 interfaceStyle; + + end +SharedLibraryCore.Interfaces.IResourceQueryHelper_2 --> IW4MAdmin.Application.Meta.ReceivedPenaltyResourceQueryHelper +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task`<[`ResourceQueryHelperResult`](../../../sharedlibrarycore/helpers/ResourceQueryHelperResultT.md)<[`ReceivedPenaltyResponse`](../../../sharedlibrarycore/dtos/meta/responses/ReceivedPenaltyResponse.md)>> | [`QueryResource`](#queryresource)([`ClientPaginationRequest`](../../../sharedlibrarycore/queryhelper/ClientPaginationRequest.md) query) | + +## Details +### Summary +implementation of IResourceQueryHelper + used to pull in penalties applied to a given client id + +### Inheritance + - [`IResourceQueryHelper`](../../../sharedlibrarycore/interfaces/IResourceQueryHelperTT.md)<[`ClientPaginationRequest`](../../../sharedlibrarycore/queryhelper/ClientPaginationRequest.md), [`ReceivedPenaltyResponse`](../../../sharedlibrarycore/dtos/meta/responses/ReceivedPenaltyResponse.md)> + +### Constructors +#### ReceivedPenaltyResourceQueryHelper +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Meta/ReceivedPenaltyResourceQueryHelper.cs#L30) +```csharp +public ReceivedPenaltyResourceQueryHelper(ILogger logger, IDatabaseContextFactory contextFactory, ApplicationConfiguration appConfig) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ILogger`<[`ReceivedPenaltyResourceQueryHelper`](iw4madmin/application/meta/ReceivedPenaltyResourceQueryHelper.md)> | logger | | +| [`IDatabaseContextFactory`](../../../data/abstractions/IDatabaseContextFactory.md) | contextFactory | | +| [`ApplicationConfiguration`](../../../sharedlibrarycore/configuration/ApplicationConfiguration.md) | appConfig | | + +### Methods +#### QueryResource +```csharp +public virtual async Task> QueryResource(ClientPaginationRequest query) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`ClientPaginationRequest`](../../../sharedlibrarycore/queryhelper/ClientPaginationRequest.md) | query | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/meta/UpdatedAliasResourceQueryHelper.md b/CodeDocumentation/iw4madmin/application/meta/UpdatedAliasResourceQueryHelper.md new file mode 100644 index 0000000..1ac797e --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/meta/UpdatedAliasResourceQueryHelper.md @@ -0,0 +1,61 @@ +# UpdatedAliasResourceQueryHelper `Public class` + +## Description +implementation if IResrouceQueryHerlp + used to pull alias changes for given client id + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Meta + IW4MAdmin.Application.Meta.UpdatedAliasResourceQueryHelper[[UpdatedAliasResourceQueryHelper]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IResourceQueryHelper_2[[IResourceQueryHelper< QueryType,ResultType >]] + class SharedLibraryCore.Interfaces.IResourceQueryHelper_2 interfaceStyle; + + end +SharedLibraryCore.Interfaces.IResourceQueryHelper_2 --> IW4MAdmin.Application.Meta.UpdatedAliasResourceQueryHelper +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task`<[`ResourceQueryHelperResult`](../../../sharedlibrarycore/helpers/ResourceQueryHelperResultT.md)<[`UpdatedAliasResponse`](../../../sharedlibrarycore/dtos/meta/responses/UpdatedAliasResponse.md)>> | [`QueryResource`](#queryresource)([`ClientPaginationRequest`](../../../sharedlibrarycore/queryhelper/ClientPaginationRequest.md) query) | + +## Details +### Summary +implementation if IResrouceQueryHerlp + used to pull alias changes for given client id + +### Inheritance + - [`IResourceQueryHelper`](../../../sharedlibrarycore/interfaces/IResourceQueryHelperTT.md)<[`ClientPaginationRequest`](../../../sharedlibrarycore/queryhelper/ClientPaginationRequest.md), [`UpdatedAliasResponse`](../../../sharedlibrarycore/dtos/meta/responses/UpdatedAliasResponse.md)> + +### Constructors +#### UpdatedAliasResourceQueryHelper +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Meta/UpdatedAliasResourceQueryHelper.cs#L24) +```csharp +public UpdatedAliasResourceQueryHelper(ILogger logger, IDatabaseContextFactory contextFactory) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ILogger`<[`UpdatedAliasResourceQueryHelper`](iw4madmin/application/meta/UpdatedAliasResourceQueryHelper.md)> | logger | | +| [`IDatabaseContextFactory`](../../../data/abstractions/IDatabaseContextFactory.md) | contextFactory | | + +### Methods +#### QueryResource +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/SharedEntity.cs#L13) +```csharp +public virtual async Task> QueryResource(ClientPaginationRequest query) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`ClientPaginationRequest`](../../../sharedlibrarycore/queryhelper/ClientPaginationRequest.md) | query | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/migration/ConfigurationMigration.md b/CodeDocumentation/iw4madmin/application/migration/ConfigurationMigration.md new file mode 100644 index 0000000..4cc16cb --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/migration/ConfigurationMigration.md @@ -0,0 +1,77 @@ +# ConfigurationMigration `Internal class` + +## Description +helps facilitate the migration of configs from one version and or location + to another + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Migration + IW4MAdmin.Application.Migration.ConfigurationMigration[[ConfigurationMigration]] + end +``` + +## Members +### Methods +#### Public Static methods +| Returns | Name | +| --- | --- | +| `void` | [`CheckDirectories`](#checkdirectories)()
ensures required directories are created | +| `void` | [`ModifyLogPath020919`](#modifylogpath020919)([`ServerConfiguration`](../../../sharedlibrarycore/configuration/ServerConfiguration.md) config) | +| `void` | [`MoveConfigFolder10518`](#moveconfigfolder10518)(`ILogger` log)
moves existing configs from the root folder into a configs folder | +| `void` | [`RemoveObsoletePlugins20210322`](#removeobsoleteplugins20210322)() | + +## Details +### Summary +helps facilitate the migration of configs from one version and or location + to another + +### Constructors +#### ConfigurationMigration +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFPenalty.cs#L45) +```csharp +public ConfigurationMigration() +``` + +### Methods +#### CheckDirectories +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Migration/ConfigurationMigration.cs#L19) +```csharp +public static void CheckDirectories() +``` +##### Summary +ensures required directories are created + +#### MoveConfigFolder10518 +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Migration/ConfigurationMigration.cs#L45) +```csharp +public static void MoveConfigFolder10518(ILogger log) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ILogger` | log | | + +##### Summary +moves existing configs from the root folder into a configs folder + +#### ModifyLogPath020919 +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Migration/ConfigurationMigration.cs#L81) +```csharp +public static void ModifyLogPath020919(ServerConfiguration config) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`ServerConfiguration`](../../../sharedlibrarycore/configuration/ServerConfiguration.md) | config | | + +#### RemoveObsoletePlugins20210322 +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Migration/ConfigurationMigration.cs#L90) +```csharp +public static void RemoveObsoletePlugins20210322() +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/migration/DatabaseHousekeeping.md b/CodeDocumentation/iw4madmin/application/migration/DatabaseHousekeeping.md new file mode 100644 index 0000000..7e47974 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/migration/DatabaseHousekeeping.md @@ -0,0 +1,33 @@ +# DatabaseHousekeeping `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Migration + IW4MAdmin.Application.Migration.DatabaseHousekeeping[[DatabaseHousekeeping]] + end +``` + +## Members +### Methods +#### Public Static methods +| Returns | Name | +| --- | --- | +| `Task` | [`RemoveOldRatings`](#removeoldratings)([`IDatabaseContextFactory`](../../../data/abstractions/IDatabaseContextFactory.md) contextFactory, `CancellationToken` token) | + +## Details +### Methods +#### RemoveOldRatings +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFPenalty.cs#L46) +```csharp +public static async Task RemoveOldRatings(IDatabaseContextFactory contextFactory, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`IDatabaseContextFactory`](../../../data/abstractions/IDatabaseContextFactory.md) | contextFactory | | +| `CancellationToken` | token | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/misc/AsyncResult.md b/CodeDocumentation/iw4madmin/application/misc/AsyncResult.md new file mode 100644 index 0000000..875f843 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/misc/AsyncResult.md @@ -0,0 +1,59 @@ +# AsyncResult `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Misc + IW4MAdmin.Application.Misc.AsyncResult[[AsyncResult]] + end + subgraph System +System.IAsyncResult[[IAsyncResult]] + end +System.IAsyncResult --> IW4MAdmin.Application.Misc.AsyncResult +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `object` | [`AsyncState`](#asyncstate) | `get, set` | +| `WaitHandle` | [`AsyncWaitHandle`](#asyncwaithandle) | `get, set` | +| `bool` | [`CompletedSynchronously`](#completedsynchronously) | `get, set` | +| `bool` | [`IsCompleted`](#iscompleted) | `get, set` | + +## Details +### Inheritance + - `IAsyncResult` + +### Constructors +#### AsyncResult +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L100) +```csharp +public AsyncResult() +``` + +### Properties +#### AsyncState +```csharp +public object AsyncState { get; set; } +``` + +#### AsyncWaitHandle +```csharp +public WaitHandle AsyncWaitHandle { get; set; } +``` + +#### CompletedSynchronously +```csharp +public bool CompletedSynchronously { get; set; } +``` + +#### IsCompleted +```csharp +public bool IsCompleted { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/misc/BaseConfigurationHandlerT.md b/CodeDocumentation/iw4madmin/application/misc/BaseConfigurationHandlerT.md new file mode 100644 index 0000000..7a564a4 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/misc/BaseConfigurationHandlerT.md @@ -0,0 +1,122 @@ +# BaseConfigurationHandler<T> `Public class` + +## Description +default implementation of IConfigurationHandler + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IBaseConfiguration[[IBaseConfiguration]] + class SharedLibraryCore.Interfaces.IBaseConfiguration interfaceStyle; + SharedLibraryCore.Interfaces.IConfigurationHandler_1[[IConfigurationHandler< T >]] + class SharedLibraryCore.Interfaces.IConfigurationHandler_1 interfaceStyle; + SharedLibraryCore.Interfaces.IConfigurationHandler_1T((T)); + SharedLibraryCore.Interfaces.IConfigurationHandler_1 -- where --o SharedLibraryCore.Interfaces.IConfigurationHandler_1T +SharedLibraryCore.Interfaces.IBaseConfiguration --> SharedLibraryCore.Interfaces.IConfigurationHandler_1T + + end + subgraph IW4MAdmin.Application.Misc + IW4MAdmin.Application.Misc.BaseConfigurationHandler_1[[BaseConfigurationHandler< T >]] + IW4MAdmin.Application.Misc.BaseConfigurationHandler_1T((T)); + IW4MAdmin.Application.Misc.BaseConfigurationHandler_1 -- where --o IW4MAdmin.Application.Misc.BaseConfigurationHandler_1T +SharedLibraryCore.Interfaces.IBaseConfiguration --> IW4MAdmin.Application.Misc.BaseConfigurationHandler_1T + + end +SharedLibraryCore.Interfaces.IConfigurationHandler_1 --> IW4MAdmin.Application.Misc.BaseConfigurationHandler_1 +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`FileName`](#filename) | `get` | + +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`Finalize`](#finalize)() | + +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`BuildAsync`](#buildasync)() | +| `T` | [`Configuration`](#configuration)() | +| `Task` | [`Save`](#save)() | +| `void` | [`Set`](#set)(`T` config) | + +## Details +### Summary +default implementation of IConfigurationHandler + +### Generic types +| Type | Description | Constraints | +| --- | --- | --- | +| `T` | base configuration type | [`IBaseConfiguration`](../../../sharedlibrarycore/interfaces/IBaseConfiguration.md) | + +### Inheritance + - [`IConfigurationHandler`](../../../sharedlibrarycore/interfaces/IConfigurationHandlerT.md)<`T`> + +### Constructors +#### BaseConfigurationHandler [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/BaseConfigurationHandler.cs#L25) +```csharp +public BaseConfigurationHandler(string fileName) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | fileName | | + +#### BaseConfigurationHandler [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/BaseConfigurationHandler.cs#L37) +```csharp +public BaseConfigurationHandler() +``` + +### Methods +#### Finalize +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/BaseConfigurationHandler.cs#L42) +```csharp +protected override void Finalize() +``` + +#### BuildAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L109) +```csharp +public virtual async Task BuildAsync() +``` + +#### Save +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L111) +```csharp +public virtual async Task Save() +``` + +#### Configuration +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/BaseConfigurationHandler.cs#L101) +```csharp +public virtual T Configuration() +``` + +#### Set +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/BaseConfigurationHandler.cs#L106) +```csharp +public virtual void Set(T config) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `T` | config | | + +### Properties +#### FileName +```csharp +public virtual string FileName { get; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/misc/ClientEntityConverter.md b/CodeDocumentation/iw4madmin/application/misc/ClientEntityConverter.md new file mode 100644 index 0000000..91b4ada --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/misc/ClientEntityConverter.md @@ -0,0 +1,73 @@ +# ClientEntityConverter `Internal class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Misc + IW4MAdmin.Application.Misc.ClientEntityConverter[[ClientEntityConverter]] + end + subgraph Newtonsoft.Json +Newtonsoft.Json.JsonConverter[[JsonConverter]] + end +Newtonsoft.Json.JsonConverter --> IW4MAdmin.Application.Misc.ClientEntityConverter +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `bool` | [`CanConvert`](#canconvert)(`Type` objectType) | +| `object` | [`ReadJson`](#readjson)(`JsonReader` reader, `Type` objectType, `object` existingValue, `JsonSerializer` serializer) | +| `void` | [`WriteJson`](#writejson)(`JsonWriter` writer, `object` value, `JsonSerializer` serializer) | + +## Details +### Inheritance + - `JsonConverter` + +### Constructors +#### ClientEntityConverter +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFMeta.cs#L33) +```csharp +public ClientEntityConverter() +``` + +### Methods +#### CanConvert +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/SerializationHelpers.cs#L58) +```csharp +public override bool CanConvert(Type objectType) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Type` | objectType | | + +#### ReadJson +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/SerializationHelpers.cs#L61) +```csharp +public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `JsonReader` | reader | | +| `Type` | objectType | | +| `object` | existingValue | | +| `JsonSerializer` | serializer | | + +#### WriteJson +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/SerializationHelpers.cs#L83) +```csharp +public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `JsonWriter` | writer | | +| `object` | value | | +| `JsonSerializer` | serializer | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/misc/ClientNoticeMessageFormatter.md b/CodeDocumentation/iw4madmin/application/misc/ClientNoticeMessageFormatter.md new file mode 100644 index 0000000..f7f88e0 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/misc/ClientNoticeMessageFormatter.md @@ -0,0 +1,62 @@ +# ClientNoticeMessageFormatter `Public class` + +## Description +implementation of IClientNoticeMessageFormatter + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Misc + IW4MAdmin.Application.Misc.ClientNoticeMessageFormatter[[ClientNoticeMessageFormatter]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IClientNoticeMessageFormatter[[IClientNoticeMessageFormatter]] + class SharedLibraryCore.Interfaces.IClientNoticeMessageFormatter interfaceStyle; + end +SharedLibraryCore.Interfaces.IClientNoticeMessageFormatter --> IW4MAdmin.Application.Misc.ClientNoticeMessageFormatter +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `string` | [`BuildFormattedMessage`](#buildformattedmessage)([`IRConParserConfiguration`](../../../sharedlibrarycore/interfaces/IRConParserConfiguration.md) config, [`EFPenalty`](../../../data/models/EFPenalty.md) currentPenalty, [`EFPenalty`](../../../data/models/EFPenalty.md) originalPenalty) | + +## Details +### Summary +implementation of IClientNoticeMessageFormatter + +### Inheritance + - [ +`IClientNoticeMessageFormatter` +](../../../sharedlibrarycore/interfaces/IClientNoticeMessageFormatter.md) + +### Constructors +#### ClientNoticeMessageFormatter +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/ClientNoticeMessageFormatter.cs#L20) +```csharp +public ClientNoticeMessageFormatter(ITranslationLookup transLookup, ApplicationConfiguration appConfig) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`ITranslationLookup`](../../../sharedlibrarycore/interfaces/ITranslationLookup.md) | transLookup | | +| [`ApplicationConfiguration`](../../../sharedlibrarycore/configuration/ApplicationConfiguration.md) | appConfig | | + +### Methods +#### BuildFormattedMessage +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/ClientNoticeMessageFormatter.cs#L27) +```csharp +public virtual string BuildFormattedMessage(IRConParserConfiguration config, EFPenalty currentPenalty, EFPenalty originalPenalty) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`IRConParserConfiguration`](../../../sharedlibrarycore/interfaces/IRConParserConfiguration.md) | config | | +| [`EFPenalty`](../../../data/models/EFPenalty.md) | currentPenalty | | +| [`EFPenalty`](../../../data/models/EFPenalty.md) | originalPenalty | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/misc/GameEventConverter.md b/CodeDocumentation/iw4madmin/application/misc/GameEventConverter.md new file mode 100644 index 0000000..7714f8f --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/misc/GameEventConverter.md @@ -0,0 +1,73 @@ +# GameEventConverter `Internal class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Misc + IW4MAdmin.Application.Misc.GameEventConverter[[GameEventConverter]] + end + subgraph Newtonsoft.Json +Newtonsoft.Json.JsonConverter[[JsonConverter]] + end +Newtonsoft.Json.JsonConverter --> IW4MAdmin.Application.Misc.GameEventConverter +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `bool` | [`CanConvert`](#canconvert)(`Type` objectType) | +| `object` | [`ReadJson`](#readjson)(`JsonReader` reader, `Type` objectType, `object` existingValue, `JsonSerializer` serializer) | +| `void` | [`WriteJson`](#writejson)(`JsonWriter` writer, `object` value, `JsonSerializer` serializer) | + +## Details +### Inheritance + - `JsonConverter` + +### Constructors +#### GameEventConverter +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFMeta.cs#L37) +```csharp +public GameEventConverter() +``` + +### Methods +#### CanConvert +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/SerializationHelpers.cs#L100) +```csharp +public override bool CanConvert(Type objectType) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Type` | objectType | | + +#### ReadJson +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/SerializationHelpers.cs#L103) +```csharp +public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `JsonReader` | reader | | +| `Type` | objectType | | +| `object` | existingValue | | +| `JsonSerializer` | serializer | | + +#### WriteJson +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/SerializationHelpers.cs#L126) +```csharp +public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `JsonWriter` | writer | | +| `object` | value | | +| `JsonSerializer` | serializer | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/misc/GeoLocationResult.md b/CodeDocumentation/iw4madmin/application/misc/GeoLocationResult.md new file mode 100644 index 0000000..8a34fa2 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/misc/GeoLocationResult.md @@ -0,0 +1,74 @@ +# GeoLocationResult `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Misc + IW4MAdmin.Application.Misc.GeoLocationResult[[GeoLocationResult]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IGeoLocationResult[[IGeoLocationResult]] + class SharedLibraryCore.Interfaces.IGeoLocationResult interfaceStyle; + end +SharedLibraryCore.Interfaces.IGeoLocationResult --> IW4MAdmin.Application.Misc.GeoLocationResult +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`ASN`](#asn) | `get, set` | +| `string` | [`Country`](#country) | `get, set` | +| `string` | [`CountryCode`](#countrycode) | `get, set` | +| `string` | [`Organization`](#organization) | `get, set` | +| `string` | [`Region`](#region) | `get, set` | +| `string` | [`Timezone`](#timezone) | `get, set` | + +## Details +### Inheritance + - [ +`IGeoLocationResult` +](../../../sharedlibrarycore/interfaces/IGeoLocationResult.md) + +### Constructors +#### GeoLocationResult +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L246) +```csharp +public GeoLocationResult() +``` + +### Properties +#### Country +```csharp +public virtual string Country { get; set; } +``` + +#### CountryCode +```csharp +public virtual string CountryCode { get; set; } +``` + +#### Region +```csharp +public virtual string Region { get; set; } +``` + +#### ASN +```csharp +public virtual string ASN { get; set; } +``` + +#### Timezone +```csharp +public virtual string Timezone { get; set; } +``` + +#### Organization +```csharp +public virtual string Organization { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/misc/GeoLocationService.md b/CodeDocumentation/iw4madmin/application/misc/GeoLocationService.md new file mode 100644 index 0000000..d0b10b1 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/misc/GeoLocationService.md @@ -0,0 +1,53 @@ +# GeoLocationService `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Misc + IW4MAdmin.Application.Misc.GeoLocationService[[GeoLocationService]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IGeoLocationService[[IGeoLocationService]] + class SharedLibraryCore.Interfaces.IGeoLocationService interfaceStyle; + end +SharedLibraryCore.Interfaces.IGeoLocationService --> IW4MAdmin.Application.Misc.GeoLocationService +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task`<[`IGeoLocationResult`](../../../sharedlibrarycore/interfaces/IGeoLocationResult.md)> | [`Locate`](#locate)(`string` address) | + +## Details +### Inheritance + - [ +`IGeoLocationService` +](../../../sharedlibrarycore/interfaces/IGeoLocationService.md) + +### Constructors +#### GeoLocationService +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/GeoLocationService.cs#L13) +```csharp +public GeoLocationService(string sourceAddress) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | sourceAddress | | + +### Methods +#### Locate +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/GeoLocationService.cs#L19) +```csharp +public virtual Task Locate(string address) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | address | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/misc/IPAddressConverter.md b/CodeDocumentation/iw4madmin/application/misc/IPAddressConverter.md new file mode 100644 index 0000000..f562661 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/misc/IPAddressConverter.md @@ -0,0 +1,73 @@ +# IPAddressConverter `Internal class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Misc + IW4MAdmin.Application.Misc.IPAddressConverter[[IPAddressConverter]] + end + subgraph Newtonsoft.Json +Newtonsoft.Json.JsonConverter[[JsonConverter]] + end +Newtonsoft.Json.JsonConverter --> IW4MAdmin.Application.Misc.IPAddressConverter +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `bool` | [`CanConvert`](#canconvert)(`Type` objectType) | +| `object` | [`ReadJson`](#readjson)(`JsonReader` reader, `Type` objectType, `object` existingValue, `JsonSerializer` serializer) | +| `void` | [`WriteJson`](#writejson)(`JsonWriter` writer, `object` value, `JsonSerializer` serializer) | + +## Details +### Inheritance + - `JsonConverter` + +### Constructors +#### IPAddressConverter +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFMeta.cs#L22) +```csharp +public IPAddressConverter() +``` + +### Methods +#### CanConvert +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/SerializationHelpers.cs#L16) +```csharp +public override bool CanConvert(Type objectType) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Type` | objectType | | + +#### WriteJson +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/SerializationHelpers.cs#L21) +```csharp +public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `JsonWriter` | writer | | +| `object` | value | | +| `JsonSerializer` | serializer | | + +#### ReadJson +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/SerializationHelpers.cs#L26) +```csharp +public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `JsonReader` | reader | | +| `Type` | objectType | | +| `object` | existingValue | | +| `JsonSerializer` | serializer | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/misc/IPEndPointConverter.md b/CodeDocumentation/iw4madmin/application/misc/IPEndPointConverter.md new file mode 100644 index 0000000..e25e46f --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/misc/IPEndPointConverter.md @@ -0,0 +1,73 @@ +# IPEndPointConverter `Internal class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Misc + IW4MAdmin.Application.Misc.IPEndPointConverter[[IPEndPointConverter]] + end + subgraph Newtonsoft.Json +Newtonsoft.Json.JsonConverter[[JsonConverter]] + end +Newtonsoft.Json.JsonConverter --> IW4MAdmin.Application.Misc.IPEndPointConverter +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `bool` | [`CanConvert`](#canconvert)(`Type` objectType) | +| `object` | [`ReadJson`](#readjson)(`JsonReader` reader, `Type` objectType, `object` existingValue, `JsonSerializer` serializer) | +| `void` | [`WriteJson`](#writejson)(`JsonWriter` writer, `object` value, `JsonSerializer` serializer) | + +## Details +### Inheritance + - `JsonConverter` + +### Constructors +#### IPEndPointConverter +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFMeta.cs#L30) +```csharp +public IPEndPointConverter() +``` + +### Methods +#### CanConvert +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/SerializationHelpers.cs#L34) +```csharp +public override bool CanConvert(Type objectType) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Type` | objectType | | + +#### WriteJson +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/SerializationHelpers.cs#L39) +```csharp +public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `JsonWriter` | writer | | +| `object` | value | | +| `JsonSerializer` | serializer | | + +#### ReadJson +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/SerializationHelpers.cs#L48) +```csharp +public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `JsonReader` | reader | | +| `Type` | objectType | | +| `object` | existingValue | | +| `JsonSerializer` | serializer | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/misc/InteractionRegistration.md b/CodeDocumentation/iw4madmin/application/misc/InteractionRegistration.md new file mode 100644 index 0000000..6c3d35d --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/misc/InteractionRegistration.md @@ -0,0 +1,109 @@ +# InteractionRegistration `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Misc + IW4MAdmin.Application.Misc.InteractionRegistration[[InteractionRegistration]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IInteractionRegistration[[IInteractionRegistration]] + class SharedLibraryCore.Interfaces.IInteractionRegistration interfaceStyle; + end +SharedLibraryCore.Interfaces.IInteractionRegistration --> IW4MAdmin.Application.Misc.InteractionRegistration +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task`<`IEnumerable`<[`IInteractionData`](../../../sharedlibrarycore/interfaces/IInteractionData.md)>> | [`GetInteractions`](#getinteractions)(`string` interactionPrefix, `Nullable`<`int`> clientId, `Nullable`<`Game`> game, `CancellationToken` token) | +| `Task`<`string`> | [`ProcessInteraction`](#processinteraction)(`string` interactionId, `int` originId, `Nullable`<`int`> targetId, `Nullable`<`Game`> game, `IDictionary`<`string`, `string`> meta, `CancellationToken` token) | +| `void` | [`RegisterInteraction`](#registerinteraction)(`string` interactionName, `Func`<`Nullable`<`int`>, `Nullable`<`Game`>, `CancellationToken`, `Task`<[`IInteractionData`](../../../sharedlibrarycore/interfaces/IInteractionData.md)>> interactionRegistration) | +| `void` | [`RegisterScriptInteraction`](#registerscriptinteraction)(`string` interactionName, `string` source, `Delegate` interactionRegistration) | +| `void` | [`UnregisterInteraction`](#unregisterinteraction)(`string` interactionName) | + +## Details +### Inheritance + - [ +`IInteractionRegistration` +](../../../sharedlibrarycore/interfaces/IInteractionRegistration.md) + +### Constructors +#### InteractionRegistration +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/InteractionRegistration.cs#L22) +```csharp +public InteractionRegistration(ILogger logger, IServiceProvider serviceProvider) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ILogger`<[`InteractionRegistration`](iw4madmin/application/misc/InteractionRegistration.md)> | logger | | +| `IServiceProvider` | serviceProvider | | + +### Methods +#### RegisterScriptInteraction +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/InteractionRegistration.cs#L16707566) +```csharp +public virtual void RegisterScriptInteraction(string interactionName, string source, Delegate interactionRegistration) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | interactionName | | +| `string` | source | | +| `Delegate` | interactionRegistration | | + +#### RegisterInteraction +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/InteractionRegistration.cs#L62) +```csharp +public virtual void RegisterInteraction(string interactionName, Func, Nullable, CancellationToken, Task> interactionRegistration) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | interactionName | | +| `Func`<`Nullable`<`int`>, `Nullable`<`Game`>, `CancellationToken`, `Task`<[`IInteractionData`](../../../sharedlibrarycore/interfaces/IInteractionData.md)>> | interactionRegistration | | + +#### UnregisterInteraction +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/InteractionRegistration.cs#L76) +```csharp +public virtual void UnregisterInteraction(string interactionName) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | interactionName | | + +#### GetInteractions +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L452) +```csharp +public virtual async Task> GetInteractions(string interactionPrefix, Nullable clientId, Nullable game, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | interactionPrefix | | +| `Nullable`<`int`> | clientId | | +| `Nullable`<`Game`> | game | | +| `CancellationToken` | token | | + +#### ProcessInteraction +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L487) +```csharp +public virtual async Task ProcessInteraction(string interactionId, int originId, Nullable targetId, Nullable game, IDictionary meta, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | interactionId | | +| `int` | originId | | +| `Nullable`<`int`> | targetId | | +| `Nullable`<`Game`> | game | | +| `IDictionary`<`string`, `string`> | meta | | +| `CancellationToken` | token | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/misc/LogPathGeneratorInfo.md b/CodeDocumentation/iw4madmin/application/misc/LogPathGeneratorInfo.md new file mode 100644 index 0000000..0422d83 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/misc/LogPathGeneratorInfo.md @@ -0,0 +1,99 @@ +# LogPathGeneratorInfo `Public class` + +## Description +dto class for handling log path generation + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Misc + IW4MAdmin.Application.Misc.LogPathGeneratorInfo[[LogPathGeneratorInfo]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`BaseGameDirectory`](#basegamedirectory)
directory under the paths where data comes from by default fs_basegame | `get, set` | +| `string` | [`BasePathDirectory`](#basepathdirectory)
base game root path fs_basepath | `get, set` | +| `string` | [`GameDirectory`](#gamedirectory)
overide game directory plugin driven | `get, set` | +| `string` | [`HomePathDirectory`](#homepathdirectory)
directory for local storage fs_homepath | `get, set` | +| `bool` | [`IsOneLog`](#isonelog)
indicates that the game does not log to the mods folder (when mod is loaded),
but rather always to the fs_basegame directory | `get, set` | +| `bool` | [`IsWindows`](#iswindows)
indicates if running on windows | `get, set` | +| `string` | [`LogFile`](#logfile)
log file name g_log | `get, set` | +| `string` | [`ModDirectory`](#moddirectory)
game director fs_game | `get, set` | + +## Details +### Summary +dto class for handling log path generation + +### Constructors +#### LogPathGeneratorInfo +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/LogPathGeneratorInfo.cs#L14) +```csharp +public LogPathGeneratorInfo() +``` + +### Properties +#### BaseGameDirectory +```csharp +public string BaseGameDirectory { get; set; } +``` +##### Summary +directory under the paths where data comes from by default fs_basegame + +#### BasePathDirectory +```csharp +public string BasePathDirectory { get; set; } +``` +##### Summary +base game root path fs_basepath + +#### HomePathDirectory +```csharp +public string HomePathDirectory { get; set; } +``` +##### Summary +directory for local storage fs_homepath + +#### GameDirectory +```csharp +public string GameDirectory { get; set; } +``` +##### Summary +overide game directory plugin driven + +#### ModDirectory +```csharp +public string ModDirectory { get; set; } +``` +##### Summary +game director fs_game + +#### LogFile +```csharp +public string LogFile { get; set; } +``` +##### Summary +log file name g_log + +#### IsWindows +```csharp +public bool IsWindows { get; set; } +``` +##### Summary +indicates if running on windows + +#### IsOneLog +```csharp +public bool IsOneLog { get; set; } +``` +##### Summary +indicates that the game does not log to the mods folder (when mod is loaded), + but rather always to the fs_basegame directory + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/misc/MasterCommunication.md b/CodeDocumentation/iw4madmin/application/misc/MasterCommunication.md new file mode 100644 index 0000000..4f525d2 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/misc/MasterCommunication.md @@ -0,0 +1,78 @@ +# MasterCommunication `Internal class` + +## Description +implementation of IMasterCommunication + talks to the master server + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Misc + IW4MAdmin.Application.Misc.MasterCommunication[[MasterCommunication]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IMasterCommunication[[IMasterCommunication]] + class SharedLibraryCore.Interfaces.IMasterCommunication interfaceStyle; + end +SharedLibraryCore.Interfaces.IMasterCommunication --> IW4MAdmin.Application.Misc.MasterCommunication +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`CheckVersion`](#checkversion)()
checks for latest version of the application
notifies user if an update is available | +| `Task` | [`RunUploadStatus`](#runuploadstatus)(`CancellationToken` token) | + +## Details +### Summary +implementation of IMasterCommunication + talks to the master server + +### Inheritance + - [ +`IMasterCommunication` +](../../../sharedlibrarycore/interfaces/IMasterCommunication.md) + +### Constructors +#### MasterCommunication +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/MasterCommunication.cs#L27) +```csharp +public MasterCommunication(ILogger logger, ApplicationConfiguration appConfig, ITranslationLookup translationLookup, IMasterApi apiInstance, IManager manager) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ILogger`<[`MasterCommunication`](iw4madmin/application/misc/MasterCommunication.md)> | logger | | +| [`ApplicationConfiguration`](../../../sharedlibrarycore/configuration/ApplicationConfiguration.md) | appConfig | | +| [`ITranslationLookup`](../../../sharedlibrarycore/interfaces/ITranslationLookup.md) | translationLookup | | +| [`IMasterApi`](../api/master/IMasterApi.md) | apiInstance | | +| [`IManager`](../../../sharedlibrarycore/interfaces/IManager.md) | manager | | + +### Methods +#### CheckVersion +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Localization/Layout.cs#L35) +```csharp +public virtual async Task CheckVersion() +``` +##### Summary +checks for latest version of the application + notifies user if an update is available + +##### Returns + + +#### RunUploadStatus +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Localization/Layout.cs#L35) +```csharp +public virtual async Task RunUploadStatus(CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `CancellationToken` | token | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/misc/MetaService.md b/CodeDocumentation/iw4madmin/application/misc/MetaService.md new file mode 100644 index 0000000..092f115 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/misc/MetaService.md @@ -0,0 +1,209 @@ +# MetaService `Public class` + +## Description +implementation of IMetaService + used to add and retrieve runtime and persistent meta + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Misc + IW4MAdmin.Application.Misc.MetaService[[MetaService]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IMetaService[[IMetaService]] + class SharedLibraryCore.Interfaces.IMetaService interfaceStyle; + end +SharedLibraryCore.Interfaces.IMetaService --> IW4MAdmin.Application.Misc.MetaService +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`AddPersistentMeta`](#addpersistentmeta-12)(`...`) | +| `void` | [`AddRuntimeMeta`](#addruntimemeta)([`MetaType`](../../../sharedlibrarycore/interfaces/MetaType.md) metaKey, `Func`<`T`, `Task`<`IEnumerable`<`V`>>> metaAction) | +| `Task` | [`DecrementPersistentMeta`](#decrementpersistentmeta)(`string` metaKey, `int` decrementAmount, `int` clientId) | +| `Task`<[`EFMeta`](../../../data/models/EFMeta.md)> | [`GetPersistentMeta`](#getpersistentmeta-12)(`...`) | +| `Task`<`IEnumerable`<[`IClientMeta`](../../../sharedlibrarycore/interfaces/IClientMeta.md)>> | [`GetRuntimeMeta`](#getruntimemeta-12)(`...`) | +| `Task` | [`IncrementPersistentMeta`](#incrementpersistentmeta)(`string` metaKey, `int` incrementAmount, `int` clientId) | +| `Task` | [`RemovePersistentMeta`](#removepersistentmeta-12)(`...`) | +| `Task` | [`SetPersistentMeta`](#setpersistentmeta)(`string` metaKey, `string` metaValue, `int` clientId) | + +#### Internal Static methods +| Returns | Name | +| --- | --- | +| `int` | [`g__indexOfSmallestColumn|16_2`](#processinformationmetagindexofsmallestcolumn162)() | + +## Details +### Summary +implementation of IMetaService + used to add and retrieve runtime and persistent meta + +### Inheritance + - [ +`IMetaService` +](../../../sharedlibrarycore/interfaces/IMetaService.md) + +### Constructors +#### MetaService +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/MetaService.cs#L28) +```csharp +public MetaService(ILogger logger, IDatabaseContextFactory contextFactory) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ILogger`<[`MetaService`](iw4madmin/application/misc/MetaService.md)> | logger | | +| [`IDatabaseContextFactory`](../../../data/abstractions/IDatabaseContextFactory.md) | contextFactory | | + +### Methods +#### AddPersistentMeta [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Localization/Permission.cs#L7) +```csharp +public virtual async Task AddPersistentMeta(string metaKey, string metaValue, EFClient client, EFMeta linkedMeta) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | metaKey | | +| `string` | metaValue | | +| [`EFClient`](../../../sharedlibrarycore/database/models/EFClient.md) | client | | +| [`EFMeta`](../../../data/models/EFMeta.md) | linkedMeta | | + +#### SetPersistentMeta +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Localization/Permission.cs#L8) +```csharp +public virtual async Task SetPersistentMeta(string metaKey, string metaValue, int clientId) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | metaKey | | +| `string` | metaValue | | +| `int` | clientId | | + +#### IncrementPersistentMeta +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Localization/Permission.cs#L8) +```csharp +public virtual async Task IncrementPersistentMeta(string metaKey, int incrementAmount, int clientId) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | metaKey | | +| `int` | incrementAmount | | +| `int` | clientId | | + +#### DecrementPersistentMeta +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/DatedRecord.cs#L7) +```csharp +public virtual async Task DecrementPersistentMeta(string metaKey, int decrementAmount, int clientId) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | metaKey | | +| `int` | decrementAmount | | +| `int` | clientId | | + +#### AddPersistentMeta [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Helpers/ParserRegex.cs#L48) +```csharp +public virtual async Task AddPersistentMeta(string metaKey, string metaValue) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | metaKey | | +| `string` | metaValue | | + +#### RemovePersistentMeta [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Helpers/ParserRegex.cs#L54) +```csharp +public virtual async Task RemovePersistentMeta(string metaKey, EFClient client) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | metaKey | | +| [`EFClient`](../../../sharedlibrarycore/database/models/EFClient.md) | client | | + +#### RemovePersistentMeta [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Helpers/ParserRegex.cs#L61) +```csharp +public virtual async Task RemovePersistentMeta(string metaKey, string metaValue) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | metaKey | | +| `string` | metaValue | | + +#### GetPersistentMeta [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Helpers/ParserRegex.cs#L63) +```csharp +public virtual async Task GetPersistentMeta(string metaKey, EFClient client) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | metaKey | | +| [`EFClient`](../../../sharedlibrarycore/database/models/EFClient.md) | client | | + +#### GetPersistentMeta [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Helpers/ParserRegex.cs#L72) +```csharp +public virtual async Task> GetPersistentMeta(string metaKey) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | metaKey | | + +#### AddRuntimeMeta +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/MetaService.cs#L220) +```csharp +public virtual void AddRuntimeMeta(MetaType metaKey, Func>> metaAction) +where T : PaginationRequest +where V : IClientMeta +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`MetaType`](../../../sharedlibrarycore/interfaces/MetaType.md) | metaKey | | +| `Func`<`T`, `Task`<`IEnumerable`<`V`>>> | metaAction | | + +#### GetRuntimeMeta [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFAlias.cs#L17) +```csharp +public virtual async Task> GetRuntimeMeta(ClientPaginationRequest request) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`ClientPaginationRequest`](../../../sharedlibrarycore/queryhelper/ClientPaginationRequest.md) | request | | + +#### GetRuntimeMeta [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFAlias.cs#L17) +```csharp +public virtual async Task> GetRuntimeMeta(ClientPaginationRequest request, MetaType metaType) +where T : IClientMeta +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`ClientPaginationRequest`](../../../sharedlibrarycore/queryhelper/ClientPaginationRequest.md) | request | | +| [`MetaType`](../../../sharedlibrarycore/interfaces/MetaType.md) | metaType | | + +#### g__indexOfSmallestColumn|16_2 +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/MetaService.cs#L283) +```csharp +internal static int g__indexOfSmallestColumn|16_2() +where T : IClientMeta +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/misc/MetaServiceV2.md b/CodeDocumentation/iw4madmin/application/misc/MetaServiceV2.md new file mode 100644 index 0000000..d8c33d1 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/misc/MetaServiceV2.md @@ -0,0 +1,267 @@ +# MetaServiceV2 `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Misc + IW4MAdmin.Application.Misc.MetaServiceV2[[MetaServiceV2]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IMetaServiceV2[[IMetaServiceV2]] + class SharedLibraryCore.Interfaces.IMetaServiceV2 interfaceStyle; + end +SharedLibraryCore.Interfaces.IMetaServiceV2 --> IW4MAdmin.Application.Misc.MetaServiceV2 +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `void` | [`AddRuntimeMeta`](#addruntimemeta)([`MetaType`](../../../sharedlibrarycore/interfaces/MetaType.md) metaKey, `Func`<`T`, `CancellationToken`, `Task`<`IEnumerable`<`TReturnType`>>> metaAction) | +| `Task` | [`DecrementPersistentMeta`](#decrementpersistentmeta)(`string` metaKey, `int` decrementAmount, `int` clientId, `CancellationToken` token) | +| `Task`<[`EFMeta`](../../../data/models/EFMeta.md)> | [`GetPersistentMeta`](#getpersistentmeta-12)(`...`) | +| `Task`<[`EFMeta`](../../../data/models/EFMeta.md)> | [`GetPersistentMetaByLookup`](#getpersistentmetabylookup)(`string` metaKey, `string` lookupKey, `int` clientId, `CancellationToken` token) | +| `Task`<`T`> | [`GetPersistentMetaValue`](#getpersistentmetavalue-12)(`...`) | +| `Task`<`IEnumerable`<[`IClientMeta`](../../../sharedlibrarycore/interfaces/IClientMeta.md)>> | [`GetRuntimeMeta`](#getruntimemeta-12)(`...`) | +| `Task` | [`IncrementPersistentMeta`](#incrementpersistentmeta)(`string` metaKey, `int` incrementAmount, `int` clientId, `CancellationToken` token) | +| `Task` | [`RemovePersistentMeta`](#removepersistentmeta-12)(`...`) | +| `Task` | [`SetPersistentMeta`](#setpersistentmeta-12)(`...`) | +| `Task` | [`SetPersistentMetaForLookupKey`](#setpersistentmetaforlookupkey)(`string` metaKey, `string` lookupKey, `int` lookupId, `int` clientId, `CancellationToken` token) | +| `Task` | [`SetPersistentMetaValue`](#setpersistentmetavalue-12)(`...`) | + +## Details +### Inheritance + - [ +`IMetaServiceV2` +](../../../sharedlibrarycore/interfaces/IMetaServiceV2.md) + +### Constructors +#### MetaServiceV2 +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/MetaServiceV2.cs#L24) +```csharp +public MetaServiceV2(ILogger logger, IDatabaseContextFactory contextFactory, IServiceProvider serviceProvider) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ILogger`<[`MetaServiceV2`](iw4madmin/application/misc/MetaServiceV2.md)> | logger | | +| [`IDatabaseContextFactory`](../../../data/abstractions/IDatabaseContextFactory.md) | contextFactory | | +| `IServiceProvider` | serviceProvider | | + +### Methods +#### SetPersistentMeta [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFAlias.cs#L21) +```csharp +public virtual async Task SetPersistentMeta(string metaKey, string metaValue, int clientId, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | metaKey | | +| `string` | metaValue | | +| `int` | clientId | | +| `CancellationToken` | token | | + +#### SetPersistentMetaValue [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFAlias.cs#L22) +```csharp +public virtual async Task SetPersistentMetaValue(string metaKey, T metaValue, int clientId, CancellationToken token) +where T : +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | metaKey | | +| `T` | metaValue | | +| `int` | clientId | | +| `CancellationToken` | token | | + +#### SetPersistentMetaForLookupKey +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFAlias.cs#L22) +```csharp +public virtual async Task SetPersistentMetaForLookupKey(string metaKey, string lookupKey, int lookupId, int clientId, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | metaKey | | +| `string` | lookupKey | | +| `int` | lookupId | | +| `int` | clientId | | +| `CancellationToken` | token | | + +#### IncrementPersistentMeta +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFAlias.cs#L24) +```csharp +public virtual async Task IncrementPersistentMeta(string metaKey, int incrementAmount, int clientId, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | metaKey | | +| `int` | incrementAmount | | +| `int` | clientId | | +| `CancellationToken` | token | | + +#### DecrementPersistentMeta +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFAlias.cs#L24) +```csharp +public virtual async Task DecrementPersistentMeta(string metaKey, int decrementAmount, int clientId, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | metaKey | | +| `int` | decrementAmount | | +| `int` | clientId | | +| `CancellationToken` | token | | + +#### GetPersistentMeta [1/2] +```csharp +public virtual async Task GetPersistentMeta(string metaKey, int clientId, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | metaKey | | +| `int` | clientId | | +| `CancellationToken` | token | | + +#### GetPersistentMetaValue [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFAliasLink.cs#L9) +```csharp +public virtual async Task GetPersistentMetaValue(string metaKey, int clientId, CancellationToken token) +where T : +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | metaKey | | +| `int` | clientId | | +| `CancellationToken` | token | | + +#### GetPersistentMetaByLookup +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFAliasLink.cs#L9) +```csharp +public virtual async Task GetPersistentMetaByLookup(string metaKey, string lookupKey, int clientId, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | metaKey | | +| `string` | lookupKey | | +| `int` | clientId | | +| `CancellationToken` | token | | + +#### RemovePersistentMeta [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFAliasLink.cs#L10) +```csharp +public virtual async Task RemovePersistentMeta(string metaKey, int clientId, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | metaKey | | +| `int` | clientId | | +| `CancellationToken` | token | | + +#### SetPersistentMeta [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFAliasLink.cs#L10) +```csharp +public virtual async Task SetPersistentMeta(string metaKey, string metaValue, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | metaKey | | +| `string` | metaValue | | +| `CancellationToken` | token | | + +#### SetPersistentMetaValue [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFAliasLink.cs#L11) +```csharp +public virtual async Task SetPersistentMetaValue(string metaKey, T metaValue, CancellationToken token) +where T : +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | metaKey | | +| `T` | metaValue | | +| `CancellationToken` | token | | + +#### GetPersistentMeta [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFAliasLink.cs#L11) +```csharp +public virtual async Task GetPersistentMeta(string metaKey, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | metaKey | | +| `CancellationToken` | token | | + +#### GetPersistentMetaValue [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFAliasLink.cs#L13) +```csharp +public virtual async Task GetPersistentMetaValue(string metaKey, CancellationToken token) +where T : +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | metaKey | | +| `CancellationToken` | token | | + +#### RemovePersistentMeta [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFChangeHistory.cs#L19) +```csharp +public virtual async Task RemovePersistentMeta(string metaKey, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | metaKey | | +| `CancellationToken` | token | | + +#### AddRuntimeMeta +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/MetaServiceV2.cs#L404) +```csharp +public virtual void AddRuntimeMeta(MetaType metaKey, Func>> metaAction) +where T : PaginationRequest +where TReturnType : IClientMeta +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`MetaType`](../../../sharedlibrarycore/interfaces/MetaType.md) | metaKey | | +| `Func`<`T`, `CancellationToken`, `Task`<`IEnumerable`<`TReturnType`>>> | metaAction | | + +#### GetRuntimeMeta [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFChangeHistory.cs#L20) +```csharp +public virtual async Task> GetRuntimeMeta(ClientPaginationRequest request, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`ClientPaginationRequest`](../../../sharedlibrarycore/queryhelper/ClientPaginationRequest.md) | request | | +| `CancellationToken` | token | | + +#### GetRuntimeMeta [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFChangeHistory.cs#L20) +```csharp +public virtual async Task> GetRuntimeMeta(ClientPaginationRequest request, MetaType metaType, CancellationToken token) +where T : IClientMeta +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`ClientPaginationRequest`](../../../sharedlibrarycore/queryhelper/ClientPaginationRequest.md) | request | | +| [`MetaType`](../../../sharedlibrarycore/interfaces/MetaType.md) | metaType | | +| `CancellationToken` | token | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/misc/MiddlewareActionHandler.md b/CodeDocumentation/iw4madmin/application/misc/MiddlewareActionHandler.md new file mode 100644 index 0000000..25ee32e --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/misc/MiddlewareActionHandler.md @@ -0,0 +1,69 @@ +# MiddlewareActionHandler `Internal class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Misc + IW4MAdmin.Application.Misc.MiddlewareActionHandler[[MiddlewareActionHandler]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IMiddlewareActionHandler[[IMiddlewareActionHandler]] + class SharedLibraryCore.Interfaces.IMiddlewareActionHandler interfaceStyle; + end +SharedLibraryCore.Interfaces.IMiddlewareActionHandler --> IW4MAdmin.Application.Misc.MiddlewareActionHandler +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task`<`T`> | [`Execute`](#execute)(`T` value, `string` name) | +| `void` | [`Register`](#register)(`T` actionType, [`IMiddlewareAction`](../../../sharedlibrarycore/interfaces/IMiddlewareActionT.md)<`T`> action, `string` name) | + +## Details +### Inheritance + - [ +`IMiddlewareActionHandler` +](../../../sharedlibrarycore/interfaces/IMiddlewareActionHandler.md) + +### Constructors +#### MiddlewareActionHandler +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/MiddlewareActionHandler.cs#L15) +```csharp +public MiddlewareActionHandler(ILogger logger) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ILogger`<[`MiddlewareActionHandler`](iw4madmin/application/misc/MiddlewareActionHandler.md)> | logger | | + +### Methods +#### Execute +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFChangeHistory.cs#L22) +```csharp +public virtual async Task Execute(T value, string name) +where T : +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `T` | value | | +| `string` | name | | + +#### Register +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/MiddlewareActionHandler.cs#L60) +```csharp +public virtual void Register(T actionType, IMiddlewareAction action, string name) +where T : +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `T` | actionType | | +| [`IMiddlewareAction`](../../../sharedlibrarycore/interfaces/IMiddlewareActionT.md)<`T`> | action | | +| `string` | name | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/misc/ParserMatchResult.md b/CodeDocumentation/iw4madmin/application/misc/ParserMatchResult.md new file mode 100644 index 0000000..b2d2196 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/misc/ParserMatchResult.md @@ -0,0 +1,62 @@ +# ParserMatchResult `Public class` + +## Description +implementation of the IMatchResult + used to hold matching results + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Misc + IW4MAdmin.Application.Misc.ParserMatchResult[[ParserMatchResult]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IMatchResult[[IMatchResult]] + class SharedLibraryCore.Interfaces.IMatchResult interfaceStyle; + end +SharedLibraryCore.Interfaces.IMatchResult --> IW4MAdmin.Application.Misc.ParserMatchResult +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `bool` | [`Success`](#success)
indicates if the match succeeded | `get, set` | +| `string``[]` | [`Values`](#values)
array of matched pattern groups | `get, set` | + +## Details +### Summary +implementation of the IMatchResult + used to hold matching results + +### Inheritance + - [ +`IMatchResult` +](../../../sharedlibrarycore/interfaces/IMatchResult.md) + +### Constructors +#### ParserMatchResult +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFChangeHistory.cs#L26) +```csharp +public ParserMatchResult() +``` + +### Properties +#### Values +```csharp +public virtual string Values { get; set; } +``` +##### Summary +array of matched pattern groups + +#### Success +```csharp +public virtual bool Success { get; set; } +``` +##### Summary +indicates if the match succeeded + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/misc/RemoteAssemblyHandler.md b/CodeDocumentation/iw4madmin/application/misc/RemoteAssemblyHandler.md new file mode 100644 index 0000000..45345cf --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/misc/RemoteAssemblyHandler.md @@ -0,0 +1,65 @@ +# RemoteAssemblyHandler `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Misc + IW4MAdmin.Application.Misc.RemoteAssemblyHandler[[RemoteAssemblyHandler]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IRemoteAssemblyHandler[[IRemoteAssemblyHandler]] + class SharedLibraryCore.Interfaces.IRemoteAssemblyHandler interfaceStyle; + end +SharedLibraryCore.Interfaces.IRemoteAssemblyHandler --> IW4MAdmin.Application.Misc.RemoteAssemblyHandler +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `IEnumerable`<`Assembly`> | [`DecryptAssemblies`](#decryptassemblies)(`string``[]` encryptedAssemblies) | +| `IEnumerable`<`string`> | [`DecryptScripts`](#decryptscripts)(`string``[]` encryptedScripts) | + +## Details +### Inheritance + - [ +`IRemoteAssemblyHandler` +](../../../sharedlibrarycore/interfaces/IRemoteAssemblyHandler.md) + +### Constructors +#### RemoteAssemblyHandler +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/RemoteAssemblyHandler.cs#L24) +```csharp +public RemoteAssemblyHandler(ILogger logger, ApplicationConfiguration appconfig) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ILogger`<[`RemoteAssemblyHandler`](iw4madmin/application/misc/RemoteAssemblyHandler.md)> | logger | | +| [`ApplicationConfiguration`](../../../sharedlibrarycore/configuration/ApplicationConfiguration.md) | appconfig | | + +### Methods +#### DecryptAssemblies +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/RemoteAssemblyHandler.cs#L31) +```csharp +public virtual IEnumerable DecryptAssemblies(string[] encryptedAssemblies) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string``[]` | encryptedAssemblies | | + +#### DecryptScripts +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/RemoteAssemblyHandler.cs#L37) +```csharp +public virtual IEnumerable DecryptScripts(string[] encryptedScripts) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string``[]` | encryptedScripts | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/misc/RemoteCommandService.md b/CodeDocumentation/iw4madmin/application/misc/RemoteCommandService.md new file mode 100644 index 0000000..e73c4b4 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/misc/RemoteCommandService.md @@ -0,0 +1,74 @@ +# RemoteCommandService `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Misc + IW4MAdmin.Application.Misc.RemoteCommandService[[RemoteCommandService]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IRemoteCommandService[[IRemoteCommandService]] + class SharedLibraryCore.Interfaces.IRemoteCommandService interfaceStyle; + end +SharedLibraryCore.Interfaces.IRemoteCommandService --> IW4MAdmin.Application.Misc.RemoteCommandService +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task`<`IEnumerable`<[`CommandResponseInfo`](../../../sharedlibrarycore/dtos/CommandResponseInfo.md)>> | [`Execute`](#execute)(`int` originId, `Nullable`<`int`> targetId, `string` command, `IEnumerable`<`string`> arguments, [`Server`](../../../sharedlibrarycore/Server.md) server) | +| `Task`<(`bool` Item1, `IEnumerable`<[`CommandResponseInfo`](../../../sharedlibrarycore/dtos/CommandResponseInfo.md)> Item2)> | [`ExecuteWithResult`](#executewithresult)(`int` originId, `Nullable`<`int`> targetId, `string` command, `IEnumerable`<`string`> arguments, [`Server`](../../../sharedlibrarycore/Server.md) server) | + +## Details +### Inheritance + - [ +`IRemoteCommandService` +](../../../sharedlibrarycore/interfaces/IRemoteCommandService.md) + +### Constructors +#### RemoteCommandService +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/RemoteCommandService.cs#L21) +```csharp +public RemoteCommandService(ILogger logger, ApplicationConfiguration appConfig, ClientService clientService) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ILogger`<[`RemoteCommandService`](iw4madmin/application/misc/RemoteCommandService.md)> | logger | | +| [`ApplicationConfiguration`](../../../sharedlibrarycore/configuration/ApplicationConfiguration.md) | appConfig | | +| [`ClientService`](../../../sharedlibrarycore/services/ClientService.md) | clientService | | + +### Methods +#### Execute +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFMeta.cs#L17) +```csharp +public virtual async Task> Execute(int originId, Nullable targetId, string command, IEnumerable arguments, Server server) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `int` | originId | | +| `Nullable`<`int`> | targetId | | +| `string` | command | | +| `IEnumerable`<`string`> | arguments | | +| [`Server`](../../../sharedlibrarycore/Server.md) | server | | + +#### ExecuteWithResult +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFMeta.cs#L19) +```csharp +public virtual async Task<(bool Item1, IEnumerable Item2)> ExecuteWithResult(int originId, Nullable targetId, string command, IEnumerable arguments, Server server) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `int` | originId | | +| `Nullable`<`int`> | targetId | | +| `string` | command | | +| `IEnumerable`<`string`> | arguments | | +| [`Server`](../../../sharedlibrarycore/Server.md) | server | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/misc/ServerDataCollector.md b/CodeDocumentation/iw4madmin/application/misc/ServerDataCollector.md new file mode 100644 index 0000000..fe8e6b6 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/misc/ServerDataCollector.md @@ -0,0 +1,57 @@ +# ServerDataCollector `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Misc + IW4MAdmin.Application.Misc.ServerDataCollector[[ServerDataCollector]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IServerDataCollector[[IServerDataCollector]] + class SharedLibraryCore.Interfaces.IServerDataCollector interfaceStyle; + end +SharedLibraryCore.Interfaces.IServerDataCollector --> IW4MAdmin.Application.Misc.ServerDataCollector +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`BeginCollectionAsync`](#begincollectionasync)(`Nullable`<`TimeSpan`> period, `CancellationToken` cancellationToken) | + +## Details +### Inheritance + - [ +`IServerDataCollector` +](../../../sharedlibrarycore/interfaces/IServerDataCollector.md) + +### Constructors +#### ServerDataCollector +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/ServerDataCollector.cs#L33) +```csharp +public ServerDataCollector(ILogger logger, ApplicationConfiguration appConfig, IManager manager, IDatabaseContextFactory contextFactory) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ILogger`<[`ServerDataCollector`](iw4madmin/application/misc/ServerDataCollector.md)> | logger | | +| [`ApplicationConfiguration`](../../../sharedlibrarycore/configuration/ApplicationConfiguration.md) | appConfig | | +| [`IManager`](../../../sharedlibrarycore/interfaces/IManager.md) | manager | | +| [`IDatabaseContextFactory`](../../../data/abstractions/IDatabaseContextFactory.md) | contextFactory | | + +### Methods +#### BeginCollectionAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFMeta.cs#L19) +```csharp +public virtual async Task BeginCollectionAsync(Nullable period, CancellationToken cancellationToken) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Nullable`<`TimeSpan`> | period | | +| `CancellationToken` | cancellationToken | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/misc/ServerDataViewer.md b/CodeDocumentation/iw4madmin/application/misc/ServerDataViewer.md new file mode 100644 index 0000000..386a645 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/misc/ServerDataViewer.md @@ -0,0 +1,97 @@ +# ServerDataViewer `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Misc + IW4MAdmin.Application.Misc.ServerDataViewer[[ServerDataViewer]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IServerDataViewer[[IServerDataViewer]] + class SharedLibraryCore.Interfaces.IServerDataViewer interfaceStyle; + end +SharedLibraryCore.Interfaces.IServerDataViewer --> IW4MAdmin.Application.Misc.ServerDataViewer +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task`<(`int` Item1, `int` Item2)> | [`ClientCountsAsync`](#clientcountsasync)(`Nullable`<`TimeSpan`> overPeriod, `Nullable`<`Game`> gameCode, `CancellationToken` token) | +| `Task`<`IEnumerable`<[`ClientHistoryInfo`](../../../sharedlibrarycore/dtos/ClientHistoryInfo.md)>> | [`ClientHistoryAsync`](#clienthistoryasync)(`Nullable`<`TimeSpan`> overPeriod, `CancellationToken` token) | +| `Task`<(`Nullable`<`int`> Item1, `Nullable`<`DateTime`> Item2)> | [`MaxConcurrentClientsAsync`](#maxconcurrentclientsasync)(`Nullable`<`long`> serverId, `Nullable`<`Game`> gameCode, `Nullable`<`TimeSpan`> overPeriod, `CancellationToken` token) | +| `Task`<`int`> | [`RankedClientsCountAsync`](#rankedclientscountasync)(`Nullable`<`long`> serverId, `CancellationToken` token) | + +## Details +### Inheritance + - [ +`IServerDataViewer` +](../../../sharedlibrarycore/interfaces/IServerDataViewer.md) + +### Constructors +#### ServerDataViewer +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/ServerDataViewer.cs#L29) +```csharp +public ServerDataViewer(ILogger logger, IDataValueCache Item1, Nullable Item2)> snapshotCache, IDataValueCache serverStatsCache, IDataValueCache> clientHistoryCache, IDataValueCache rankedClientsCache) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ILogger`<[`ServerDataViewer`](iw4madmin/application/misc/ServerDataViewer.md)> | logger | | +| `IDataValueCache`<[`EFServerSnapshot`](../../../data/models/server/EFServerSnapshot.md), (`Nullable`<`int`> Item1, `Nullable`<`DateTime`> Item2)> | snapshotCache | | +| `IDataValueCache`<[`EFClient`](../../../data/models/client/EFClient.md), (`int` Item1, `int` Item2)> | serverStatsCache | | +| `IDataValueCache`<[`EFServerSnapshot`](../../../data/models/server/EFServerSnapshot.md), `List`<[`ClientHistoryInfo`](../../../sharedlibrarycore/dtos/ClientHistoryInfo.md)>> | clientHistoryCache | | +| [`IDataValueCache`](../../../data/abstractions/IDataValueCacheTT.md)<[`EFClientRankingHistory`](../../../data/models/client/stats/EFClientRankingHistory.md), `int`> | rankedClientsCache | | + +### Methods +#### MaxConcurrentClientsAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFPenalty.cs#L31) +```csharp +public virtual async Task<(Nullable Item1, Nullable Item2)> MaxConcurrentClientsAsync(Nullable serverId, Nullable gameCode, Nullable overPeriod, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Nullable`<`long`> | serverId | | +| `Nullable`<`Game`> | gameCode | | +| `Nullable`<`TimeSpan`> | overPeriod | | +| `CancellationToken` | token | | + +#### ClientCountsAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFPenalty.cs#L33) +```csharp +public virtual async Task<(int Item1, int Item2)> ClientCountsAsync(Nullable overPeriod, Nullable gameCode, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Nullable`<`TimeSpan`> | overPeriod | | +| `Nullable`<`Game`> | gameCode | | +| `CancellationToken` | token | | + +#### ClientHistoryAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFPenalty.cs#L33) +```csharp +public virtual async Task> ClientHistoryAsync(Nullable overPeriod, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Nullable`<`TimeSpan`> | overPeriod | | +| `CancellationToken` | token | | + +#### RankedClientsCountAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Data/Models/EFPenalty.cs#L35) +```csharp +public virtual async Task RankedClientsCountAsync(Nullable serverId, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Nullable`<`long`> | serverId | | +| `CancellationToken` | token | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/misc/TokenAuthentication.md b/CodeDocumentation/iw4madmin/application/misc/TokenAuthentication.md new file mode 100644 index 0000000..41b7b32 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/misc/TokenAuthentication.md @@ -0,0 +1,75 @@ +# TokenAuthentication `Internal class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Misc + IW4MAdmin.Application.Misc.TokenAuthentication[[TokenAuthentication]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.ITokenAuthentication[[ITokenAuthentication]] + class SharedLibraryCore.Interfaces.ITokenAuthentication interfaceStyle; + end +SharedLibraryCore.Interfaces.ITokenAuthentication --> IW4MAdmin.Application.Misc.TokenAuthentication +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `bool` | [`AuthorizeToken`](#authorizetoken)([`ITokenIdentifier`](../../../sharedlibrarycore/interfaces/ITokenIdentifier.md) authInfo) | +| [`TokenState`](../../../sharedlibrarycore/helpers/TokenState.md) | [`GenerateNextToken`](#generatenexttoken)([`ITokenIdentifier`](../../../sharedlibrarycore/interfaces/ITokenIdentifier.md) authInfo) | + +#### Internal Static methods +| Returns | Name | +| --- | --- | +| `bool` | [`<_generateToken>g__ValidCharacter|7_0`](#generatetokengvalidcharacter70)(`char` c) | + +## Details +### Inheritance + - [ +`ITokenAuthentication` +](../../../sharedlibrarycore/interfaces/ITokenAuthentication.md) + +### Constructors +#### TokenAuthentication +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/TokenAuthentication.cs#L17) +```csharp +public TokenAuthentication() +``` + +### Methods +#### AuthorizeToken +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/TokenAuthentication.cs#L24) +```csharp +public virtual bool AuthorizeToken(ITokenIdentifier authInfo) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`ITokenIdentifier`](../../../sharedlibrarycore/interfaces/ITokenIdentifier.md) | authInfo | | + +#### GenerateNextToken +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/TokenAuthentication.cs#L37) +```csharp +public virtual TokenState GenerateNextToken(ITokenIdentifier authInfo) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`ITokenIdentifier`](../../../sharedlibrarycore/interfaces/ITokenIdentifier.md) | authInfo | | + +#### <_generateToken>g__ValidCharacter|7_0 +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/TokenAuthentication.cs#L78) +```csharp +internal static bool <_generateToken>g__ValidCharacter|7_0(char c) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `char` | c | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/plugin/PluginImporter.md b/CodeDocumentation/iw4madmin/application/plugin/PluginImporter.md new file mode 100644 index 0000000..20724d0 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/plugin/PluginImporter.md @@ -0,0 +1,77 @@ +# PluginImporter `Public class` + +## Description +implementation of IPluginImporter + discovers plugins and script plugins + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Plugin + IW4MAdmin.Application.Plugin.PluginImporter[[PluginImporter]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IPluginImporter[[IPluginImporter]] + class SharedLibraryCore.Interfaces.IPluginImporter interfaceStyle; + end +SharedLibraryCore.Interfaces.IPluginImporter --> IW4MAdmin.Application.Plugin.PluginImporter +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| (`IEnumerable`<`Type`> Item1, `IEnumerable`<`Type`> Item2, `IEnumerable`<`Type`> Item3) | [`DiscoverAssemblyPluginImplementations`](#discoverassemblypluginimplementations)()
discovers all the C# assembly plugins and commands | +| `IEnumerable`<(`Type` Item1, `string` Item2)> | [`DiscoverScriptPlugins`](#discoverscriptplugins)()
discovers all the script plugins in the plugins dir | + +## Details +### Summary +implementation of IPluginImporter + discovers plugins and script plugins + +### Inheritance + - [ +`IPluginImporter` +](../../../sharedlibrarycore/interfaces/IPluginImporter.md) + +### Constructors +#### PluginImporter +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/PluginImporter.cs#L30) +```csharp +public PluginImporter(ILogger logger, ApplicationConfiguration appConfig, IMasterApi masterApi, IRemoteAssemblyHandler remoteAssemblyHandler) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ILogger`<[`PluginImporter`](iw4madmin/application/plugin/PluginImporter.md)> | logger | | +| [`ApplicationConfiguration`](../../../sharedlibrarycore/configuration/ApplicationConfiguration.md) | appConfig | | +| [`IMasterApi`](../api/master/IMasterApi.md) | masterApi | | +| [`IRemoteAssemblyHandler`](../../../sharedlibrarycore/interfaces/IRemoteAssemblyHandler.md) | remoteAssemblyHandler | | + +### Methods +#### DiscoverScriptPlugins +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/PluginImporter.cs#L44) +```csharp +public virtual IEnumerable<(Type Item1, string Item2)> DiscoverScriptPlugins() +``` +##### Summary +discovers all the script plugins in the plugins dir + +##### Returns + + +#### DiscoverAssemblyPluginImplementations +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/PluginImporter.cs#L78) +```csharp +public virtual (IEnumerable Item1, IEnumerable Item2, IEnumerable Item3) DiscoverAssemblyPluginImplementations() +``` +##### Summary +discovers all the C# assembly plugins and commands + +##### Returns + + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/plugin/PluginType.md b/CodeDocumentation/iw4madmin/application/plugin/PluginType.md new file mode 100644 index 0000000..2a16dbb --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/plugin/PluginType.md @@ -0,0 +1,21 @@ +# PluginType `Public enum` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Plugin + IW4MAdmin.Application.Plugin.PluginType[[PluginType]] + end +``` + +## Details +### Fields +#### Binary + + +#### Script + + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/plugin/script/PermissionLevelToStringConverter.md b/CodeDocumentation/iw4madmin/application/plugin/script/PermissionLevelToStringConverter.md new file mode 100644 index 0000000..1d9238b --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/plugin/script/PermissionLevelToStringConverter.md @@ -0,0 +1,47 @@ +# PermissionLevelToStringConverter `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Plugin.Script + IW4MAdmin.Application.Plugin.Script.PermissionLevelToStringConverter[[PermissionLevelToStringConverter]] + end + subgraph Jint.Runtime.Interop +Jint.Runtime.Interop.IObjectConverter[[IObjectConverter]] + end +Jint.Runtime.Interop.IObjectConverter --> IW4MAdmin.Application.Plugin.Script.PermissionLevelToStringConverter +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `bool` | [`TryConvert`](#tryconvert)(`Engine` engine, `object` value, out `JsValue` result) | + +## Details +### Inheritance + - `IObjectConverter` + +### Constructors +#### PermissionLevelToStringConverter +```csharp +public PermissionLevelToStringConverter() +``` + +### Methods +#### TryConvert +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPlugin.cs#L556) +```csharp +public virtual bool TryConvert(Engine engine, object value, out JsValue result) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Engine` | engine | | +| `object` | value | | +| `out` `JsValue` | result | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/plugin/script/ScriptCommand.md b/CodeDocumentation/iw4madmin/application/plugin/script/ScriptCommand.md new file mode 100644 index 0000000..29aa4e5 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/plugin/script/ScriptCommand.md @@ -0,0 +1,69 @@ +# ScriptCommand `Public class` + +## Description +generic script command implementation + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Plugin.Script + IW4MAdmin.Application.Plugin.Script.ScriptCommand[[ScriptCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> IW4MAdmin.Application.Plugin.Script.ScriptCommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../../../../sharedlibrarycore/GameEvent.md) e) | + +## Details +### Summary +generic script command implementation + +### Inheritance + - [ +`Command` +](../../../../sharedlibrarycore/Command.md) + +### Constructors +#### ScriptCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptCommand.cs#L28) +```csharp +public ScriptCommand(string name, string alias, string description, bool isTargetRequired, Permission permission, IEnumerable args, Func executeAction, CommandConfiguration config, ITranslationLookup layout, ILogger logger, IEnumerable supportedGames) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | name | | +| `string` | alias | | +| `string` | description | | +| `bool` | isTargetRequired | | +| `Permission` | permission | | +| `IEnumerable`<[`CommandArgument`](../../../../sharedlibrarycore/commands/CommandArgument.md)> | args | | +| `Func`<[`GameEvent`](../../../../sharedlibrarycore/GameEvent.md), `Task`> | executeAction | | +| [`CommandConfiguration`](../../../../sharedlibrarycore/configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../../../../sharedlibrarycore/interfaces/ITranslationLookup.md) | layout | | +| `ILogger`<[`ScriptCommand`](iw4madmin/application/plugin/script/ScriptCommand.md)> | logger | | +| `IEnumerable`<`Game`> | supportedGames | | + +### Methods +#### ExecuteAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1179) +```csharp +public override async Task ExecuteAsync(GameEvent e) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](../../../../sharedlibrarycore/GameEvent.md) | e | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/plugin/script/ScriptPlugin.md b/CodeDocumentation/iw4madmin/application/plugin/script/ScriptPlugin.md new file mode 100644 index 0000000..85f702f --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/plugin/script/ScriptPlugin.md @@ -0,0 +1,184 @@ +# ScriptPlugin `Public class` + +## Description +implementation of IPlugin + used to proxy script plugin requests + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Plugin.Script + IW4MAdmin.Application.Plugin.Script.ScriptPlugin[[ScriptPlugin]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IPlugin[[IPlugin]] + class SharedLibraryCore.Interfaces.IPlugin interfaceStyle; + end +SharedLibraryCore.Interfaces.IPlugin --> IW4MAdmin.Application.Plugin.Script.ScriptPlugin +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`Author`](#author) | `get, set` | +| `bool` | [`IsParser`](#isparser)
indicates if the plugin is a parser | `get, private set` | +| `string` | [`Name`](#name) | `get, set` | +| `float` | [`Version`](#version) | `get, set` | +| `FileSystemWatcher` | [`Watcher`](#watcher) | `get` | + +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`Finalize`](#finalize)() | + +#### Public methods +| Returns | Name | +| --- | --- | +| `T` | [`ExecuteAction`](#executeaction)(`Delegate` action, `CancellationToken` token, `object``[]` param) | +| `Task` | [`Initialize`](#initialize)([`IManager`](../../../../sharedlibrarycore/interfaces/IManager.md) manager, [`IScriptCommandFactory`](../../../../sharedlibrarycore/interfaces/IScriptCommandFactory.md) scriptCommandFactory, [`IScriptPluginServiceResolver`](../../../../sharedlibrarycore/interfaces/IScriptPluginServiceResolver.md) serviceResolver, [`IConfigurationHandlerV2`](../../../../sharedlibrarycore/interfaces/IConfigurationHandlerV2T.md)<[`ScriptPluginConfiguration`](../../configuration/ScriptPluginConfiguration.md)> configHandler) | +| `Task` | [`OnEventAsync`](#oneventasync)([`GameEvent`](../../../../sharedlibrarycore/GameEvent.md) gameEvent, [`Server`](../../../../sharedlibrarycore/Server.md) server) | +| `Task` | [`OnLoadAsync`](#onloadasync)([`IManager`](../../../../sharedlibrarycore/interfaces/IManager.md) manager) | +| `Task` | [`OnTickAsync`](#ontickasync)([`Server`](../../../../sharedlibrarycore/Server.md) server) | +| `Task` | [`OnUnloadAsync`](#onunloadasync)() | +| `T` | [`WrapDelegate`](#wrapdelegate)(`Delegate` act, `CancellationToken` token, `object``[]` args) | + +## Details +### Summary +implementation of IPlugin + used to proxy script plugin requests + +### Inheritance + - [ +`IPlugin` +](../../../../sharedlibrarycore/interfaces/IPlugin.md) + +### Constructors +#### ScriptPlugin +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPlugin.cs#L50) +```csharp +public ScriptPlugin(ILogger logger, string filename, string workingDirectory) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ILogger` | logger | | +| `string` | filename | | +| `string` | workingDirectory | | + +### Methods +#### Finalize +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPlugin.cs#L71) +```csharp +protected override void Finalize() +``` + +#### Initialize +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L16707566) +```csharp +public async Task Initialize(IManager manager, IScriptCommandFactory scriptCommandFactory, IScriptPluginServiceResolver serviceResolver, IConfigurationHandlerV2 configHandler) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`IManager`](../../../../sharedlibrarycore/interfaces/IManager.md) | manager | | +| [`IScriptCommandFactory`](../../../../sharedlibrarycore/interfaces/IScriptCommandFactory.md) | scriptCommandFactory | | +| [`IScriptPluginServiceResolver`](../../../../sharedlibrarycore/interfaces/IScriptPluginServiceResolver.md) | serviceResolver | | +| [`IConfigurationHandlerV2`](../../../../sharedlibrarycore/interfaces/IConfigurationHandlerV2T.md)<[`ScriptPluginConfiguration`](../../configuration/ScriptPluginConfiguration.md)> | configHandler | | + +#### OnEventAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1359) +```csharp +public virtual async Task OnEventAsync(GameEvent gameEvent, Server server) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](../../../../sharedlibrarycore/GameEvent.md) | gameEvent | | +| [`Server`](../../../../sharedlibrarycore/Server.md) | server | | + +#### OnLoadAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPlugin.cs#L16707566) +```csharp +public virtual Task OnLoadAsync(IManager manager) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`IManager`](../../../../sharedlibrarycore/interfaces/IManager.md) | manager | | + +#### OnTickAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPlugin.cs#L297) +```csharp +public virtual Task OnTickAsync(Server server) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`Server`](../../../../sharedlibrarycore/Server.md) | server | | + +#### OnUnloadAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L721) +```csharp +public virtual async Task OnUnloadAsync() +``` + +#### ExecuteAction +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPlugin.cs#L16707566) +```csharp +public T ExecuteAction(Delegate action, CancellationToken token, object[] param) +where T : +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Delegate` | action | | +| `CancellationToken` | token | | +| `object``[]` | param | | + +#### WrapDelegate +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPlugin.cs#L16707566) +```csharp +public T WrapDelegate(Delegate act, CancellationToken token, object[] args) +where T : +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Delegate` | act | | +| `CancellationToken` | token | | +| `object``[]` | args | | + +### Properties +#### Name +```csharp +public string Name { get; set; } +``` + +#### Version +```csharp +public float Version { get; set; } +``` + +#### Author +```csharp +public string Author { get; set; } +``` + +#### IsParser +```csharp +public virtual bool IsParser { get; private set; } +``` +##### Summary +indicates if the plugin is a parser + +#### Watcher +```csharp +public FileSystemWatcher Watcher { get; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/plugin/script/ScriptPluginConfigurationWrapper.md b/CodeDocumentation/iw4madmin/application/plugin/script/ScriptPluginConfigurationWrapper.md new file mode 100644 index 0000000..b244fd9 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/plugin/script/ScriptPluginConfigurationWrapper.md @@ -0,0 +1,95 @@ +# ScriptPluginConfigurationWrapper `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Plugin.Script + IW4MAdmin.Application.Plugin.Script.ScriptPluginConfigurationWrapper[[ScriptPluginConfigurationWrapper]] + end +``` + +## Members +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`Finalize`](#finalize)() | + +#### Public methods +| Returns | Name | +| --- | --- | +| `JsValue` | [`GetValue`](#getvalue-12)(`...`) | +| `void` | [`SetName`](#setname)(`string` name) | +| `Task` | [`SetValue`](#setvalue)(`string` key, `object` value) | + +## Details +### Constructors +#### ScriptPluginConfigurationWrapper +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginConfigurationWrapper.cs#L23) +```csharp +public ScriptPluginConfigurationWrapper(string pluginName, Engine scriptEngine, IConfigurationHandlerV2 configHandler) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | pluginName | | +| `Engine` | scriptEngine | | +| [`IConfigurationHandlerV2`](../../../../sharedlibrarycore/interfaces/IConfigurationHandlerV2T.md)<[`ScriptPluginConfiguration`](../../configuration/ScriptPluginConfiguration.md)> | configHandler | | + +### Methods +#### Finalize +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginConfigurationWrapper.cs#L37) +```csharp +protected override void Finalize() +``` + +#### SetName +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginConfigurationWrapper.cs#L42) +```csharp +public void SetName(string name) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | name | | + +#### SetValue +```csharp +public async Task SetValue(string key, object value) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | key | | +| `object` | value | | + +#### GetValue [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginConfigurationWrapper.cs#L80) +```csharp +public JsValue GetValue(string key) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | key | | + +#### GetValue [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginConfigurationWrapper.cs#L83) +```csharp +public JsValue GetValue(string key, Delegate updateCallback) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | key | | +| `Delegate` | updateCallback | | + +### Events +#### ConfigurationUpdated +```csharp +public event Action ConfigurationUpdated +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/plugin/script/ScriptPluginFactory.md b/CodeDocumentation/iw4madmin/application/plugin/script/ScriptPluginFactory.md new file mode 100644 index 0000000..6b5d58d --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/plugin/script/ScriptPluginFactory.md @@ -0,0 +1,54 @@ +# ScriptPluginFactory `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Plugin.Script + IW4MAdmin.Application.Plugin.Script.ScriptPluginFactory[[ScriptPluginFactory]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IScriptPluginFactory[[IScriptPluginFactory]] + class SharedLibraryCore.Interfaces.IScriptPluginFactory interfaceStyle; + end +SharedLibraryCore.Interfaces.IScriptPluginFactory --> IW4MAdmin.Application.Plugin.Script.ScriptPluginFactory +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `object` | [`CreateScriptPlugin`](#createscriptplugin)(`Type` type, `string` fileName) | + +## Details +### Inheritance + - [ +`IScriptPluginFactory` +](../../../../sharedlibrarycore/interfaces/IScriptPluginFactory.md) + +### Constructors +#### ScriptPluginFactory +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginFactory.cs#L13) +```csharp +public ScriptPluginFactory(IServiceProvider serviceProvider) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `IServiceProvider` | serviceProvider | | + +### Methods +#### CreateScriptPlugin +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginFactory.cs#L19) +```csharp +public virtual object CreateScriptPlugin(Type type, string fileName) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Type` | type | | +| `string` | fileName | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/plugin/script/ScriptPluginHelper.md b/CodeDocumentation/iw4madmin/application/plugin/script/ScriptPluginHelper.md new file mode 100644 index 0000000..0cdd43a --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/plugin/script/ScriptPluginHelper.md @@ -0,0 +1,95 @@ +# ScriptPluginHelper `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Plugin.Script + IW4MAdmin.Application.Plugin.Script.ScriptPluginHelper[[ScriptPluginHelper]] + end +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `void` | [`GetUrl`](#geturl-12)(`...`) | +| `void` | [`PostUrl`](#posturl)(`string` url, `string` body, `string` bearerToken, `Delegate` callback) | +| `void` | [`RequestNotifyAfterDelay`](#requestnotifyafterdelay)(`int` delayMs, `Delegate` callback) | +| `void` | [`RequestUrl`](#requesturl)([`ScriptPluginWebRequest`](./ScriptPluginWebRequest.md) request, `Delegate` callback) | + +## Details +### Constructors +#### ScriptPluginHelper +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginHelper.cs#L17) +```csharp +public ScriptPluginHelper(IManager manager, ScriptPluginV2 scriptPlugin) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`IManager`](../../../../sharedlibrarycore/interfaces/IManager.md) | manager | | +| [`ScriptPluginV2`](./ScriptPluginV2.md) | scriptPlugin | | + +### Methods +#### GetUrl [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginHelper.cs#L27) +```csharp +public void GetUrl(string url, Delegate callback) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | url | | +| `Delegate` | callback | | + +#### GetUrl [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginHelper.cs#L32) +```csharp +public void GetUrl(string url, string bearerToken, Delegate callback) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | url | | +| `string` | bearerToken | | +| `Delegate` | callback | | + +#### PostUrl +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginHelper.cs#L38) +```csharp +public void PostUrl(string url, string body, string bearerToken, Delegate callback) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | url | | +| `string` | body | | +| `string` | bearerToken | | +| `Delegate` | callback | | + +#### RequestUrl +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginHelper.cs#L16707566) +```csharp +public void RequestUrl(ScriptPluginWebRequest request, Delegate callback) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`ScriptPluginWebRequest`](./ScriptPluginWebRequest.md) | request | | +| `Delegate` | callback | | + +#### RequestNotifyAfterDelay +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginHelper.cs#L16707566) +```csharp +public void RequestNotifyAfterDelay(int delayMs, Delegate callback) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `int` | delayMs | | +| `Delegate` | callback | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/plugin/script/ScriptPluginServiceResolver.md b/CodeDocumentation/iw4madmin/application/plugin/script/ScriptPluginServiceResolver.md new file mode 100644 index 0000000..0995442 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/plugin/script/ScriptPluginServiceResolver.md @@ -0,0 +1,70 @@ +# ScriptPluginServiceResolver `Public class` + +## Description +implementation of IScriptPluginServiceResolver + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Plugin.Script + IW4MAdmin.Application.Plugin.Script.ScriptPluginServiceResolver[[ScriptPluginServiceResolver]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IScriptPluginServiceResolver[[IScriptPluginServiceResolver]] + class SharedLibraryCore.Interfaces.IScriptPluginServiceResolver interfaceStyle; + end +SharedLibraryCore.Interfaces.IScriptPluginServiceResolver --> IW4MAdmin.Application.Plugin.Script.ScriptPluginServiceResolver +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `object` | [`ResolveService`](#resolveservice-12)(`...`) | + +## Details +### Summary +implementation of IScriptPluginServiceResolver + +### Inheritance + - [ +`IScriptPluginServiceResolver` +](../../../../sharedlibrarycore/interfaces/IScriptPluginServiceResolver.md) + +### Constructors +#### ScriptPluginServiceResolver +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginServiceResolver.cs#L14) +```csharp +public ScriptPluginServiceResolver(IServiceProvider serviceProvider) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `IServiceProvider` | serviceProvider | | + +### Methods +#### ResolveService [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginServiceResolver.cs#L20) +```csharp +public virtual object ResolveService(string serviceName) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | serviceName | | + +#### ResolveService [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginServiceResolver.cs#L26) +```csharp +public virtual object ResolveService(string serviceName, string[] genericParameters) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | serviceName | | +| `string``[]` | genericParameters | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/plugin/script/ScriptPluginTimerHelper.md b/CodeDocumentation/iw4madmin/application/plugin/script/ScriptPluginTimerHelper.md new file mode 100644 index 0000000..e895253 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/plugin/script/ScriptPluginTimerHelper.md @@ -0,0 +1,123 @@ +# ScriptPluginTimerHelper `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Plugin.Script + IW4MAdmin.Application.Plugin.Script.ScriptPluginTimerHelper[[ScriptPluginTimerHelper]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IScriptPluginTimerHelper[[IScriptPluginTimerHelper]] + class SharedLibraryCore.Interfaces.IScriptPluginTimerHelper interfaceStyle; + end +SharedLibraryCore.Interfaces.IScriptPluginTimerHelper --> IW4MAdmin.Application.Plugin.Script.ScriptPluginTimerHelper +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `bool` | [`IsRunning`](#isrunning) | `get, private set` | + +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`Finalize`](#finalize)() | + +#### Public methods +| Returns | Name | +| --- | --- | +| `void` | [`OnTick`](#ontick)(`Delegate` action, `string` actionName) | +| `void` | [`SetDependency`](#setdependency)(`SemaphoreSlim` dependentSemaphore) | +| `void` | [`Start`](#start-13)(`...`) | +| `void` | [`Stop`](#stop)() | + +## Details +### Inheritance + - [ +`IScriptPluginTimerHelper` +](../../../../sharedlibrarycore/interfaces/IScriptPluginTimerHelper.md) + +### Constructors +#### ScriptPluginTimerHelper +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginTimerHelper.cs#L18) +```csharp +public ScriptPluginTimerHelper(ILogger logger) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ILogger`<[`ScriptPluginTimerHelper`](iw4madmin/application/plugin/script/ScriptPluginTimerHelper.md)> | logger | | + +### Methods +#### Finalize +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginTimerHelper.cs#L33) +```csharp +protected override void Finalize() +``` + +#### Start [1/3] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginTimerHelper.cs#L43) +```csharp +public virtual void Start(int delay, int interval) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `int` | delay | | +| `int` | interval | | + +#### Start [2/3] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginTimerHelper.cs#L69) +```csharp +public virtual void Start(int interval) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `int` | interval | | + +#### Start [3/3] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginTimerHelper.cs#L74) +```csharp +public virtual void Start() +``` + +#### Stop +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginTimerHelper.cs#L79) +```csharp +public virtual void Stop() +``` + +#### OnTick +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginTimerHelper.cs#L93) +```csharp +public virtual void OnTick(Delegate action, string actionName) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Delegate` | action | | +| `string` | actionName | | + +#### SetDependency +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginTimerHelper.cs#L196) +```csharp +public virtual void SetDependency(SemaphoreSlim dependentSemaphore) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `SemaphoreSlim` | dependentSemaphore | | + +### Properties +#### IsRunning +```csharp +public virtual bool IsRunning { get; private set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/plugin/script/ScriptPluginV2.md b/CodeDocumentation/iw4madmin/application/plugin/script/ScriptPluginV2.md new file mode 100644 index 0000000..f10879e --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/plugin/script/ScriptPluginV2.md @@ -0,0 +1,104 @@ +# ScriptPluginV2 `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Plugin.Script + IW4MAdmin.Application.Plugin.Script.ScriptPluginV2[[ScriptPluginV2]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IPluginV2[[IPluginV2]] + class SharedLibraryCore.Interfaces.IPluginV2 interfaceStyle; + SharedLibraryCore.Interfaces.IModularAssembly[[IModularAssembly]] + class SharedLibraryCore.Interfaces.IModularAssembly interfaceStyle; + end +SharedLibraryCore.Interfaces.IPluginV2 --> IW4MAdmin.Application.Plugin.Script.ScriptPluginV2 +SharedLibraryCore.Interfaces.IModularAssembly --> SharedLibraryCore.Interfaces.IPluginV2 +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`Author`](#author) | `get, private set` | +| `string` | [`Name`](#name) | `get, private set` | +| `string` | [`Version`](#version) | `get, private set` | + +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `void` | [`ExecuteWithErrorHandling`](#executewitherrorhandling)(`Action`<`Engine`> work) | +| `object` | [`QueryWithErrorHandling`](#querywitherrorhandling)(`Delegate` action, `object``[]` args) | + +## Details +### Inheritance + - [ +`IPluginV2` +](../../../../sharedlibrarycore/interfaces/IPluginV2.md) + - [ +`IModularAssembly` +](../../../../sharedlibrarycore/interfaces/IModularAssembly.md) + +### Nested types +#### Classes + - `EnumsToStringConverter` + +### Constructors +#### ScriptPluginV2 +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginV2.cs#L34) +```csharp +public ScriptPluginV2(string fileName, ILogger logger, IScriptPluginServiceResolver pluginServiceResolver, IScriptCommandFactory scriptCommandFactory, IConfigurationHandlerV2 configHandler, IInteractionRegistration interactionRegistration) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | fileName | | +| `ILogger`<[`ScriptPluginV2`](iw4madmin/application/plugin/script/ScriptPluginV2.md)> | logger | | +| [`IScriptPluginServiceResolver`](../../../../sharedlibrarycore/interfaces/IScriptPluginServiceResolver.md) | pluginServiceResolver | | +| [`IScriptCommandFactory`](../../../../sharedlibrarycore/interfaces/IScriptCommandFactory.md) | scriptCommandFactory | | +| [`IConfigurationHandlerV2`](../../../../sharedlibrarycore/interfaces/IConfigurationHandlerV2T.md)<[`ScriptPluginConfiguration`](../../configuration/ScriptPluginConfiguration.md)> | configHandler | | +| [`IInteractionRegistration`](../../../../sharedlibrarycore/interfaces/IInteractionRegistration.md) | interactionRegistration | | + +### Methods +#### ExecuteWithErrorHandling +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginV2.cs#L16707566) +```csharp +public void ExecuteWithErrorHandling(Action work) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Action`<`Engine`> | work | | + +#### QueryWithErrorHandling +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginV2.cs#L16707566) +```csharp +public object QueryWithErrorHandling(Delegate action, object[] args) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Delegate` | action | | +| `object``[]` | args | | + +### Properties +#### Name +```csharp +public virtual string Name { get; private set; } +``` + +#### Author +```csharp +public virtual string Author { get; private set; } +``` + +#### Version +```csharp +public virtual string Version { get; private set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/plugin/script/ScriptPluginWebRequest.md b/CodeDocumentation/iw4madmin/application/plugin/script/ScriptPluginWebRequest.md new file mode 100644 index 0000000..25a42fa --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/plugin/script/ScriptPluginWebRequest.md @@ -0,0 +1,199 @@ +# ScriptPluginWebRequest `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Plugin.Script + IW4MAdmin.Application.Plugin.Script.ScriptPluginWebRequest[[ScriptPluginWebRequest]] + end + subgraph System +System.IEquatable_1[[IEquatable]] + end +System.IEquatable_1 --> IW4MAdmin.Application.Plugin.Script.ScriptPluginWebRequest +``` + +## Members +### Properties +#### Protected properties +| Type | Name | Methods | +| --- | --- | --- | +| `Type` | [`EqualityContract`](#equalitycontract) | `get` | + +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `object` | [`Body`](#body) | `get, init` | +| `string` | [`ContentType`](#contenttype) | `get, init` | +| `Dictionary`<`string`, `string`> | [`Headers`](#headers) | `get, init` | +| `string` | [`Method`](#method) | `get, init` | +| `string` | [`Url`](#url) | `get, init` | + +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| [`ScriptPluginWebRequest`](iw4madmin/application/plugin/script/ScriptPluginWebRequest.md) | [`$`](#clone)() | +| `void` | [`Deconstruct`](#deconstruct)(out `string` Url, out `object` Body, out `string` Method, out `string` ContentType, out `Dictionary`<`string`, `string`> Headers) | +| `bool` | [`Equals`](#equals-12)(`...`) | +| `int` | [`GetHashCode`](#gethashcode)() | +| `string` | [`ToString`](#tostring)() | + +#### Protected methods +| Returns | Name | +| --- | --- | +| `bool` | [`PrintMembers`](#printmembers)(`StringBuilder` builder) | + +#### Public Static methods +| Returns | Name | +| --- | --- | +| `bool` | `operator` [`!=`](#operator-)([`ScriptPluginWebRequest`](iw4madmin/application/plugin/script/ScriptPluginWebRequest.md) left, [`ScriptPluginWebRequest`](iw4madmin/application/plugin/script/ScriptPluginWebRequest.md) right) | +| `bool` | `operator` [`==`](#operator-)([`ScriptPluginWebRequest`](iw4madmin/application/plugin/script/ScriptPluginWebRequest.md) left, [`ScriptPluginWebRequest`](iw4madmin/application/plugin/script/ScriptPluginWebRequest.md) right) | + +## Details +### Inheritance + - `IEquatable`<[`ScriptPluginWebRequest`](iw4madmin/application/plugin/script/ScriptPluginWebRequest.md)> + +### Constructors +#### ScriptPluginWebRequest [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Plugin/Script/ScriptPluginWebRequest.cs#L5) +```csharp +public ScriptPluginWebRequest(string Url, object Body, string Method, string ContentType, Dictionary Headers) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | Url | | +| `object` | Body | | +| `string` | Method | | +| `string` | ContentType | | +| `Dictionary`<`string`, `string`> | Headers | | + +#### ScriptPluginWebRequest [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L88) +```csharp +protected ScriptPluginWebRequest(ScriptPluginWebRequest original) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`ScriptPluginWebRequest`](iw4madmin/application/plugin/script/ScriptPluginWebRequest.md) | original | | + +### Methods +#### ToString +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L65) +```csharp +public override string ToString() +``` + +#### PrintMembers +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L67) +```csharp +protected virtual bool PrintMembers(StringBuilder builder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `StringBuilder` | builder | | + +#### Operator != +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L75) +```csharp +public static bool operator !=(ScriptPluginWebRequest left, ScriptPluginWebRequest right) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`ScriptPluginWebRequest`](iw4madmin/application/plugin/script/ScriptPluginWebRequest.md) | left | | +| [`ScriptPluginWebRequest`](iw4madmin/application/plugin/script/ScriptPluginWebRequest.md) | right | | + +#### Operator == +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L80) +```csharp +public static bool operator ==(ScriptPluginWebRequest left, ScriptPluginWebRequest right) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`ScriptPluginWebRequest`](iw4madmin/application/plugin/script/ScriptPluginWebRequest.md) | left | | +| [`ScriptPluginWebRequest`](iw4madmin/application/plugin/script/ScriptPluginWebRequest.md) | right | | + +#### GetHashCode +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L81) +```csharp +public override int GetHashCode() +``` + +#### Equals [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L84) +```csharp +public override bool Equals(object obj) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `object` | obj | | + +#### Equals [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L86) +```csharp +public virtual bool Equals(ScriptPluginWebRequest other) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`ScriptPluginWebRequest`](iw4madmin/application/plugin/script/ScriptPluginWebRequest.md) | other | | + +#### $ +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L88) +```csharp +public virtual ScriptPluginWebRequest $() +``` + +#### Deconstruct +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L90) +```csharp +public void Deconstruct(out string Url, out object Body, out string Method, out string ContentType, out Dictionary Headers) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `out` `string` | Url | | +| `out` `object` | Body | | +| `out` `string` | Method | | +| `out` `string` | ContentType | | +| `out` `Dictionary`<`string`, `string`> | Headers | | + +### Properties +#### EqualityContract +```csharp +protected virtual Type EqualityContract { get; } +``` + +#### Url +```csharp +public string Url { get; init; } +``` + +#### Body +```csharp +public object Body { get; init; } +``` + +#### Method +```csharp +public string Method { get; init; } +``` + +#### ContentType +```csharp +public string ContentType { get; init; } +``` + +#### Headers +```csharp +public Dictionary Headers { get; init; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/plugin/script/scriptpluginv2/EnumsToStringConverter.md b/CodeDocumentation/iw4madmin/application/plugin/script/scriptpluginv2/EnumsToStringConverter.md new file mode 100644 index 0000000..90cc49d --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/plugin/script/scriptpluginv2/EnumsToStringConverter.md @@ -0,0 +1,48 @@ +# EnumsToStringConverter `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.Plugin.Script.ScriptPluginV2 + IW4MAdmin.Application.Plugin.Script.ScriptPluginV2.EnumsToStringConverter[[EnumsToStringConverter]] + end + subgraph Jint.Runtime.Interop +Jint.Runtime.Interop.IObjectConverter[[IObjectConverter]] + end +Jint.Runtime.Interop.IObjectConverter --> IW4MAdmin.Application.Plugin.Script.ScriptPluginV2.EnumsToStringConverter +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `bool` | [`TryConvert`](#tryconvert)(`Engine` engine, `object` value, out `JsValue` result) | + +## Details +### Inheritance + - `IObjectConverter` + +### Constructors +#### EnumsToStringConverter +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ClientInfo.cs#L12) +```csharp +public EnumsToStringConverter() +``` + +### Methods +#### TryConvert +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ClientInfo.cs#L12) +```csharp +public virtual bool TryConvert(Engine engine, object value, out JsValue result) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Engine` | engine | | +| `object` | value | | +| `out` `JsValue` | result | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/queryhelpers/ClientResourceQueryHelper.md b/CodeDocumentation/iw4madmin/application/queryhelpers/ClientResourceQueryHelper.md new file mode 100644 index 0000000..7931e4d --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/queryhelpers/ClientResourceQueryHelper.md @@ -0,0 +1,52 @@ +# ClientResourceQueryHelper `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.QueryHelpers + IW4MAdmin.Application.QueryHelpers.ClientResourceQueryHelper[[ClientResourceQueryHelper]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IResourceQueryHelper_2[[IResourceQueryHelper< QueryType,ResultType >]] + class SharedLibraryCore.Interfaces.IResourceQueryHelper_2 interfaceStyle; + + end +SharedLibraryCore.Interfaces.IResourceQueryHelper_2 --> IW4MAdmin.Application.QueryHelpers.ClientResourceQueryHelper +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task`<[`ResourceQueryHelperResult`](../../../sharedlibrarycore/helpers/ResourceQueryHelperResultT.md)<`ClientResourceResponse`>> | [`QueryResource`](#queryresource)(`ClientResourceRequest` query) | + +## Details +### Inheritance + - [`IResourceQueryHelper`](../../../sharedlibrarycore/interfaces/IResourceQueryHelperTT.md)<`ClientResourceRequest`, `ClientResourceResponse`> + +### Constructors +#### ClientResourceQueryHelper +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/QueryHelpers/ClientResourceQueryHelper.cs#L30) +```csharp +public ClientResourceQueryHelper(IDatabaseContextFactory contextFactory, IGeoLocationService geoLocationService) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`IDatabaseContextFactory`](../../../data/abstractions/IDatabaseContextFactory.md) | contextFactory | | +| [`IGeoLocationService`](../../../sharedlibrarycore/interfaces/IGeoLocationService.md) | geoLocationService | | + +### Methods +#### QueryResource +```csharp +public virtual async Task> QueryResource(ClientResourceRequest query) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ClientResourceRequest` | query | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/rconparsers/BaseRConParser.md b/CodeDocumentation/iw4madmin/application/rconparsers/BaseRConParser.md new file mode 100644 index 0000000..cd1a802 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/rconparsers/BaseRConParser.md @@ -0,0 +1,220 @@ +# BaseRConParser `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.RConParsers + IW4MAdmin.Application.RConParsers.BaseRConParser[[BaseRConParser]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IRConParser[[IRConParser]] + class SharedLibraryCore.Interfaces.IRConParser interfaceStyle; + end +SharedLibraryCore.Interfaces.IRConParser --> IW4MAdmin.Application.RConParsers.BaseRConParser +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `bool` | [`CanGenerateLogPath`](#cangeneratelogpath) | `get, set` | +| [`IRConParserConfiguration`](../../../sharedlibrarycore/interfaces/IRConParserConfiguration.md) | [`Configuration`](#configuration) | `get, set` | +| `Game` | [`GameName`](#gamename) | `get, set` | +| `bool` | [`IsOneLog`](#isonelog) | `get, set` | +| `string` | [`Name`](#name) | `get, set` | +| `string` | [`RConEngine`](#rconengine) | `get, set` | +| `string` | [`Version`](#version) | `get, set` | + +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `void` | [`BeginGetDvar`](#begingetdvar)([`IRConConnection`](../../../sharedlibrarycore/interfaces/IRConConnection.md) connection, `string` dvarName, `AsyncCallback` callback, `CancellationToken` token) | +| `void` | [`BeginSetDvar`](#beginsetdvar)([`IRConConnection`](../../../sharedlibrarycore/interfaces/IRConConnection.md) connection, `string` dvarName, `object` dvarValue, `AsyncCallback` callback, `CancellationToken` token) | +| `Task`<`string``[]`> | [`ExecuteCommandAsync`](#executecommandasync)([`IRConConnection`](../../../sharedlibrarycore/interfaces/IRConConnection.md) connection, `string` command, `CancellationToken` token) | +| `T` | [`GetDefaultDvarValue`](#getdefaultdvarvalue)(`string` dvarName) | +| `Task`<[`Dvar`](../../../sharedlibrarycore/DvarT.md)<`T`>> | [`GetDvarAsync`](#getdvarasync)([`IRConConnection`](../../../sharedlibrarycore/interfaces/IRConConnection.md) connection, `string` dvarName, `T` fallbackValue, `CancellationToken` token) | +| `string` | [`GetOverrideDvarName`](#getoverridedvarname)(`string` dvarName) | +| `Task`<[`IStatusResponse`](../../../sharedlibrarycore/interfaces/IStatusResponse.md)> | [`GetStatusAsync`](#getstatusasync)([`IRConConnection`](../../../sharedlibrarycore/interfaces/IRConConnection.md) connection, `CancellationToken` token) | +| `Nullable`<`TimeSpan`> | [`OverrideTimeoutForCommand`](#overridetimeoutforcommand)(`string` command) | +| `Task`<`bool`> | [`SetDvarAsync`](#setdvarasync)([`IRConConnection`](../../../sharedlibrarycore/interfaces/IRConConnection.md) connection, `string` dvarName, `object` dvarValue, `CancellationToken` token) | + +#### Internal Static methods +| Returns | Name | +| --- | --- | +| `string` | [`g__RemoveTrailingColorCode|32_0`](#getdvarasyncgremovetrailingcolorcode320)(`string` input) | + +## Details +### Inheritance + - [ +`IRConParser` +](../../../sharedlibrarycore/interfaces/IRConParser.md) + +### Constructors +#### BaseRConParser +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/BaseRConParser.cs#L76) +```csharp +public BaseRConParser(ILogger logger, IParserRegexFactory parserRegexFactory) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ILogger`<[`BaseRConParser`](iw4madmin/application/rconparsers/BaseRConParser.md)> | logger | | +| [`IParserRegexFactory`](../../../sharedlibrarycore/interfaces/IParserRegexFactory.md) | parserRegexFactory | | + +### Methods +#### ExecuteCommandAsync +```csharp +public virtual async Task ExecuteCommandAsync(IRConConnection connection, string command, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`IRConConnection`](../../../sharedlibrarycore/interfaces/IRConConnection.md) | connection | | +| `string` | command | | +| `CancellationToken` | token | | + +#### GetDvarAsync +```csharp +public virtual async Task> GetDvarAsync(IRConConnection connection, string dvarName, T fallbackValue, CancellationToken token) +where T : +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`IRConConnection`](../../../sharedlibrarycore/interfaces/IRConConnection.md) | connection | | +| `string` | dvarName | | +| `T` | fallbackValue | | +| `CancellationToken` | token | | + +#### BeginGetDvar +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/BaseRConParser.cs#L16707566) +```csharp +public void BeginGetDvar(IRConConnection connection, string dvarName, AsyncCallback callback, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`IRConConnection`](../../../sharedlibrarycore/interfaces/IRConConnection.md) | connection | | +| `string` | dvarName | | +| `AsyncCallback` | callback | | +| `CancellationToken` | token | | + +#### GetStatusAsync +```csharp +public virtual async Task GetStatusAsync(IRConConnection connection, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`IRConConnection`](../../../sharedlibrarycore/interfaces/IRConConnection.md) | connection | | +| `CancellationToken` | token | | + +#### SetDvarAsync +```csharp +public virtual async Task SetDvarAsync(IRConConnection connection, string dvarName, object dvarValue, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`IRConConnection`](../../../sharedlibrarycore/interfaces/IRConConnection.md) | connection | | +| `string` | dvarName | | +| `object` | dvarValue | | +| `CancellationToken` | token | | + +#### BeginSetDvar +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/BaseRConParser.cs#L16707566) +```csharp +public void BeginSetDvar(IRConConnection connection, string dvarName, object dvarValue, AsyncCallback callback, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`IRConConnection`](../../../sharedlibrarycore/interfaces/IRConConnection.md) | connection | | +| `string` | dvarName | | +| `object` | dvarValue | | +| `AsyncCallback` | callback | | +| `CancellationToken` | token | | + +#### GetOverrideDvarName +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/BaseRConParser.cs#L358) +```csharp +public virtual string GetOverrideDvarName(string dvarName) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | dvarName | | + +#### GetDefaultDvarValue +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/BaseRConParser.cs#L367) +```csharp +public virtual T GetDefaultDvarValue(string dvarName) +where T : +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | dvarName | | + +#### OverrideTimeoutForCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/BaseRConParser.cs#L372) +```csharp +public virtual Nullable OverrideTimeoutForCommand(string command) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | command | | + +#### g__RemoveTrailingColorCode|32_0 +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/BaseRConParser.cs#L130) +```csharp +internal static string g__RemoveTrailingColorCode|32_0(string input) +where T : +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | input | | + +### Properties +#### Configuration +```csharp +public virtual IRConParserConfiguration Configuration { get; set; } +``` + +#### Version +```csharp +public virtual string Version { get; set; } +``` + +#### GameName +```csharp +public Game GameName { get; set; } +``` + +#### CanGenerateLogPath +```csharp +public bool CanGenerateLogPath { get; set; } +``` + +#### Name +```csharp +public string Name { get; set; } +``` + +#### RConEngine +```csharp +public string RConEngine { get; set; } +``` + +#### IsOneLog +```csharp +public bool IsOneLog { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/rconparsers/DynamicRConParser.md b/CodeDocumentation/iw4madmin/application/rconparsers/DynamicRConParser.md new file mode 100644 index 0000000..7ed5f59 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/rconparsers/DynamicRConParser.md @@ -0,0 +1,41 @@ +# DynamicRConParser `Internal class` + +## Description +empty implementation of the IW4RConParser + allows script plugins to generate dynamic RCon parsers + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.RConParsers + IW4MAdmin.Application.RConParsers.DynamicRConParser[[DynamicRConParser]] + IW4MAdmin.Application.RConParsers.BaseRConParser[[BaseRConParser]] + end +IW4MAdmin.Application.RConParsers.BaseRConParser --> IW4MAdmin.Application.RConParsers.DynamicRConParser +``` + +## Details +### Summary +empty implementation of the IW4RConParser + allows script plugins to generate dynamic RCon parsers + +### Inheritance + - [ +`BaseRConParser` +](./BaseRConParser.md) + +### Constructors +#### DynamicRConParser +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/DynamicRConParser.cs#L12) +```csharp +public DynamicRConParser(ILogger logger, IParserRegexFactory parserRegexFactory) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ILogger`<[`BaseRConParser`](./BaseRConParser.md)> | logger | | +| [`IParserRegexFactory`](../../../sharedlibrarycore/interfaces/IParserRegexFactory.md) | parserRegexFactory | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/rconparsers/DynamicRConParserConfiguration.md b/CodeDocumentation/iw4madmin/application/rconparsers/DynamicRConParserConfiguration.md new file mode 100644 index 0000000..3e2bb28 --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/rconparsers/DynamicRConParserConfiguration.md @@ -0,0 +1,182 @@ +# DynamicRConParserConfiguration `Public class` + +## Description +generic implementation of the IRConParserConfiguration + allows script plugins to generate dynamic RCon configurations + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.RConParsers + IW4MAdmin.Application.RConParsers.DynamicRConParserConfiguration[[DynamicRConParserConfiguration]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IRConParserConfiguration[[IRConParserConfiguration]] + class SharedLibraryCore.Interfaces.IRConParserConfiguration interfaceStyle; + end +SharedLibraryCore.Interfaces.IRConParserConfiguration --> IW4MAdmin.Application.RConParsers.DynamicRConParserConfiguration +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| [`ColorCodeMapping`](../../../sharedlibrarycore/formatting/ColorCodeMapping.md) | [`ColorCodeMapping`](#colorcodemapping) | `get, set` | +| [`CommandPrefix`](../../../sharedlibrarycore/rcon/CommandPrefix.md) | [`CommandPrefixes`](#commandprefixes) | `get, set` | +| `IDictionary`<`string`, `string`> | [`DefaultDvarValues`](#defaultdvarvalues) | `get, set` | +| `string` | [`DefaultInstallationDirectoryHint`](#defaultinstallationdirectoryhint) | `get, set` | +| `Nullable`<`int`> | [`DefaultRConPort`](#defaultrconport) | `get, set` | +| [`ParserRegex`](../../../sharedlibrarycore/interfaces/ParserRegex.md) | [`Dvar`](#dvar) | `get, set` | +| `short` | [`FloodProtectInterval`](#floodprotectinterval) | `get, set` | +| [`ParserRegex`](../../../sharedlibrarycore/interfaces/ParserRegex.md) | [`GametypeStatus`](#gametypestatus) | `get, set` | +| `NumberStyles` | [`GuidNumberStyle`](#guidnumberstyle) | `get, set` | +| [`ParserRegex`](../../../sharedlibrarycore/interfaces/ParserRegex.md) | [`HostnameStatus`](#hostnamestatus) | `get, set` | +| [`ParserRegex`](../../../sharedlibrarycore/interfaces/ParserRegex.md) | [`MapStatus`](#mapstatus) | `get, set` | +| [`ParserRegex`](../../../sharedlibrarycore/interfaces/ParserRegex.md) | [`MaxPlayersStatus`](#maxplayersstatus) | `get, set` | +| `string` | [`NoticeLineSeparator`](#noticelineseparator) | `get, set` | +| `int` | [`NoticeMaxCharactersPerLine`](#noticemaxcharactersperline) | `get, set` | +| `int` | [`NoticeMaximumLines`](#noticemaximumlines) | `get, set` | +| `IDictionary`<`string`, `Nullable`<`int`>> | [`OverrideCommandTimeouts`](#overridecommandtimeouts) | `get, set` | +| `IDictionary`<`string`, `string`> | [`OverrideDvarNameMapping`](#overridedvarnamemapping) | `get, set` | +| `string` | [`ServerNotRunningResponse`](#servernotrunningresponse) | `get, set` | +| `bool` | [`ShouldRemoveDiacritics`](#shouldremovediacritics) | `get, set` | +| [`ParserRegex`](../../../sharedlibrarycore/interfaces/ParserRegex.md) | [`Status`](#status) | `get, set` | +| [`ParserRegex`](../../../sharedlibrarycore/interfaces/ParserRegex.md) | [`StatusHeader`](#statusheader) | `get, set` | +| `bool` | [`WaitForResponse`](#waitforresponse) | `get, set` | + +## Details +### Summary +generic implementation of the IRConParserConfiguration + allows script plugins to generate dynamic RCon configurations + +### Inheritance + - [ +`IRConParserConfiguration` +](../../../sharedlibrarycore/interfaces/IRConParserConfiguration.md) + +### Constructors +#### DynamicRConParserConfiguration +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/RConParsers/DynamicRConParserConfiguration.cs#L25) +```csharp +public DynamicRConParserConfiguration(IParserRegexFactory parserRegexFactory) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`IParserRegexFactory`](../../../sharedlibrarycore/interfaces/IParserRegexFactory.md) | parserRegexFactory | | + +### Properties +#### CommandPrefixes +```csharp +public CommandPrefix CommandPrefixes { get; set; } +``` + +#### Status +```csharp +public ParserRegex Status { get; set; } +``` + +#### MapStatus +```csharp +public ParserRegex MapStatus { get; set; } +``` + +#### GametypeStatus +```csharp +public ParserRegex GametypeStatus { get; set; } +``` + +#### HostnameStatus +```csharp +public ParserRegex HostnameStatus { get; set; } +``` + +#### MaxPlayersStatus +```csharp +public ParserRegex MaxPlayersStatus { get; set; } +``` + +#### Dvar +```csharp +public ParserRegex Dvar { get; set; } +``` + +#### StatusHeader +```csharp +public ParserRegex StatusHeader { get; set; } +``` + +#### ServerNotRunningResponse +```csharp +public string ServerNotRunningResponse { get; set; } +``` + +#### WaitForResponse +```csharp +public bool WaitForResponse { get; set; } +``` + +#### GuidNumberStyle +```csharp +public NumberStyles GuidNumberStyle { get; set; } +``` + +#### OverrideDvarNameMapping +```csharp +public IDictionary OverrideDvarNameMapping { get; set; } +``` + +#### DefaultDvarValues +```csharp +public IDictionary DefaultDvarValues { get; set; } +``` + +#### OverrideCommandTimeouts +```csharp +public IDictionary> OverrideCommandTimeouts { get; set; } +``` + +#### NoticeMaximumLines +```csharp +public virtual int NoticeMaximumLines { get; set; } +``` + +#### NoticeMaxCharactersPerLine +```csharp +public int NoticeMaxCharactersPerLine { get; set; } +``` + +#### NoticeLineSeparator +```csharp +public string NoticeLineSeparator { get; set; } +``` + +#### DefaultRConPort +```csharp +public Nullable DefaultRConPort { get; set; } +``` + +#### DefaultInstallationDirectoryHint +```csharp +public string DefaultInstallationDirectoryHint { get; set; } +``` + +#### FloodProtectInterval +```csharp +public short FloodProtectInterval { get; set; } +``` + +#### ShouldRemoveDiacritics +```csharp +public bool ShouldRemoveDiacritics { get; set; } +``` + +#### ColorCodeMapping +```csharp +public ColorCodeMapping ColorCodeMapping { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/iw4madmin/application/rconparsers/StatusResponse.md b/CodeDocumentation/iw4madmin/application/rconparsers/StatusResponse.md new file mode 100644 index 0000000..e26603e --- /dev/null +++ b/CodeDocumentation/iw4madmin/application/rconparsers/StatusResponse.md @@ -0,0 +1,67 @@ +# StatusResponse `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph IW4MAdmin.Application.RConParsers + IW4MAdmin.Application.RConParsers.StatusResponse[[StatusResponse]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IStatusResponse[[IStatusResponse]] + class SharedLibraryCore.Interfaces.IStatusResponse interfaceStyle; + end +SharedLibraryCore.Interfaces.IStatusResponse --> IW4MAdmin.Application.RConParsers.StatusResponse +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| [`EFClient`](../../../sharedlibrarycore/database/models/EFClient.md)`[]` | [`Clients`](#clients) | `get, set` | +| `string` | [`GameType`](#gametype) | `get, set` | +| `string` | [`Hostname`](#hostname) | `get, set` | +| `string` | [`Map`](#map) | `get, set` | +| `Nullable`<`int`> | [`MaxClients`](#maxclients) | `get, set` | + +## Details +### Inheritance + - [ +`IStatusResponse` +](../../../sharedlibrarycore/interfaces/IStatusResponse.md) + +### Constructors +#### StatusResponse +```csharp +public StatusResponse() +``` + +### Properties +#### Map +```csharp +public string Map { get; set; } +``` + +#### GameType +```csharp +public string GameType { get; set; } +``` + +#### Hostname +```csharp +public string Hostname { get; set; } +``` + +#### MaxClients +```csharp +public Nullable MaxClients { get; set; } +``` + +#### Clients +```csharp +public EFClient Clients { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/stats/models/AuditFields.md b/CodeDocumentation/stats/models/AuditFields.md new file mode 100644 index 0000000..379cd8e --- /dev/null +++ b/CodeDocumentation/stats/models/AuditFields.md @@ -0,0 +1,49 @@ +# AuditFields `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph Stats.Models + Stats.Models.AuditFields[[AuditFields]] + end + subgraph Data.Abstractions + Data.Abstractions.IAuditFields[[IAuditFields]] + end +Data.Abstractions.IAuditFields --> Stats.Models.AuditFields +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `DateTime` | [`CreatedDateTime`](#createddatetime) | `get, set` | +| `Nullable`<`DateTime`> | [`UpdatedDateTime`](#updateddatetime) | `get, set` | + +## Details +### Inheritance + - [ +`IAuditFields` +](../../data/abstractions/IAuditFields.md) + +### Constructors +#### AuditFields +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/Application/Misc/MasterCommunication.cs#L30) +```csharp +public AuditFields() +``` + +### Properties +#### CreatedDateTime +```csharp +public DateTime CreatedDateTime { get; set; } +``` + +#### UpdatedDateTime +```csharp +public Nullable UpdatedDateTime { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/Plugin-Development.md b/Plugin-Development.md index 8a6b903..2535515 100644 --- a/Plugin-Development.md +++ b/Plugin-Development.md @@ -5,43 +5,97 @@ The NuGet package for **IW4MAdmin's** "Shared Library" can be obtained from the Referencing this package will give you the ability to write plugins against **IW4MAdmin's** core library. ### Code **IW4MAdmin's** functionality can be extended by writing additional plugins in C#. -Each class library must implement the `IPlugin` interface. -See the existing [plugins](https://github.com/RaidMax/IW4M-Admin/tree/master/Plugins) for examples. +Each class library must implement the [IPluginV2](./CodeDocumentation/SharedLibraryCore/interfaces/IPluginV2.md) interface. +See the existing [plugins](https://github.com/RaidMax/IW4M-Admin/tree/release/pre/Plugins) for examples. ### JavaScript **IW4MAdmin** functionality can also be extended using JavaScript. -The JavaScript parser supports [ECMA 5.1](https://ecma-international.org/ecma-262/5.1/) standards. +The JavaScript parser supports these [ECMA Features](https://github.com/sebastienros/jint#supported-features). +JavaScript plugins use C# classes behind the scenes and as such there is interop between the C# backing. ### Plugin Object Template In order to be properly parsed by the JavaScript engine, every plugin must conform to the following template. + ```js -var plugin = { - author: 'YourHandle', - version: 1.0, - name: 'Sample JavaScript Plugin', +const init = (registerNotify, serviceResolver, config) => { + return plugin; +}; - onEventAsync: function (gameEvent, server) { - }, +const plugin = { + author: 'Author', + version: '1.0', + name: 'PluginName' +} - onLoadAsync: function (manager) { - }, +const commands = []; +``` - onUnloadAsync: function () { - }, - - onTickAsync: function (server) { - } +### Template Example/Breakdown +```javascript +const init = (registerNotify, serviceResolver, config) => { + registerNotify('IManagementEventSubscriptions.ClientStateInitialized', (clientEvent, _) => plugin.onClientEnteredMatch(clientEvent)); + plugin.onLoad(serviceResolver, config); + return plugin; }; ``` -### Required Properties -- `author` — [string] Author of the plugin (usually your name or online name/alias) -- `version` — [float] Version number of your plugin (useful if you release several different versions) -- `name` — [string] Name of your plugin (be descriptive!) -- `onEventAsync` — [function] Handler executed when an event occurs - - `gameEvent` — [parameter object] Object containing event type, origin, target, and other info (see the GameEvent class declaration) - - `server` — [parameter object] Object containing information and methods about the server the event occured on (see the Server class declaration) -- `onLoadAsync` — [function] Handler executed when the plugin is loaded by code - - `manager` — [parameter object] Object reference to the application manager (see the IManager interface definition) -- `onUnloadAsync` — [function] Handler executed when the plugin is unloaded by code (see live reloading) -- `onTickAsync` — [function] Handler executed approximately once per second by code *(unimplemented as of version 2.\*)* - - `server` — [parameter object] Object containing information and methods about the server the event occured on (see the Server class declaration) +##### Arguments +| Name | Description | +| --- | --- | +| registerNotify | Helper to subscribe to events | +| serviceResolver | [IScriptPluginServiceResolver](./CodeDocumentation/SharedLibraryCore/interfaces/IScriptPluginServiceResolver.md) | +| config | [ScriptPluginConfigurationWrapper](./CodeDocumentation/iw4madmin/application/plugin/script/ScriptPluginConfigurationWrapper.md) | + +##### `registerNotify` event sources +[IManagementEventSubscriptions](./CodeDocumentation/SharedLibraryCore/interfaces/events/IManagementEventSubscriptions.md) +[IGameServerEventSubscriptions](./CodeDocumentation/SharedLibraryCore/interfaces/events/IGameServerEventSubscriptions.md) +[IGameEventSubscriptions](./CodeDocumentation/SharedLibraryCore/interfaces/events/IGameEventSubscriptions.md) + +--- + +```javascript +const plugin = { + author: 'Raidmax', + version: '1.0', + name: 'Example PLugin', + eventManager: null, + onLoad: function(serviceResolver, config) { + // use pseudo dependency injection to get IManager + this.eventManager = serviceResolver.resolveService('IManager'); + }, + requestExecuteCommand: function(command, server) { + const serverEvents = importNamespace('SharedLibraryCore.Events.Server'); + const requestEvent = new serverEvents.ServerCommandExecuteRequested(command, server); + requestEvent.timeoutMs = 2000; + requestEvent.source = this.name; + + // queue our request on the event manager + this.eventManager.queueEvent(requestEvent); + } +} +``` +[IManager](./CodeDocumentation/SharedLibraryCore/interfaces/IManager.md.md) +[ServerCommandExecuteRequested](./CodeDocumentation/SharedLibraryCore/events/server/ServerCommandRequestExecuteEvent.md) +[IPluginV2](./CodeDocumentation/SharedLibraryCore/interfaces/IPluginV2.md) + +--- +```javascript +const commands = [{ + name: 'example', + description: 'executes example command', + alias: 'ex', + permission: 'User', + targetRequired: false, + arguments: [], + execute: (gameEvent) => { + plugin.requestExecuteCommand('example', gameEvent.owner); + } +}]; +``` +[IManagerCommand](./CodeDocumentation/SharedLibraryCore/interfaces/IManagerCommand.md) +[Permission](./CodeDocumentation/data/models/client/efclient/Permission.md) +[GameEvent](./CodeDocumentation/SharedLibraryCore/GameEvent.md) + +--- + ### Live Reloading -Thanks to JavaScript's flexibility and parsability, the plugin importer scans the plugins folder and reloads the JavaScript plugins on demand as they're modified. This allows faster development/testing/debugging. \ No newline at end of file +Thanks to JavaScript's flexibility and parsability, the plugin importer scans the plugins folder and reloads the JavaScript plugins on demand as they're modified. This allows faster development/testing/debugging. + +## [Additional Examples](https://github.com/RaidMax/IW4M-Admin/tree/release/pre/Plugins/ScriptPlugins) \ No newline at end of file diff --git a/_Sidebar.md b/_Sidebar.md index cfb7052..33a8252 100644 --- a/_Sidebar.md +++ b/_Sidebar.md @@ -10,7 +10,6 @@ * [Searching](https://github.com/RaidMax/IW4M-Admin/wiki/Searching) * [Plugin Development](https://github.com/RaidMax/IW4M-Admin/wiki/Plugin-Development) * [Examples](https://github.com/RaidMax/IW4M-Admin/wiki/Plugin-Examples) - * [Documentation](https://github.com/RaidMax/IW4M-Admin/wiki/CodeDocumentation/SharedLibraryCore) * [Configuration](https://github.com/RaidMax/IW4M-Admin/wiki/Configuration) * [Game Log Server](https://github.com/RaidMax/IW4M-Admin/wiki/Game-Log-Server) * [Webfront](https://github.com/RaidMax/IW4M-Admin/wiki/Webfront) \ No newline at end of file