sarsoo/Spotify.NET
1
0
Fork 0
mirror of https://github.com/Sarsoo/Spotify.NET.git synced 2024-12-23 22:56:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

Built mkdocs | Travis Build 21

Browse Source
This commit is contained in:
Travis-CI 2016-03-05 20:00:24 +00:00
parent ddc05e80c3
commit 36836a511d
7 changed files with 212 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
SpotifyWebAPI/search/index.html
View File

@ -210,9 +210,9 @@
</tr> </tr>
</tbody> </tbody>
</table> </table>
<p>Returns a <strong>SearchItem</strong> which contains the properties <code>Paging&lt;SimpleArtist&gt; Artists</code>,<code>Paging&lt;FullTrack&gt; Tracks</code>, <code>Paging&lt;SimpleAlbum&gt; Albums</code>. They are filled based on your search-type.</p> <p>Returns a <strong>SearchItem</strong> which contains the properties <code>Paging&lt;FullArtist&gt; Artists</code>,<code>Paging&lt;FullTrack&gt; Tracks</code>, <code>Paging&lt;SimpleAlbum&gt; Albums</code>, <code>Paging&lt;SimplePlaylist&gt; Playlists</code>. They are filled based on your search-type.</p>
<p><strong>Usage</strong></p> <p><strong>Usage</strong></p>
<pre><code class="cs">SearchItem item = _spotify.SearchItems(&quot;roadhouse+blues&quot;, SearchType.Album); <pre><code class="cs">SearchItem item = _spotify.SearchItems(&quot;roadhouse+blues&quot;, SearchType.Album | SearchType.Playlist);
Console.WriteLine(item.Albums.Total); //How many results are there in total? NOTE: item.Tracks = item.Artists = null Console.WriteLine(item.Albums.Total); //How many results are there in total? NOTE: item.Tracks = item.Artists = null
</code></pre> </code></pre>

49
base.html Normal file
View File

@ -0,0 +1,49 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
{% if page_description %}<meta name="description" content="{{ page_description }}">{% endif %}
{% if site_author %}<meta name="author" content="{{ site_author }}">{% endif %}
{% if canonical_url %}<link rel="canonical" href="{{ canonical_url }}">{% endif %}
{% if favicon %}<link rel="shortcut icon" href="{{ favicon }}">
{% else %}<link rel="shortcut icon" href="{{ base_url }}/img/favicon.ico">{% endif %}
<title>{% if page_title %}{{ page_title }} - {% endif %}{{ site_name }}</title>
<link href="{{ base_url }}/css/bootstrap-custom.min.css" rel="stylesheet">
<link href="{{ base_url }}/css/font-awesome-4.0.3.css" rel="stylesheet">
<link href="{{ base_url }}/css/prettify-1.0.css" rel="stylesheet">
<link href="{{ base_url }}/css/base.css" rel="stylesheet">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.6/styles/agate.min.css">
{%- for path in extra_css %}
<link href="{{ path }}" rel="stylesheet">
{%- endfor %}
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
<![endif]-->
</head>
<body>
{% include "nav.html" %}
<div class="container">
<div class="col-md-3">{% include "toc.html" %}</div>
<div class="col-md-9" role="main">{% include "content.html" %}</div>
</div>
{% if include_search %}{% include "search.html" %}{% endif %}
<script src="https://code.jquery.com/jquery-1.10.2.min.js"></script>
<script src="{{ base_url }}/js/bootstrap-3.0.3.min.js"></script>
<script src="{{ base_url }}/js/base.js"></script>
{%- for path in extra_javascript %}
<script src="{{ path }}"></script>
{%- endfor %}
</body>
</html>

9
content.html Normal file
View File

@ -0,0 +1,9 @@
{% if meta.source %}
<div class="source-links">
{% for filename in meta.source %}
<span class="label label-primary">{{ filename }}</span>
{% endfor %}
</div>
{% endif %}
{{ content }}

56
mkdocs/search_index.json
View File

@ -62,9 +62,59 @@
}, },
{ {
"location": "/SpotifyWebAPI/gettingstarted/#api-reference", "location": "/SpotifyWebAPI/gettingstarted/#api-reference",
"text": "Albums GetAlbumTracks GetAlbum GetSeveralAlbums Artists GetArtist GetRelatedArtists GetArtistsTopTracks GetArtistsAlbums GetSeveralArtists Browse GetFeaturedPlaylists GetNewAlbumReleases GetCategories GetCategory GetCategoryPlaylists Follow Follow Unfollow IsFollowing FollowPlaylist UnfollowPlaylist IsFollowingPlaylist Library SaveTracks SaveTrack GetSavedTracks RemoveSavedTracks CheckSavedTracks SaveAlbums SaveAlbum GetSavedAlbums RemoveSavedAlbums CheckSavedAlbums Playlists GetUserPlaylists GetPlaylist GetPlaylistTracks CreatePlaylist UpdatePlaylist ReplacePlaylistTracks RemovePlaylistTracks RemovePlaylistTrack AddPlaylistTracks AddPlaylistTrack ReorderPlaylist Profiles GetPublicProfile GetPrivateProfile Search SearchItems Tracks GetSeveralTracks GetTrack Util Utility-Functions", "text": "",
"title": "API-Reference" "title": "API-Reference"
}, },
{
"location": "/SpotifyWebAPI/gettingstarted/#albums",
"text": "GetAlbumTracks GetAlbum GetSeveralAlbums",
"title": "Albums"
},
{
"location": "/SpotifyWebAPI/gettingstarted/#artists",
"text": "GetArtist GetRelatedArtists GetArtistsTopTracks GetArtistsAlbums GetSeveralArtists",
"title": "Artists"
},
{
"location": "/SpotifyWebAPI/gettingstarted/#browse",
"text": "GetFeaturedPlaylists GetNewAlbumReleases GetCategories GetCategory GetCategoryPlaylists",
"title": "Browse"
},
{
"location": "/SpotifyWebAPI/gettingstarted/#follow",
"text": "Follow Unfollow IsFollowing FollowPlaylist UnfollowPlaylist IsFollowingPlaylist",
"title": "Follow"
},
{
"location": "/SpotifyWebAPI/gettingstarted/#library",
"text": "SaveTracks SaveTrack GetSavedTracks RemoveSavedTracks CheckSavedTracks SaveAlbums SaveAlbum GetSavedAlbums RemoveSavedAlbums CheckSavedAlbums",
"title": "Library"
},
{
"location": "/SpotifyWebAPI/gettingstarted/#playlists",
"text": "GetUserPlaylists GetPlaylist GetPlaylistTracks CreatePlaylist UpdatePlaylist ReplacePlaylistTracks RemovePlaylistTracks RemovePlaylistTrack AddPlaylistTracks AddPlaylistTrack ReorderPlaylist",
"title": "Playlists"
},
{
"location": "/SpotifyWebAPI/gettingstarted/#profiles",
"text": "GetPublicProfile GetPrivateProfile",
"title": "Profiles"
},
{
"location": "/SpotifyWebAPI/gettingstarted/#search",
"text": "SearchItems",
"title": "Search"
},
{
"location": "/SpotifyWebAPI/gettingstarted/#tracks",
"text": "GetSeveralTracks GetTrack",
"title": "Tracks"
},
{
"location": "/SpotifyWebAPI/gettingstarted/#util",
"text": "Utility-Functions",
"title": "Util"
},
{ {
"location": "/SpotifyWebAPI/examples/", "location": "/SpotifyWebAPI/examples/",
"text": "", "text": "",
@ -347,12 +397,12 @@
}, },
{ {
"location": "/SpotifyWebAPI/search/", "location": "/SpotifyWebAPI/search/",
"text": "SearchItems\n\n\n\n\nGet Spotify catalog information about artists, albums, tracks or playlists that match a keyword string.\n\n\n\n\nParamters\n\n\n\n\n\n\n\n\nName\n\n\nDescription\n\n\nExample\n\n\n\n\n\n\n\n\n\n\nq\n\n\nThe search query's keywords (and optional field filters and operators), for example q=roadhouse+blues.\n\n\n\"roadhouse+blues\"\n\n\n\n\n\n\ntype\n\n\nA list of item types to search across.\n\n\nSearchType.Album\n\n\n\n\n\n\n[limit]\n\n\nThe maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.\n\n\n20\n\n\n\n\n\n\n[offset]\n\n\nThe index of the first result to return. Default: 0\n\n\n0\n\n\n\n\n\n\n[market]\n\n\nAn ISO 3166-1 alpha-2 country code or the string from_token.\n\n\n\"de\"\n\n\n\n\n\n\n\n\nReturns a \nSearchItem\n which contains the properties \nPaging\nSimpleArtist\n Artists\n,\nPaging\nFullTrack\n Tracks\n, \nPaging\nSimpleAlbum\n Albums\n. They are filled based on your search-type.\n\n\nUsage\n\n\nSearchItem item = _spotify.SearchItems(\nroadhouse+blues\n, SearchType.Album);\nConsole.WriteLine(item.Albums.Total); //How many results are there in total? NOTE: item.Tracks = item.Artists = null", "text": "SearchItems\n\n\n\n\nGet Spotify catalog information about artists, albums, tracks or playlists that match a keyword string.\n\n\n\n\nParamters\n\n\n\n\n\n\n\n\nName\n\n\nDescription\n\n\nExample\n\n\n\n\n\n\n\n\n\n\nq\n\n\nThe search query's keywords (and optional field filters and operators), for example q=roadhouse+blues.\n\n\n\"roadhouse+blues\"\n\n\n\n\n\n\ntype\n\n\nA list of item types to search across.\n\n\nSearchType.Album\n\n\n\n\n\n\n[limit]\n\n\nThe maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.\n\n\n20\n\n\n\n\n\n\n[offset]\n\n\nThe index of the first result to return. Default: 0\n\n\n0\n\n\n\n\n\n\n[market]\n\n\nAn ISO 3166-1 alpha-2 country code or the string from_token.\n\n\n\"de\"\n\n\n\n\n\n\n\n\nReturns a \nSearchItem\n which contains the properties \nPaging\nFullArtist\n Artists\n,\nPaging\nFullTrack\n Tracks\n, \nPaging\nSimpleAlbum\n Albums\n, \nPaging\nSimplePlaylist\n Playlists\n. They are filled based on your search-type.\n\n\nUsage\n\n\nSearchItem item = _spotify.SearchItems(\nroadhouse+blues\n, SearchType.Album | SearchType.Playlist);\nConsole.WriteLine(item.Albums.Total); //How many results are there in total? NOTE: item.Tracks = item.Artists = null",
"title": "- Search" "title": "- Search"
}, },
{ {
"location": "/SpotifyWebAPI/search/#searchitems", "location": "/SpotifyWebAPI/search/#searchitems",
"text": "Get Spotify catalog information about artists, albums, tracks or playlists that match a keyword string. Paramters Name Description Example q The search query's keywords (and optional field filters and operators), for example q=roadhouse+blues. \"roadhouse+blues\" type A list of item types to search across. SearchType.Album [limit] The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50. 20 [offset] The index of the first result to return. Default: 0 0 [market] An ISO 3166-1 alpha-2 country code or the string from_token. \"de\" Returns a SearchItem which contains the properties Paging SimpleArtist Artists , Paging FullTrack Tracks , Paging SimpleAlbum Albums . They are filled based on your search-type. Usage SearchItem item = _spotify.SearchItems( roadhouse+blues , SearchType.Album);\nConsole.WriteLine(item.Albums.Total); //How many results are there in total? NOTE: item.Tracks = item.Artists = null", "text": "Get Spotify catalog information about artists, albums, tracks or playlists that match a keyword string. Paramters Name Description Example q The search query's keywords (and optional field filters and operators), for example q=roadhouse+blues. \"roadhouse+blues\" type A list of item types to search across. SearchType.Album [limit] The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50. 20 [offset] The index of the first result to return. Default: 0 0 [market] An ISO 3166-1 alpha-2 country code or the string from_token. \"de\" Returns a SearchItem which contains the properties Paging FullArtist Artists , Paging FullTrack Tracks , Paging SimpleAlbum Albums , Paging SimplePlaylist Playlists . They are filled based on your search-type. Usage SearchItem item = _spotify.SearchItems( roadhouse+blues , SearchType.Album | SearchType.Playlist);\nConsole.WriteLine(item.Albums.Total); //How many results are there in total? NOTE: item.Tracks = item.Artists = null",
"title": "SearchItems" "title": "SearchItems"
}, },
{ {

74
nav.html Normal file
View File

@ -0,0 +1,74 @@
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<!-- Collapsed navigation -->
<div class="navbar-header">
<!-- Expander button -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<!-- Main title -->
<a class="navbar-brand" href="{{ homepage_url }}">{{ site_name }}</a>
</div>
<!-- Expanded navigation -->
<div class="navbar-collapse collapse">
<!-- Main navigation -->
<ul class="nav navbar-nav">
{% for nav_item in nav %}
{% if nav_item.children %}
<li class="dropdown{% if nav_item.active %} active{% endif %}">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">{{ nav_item.title }} <b class="caret"></b></a>
<ul class="dropdown-menu">
{% for nav_item in nav_item.children %}
<li {% if nav_item.active %}class="active"{% endif %}>
<a href="{{ nav_item.url }}">{{ nav_item.title }}</a>
</li>
{% endfor %}
</ul>
</li>
{% else %}
<li {% if nav_item.active %}class="active"{% endif %}>
<a href="{{ nav_item.url }}">{{ nav_item.title }}</a>
</li>
{% endif %}
{% endfor %}
</ul>
<!-- Search, Navigation and Repo links -->
<ul class="nav navbar-nav navbar-right">
{% if include_search %}
<li>
<a href="#searchModal" data-toggle="modal"><i class="fa fa-search"></i> Search</a>
</li>
{% endif %}
<li {% if not previous_page %}class="disabled"{% endif %}>
<a rel="next" {% if previous_page %}href="{{ previous_page.url }}"{% endif %}>
<i class="fa fa-arrow-left"></i> Previous
</a>
</li>
<li {% if not next_page %}class="disabled"{% endif %}>
<a rel="prev" {% if next_page %}href="{{ next_page.url }}"{% endif %}>
Next <i class="fa fa-arrow-right"></i>
</a>
</li>
{% if repo_url %}
<li>
<a href="{{ repo_url }}">
{% if repo_name == 'GitHub' %}
<i class="fa fa-github"></i>
{% elif repo_name == 'Bitbucket' %}
<i class="fa fa-bitbucket"></i>
{% endif %}
{{ repo_name }}
</a>
</li>
{% endif %}
</ul>
</div>
</div>
</div>

30
sitemap.xml
View File

@ -4,7 +4,7 @@
<url> <url>
<loc>None/</loc> <loc>None/</loc>
<lastmod>2015-12-07</lastmod> <lastmod>2016-03-05</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
@ -13,79 +13,79 @@
<url> <url>
<loc>None/SpotifyWebAPI/gettingstarted/</loc> <loc>None/SpotifyWebAPI/gettingstarted/</loc>
<lastmod>2015-12-07</lastmod> <lastmod>2016-03-05</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None/SpotifyWebAPI/examples/</loc> <loc>None/SpotifyWebAPI/examples/</loc>
<lastmod>2015-12-07</lastmod> <lastmod>2016-03-05</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None/SpotifyWebAPI/auth/</loc> <loc>None/SpotifyWebAPI/auth/</loc>
<lastmod>2015-12-07</lastmod> <lastmod>2016-03-05</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None/SpotifyWebAPI/albums/</loc> <loc>None/SpotifyWebAPI/albums/</loc>
<lastmod>2015-12-07</lastmod> <lastmod>2016-03-05</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None/SpotifyWebAPI/artists/</loc> <loc>None/SpotifyWebAPI/artists/</loc>
<lastmod>2015-12-07</lastmod> <lastmod>2016-03-05</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None/SpotifyWebAPI/browse/</loc> <loc>None/SpotifyWebAPI/browse/</loc>
<lastmod>2015-12-07</lastmod> <lastmod>2016-03-05</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None/SpotifyWebAPI/follow/</loc> <loc>None/SpotifyWebAPI/follow/</loc>
<lastmod>2015-12-07</lastmod> <lastmod>2016-03-05</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None/SpotifyWebAPI/library/</loc> <loc>None/SpotifyWebAPI/library/</loc>
<lastmod>2015-12-07</lastmod> <lastmod>2016-03-05</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None/SpotifyWebAPI/playlists/</loc> <loc>None/SpotifyWebAPI/playlists/</loc>
<lastmod>2015-12-07</lastmod> <lastmod>2016-03-05</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None/SpotifyWebAPI/profiles/</loc> <loc>None/SpotifyWebAPI/profiles/</loc>
<lastmod>2015-12-07</lastmod> <lastmod>2016-03-05</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None/SpotifyWebAPI/search/</loc> <loc>None/SpotifyWebAPI/search/</loc>
<lastmod>2015-12-07</lastmod> <lastmod>2016-03-05</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None/SpotifyWebAPI/tracks/</loc> <loc>None/SpotifyWebAPI/tracks/</loc>
<lastmod>2015-12-07</lastmod> <lastmod>2016-03-05</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None/SpotifyWebAPI/util/</loc> <loc>None/SpotifyWebAPI/util/</loc>
<lastmod>2015-12-07</lastmod> <lastmod>2016-03-05</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
@ -95,7 +95,7 @@
<url> <url>
<loc>None/SpotifyLocalAPI/</loc> <loc>None/SpotifyLocalAPI/</loc>
<lastmod>2015-12-07</lastmod> <lastmod>2016-03-05</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>

10
toc.html Normal file
View File

@ -0,0 +1,10 @@
<div class="bs-sidebar hidden-print affix well" role="complementary" style="height=90%;">
<ul class="nav bs-sidenav">
{% for toc_item in toc %}
<li class="main {% if toc_item.active %}active{% endif %}"><a href="{{ toc_item.url }}">{{ toc_item.title }}</a></li>
{% for toc_item in toc_item.children %}
<li><a href="{{ toc_item.url }}">{{ toc_item.title }}</a></li>
{% endfor %}
{% endfor %}
</ul>
</div>