mirror of
https://github.com/Sarsoo/IF.Lastfm.git
synced 2024-10-16 23:13:07 +01:00
101 lines
3.4 KiB
Markdown
101 lines
3.4 KiB
Markdown
# Inflatable Last.fm .NET SDK
|
|
[](LICENCE.md) [](https://ci.appveyor.com/project/rikkit/lastfm) [](https://gitter.im/inflatablefriends/lastfm?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
|
|
|
|
## Project Goals
|
|
|
|
- To provide complete .NET bindings for the Last.fm REST API
|
|
- To build useful components for Last.fm applications
|
|
- To be the very best, like no-one ever was
|
|
|
|
## Contributing
|
|
|
|
Input is always welcome! [Raise an issue on GitHub](https://github.com/inflatablefriends/lastfm/issues), or send a message to [the Gitter chatroom](https://gitter.im/inflatablefriends/lastfm) if you need help with the library.
|
|
|
|
If you're interested in contributing code or documentation, [this short introduction to the library](doc/contributing.md) will help you get started.
|
|
|
|
## Quickstart
|
|
|
|
### Installing the SDK
|
|
|
|
#### NuGet - production code
|
|
|
|
Install [the NuGet package](
|
|
https://www.nuget.org/packages/Inflatable.Lastfm/). Search for ```Inflatable.Lastfm``` in the NuGet package browser.
|
|
|
|
#### NuGet - prerelease code
|
|
|
|
There is a NuGet package built for every commit to master. Add ```https://ci.appveyor.com/nuget/lastfm``` to your NuGet package sources, and install the ```IF.Lastfm.Core``` prerelease package.
|
|
|
|
#### From source
|
|
|
|
Clone this repo and reference ```IF.Lastfm.Core``` in your application. Your IDE needs to support C# 6 and portable libraries - Visual Studio 2015 Community or better.
|
|
|
|
### Using the SDK
|
|
|
|
First, [sign up for Last.fm API](http://last.fm/api) access if you haven't already.
|
|
|
|
Create a LastfmClient:
|
|
|
|
```c#
|
|
var client = new LastfmClient("apikey", "apisecret");
|
|
```
|
|
|
|
Get information about an album:
|
|
|
|
```c#
|
|
var response = client.Album.GetInfoAsync("Grimes", "Visions");
|
|
|
|
LastAlbum visions = response.Content;
|
|
```
|
|
|
|
For methods that return several items, you can iterate over the response:
|
|
|
|
```c#
|
|
var pageResponse = await client.Artist.GetTopTracksAsync("Ben Frost", page: 5, itemsPerPage: 100);
|
|
|
|
var trackNames = pageResponse.Select(track => track.Name);
|
|
```
|
|
|
|
Several API methods require user authentication. Once you have your user's Last.fm username and password, you can authenticate your instance of LastfmClient:
|
|
|
|
```c#
|
|
var response = await client.Auth.GetSessionTokenAsync("username", "pass");
|
|
|
|
// or load an existing session
|
|
UserSession cachedSession;
|
|
var succesful = client.Auth.LoadSession(cachedSession);
|
|
```
|
|
|
|
Authenticated methods then work like any other
|
|
|
|
```c#
|
|
if (client.Auth.HasAuthenticated) {
|
|
var response = await client.Track.LoveAsync("Ibi Dreams of Pavement (A Better Day)", "Broken Social Scene");
|
|
}
|
|
```
|
|
|
|
## Documentation
|
|
|
|
- [Api method progress report](PROGRESS.md)
|
|
- [Contributing](doc/contributing.md)
|
|
- [Scrobbling](doc/scrobbling.md)
|
|
- [Dependency Injection](doc/dependency-injection.md)
|
|
- [Example Windows Phone app](https://github.com/inflatablefriends/lastfm-samples)
|
|
|
|
## Platform Compatibility
|
|
|
|
The library is compatible with:
|
|
|
|
- .NET 4.5 (including Mono)
|
|
- Windows 8.0
|
|
- Windows Phone 8.1
|
|
- Windows Phone Silverlight 8
|
|
- Xamarin.Android and Xamarin.iOS
|
|
|
|
If you need support for Windows Phone 7, or another .NET platform, it's probably easy enough. Raise an issue or send a PR.
|
|
|
|
## Credits
|
|
|
|
Maintained by [@rikkilt](http://twitter.com/rikkilt).
|
|
Thanks to [all contributors](https://github.com/inflatablefriends/lastfm/graphs/contributors)!
|