sarsoo/Spotify.NET
1
0
Fork 0
mirror of https://github.com/Sarsoo/Spotify.NET.git synced 2024-12-25 15:36:26 +00:00
Code Issues Packages Projects Releases Wiki Activity
443395322d
Spotify.NET/docs/5.1.1/web/browse/index.html
GH Actions Docs Builder 443395322d Deploy website - based on 01904ac013
2021-11-23 20:38:18 +00:00

17 lines
19 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!doctype html>
<html lang="en" dir="ltr">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="generator" content="Docusaurus v2.0.0-beta.4">
<title data-react-helmet="true">Browse | SpotifyAPI-NET</title><meta data-react-helmet="true" property="og:url" content="https://johnnycrazy.github.io/SpotifyAPI-NET/docs/5.1.1/web/browse"><meta data-react-helmet="true" name="docusaurus_locale" content="en"><meta data-react-helmet="true" name="docusaurus_version" content="5.1.1"><meta data-react-helmet="true" name="docusaurus_tag" content="docs-default-5.1.1"><meta data-react-helmet="true" property="og:title" content="Browse | SpotifyAPI-NET"><meta data-react-helmet="true" name="description" content="GetFeaturedPlaylists"><meta data-react-helmet="true" property="og:description" content="GetFeaturedPlaylists"><link data-react-helmet="true" rel="shortcut icon" href="/SpotifyAPI-NET/img/favicon.ico"><link data-react-helmet="true" rel="canonical" href="https://johnnycrazy.github.io/SpotifyAPI-NET/docs/5.1.1/web/browse"><link data-react-helmet="true" rel="alternate" href="https://johnnycrazy.github.io/SpotifyAPI-NET/docs/5.1.1/web/browse" hreflang="en"><link data-react-helmet="true" rel="alternate" href="https://johnnycrazy.github.io/SpotifyAPI-NET/docs/5.1.1/web/browse" hreflang="x-default"><link rel="stylesheet" href="/SpotifyAPI-NET/assets/css/styles.834af7f3.css">
<link rel="preload" href="/SpotifyAPI-NET/assets/js/runtime~main.a8a9466f.js" as="script">
<link rel="preload" href="/SpotifyAPI-NET/assets/js/main.df3c80a8.js" as="script">
</head>
<body>
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus">
<div><a href="#" class="skipToContent_1oUP">Skip to main content</a></div><nav class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Navigation bar toggle" class="navbar__toggle clean-btn" type="button" tabindex="0"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/SpotifyAPI-NET/"><img src="/SpotifyAPI-NET/img/logo.svg" alt="SpotifyAPI-NET" class="themedImage_1VuW themedImage--light_3UqQ navbar__logo"><img src="/SpotifyAPI-NET/img/logo.svg" alt="SpotifyAPI-NET" class="themedImage_1VuW themedImage--dark_hz6m navbar__logo"><b class="navbar__title">SpotifyAPI-NET</b></a><div class="navbar__item dropdown dropdown--hoverable"><a class="navbar__item navbar__link">Docs</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/SpotifyAPI-NET/docs/introduction">6.X (current)</a></li><li><a class="dropdown__link" href="/SpotifyAPI-NET/docs/5.1.1/home">5.1.1</a></li></ul></div></div><div class="navbar__items navbar__items--right"><a href="https://github.com/JohnnyCrazy/SpotifyAPI-NET" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link"><span>GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_3J9K"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></span></a><div class="react-toggle toggle_3Zt9 react-toggle--disabled"><div class="react-toggle-track" role="button" tabindex="-1"><div class="react-toggle-track-check"><span class="toggle_71bT">🌜</span></div><div class="react-toggle-track-x"><span class="toggle_71bT">🌞</span></div><div class="react-toggle-thumb"></div></div><input type="checkbox" class="react-toggle-screenreader-only" aria-label="Switch between dark and light mode"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div class="main-wrapper docs-wrapper doc-page"><div class="docPage_31aa"><button class="clean-btn backToTopButton_35hR" type="button" title="Scroll to top"><svg viewBox="0 0 24 24" width="28"><path d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z" fill="currentColor"></path></svg></button><aside class="docSidebarContainer_3Kbt"><div class="sidebar_15mo"><nav class="menu thin-scrollbar menu_Bmed menuWithAnnouncementBar_2WvA"><ul class="menu__list"><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#">SpotifyAPI-NET</a></li><li class="menu__list-item"><a class="menu__link menu__link--sublist menu__link--active" href="#">SpotifyAPI-NET.Web</a><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/SpotifyAPI-NET/docs/5.1.1/web/getting_started">Getting Started</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/SpotifyAPI-NET/docs/5.1.1/web/albums">Albums</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/SpotifyAPI-NET/docs/5.1.1/web/artists">Artists</a></li><li class="menu__list-item"><a aria-current="page" class="menu__link menu__link--active active" tabindex="0" href="/SpotifyAPI-NET/docs/5.1.1/web/browse">Browse</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/SpotifyAPI-NET/docs/5.1.1/web/follow">Follow</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/SpotifyAPI-NET/docs/5.1.1/web/library">Library</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/SpotifyAPI-NET/docs/5.1.1/web/personalization">Personalization</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/SpotifyAPI-NET/docs/5.1.1/web/player">Player</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/SpotifyAPI-NET/docs/5.1.1/web/playlists">Playlists</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/SpotifyAPI-NET/docs/5.1.1/web/profiles">Profiles</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/SpotifyAPI-NET/docs/5.1.1/web/proxy">Proxy Settings</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/SpotifyAPI-NET/docs/5.1.1/web/search">Search</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/SpotifyAPI-NET/docs/5.1.1/web/tracks">Tracks</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/SpotifyAPI-NET/docs/5.1.1/web/utilities">Utilities</a></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#">SpotifyAPI-NET.Auth</a></li></ul></nav></div></aside><main class="docMainContainer_3ufF"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_3FnS"><div class="alert alert--warning margin-bottom--md" role="alert"><div>This is documentation for SpotifyAPI-NET <b>5.1.1</b>, which is no longer actively maintained.</div><div class="margin-top--md">For up-to-date documentation, see the <b><a href="/SpotifyAPI-NET/docs/introduction">latest version</a></b> (6.X).</div></div><div class="docItemContainer_33ec"><article><span class="badge badge--secondary">Version: 5.1.1</span><div class="tocCollapsible_1PrD tocMobile_3Hoh"><button type="button" class="clean-btn tocCollapsibleButton_2O1e">On this page</button></div><div class="markdown"><header><h1 class="h1Heading_27L5">Browse</h1></header><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="getfeaturedplaylists"></a>GetFeaturedPlaylists<a class="hash-link" href="#getfeaturedplaylists" title="Direct link to heading">#</a></h2><blockquote><p>Get a list of Spotify featured playlists (shown, for example, on a Spotify player’s “Browse” tab).</p></blockquote><p><strong>Parameters</strong></p><table><thead><tr><th>Name</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td>[locale]</td><td>The desired language, consisting of a lowercase ISO 639 language code and an uppercase ISO 3166-1 alpha-2 country code, joined by an underscore.</td><td><code>&quot;de_DE&quot; //Germany</code></td></tr><tr><td>[country]</td><td>A country: an ISO 3166-1 alpha-2 country code.</td><td><code>&quot;DE&quot;</code></td></tr><tr><td>[timestamp]</td><td>A timestamp in ISO 8601 format</td><td><code>DateTime.Now</code></td></tr><tr><td>[limit]</td><td>The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.</td><td><code>20</code></td></tr><tr><td>[offset]</td><td>The index of the first item to return. Default: 0</td><td><code>0</code></td></tr></tbody></table><p>Returns a <code>FeaturedPlaylists</code> object, which has 2 properties. <code>String Message</code> and <code>Paging&lt;SimplePlaylist&gt; Playlists</code></p><p><strong>Usage</strong></p><div class="codeBlockContainer_K1bP"><div class="codeBlockContent_hGly csharp"><pre tabindex="0" class="prism-code language-csharp codeBlock_23N8 thin-scrollbar" style="color:#bfc7d5;background-color:#292d3e"><code class="codeBlockLines_39YC"><span class="token-line" style="color:#bfc7d5"><span class="token plain">FeaturedPlaylists playlists = _spotify.GetFeaturedPlaylists();</span></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">Console.WriteLine(playlists.Message);</span></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">playlists.Playlists.Items.ForEach(playlist =&gt; Console.WriteLine(playlist.Name));</span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_Ue-o clean-btn">Copy</button></div></div><hr><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="getnewalbumreleases"></a>GetNewAlbumReleases<a class="hash-link" href="#getnewalbumreleases" title="Direct link to heading">#</a></h2><blockquote><p>Get a list of new album releases featured in Spotify (shown, for example, on a Spotify player’s “Browse” tab).</p></blockquote><p><strong>Parameters</strong></p><table><thead><tr><th>Name</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td>[country]</td><td>A country: an ISO 3166-1 alpha-2 country code.</td><td><code>&quot;DE&quot;</code></td></tr><tr><td>[limit]</td><td>The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.</td><td><code>20</code></td></tr><tr><td>[offset]</td><td>The index of the first item to return. Default: 0</td><td><code>0</code></td></tr></tbody></table><p>Returns a <code>NewAlbumReleases</code> object, which has the property <code>Paging&lt;SimpleAlbum&gt; Albums</code>.</p><p><strong>Usage</strong></p><div class="codeBlockContainer_K1bP"><div class="codeBlockContent_hGly csharp"><pre tabindex="0" class="prism-code language-csharp codeBlock_23N8 thin-scrollbar" style="color:#bfc7d5;background-color:#292d3e"><code class="codeBlockLines_39YC"><span class="token-line" style="color:#bfc7d5"><span class="token plain">NewAlbumReleases newAlbums = _spotify.GetNewAlbumReleases();</span></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">newAlbums.Albums.Items.ForEach(album =&gt; Console.WriteLine(album.Name));</span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_Ue-o clean-btn">Copy</button></div></div><hr><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="getcategories"></a>GetCategories<a class="hash-link" href="#getcategories" title="Direct link to heading">#</a></h2><blockquote><p>Get a list of categories used to tag items in Spotify (on, for example, the Spotify player’s “Browse” tab).</p></blockquote><p><strong>Parameters</strong></p><table><thead><tr><th>Name</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td>[country]</td><td>A country: an ISO 3166-1 alpha-2 country code. Provide this parameter if you want to narrow the list of returned categories to those relevant to a particular country</td><td><code>&quot;DE&quot;</code></td></tr><tr><td>[locale]</td><td>The desired language, consisting of an ISO 639 language code and an ISO 3166-1 alpha-2 country code, joined by an underscore</td><td><code>&quot;de_DE&quot;</code></td></tr><tr><td>[limit]</td><td>The maximum number of categories to return. Default: 20. Minimum: 1. Maximum: 50.</td><td><code>20</code></td></tr><tr><td>[offset]</td><td>The index of the first item to return. Default: 0 (the first object).</td><td><code>0</code></td></tr></tbody></table><p>Returns a <code>CategoryList</code> object, which has the property <code>Paging&lt;Category&gt; Categories</code>.</p><p><strong>Usage</strong></p><div class="codeBlockContainer_K1bP"><div class="codeBlockContent_hGly csharp"><pre tabindex="0" class="prism-code language-csharp codeBlock_23N8 thin-scrollbar" style="color:#bfc7d5;background-color:#292d3e"><code class="codeBlockLines_39YC"><span class="token-line" style="color:#bfc7d5"><span class="token plain">CategoryList categoryList = _spotify.GetCategories();</span></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">categoryList.Categories.Items.ForEach(category =&gt; Console.WriteLine(category.Name));</span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_Ue-o clean-btn">Copy</button></div></div><hr><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="getcategory"></a>GetCategory<a class="hash-link" href="#getcategory" title="Direct link to heading">#</a></h2><blockquote><p>Get a single category used to tag items in Spotify (on, for example, the Spotify player’s “Browse” tab).</p></blockquote><p><strong>Parameters</strong></p><table><thead><tr><th>Name</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td>categoryId</td><td>The Spotify category ID for the category.</td><td><code>&quot;party&quot;</code></td></tr><tr><td>[country]</td><td>A country: an ISO 3166-1 alpha-2 country code. Provide this parameter to ensure that the category exists for a particular country.</td><td><code>&quot;DE&quot;</code></td></tr><tr><td>[locale]</td><td>The desired language, consisting of an ISO 639 language code and an ISO 3166-1 alpha-2 country code, joined by an underscore</td><td><code>&quot;de_DE&quot;</code></td></tr></tbody></table><p>Returns a <a href="https://developer.spotify.com/web-api/object-model/#category-object" target="_blank" rel="noopener noreferrer">Category</a></p><p><strong>Usage</strong></p><div class="codeBlockContainer_K1bP"><div class="codeBlockContent_hGly csharp"><pre tabindex="0" class="prism-code language-csharp codeBlock_23N8 thin-scrollbar" style="color:#bfc7d5;background-color:#292d3e"><code class="codeBlockLines_39YC"><span class="token-line" style="color:#bfc7d5"><span class="token plain">Category cat = _spotify.GetCategory(&quot;party&quot;);</span></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">Console.WriteLine(cat.Name);</span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_Ue-o clean-btn">Copy</button></div></div><hr><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="getcategoryplaylists"></a>GetCategoryPlaylists<a class="hash-link" href="#getcategoryplaylists" title="Direct link to heading">#</a></h2><blockquote><p>Get a list of Spotify playlists tagged with a particular category.</p></blockquote><p><strong>Parameters</strong></p><table><thead><tr><th>Name</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td>categoryId</td><td>The Spotify category ID for the category.</td><td><code>&quot;party&quot;</code></td></tr><tr><td>[country]</td><td>A country: an ISO 3166-1 alpha-2 country code.</td><td><code>&quot;DE&quot;</code></td></tr><tr><td>[limit]</td><td>The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.</td><td><code>20</code></td></tr><tr><td>[offset]</td><td>The index of the first item to return. Default: 0</td><td><code>0</code></td></tr></tbody></table><p>Returns a <code>CategoryPlaylist</code> object, which has the property <code>Paging&lt;SimplePlaylist&gt; Playlists</code></p><p><strong>Usage</strong></p><div class="codeBlockContainer_K1bP"><div class="codeBlockContent_hGly csharp"><pre tabindex="0" class="prism-code language-csharp codeBlock_23N8 thin-scrollbar" style="color:#bfc7d5;background-color:#292d3e"><code class="codeBlockLines_39YC"><span class="token-line" style="color:#bfc7d5"><span class="token plain">CategoryPlaylist playlists = _spotify.GetCategoryPlaylists(&quot;party&quot;);</span></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">playlists.Playlists.Items.ForEach(playlist =&gt; Console.WriteLine(playlist.Name));</span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_Ue-o clean-btn">Copy</button></div></div><hr></div><footer class="row docusaurus-mt-lg"><div class="col"><a href="https://github.com/JohnnyCrazy/SpotifyAPI-NET/edit/master/SpotifyAPI.Docs/versioned_docs/version-5.1.1/web/browse.md" target="_blank" rel="noreferrer noopener"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_2_ui" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_3DPF">Last updated on <b><time datetime="2021-11-23T20:36:33.000Z">11/23/2021</time></b> by <b>dependabot[bot]</b></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages navigation"><div class="pagination-nav__item"><a class="pagination-nav__link" href="/SpotifyAPI-NET/docs/5.1.1/web/artists"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">« Artists</div></a></div><div class="pagination-nav__item pagination-nav__item--next"><a class="pagination-nav__link" href="/SpotifyAPI-NET/docs/5.1.1/web/follow"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Follow »</div></a></div></nav></div></div><div class="col col--3"><div class="tableOfContents_35-E thin-scrollbar"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#getfeaturedplaylists" class="table-of-contents__link">GetFeaturedPlaylists</a></li><li><a href="#getnewalbumreleases" class="table-of-contents__link">GetNewAlbumReleases</a></li><li><a href="#getcategories" class="table-of-contents__link">GetCategories</a></li><li><a href="#getcategory" class="table-of-contents__link">GetCategory</a></li><li><a href="#getcategoryplaylists" class="table-of-contents__link">GetCategoryPlaylists</a></li></ul></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2021 Jonas Dellinger. Built with Docusaurus.</div></div></div></footer></div>
<script src="/SpotifyAPI-NET/assets/js/runtime~main.a8a9466f.js"></script>
<script src="/SpotifyAPI-NET/assets/js/main.df3c80a8.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink