Skip to content

Commit

Permalink
Update GitHub Pages
Browse files Browse the repository at this point in the history
  • Loading branch information
@tparviainen
tparviainen committed Jun 6, 2023
1 parent 66ac34e commit 70f020e
Show file tree
Hide file tree
Showing 20 changed files with 2,695 additions and 93 deletions.
142 changes: 142 additions & 0 deletions docs/api/ClashOfClans.ILeagues.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,148 @@ <h5 id="ClashOfClans_ILeagues_syntax">Syntax</h5>
</div>
<h3 id="methods">Methods
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/tparviainen/clashofclans/new/develop/apiSpec/new?filename=ClashOfClans_ILeagues_GetBuilderBaseLeagueAsync_System_Nullable_System_Int32__.md&amp;value=---%0Auid%3A%20ClashOfClans.ILeagues.GetBuilderBaseLeagueAsync(System.Nullable%7BSystem.Int32%7D)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/tparviainen/clashofclans/blob/develop/src/ClashOfClans/ILeagues.cs/#L103">View Source</a>
</span>
<a id="ClashOfClans_ILeagues_GetBuilderBaseLeagueAsync_" data-uid="ClashOfClans.ILeagues.GetBuilderBaseLeagueAsync*"></a>
<h4 id="ClashOfClans_ILeagues_GetBuilderBaseLeagueAsync_System_Nullable_System_Int32__" data-uid="ClashOfClans.ILeagues.GetBuilderBaseLeagueAsync(System.Nullable{System.Int32})">GetBuilderBaseLeagueAsync(Nullable&lt;Int32&gt;)</h4>
<div class="markdown level1 summary"><p>Get Builder Base league information</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">Task&lt;BuilderBaseLeague&gt; GetBuilderBaseLeagueAsync(int? leagueId)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.nullable-1">Nullable</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">Int32</a>&gt;</td>
<td><span class="parametername">leagueId</span></td>
<td><p>Identifier of the league</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1">Task</a>&lt;<a class="xref" href="ClashOfClans.Models.BuilderBaseLeague.html">BuilderBaseLeague</a>&gt;</td>
<td><p>Requested builder base league</p>
</td>
</tr>
</tbody>
</table>
<h5 class="exceptions">Exceptions</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Condition</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="ClashOfClans.Core.ClashOfClansException.html">ClashOfClansException</a></td>
<td><p>Communication error with the backend API</p>
</td>
</tr>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.argumentexception">ArgumentException</a></td>
<td><p>Argument is invalid</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/tparviainen/clashofclans/new/develop/apiSpec/new?filename=ClashOfClans_ILeagues_GetBuilderBaseLeaguesAsync_ClashOfClans_Search_Query_.md&amp;value=---%0Auid%3A%20ClashOfClans.ILeagues.GetBuilderBaseLeaguesAsync(ClashOfClans.Search.Query)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/tparviainen/clashofclans/blob/develop/src/ClashOfClans/ILeagues.cs/#L94">View Source</a>
</span>
<a id="ClashOfClans_ILeagues_GetBuilderBaseLeaguesAsync_" data-uid="ClashOfClans.ILeagues.GetBuilderBaseLeaguesAsync*"></a>
<h4 id="ClashOfClans_ILeagues_GetBuilderBaseLeaguesAsync_ClashOfClans_Search_Query_" data-uid="ClashOfClans.ILeagues.GetBuilderBaseLeaguesAsync(ClashOfClans.Search.Query)">GetBuilderBaseLeaguesAsync(Query)</h4>
<div class="markdown level1 summary"><p>List Builder Base leagues</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">Task&lt;QueryResult&lt;BuilderBaseLeagueList&gt;&gt; GetBuilderBaseLeaguesAsync(Query query = null)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="ClashOfClans.Search.Query.html">Query</a></td>
<td><span class="parametername">query</span></td>
<td><p>Optional query parameters</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1">Task</a>&lt;<a class="xref" href="ClashOfClans.Search.QueryResult-1.html">QueryResult</a>&lt;<a class="xref" href="ClashOfClans.Models.BuilderBaseLeagueList.html">BuilderBaseLeagueList</a>&gt;&gt;</td>
<td><p>Builder Base league list</p>
</td>
</tr>
</tbody>
</table>
<h5 class="exceptions">Exceptions</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Condition</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="ClashOfClans.Core.ClashOfClansException.html">ClashOfClansException</a></td>
<td><p>Communication error with the backend API</p>
</td>
</tr>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.argumentexception">ArgumentException</a></td>
<td><p>Argument is invalid</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/tparviainen/clashofclans/new/develop/apiSpec/new?filename=ClashOfClans_ILeagues_GetCapitalLeagueAsync_System_Nullable_System_Int32__.md&amp;value=---%0Auid%3A%20ClashOfClans.ILeagues.GetCapitalLeagueAsync(System.Nullable%7BSystem.Int32%7D)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
Expand Down
154 changes: 154 additions & 0 deletions docs/api/ClashOfClans.ILocations.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,83 @@ <h5 id="ClashOfClans_ILocations_syntax">Syntax</h5>
</div>
<h3 id="methods">Methods
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/tparviainen/clashofclans/new/develop/apiSpec/new?filename=ClashOfClans_ILocations_GetClanBuilderBaseRankingAsync_System_Nullable_System_Int32__ClashOfClans_Search_Query_.md&amp;value=---%0Auid%3A%20ClashOfClans.ILocations.GetClanBuilderBaseRankingAsync(System.Nullable%7BSystem.Int32%7D%2CClashOfClans.Search.Query)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/tparviainen/clashofclans/blob/develop/src/ClashOfClans/ILocations.cs/#L98">View Source</a>
</span>
<a id="ClashOfClans_ILocations_GetClanBuilderBaseRankingAsync_" data-uid="ClashOfClans.ILocations.GetClanBuilderBaseRankingAsync*"></a>
<h4 id="ClashOfClans_ILocations_GetClanBuilderBaseRankingAsync_System_Nullable_System_Int32__ClashOfClans_Search_Query_" data-uid="ClashOfClans.ILocations.GetClanBuilderBaseRankingAsync(System.Nullable{System.Int32},ClashOfClans.Search.Query)">GetClanBuilderBaseRankingAsync(Nullable&lt;Int32&gt;, Query)</h4>
<div class="markdown level1 summary"><p>Get clan Builder Base rankings for a specific location</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">Task&lt;QueryResult&lt;ClanBuilderBaseRankingList&gt;&gt; GetClanBuilderBaseRankingAsync(int? locationId, Query query = null)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.nullable-1">Nullable</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">Int32</a>&gt;</td>
<td><span class="parametername">locationId</span></td>
<td><p>Identifier of the location to retrieve</p>
</td>
</tr>
<tr>
<td><a class="xref" href="ClashOfClans.Search.Query.html">Query</a></td>
<td><span class="parametername">query</span></td>
<td><p>Optional query parameters</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1">Task</a>&lt;<a class="xref" href="ClashOfClans.Search.QueryResult-1.html">QueryResult</a>&lt;<a class="xref" href="ClashOfClans.Models.ClanBuilderBaseRankingList.html">ClanBuilderBaseRankingList</a>&gt;&gt;</td>
<td><p>Clan builder base ranking list</p>
</td>
</tr>
</tbody>
</table>
<h5 class="exceptions">Exceptions</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Condition</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="ClashOfClans.Core.ClashOfClansException.html">ClashOfClansException</a></td>
<td><p>Communication error with the backend API</p>
</td>
</tr>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.argumentexception">ArgumentException</a></td>
<td><p>Argument is invalid</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/tparviainen/clashofclans/new/develop/apiSpec/new?filename=ClashOfClans_ILocations_GetClanCapitalRankingAsync_System_Nullable_System_Int32__ClashOfClans_Search_Query_.md&amp;value=---%0Auid%3A%20ClashOfClans.ILocations.GetClanCapitalRankingAsync(System.Nullable%7BSystem.Int32%7D%2CClashOfClans.Search.Query)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
Expand Down Expand Up @@ -453,6 +530,83 @@ <h5 class="exceptions">Exceptions</h5>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.argumentexception">ArgumentException</a></td>
<td><p>Argument is invalid</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/tparviainen/clashofclans/new/develop/apiSpec/new?filename=ClashOfClans_ILocations_GetPlayerBuilderBaseRankingAsync_System_Nullable_System_Int32__ClashOfClans_Search_Query_.md&amp;value=---%0Auid%3A%20ClashOfClans.ILocations.GetPlayerBuilderBaseRankingAsync(System.Nullable%7BSystem.Int32%7D%2CClashOfClans.Search.Query)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/tparviainen/clashofclans/blob/develop/src/ClashOfClans/ILocations.cs/#L88">View Source</a>
</span>
<a id="ClashOfClans_ILocations_GetPlayerBuilderBaseRankingAsync_" data-uid="ClashOfClans.ILocations.GetPlayerBuilderBaseRankingAsync*"></a>
<h4 id="ClashOfClans_ILocations_GetPlayerBuilderBaseRankingAsync_System_Nullable_System_Int32__ClashOfClans_Search_Query_" data-uid="ClashOfClans.ILocations.GetPlayerBuilderBaseRankingAsync(System.Nullable{System.Int32},ClashOfClans.Search.Query)">GetPlayerBuilderBaseRankingAsync(Nullable&lt;Int32&gt;, Query)</h4>
<div class="markdown level1 summary"><p>Get player Builder Base rankings for a specific location</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">Task&lt;QueryResult&lt;PlayerBuilderBaseRankingList&gt;&gt; GetPlayerBuilderBaseRankingAsync(int? locationId, Query query = null)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.nullable-1">Nullable</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">Int32</a>&gt;</td>
<td><span class="parametername">locationId</span></td>
<td><p>Identifier of the location to retrieve</p>
</td>
</tr>
<tr>
<td><a class="xref" href="ClashOfClans.Search.Query.html">Query</a></td>
<td><span class="parametername">query</span></td>
<td><p>Optional query parameters</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1">Task</a>&lt;<a class="xref" href="ClashOfClans.Search.QueryResult-1.html">QueryResult</a>&lt;<a class="xref" href="ClashOfClans.Models.PlayerBuilderBaseRankingList.html">PlayerBuilderBaseRankingList</a>&gt;&gt;</td>
<td><p>Player builder base ranking list</p>
</td>
</tr>
</tbody>
</table>
<h5 class="exceptions">Exceptions</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Condition</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="ClashOfClans.Core.ClashOfClansException.html">ClashOfClansException</a></td>
<td><p>Communication error with the backend API</p>
</td>
</tr>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.argumentexception">ArgumentException</a></td>
<td><p>Argument is invalid</p>
</td>
</tr>
</tbody>
Expand Down

0 comments on commit 70f020e

Please sign in to comment.