Spotify.NET/SpotifyWebApi/gettingstarted/index.html

191 lines
6.8 KiB
HTML
Raw Normal View History

2015-02-14 17:56:09 +00:00
<!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">
<meta name="author" content="JohnnyCrazy">
<link rel="shortcut icon" href="../../img/favicon.ico">
2015-02-14 17:56:09 +00:00
<title>Getting started - SpotifyAPI-NET</title>
2015-02-14 17:56:09 +00:00
<link href="../../css/bootstrap-custom.min.css" rel="stylesheet">
<link href="../../css/font-awesome-4.0.3.css" rel="stylesheet">
<link href="../../css/prettify-1.0.css" rel="stylesheet">
<link href="../../css/base.css" rel="stylesheet">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.6/styles/agate.min.css">
2015-02-14 17:56:09 +00:00
<!-- 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>
<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="../..">SpotifyAPI-NET</a>
2015-02-14 17:56:09 +00:00
</div>
<!-- Expanded navigation -->
<div class="navbar-collapse collapse">
<!-- Main navigation -->
<ul class="nav navbar-nav">
<li >
<a href="../..">Home</a>
2015-02-14 17:56:09 +00:00
</li>
<li class="dropdown active">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyWebApi <b class="caret"></b></a>
<ul class="dropdown-menu">
<li class="active">
<a href="./">Getting started</a>
</li>
<li >
<a href="../examples/">Examples</a>
</li>
<li >
<a href="../auth/">Authentication</a>
</li>
<li >
<a href="../albums/">- Albums</a>
</li>
<li >
<a href="../artists/">- Artists</a>
2015-02-14 17:56:09 +00:00
</li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">SpotifyLocalApi <b class="caret"></b></a>
<ul class="dropdown-menu">
<li >
<a href="../../SpotifyLocalApi/">SpotifyLocalApi</a>
2015-02-14 17:56:09 +00:00
</li>
</ul>
</li>
</ul>
<!-- Search, Navigation and Repo links -->
<ul class="nav navbar-nav navbar-right">
<li >
<a rel="next" href="../..">
2015-02-14 17:56:09 +00:00
<i class="fa fa-arrow-left"></i> Previous
</a>
</li>
<li >
<a rel="prev" href="../examples/">
2015-02-14 17:56:09 +00:00
Next <i class="fa fa-arrow-right"></i>
</a>
</li>
<li>
<a href="https://github.com/JohnnyCrazy/SpotifyAPI-NET">
<i class="fa fa-github"></i>
GitHub
</a>
</li>
</ul>
</div>
</div>
</div>
<div class="container">
<div class="col-md-3"><div class="bs-sidebar hidden-print affix well" role="complementary" style="height=90%;">
2015-02-14 17:56:09 +00:00
<ul class="nav bs-sidenav">
<li class="main active"><a href="#spotifywebapi">SpotifyWebAPI</a></li>
<li class="main "><a href="#getting-started">Getting started</a></li>
<li class="main "><a href="#properties">Properties</a></li>
<li><a href="#useauth">UseAuth</a></li>
<li><a href="#tokentype">TokenType</a></li>
<li><a href="#accesstoken">AccessToken</a></li>
2015-02-14 17:56:09 +00:00
</ul>
</div></div>
<div class="col-md-9" role="main">
<h1 id="spotifywebapi">SpotifyWebAPI</h1>
<p>This API provides full access to the new SpotifyWebAPI introduced <a href="https://developer.spotify.com/web-api/">here</a>.<br />
With it, you can search for Tracks/Albums/Artists and also get User-based information.<br />
It's also possible to create new playlists and add tracks to it.</p>
<hr />
<h1 id="getting-started">Getting started</h1>
<p>The API features all currently available features and also provides some examples to get things rolling!<br />
Full-Method Reference: </p>
<ul>
<li><a href="../test">Albums</a></li>
</ul>
<p><a href="../../SpotifyWebApi/examples">Examples</a></p>
<hr />
<h1 id="properties">Properties</h1>
<h2 id="useauth">UseAuth</h2>
<p>Wether auth should be used or not. User-stuff can only be fetched with auth.<br />
<strong>NOTE:</strong> If you use auth, you need to provide both, <code>TokenType</code> and <code>AccessToken</code> </p>
<pre><code class="csharp">_spotify.UseAuth = false;
2015-02-14 17:56:09 +00:00
</code></pre>
<h2 id="tokentype">TokenType</h2>
<p>The token-type. Normally "Bearer" or "Basic". </p>
<pre><code class="csharp">_spotify.TokenType = &quot;XXXXXXXXXXXXXXXX&quot;;
</code></pre>
<h2 id="accesstoken">AccessToken</h2>
<p>The access-token received by your auth-type. </p>
<pre><code class="csharp">_spotify.AccessToken = &quot;XXXXXXXXXXXXXXXX&quot;;
</code></pre></div>
2015-02-14 17:56:09 +00:00
</div>
<script src="https://code.jquery.com/jquery-1.10.2.min.js"></script>
<script src="../../js/bootstrap-3.0.3.min.js"></script>
<script src="../../js/base.js"></script>
2015-02-14 17:56:09 +00:00
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/8.4/highlight.min.js"></script>
<script src="../../highlight.js"></script>
2015-02-14 17:56:09 +00:00
</body>
</html>