Added missing docs

This commit is contained in:
Jonas Dellinger 2018-01-15 23:32:21 +01:00
parent a6ffa961b2
commit 05721ef9f7
3 changed files with 64 additions and 1 deletions

View File

@ -0,0 +1,63 @@
## GetUsersTopTracks
> Get the current users top tracks based on calculated affinity.
**Parameters**
|Name|Description|Example|
|--------------|-------------------------|-------------------------|
|[timeRange]| Over what time frame the affinities are compute. | `TimeRangeType.MediumTerm`
|[limit]| The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50. | `20`
|[offset]| The index of the first entity to return. Default: 0 (i.e., the first track). Use with limit to get the next set of entities. | `0`
Returns a [FullTrack](https://developer.spotify.com/web-api/object-model/#track-object-full) wrapped inside a [Paging-object](https://developer.spotify.com/web-api/object-model/#paging-object)
**Usage**
```
Paging<FullTrack> tracks = _spotify.GetUsersTopTracks();
tracks.Items.ForEach(item => Console.WriteLine(item.Name)); //Display all fetched Track-Names (max 20)
Console.WriteLine(tracks.Total.ToString()) //Display total album track count
```
---
## GetUsersTopArtists
> Get the current users top artists based on calculated affinity.
**Parameters**
|Name|Description|Example|
|--------------|-------------------------|-------------------------|
|[timeRange]| Over what time frame the affinities are compute. | `TimeRangeType.MediumTerm`
|[limit]| The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50. | `20`
|[offset]| The index of the first entity to return. Default: 0 (i.e., the first track). Use with limit to get the next set of entities. | `0`
Returns a [FullArtist](https://developer.spotify.com/web-api/object-model/#artist-object-full) wrapped inside a [Paging-object](https://developer.spotify.com/web-api/object-model/#paging-object)
**Usage**
```
Paging<FullArtist> artists = _spotify.GetUsersTopArtists();
artists.Items.ForEach(item => Console.WriteLine(item.Name)); //Display all fetched Artist-Names (max 20)
```
---
## GetUsersRecentlyPlayedTracks
> Get tracks from the current users recent play history.
**Parameters**
|Name|Description|Example|
|--------------|-------------------------|-------------------------|
|[limit]| The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50. | `20`
|[after]| Returns all items after (but not including) this cursor position. | `DateTime.Now.AddDays(-1)`
|[before]| Returns all items before (but not including) this cursor position. | `DateTime.Now.AddDays(-1)`
Returns a `PlayHistory` wrapped inside a [CursorPaging-object](https://developer.spotify.com/web-api/object-model/#cursor-based-paging-object)
**Usage**
```
CursorPaging<PlayHistory> histories = _spotify.GetUsersRecentlyPlayedTracks();
histories.Items.ForEach(item => Console.WriteLine(item.Track.Name));
```
---

View File

@ -11,6 +11,7 @@ pages:
- '- Browse': 'SpotifyWebAPI/browse.md' - '- Browse': 'SpotifyWebAPI/browse.md'
- '- Follow': 'SpotifyWebAPI/follow.md' - '- Follow': 'SpotifyWebAPI/follow.md'
- '- Library': 'SpotifyWebAPI/library.md' - '- Library': 'SpotifyWebAPI/library.md'
- '- Personalization': 'SpotifyWebAPI/personalization.md'
- '- Player': 'SpotifyWebAPI/player.md' - '- Player': 'SpotifyWebAPI/player.md'
- '- Playlists': 'SpotifyWebAPI/playlists.md' - '- Playlists': 'SpotifyWebAPI/playlists.md'
- '- Profiles': 'SpotifyWebAPI/profiles.md' - '- Profiles': 'SpotifyWebAPI/profiles.md'

View File

@ -2148,7 +2148,6 @@ namespace SpotifyAPI.Web
response.Item2.AddResponseInfo(response.Item1); response.Item2.AddResponseInfo(response.Item1);
lastError = response.Item2.Error; lastError = response.Item2.Error;
triesLeft -= 1; triesLeft -= 1;
} while (UseAutoRetry && triesLeft > 0 && lastError != null && RetryErrorCodes.Contains(lastError.Status)); } while (UseAutoRetry && triesLeft > 0 && lastError != null && RetryErrorCodes.Contains(lastError.Status));