TheFinals.NET
1.0.3
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package TheFinals.NET --version 1.0.3
NuGet\Install-Package TheFinals.NET -Version 1.0.3
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="TheFinals.NET" Version="1.0.3" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add TheFinals.NET --version 1.0.3
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: TheFinals.NET, 1.0.3"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install TheFinals.NET as a Cake Addin #addin nuget:?package=TheFinals.NET&version=1.0.3 // Install TheFinals.NET as a Cake Tool #tool nuget:?package=TheFinals.NET&version=1.0.3
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
TheFinals.NET
TheFinals.NET is a .NET wrapper for The Finals API. This library provides a simple and efficient way to interact with the API, allowing you to retrieve for eaxmple leaderboard data with ease.
Features
- Supports multiple versions/seasons of the leaderboard API.
- Simple api to get leaderboard data.
- Allows filtering of leaderboard entries by name.
- Supports retrieving a specific number of leaderboard entries.
- Supports retrieving League image for each league, as url or byte array.
Installation
&labelColor=hsl(220%2C%206%25%2C%2090%25)&color=hsl(350%2C%2074%25%2C%2046%25))
Usage
Here's a basic example of how to use TheFinals.NET:
using TheFinals.NET.Endpoints;
using TheFinals.NET.Enums;
using TheFinals.NET.Models;
using TheFinals.NET.Providers;
TheFinalsClient client = new TheFinalsClient();
List<LeaderboardEntry> leaderboardSeason2 = await client.Leaderboard.GetAsync(LeaderboardVersion.Season2);
List<LeaderboardEntry> leaderboardSeason1Filters = await client.Leaderboard.GetAsync(LeaderboardVersion.Season1, Platform.Steam, count:500, nameFilter:"asd");
string imageUrl = client.League.GetImageUrl(leaderboardSeason2[0].League, LeagueImageType.Full);
byte[] imageByte = client.League.GetImageAsync(League.Diamond4, LeagueImageType.Thumbnail);
Contributing
Contributions are always welcomed.
Note
Project is not affiliated with Embark Studios or The Finals.
Links
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
| .NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
| .NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
| .NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
| MonoAndroid | monoandroid was computed. |
| MonoMac | monomac was computed. |
| MonoTouch | monotouch was computed. |
| Tizen | tizen40 was computed. tizen60 was computed. |
| Xamarin.iOS | xamarinios was computed. |
| Xamarin.Mac | xamarinmac was computed. |
| Xamarin.TVOS | xamarintvos was computed. |
| Xamarin.WatchOS | xamarinwatchos was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.NETStandard 2.0
- Newtonsoft.Json (>= 13.0.3)
- xunit.assert (>= 2.7.0)
- xunit.extensibility.core (>= 2.7.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Routes managment, implementation of League endpoit/service, League enum and updated LeaderboardEntry to get League enum instead of int and string function