Skip to content

Commit feb9faf

Browse files
mdelolmomdelolmo
committed
Update JavaDoc
1 parent da07b23 commit feb9faf

File tree

98 files changed

+1048
-979
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

98 files changed

+1048
-979
lines changed

‎app-remote-lib/docs/allclasses-frame.html‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_171) on Wed Jan 23 22:11:40 CET 2019 -->
5+
<!-- Generated by javadoc (1.8.0_221) on Wed Nov 20 11:49:20 CET 2019 -->
66
<title>All Classes (Spotify App Remote)</title>
7-
<meta name="date" content="2019-01-23">
7+
<meta name="date" content="2019-11-20">
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
99
<script type="text/javascript" src="script.js"></script>
1010
</head>
@@ -26,8 +26,9 @@ <h1 class="bar">All&nbsp;Classes</h1>
2626
<li><a href="com/spotify/android/appremote/api/Connector.html" title="interface in com.spotify.android.appremote.api" target="classFrame"><span class="interfaceName">Connector</span></a></li>
2727
<li><a href="com/spotify/android/appremote/api/Connector.ConnectionListener.html" title="interface in com.spotify.android.appremote.api" target="classFrame"><span class="interfaceName">Connector.ConnectionListener</span></a></li>
2828
<li><a href="com/spotify/android/appremote/api/ContentApi.html" title="interface in com.spotify.android.appremote.api" target="classFrame"><span class="interfaceName">ContentApi</span></a></li>
29-
<li><a href="com/spotify/android/appremote/api/ContentApi.ContentType.html" title="enum in com.spotify.android.appremote.api" target="classFrame">ContentApi.ContentType</a></li>
29+
<li><a href="com/spotify/android/appremote/api/ContentApi.ContentType.html" title="interface in com.spotify.android.appremote.api" target="classFrame"><span class="interfaceName">ContentApi.ContentType</span></a></li>
3030
<li><a href="com/spotify/android/appremote/api/error/CouldNotFindSpotifyApp.html" title="class in com.spotify.android.appremote.api.error" target="classFrame">CouldNotFindSpotifyApp</a></li>
31+
<li><a href="com/spotify/protocol/types/CrossfadeState.html" title="class in com.spotify.protocol.types" target="classFrame">CrossfadeState</a></li>
3132
<li><a href="com/spotify/protocol/types/Empty.html" title="class in com.spotify.protocol.types" target="classFrame">Empty</a></li>
3233
<li><a href="com/spotify/protocol/types/GetRecommendedContentItemsRequest.html" title="class in com.spotify.protocol.types" target="classFrame">GetRecommendedContentItemsRequest</a></li>
3334
<li><a href="com/spotify/protocol/types/HelloDetails.html" title="class in com.spotify.protocol.types" target="classFrame">HelloDetails</a></li>

‎app-remote-lib/docs/allclasses-noframe.html‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_171) on Wed Jan 23 22:11:40 CET 2019 -->
5+
<!-- Generated by javadoc (1.8.0_221) on Wed Nov 20 11:49:20 CET 2019 -->
66
<title>All Classes (Spotify App Remote)</title>
7-
<meta name="date" content="2019-01-23">
7+
<meta name="date" content="2019-11-20">
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
99
<script type="text/javascript" src="script.js"></script>
1010
</head>
@@ -26,8 +26,9 @@ <h1 class="bar">All&nbsp;Classes</h1>
2626
<li><a href="com/spotify/android/appremote/api/Connector.html" title="interface in com.spotify.android.appremote.api"><span class="interfaceName">Connector</span></a></li>
2727
<li><a href="com/spotify/android/appremote/api/Connector.ConnectionListener.html" title="interface in com.spotify.android.appremote.api"><span class="interfaceName">Connector.ConnectionListener</span></a></li>
2828
<li><a href="com/spotify/android/appremote/api/ContentApi.html" title="interface in com.spotify.android.appremote.api"><span class="interfaceName">ContentApi</span></a></li>
29-
<li><a href="com/spotify/android/appremote/api/ContentApi.ContentType.html" title="enum in com.spotify.android.appremote.api">ContentApi.ContentType</a></li>
29+
<li><a href="com/spotify/android/appremote/api/ContentApi.ContentType.html" title="interface in com.spotify.android.appremote.api"><span class="interfaceName">ContentApi.ContentType</span></a></li>
3030
<li><a href="com/spotify/android/appremote/api/error/CouldNotFindSpotifyApp.html" title="class in com.spotify.android.appremote.api.error">CouldNotFindSpotifyApp</a></li>
31+
<li><a href="com/spotify/protocol/types/CrossfadeState.html" title="class in com.spotify.protocol.types">CrossfadeState</a></li>
3132
<li><a href="com/spotify/protocol/types/Empty.html" title="class in com.spotify.protocol.types">Empty</a></li>
3233
<li><a href="com/spotify/protocol/types/GetRecommendedContentItemsRequest.html" title="class in com.spotify.protocol.types">GetRecommendedContentItemsRequest</a></li>
3334
<li><a href="com/spotify/protocol/types/HelloDetails.html" title="class in com.spotify.protocol.types">HelloDetails</a></li>

‎app-remote-lib/docs/com/spotify/android/appremote/api/ConnectApi.html‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_171) on Wed Jan 23 22:11:40 CET 2019 -->
5+
<!-- Generated by javadoc (1.8.0_221) on Wed Nov 20 11:49:20 CET 2019 -->
66
<title>ConnectApi (Spotify App Remote)</title>
7-
<meta name="date" content="2019-01-23">
7+
<meta name="date" content="2019-11-20">
88
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
99
<script type="text/javascript" src="../../../../../script.js"></script>
1010
</head>
@@ -101,8 +101,8 @@ <h2 title="Interface ConnectApi" class="title">Interface ConnectApi</h2>
101101
<hr>
102102
<br>
103103
<pre>public interface <span class="typeNameLabel">ConnectApi</span></pre>
104-
<div class="block">Control on what device the Spotify App should be playing music
105-
Get an instance of a ConnectApi with <a href="../../../../../com/spotify/android/appremote/api/SpotifyAppRemote.html#getConnectApi--"><code>SpotifyAppRemote.getConnectApi()</code></a></div>
104+
<div class="block">Control on what device the Spotify App should be playing music Get an instance of a ConnectApi
105+
with <a href="../../../../../com/spotify/android/appremote/api/SpotifyAppRemote.html#getConnectApi--"><code>SpotifyAppRemote.getConnectApi()</code></a></div>
106106
<dl>
107107
<dt><span class="seeLabel">See Also:</span></dt>
108108
<dd><a href="../../../../../com/spotify/android/appremote/api/SpotifyAppRemote.html" title="class in com.spotify.android.appremote.api"><code>SpotifyAppRemote</code></a></dd>
@@ -128,8 +128,8 @@ <h3>Method Summary</h3>
128128
<tr id="i0" class="altColor">
129129
<td class="colFirst"><code><a href="../../../../../com/spotify/protocol/client/CallResult.html" title="class in com.spotify.protocol.client">CallResult</a>&lt;<a href="../../../../../com/spotify/protocol/types/Empty.html" title="class in com.spotify.protocol.types">Empty</a>&gt;</code></td>
130130
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/spotify/android/appremote/api/ConnectApi.html#connectSwitchToLocalDevice--">connectSwitchToLocalDevice</a></span>()</code>
131-
<div class="block">Switch music to play on this (local) device,
132-
in case it is playing on another device (such as a computer) over Spotify Connect.</div>
131+
<div class="block">Switch music to play on this (local) device, in case it is playing on another device (such as
132+
a computer) over Spotify Connect.</div>
133133
</td>
134134
</tr>
135135
</table>
@@ -154,10 +154,10 @@ <h3>Method Detail</h3>
154154
<li class="blockList">
155155
<h4>connectSwitchToLocalDevice</h4>
156156
<pre><a href="../../../../../com/spotify/protocol/client/CallResult.html" title="class in com.spotify.protocol.client">CallResult</a>&lt;<a href="../../../../../com/spotify/protocol/types/Empty.html" title="class in com.spotify.protocol.types">Empty</a>&gt;&nbsp;connectSwitchToLocalDevice()</pre>
157-
<div class="block">Switch music to play on this (local) device,
158-
in case it is playing on another device (such as a computer) over Spotify Connect.
157+
<div class="block">Switch music to play on this (local) device, in case it is playing on another device (such as
158+
a computer) over Spotify Connect.
159159

160-
Introduced in <code>com.spotify.protocol.client.RequiredFeatures#FEATURES_V3</code></div>
160+
<p>Introduced in <code>com.spotify.protocol.client.RequiredFeatures#FEATURES_V3</code></div>
161161
</li>
162162
</ul>
163163
</li>

‎app-remote-lib/docs/com/spotify/android/appremote/api/ConnectionParams.AuthMethod.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_171) on Wed Jan 23 22:11:40 CET 2019 -->
5+
<!-- Generated by javadoc (1.8.0_221) on Wed Nov 20 11:49:20 CET 2019 -->
66
<title>ConnectionParams.AuthMethod (Spotify App Remote)</title>
7-
<meta name="date" content="2019-01-23">
7+
<meta name="date" content="2019-11-20">
88
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
99
<script type="text/javascript" src="../../../../../script.js"></script>
1010
</head>

‎app-remote-lib/docs/com/spotify/android/appremote/api/ConnectionParams.Builder.html‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_171) on Wed Jan 23 22:11:40 CET 2019 -->
5+
<!-- Generated by javadoc (1.8.0_221) on Wed Nov 20 11:49:20 CET 2019 -->
66
<title>ConnectionParams.Builder (Spotify App Remote)</title>
7-
<meta name="date" content="2019-01-23">
7+
<meta name="date" content="2019-11-20">
88
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
99
<script type="text/javascript" src="../../../../../script.js"></script>
1010
</head>
@@ -225,8 +225,7 @@ <h3>Method Detail</h3>
225225
<li class="blockList">
226226
<h4>setRedirectUri</h4>
227227
<pre>public&nbsp;<a href="../../../../../com/spotify/android/appremote/api/ConnectionParams.Builder.html" title="class in com.spotify.android.appremote.api">ConnectionParams.Builder</a>&nbsp;setRedirectUri(java.lang.String&nbsp;redirectUri)</pre>
228-
<div class="block">Send redirect uri for authentication purposes.
229-
Required for release builds.</div>
228+
<div class="block">Send redirect uri for authentication purposes. Required for release builds.</div>
230229
<dl>
231230
<dt><span class="paramLabel">Parameters:</span></dt>
232231
<dd><code>redirectUri</code> - uri registered in the developer.spotify.com page</dd>

‎app-remote-lib/docs/com/spotify/android/appremote/api/ConnectionParams.html‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_171) on Wed Jan 23 22:11:40 CET 2019 -->
5+
<!-- Generated by javadoc (1.8.0_221) on Wed Nov 20 11:49:20 CET 2019 -->
66
<title>ConnectionParams (Spotify App Remote)</title>
7-
<meta name="date" content="2019-01-23">
7+
<meta name="date" content="2019-11-20">
88
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
99
<script type="text/javascript" src="../../../../../script.js"></script>
1010
</head>
@@ -173,7 +173,7 @@ <h3>Method Summary</h3>
173173
</tr>
174174
<tr id="i5" class="rowColor">
175175
<td class="colFirst"><code>boolean</code></td>
176-
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/spotify/android/appremote/api/ConnectionParams.html#getShowAuthView--">getShowAuthView</a></span>()</code>&nbsp;</td>
176+
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/spotify/android/appremote/api/ConnectionParams.html#shouldShowAuthView--">shouldShowAuthView</a></span>()</code>&nbsp;</td>
177177
</tr>
178178
</table>
179179
<ul class="blockList">
@@ -224,13 +224,13 @@ <h4>getAuthMethod</h4>
224224
<pre>public&nbsp;<a href="../../../../../com/spotify/android/appremote/api/ConnectionParams.AuthMethod.html" title="enum in com.spotify.android.appremote.api">ConnectionParams.AuthMethod</a>&nbsp;getAuthMethod()</pre>
225225
</li>
226226
</ul>
227-
<a name="getShowAuthView--">
227+
<a name="shouldShowAuthView--">
228228
<!-- -->
229229
</a>
230230
<ul class="blockList">
231231
<li class="blockList">
232-
<h4>getShowAuthView</h4>
233-
<pre>public&nbsp;boolean&nbsp;getShowAuthView()</pre>
232+
<h4>shouldShowAuthView</h4>
233+
<pre>public&nbsp;boolean&nbsp;shouldShowAuthView()</pre>
234234
</li>
235235
</ul>
236236
<a name="getRequiredFeatures--">

‎app-remote-lib/docs/com/spotify/android/appremote/api/Connector.ConnectionListener.html‎

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_171) on Wed Jan 23 22:11:40 CET 2019 -->
5+
<!-- Generated by javadoc (1.8.0_221) on Wed Nov 20 11:49:20 CET 2019 -->
66
<title>Connector.ConnectionListener (Spotify App Remote)</title>
7-
<meta name="date" content="2019-01-23">
7+
<meta name="date" content="2019-11-20">
88
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
99
<script type="text/javascript" src="../../../../../script.js"></script>
1010
</head>
@@ -132,11 +132,7 @@ <h3>Method Summary</h3>
132132
<tr id="i1" class="rowColor">
133133
<td class="colFirst"><code>void</code></td>
134134
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/spotify/android/appremote/api/Connector.ConnectionListener.html#onFailure-java.lang.Throwable-">onFailure</a></span>(java.lang.Throwable&nbsp;error)</code>
135-
<div class="block">Called when connection to the Spotify app fails or is lost
136-
See
137-
<a href="../../../../../com/spotify/android/appremote/api/error/CouldNotFindSpotifyApp.html" title="class in com.spotify.android.appremote.api.error"><code>CouldNotFindSpotifyApp</code></a>
138-
<a href="../../../../../com/spotify/android/appremote/api/error/LoggedOutException.html" title="class in com.spotify.android.appremote.api.error"><code>LoggedOutException</code></a>
139-
<a href="../../../../../com/spotify/android/appremote/api/error/SpotifyConnectionTerminatedException.html" title="class in com.spotify.android.appremote.api.error"><code>SpotifyConnectionTerminatedException</code></a></div>
135+
<div class="block">Called when connection to the Spotify app fails or is lost See <a href="../../../../../com/spotify/android/appremote/api/error/CouldNotFindSpotifyApp.html" title="class in com.spotify.android.appremote.api.error"><code>CouldNotFindSpotifyApp</code></a> <a href="../../../../../com/spotify/android/appremote/api/error/LoggedOutException.html" title="class in com.spotify.android.appremote.api.error"><code>LoggedOutException</code></a> <a href="../../../../../com/spotify/android/appremote/api/error/SpotifyConnectionTerminatedException.html" title="class in com.spotify.android.appremote.api.error"><code>SpotifyConnectionTerminatedException</code></a></div>
140136
</td>
141137
</tr>
142138
</table>
@@ -175,11 +171,7 @@ <h4>onConnected</h4>
175171
<li class="blockList">
176172
<h4>onFailure</h4>
177173
<pre>void&nbsp;onFailure(java.lang.Throwable&nbsp;error)</pre>
178-
<div class="block">Called when connection to the Spotify app fails or is lost
179-
See
180-
<a href="../../../../../com/spotify/android/appremote/api/error/CouldNotFindSpotifyApp.html" title="class in com.spotify.android.appremote.api.error"><code>CouldNotFindSpotifyApp</code></a>
181-
<a href="../../../../../com/spotify/android/appremote/api/error/LoggedOutException.html" title="class in com.spotify.android.appremote.api.error"><code>LoggedOutException</code></a>
182-
<a href="../../../../../com/spotify/android/appremote/api/error/SpotifyConnectionTerminatedException.html" title="class in com.spotify.android.appremote.api.error"><code>SpotifyConnectionTerminatedException</code></a></div>
174+
<div class="block">Called when connection to the Spotify app fails or is lost See <a href="../../../../../com/spotify/android/appremote/api/error/CouldNotFindSpotifyApp.html" title="class in com.spotify.android.appremote.api.error"><code>CouldNotFindSpotifyApp</code></a> <a href="../../../../../com/spotify/android/appremote/api/error/LoggedOutException.html" title="class in com.spotify.android.appremote.api.error"><code>LoggedOutException</code></a> <a href="../../../../../com/spotify/android/appremote/api/error/SpotifyConnectionTerminatedException.html" title="class in com.spotify.android.appremote.api.error"><code>SpotifyConnectionTerminatedException</code></a></div>
183175
<dl>
184176
<dt><span class="paramLabel">Parameters:</span></dt>
185177
<dd><code>error</code> - associated with why/how the connection failed or broke</dd>

‎app-remote-lib/docs/com/spotify/android/appremote/api/Connector.html‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_171) on Wed Jan 23 22:11:40 CET 2019 -->
5+
<!-- Generated by javadoc (1.8.0_221) on Wed Nov 20 11:49:20 CET 2019 -->
66
<title>Connector (Spotify App Remote)</title>
7-
<meta name="date" content="2019-01-23">
7+
<meta name="date" content="2019-11-20">
88
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
99
<script type="text/javascript" src="../../../../../script.js"></script>
1010
</head>
@@ -186,7 +186,8 @@ <h4>connect</h4>
186186
<dt><span class="paramLabel">Parameters:</span></dt>
187187
<dd><code>context</code> - a valid Android context</dd>
188188
<dd><code>params</code> - parameters to identify and configure the connection</dd>
189-
<dd><code>connectionListener</code> - a listener that will be called when the connection is successful, fails or is lost</dd>
189+
<dd><code>connectionListener</code> - a listener that will be called when the connection is successful,
190+
fails or is lost</dd>
190191
</dl>
191192
</li>
192193
</ul>

0 commit comments

Comments
 (0)