Usage
AvailabeDevices devices = _spotify.GetDevices();
diff --git a/SpotifyWebAPI/profiles/index.html b/SpotifyWebAPI/profiles/index.html
index 807106cc..8e0cdff4 100644
--- a/SpotifyWebAPI/profiles/index.html
+++ b/SpotifyWebAPI/profiles/index.html
@@ -183,7 +183,13 @@
Example
-
+
+
+
+
Returns a PrivateProfile
Usage
diff --git a/mkdocs/search_index.json b/mkdocs/search_index.json
index 2c318246..abc0123c 100644
--- a/mkdocs/search_index.json
+++ b/mkdocs/search_index.json
@@ -332,12 +332,12 @@
},
{
"location": "/SpotifyWebAPI/player/",
- "text": "GetDevices\n\n\n\n\nGet information about a user\u2019s available devices.\n\n\n\n\nParamters\n \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\nUsage\n \n\n\nAvailabeDevices devices = _spotify.GetDevices();\ndevices.Devices.ForEach(device =\n Console.WriteLine(device.Name));\n\n\n\n\n\n\nGetPlayback\n\n\n\n\nGet information about the user\u2019s current playback state, including track, track progress, and active device.\n\n\n\n\nParamters\n \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\n[market]\n\n\nAn ISO 3166-1 alpha-2 country code. Provide this parameter if you want to apply Track Relinking.\n\n\n\"DE\"\n\n\n\n\n\n\n\n\nUsage\n \n\n\nPlaybackContext context = _spotify.GetPlayback();\nif(contex.Item != null)\n Console.WriteLine(context.Item.Name)); //Print the current song\n\n\n\n\n\n\nGetPlayingTrack\n\n\n\n\nGet the object currently being played on the user\u2019s Spotify account.\n\n\n\n\nParamters\n \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\n[market]\n\n\nAn ISO 3166-1 alpha-2 country code. Provide this parameter if you want to apply Track Relinking.\n\n\n\"DE\"\n\n\n\n\n\n\n\n\nThis is a simpler (less data) version of \nGetPlayback\n\n\nUsage\n \n\n\nPlaybackContext context = _spotify.GetPlayingTrack();\nif(contex.Item != null)\n Console.WriteLine(context.Item.Name)); //Print the current song\n\n\n\n\n\n\nTransferPlayback\n\n\n\n\nTransfer playback to a new device and determine if it should start playing.\n\n\n\n\nParamters\n \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\ndeviceIds or deviceId\n\n\nA JSON array containing the ID of the device on which playback should be started/transferred\n\n\n\"XXXX-XXXX-XXXX-XXXX\"\n\n\n\n\n\n\nplay\n\n\ntrue: ensure playback happens on new device, false: keep current playback state\n\n\ntrue\n\n\n\n\n\n\n\n\nUsage\n \n\n\nErrorResponse error = _spotify.TransferPlayback(\nXXXX-XXXX-XXXX-XXXX\n);\n\n\n\n\n\n\nResumePlayback\n\n\n\n\nStart a new context or resume current playback on the user\u2019s active device.\n\n\n\n\nParamters\n \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\n[deviceId]\n\n\nThe id of the device this command is targeting. If not supplied, the user's currently active device is the target.\n\n\n\"XXXX-XXXX-XXXX-XXXX\"\n\n\n\n\n\n\ncontextUri\n\n\nSpotify URI of the context to play\n\n\n\"spotify:album:1Je1IMUlBXcx1Fz0WE7oPT\"\n\n\n\n\n\n\nuris\n\n\nAn array of the Spotify track URIs to play.\n\n\nnew List\nstring\n { \"spotify:track:4iV5W9uYEdYUVa79Axb7Rh\" }\n\n\n\n\n\n\noffset\n\n\nIndicates from where in the context playback should start. Only available when context_uri corresponds to an album or playlist object, or when the uris parameter is used.\n\n\n0\n\n\n\n\n\n\n\n\nUsage\n \n\n\nErrorResponse error = _spotify.ResumePlayback(uris: new List\nstring\n { \nspotify:track:4iV5W9uYEdYUVa79Axb7Rh\n });\n\n\n\n\n\n\nPausePlayback\n\n\n\n\nPause playback on the user\u2019s account.\n\n\n\n\nParamters\n \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\n[deviceId]\n\n\nThe id of the device this command is targeting. If not supplied, the user's currently active device is the target.\n\n\n\"XXXX-XXXX-XXXX-XXXX\"\n\n\n\n\n\n\n\n\nUsage\n \n\n\nErrorResponse error = _spotify.PausePlayback();\n\n\n\n\n\n\nSkipPlaybackToNext\n\n\n\n\nSkips to next track in the user\u2019s queue.\n\n\n\n\nParamters\n \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\n[deviceId]\n\n\nThe id of the device this command is targeting. If not supplied, the user's currently active device is the target.\n\n\n\"XXXX-XXXX-XXXX-XXXX\"\n\n\n\n\n\n\n\n\nUsage\n \n\n\nErrorResponse error = _spotify.SkipPlaybackToNext();\n\n\n\n\n\n\nSkipPlaybackToPrevious\n\n\n\n\nSkips to previous track in the user\u2019s queue.\nNote that this will ALWAYS skip to the previous track, regardless of the current track\u2019s progress.\nReturning to the start of the current track should be performed using the https://api.spotify.com/v1/me/player/seek endpoint.\n\n\n\n\nParamters\n \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\n[deviceId]\n\n\nThe id of the device this command is targeting. If not supplied, the user's currently active device is the target.\n\n\n\"XXXX-XXXX-XXXX-XXXX\"\n\n\n\n\n\n\n\n\nUsage\n \n\n\nErrorResponse error = _spotify.SkipPlaybackToPrevious();\n\n\n\n\n\n\nSeekPlayback\n\n\n\n\nSeeks to the given position in the user\u2019s currently playing track.\n\n\n\n\nParamters\n \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\npositionMs\n\n\nThe position in milliseconds to seek to. Must be a positive number. Passing in a position that is greater than the length of the track will cause the player to start playing the next song.\n\n\n50\n\n\n\n\n\n\n[deviceId]\n\n\nThe id of the device this command is targeting. If not supplied, the user's currently active device is the target.\n\n\n\"XXXX-XXXX-XXXX-XXXX\"\n\n\n\n\n\n\n\n\nUsage\n \n\n\nErrorResponse error = _spotify.SeekPlayback(50);\n\n\n\n\n\n\nSetRepeatMode\n\n\n\n\nSet the repeat mode for the user\u2019s playback. Options are repeat-track, repeat-context, and off.\n\n\n\n\nParamters\n \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\nstate\n\n\ntrack, context or off.\n\n\nRepeatState.Track\n\n\n\n\n\n\n[deviceId]\n\n\nThe id of the device this command is targeting. If not supplied, the user's currently active device is the target.\n\n\n\"XXXX-XXXX-XXXX-XXXX\"\n\n\n\n\n\n\n\n\nUsage\n \n\n\nErrorResponse error = _spotify.SetRepeatMode(RepeatState.Track);\n\n\n\n\n\n\nSetVolume\n\n\n\n\nSet the volume for the user\u2019s current playback device.\n\n\n\n\nParamters\n \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\nvolumePercent\n\n\nInteger. The volume to set. Must be a value from 0 to 100 inclusive.\n\n\n50\n\n\n\n\n\n\n[deviceId]\n\n\nThe id of the device this command is targeting. If not supplied, the user's currently active device is the target.\n\n\n\"XXXX-XXXX-XXXX-XXXX\"\n\n\n\n\n\n\n\n\nUsage\n \n\n\nErrorResponse error = _spotify.SetVolume(50);\n\n\n\n\n\n\nSetShuffle\n\n\n\n\nToggle shuffle on or off for user\u2019s playback.\n\n\n\n\nParamters\n \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\nshuffle\n\n\nTrue or False\n\n\nfalse\n\n\n\n\n\n\n[deviceId]\n\n\nThe id of the device this command is targeting. If not supplied, the user's currently active device is the target.\n\n\n\"XXXX-XXXX-XXXX-XXXX\"\n\n\n\n\n\n\n\n\nUsage\n \n\n\nErrorResponse error = _spotify.SetShuffle(false);",
+ "text": "GetDevices\n\n\n\n\nGet information about a user\u2019s available devices.\n\n\n\n\nParamters\n \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\n\n\n\n\n\n\n\n\n\n\n\n\nUsage\n \n\n\nAvailabeDevices devices = _spotify.GetDevices();\ndevices.Devices.ForEach(device =\n Console.WriteLine(device.Name));\n\n\n\n\n\n\nGetPlayback\n\n\n\n\nGet information about the user\u2019s current playback state, including track, track progress, and active device.\n\n\n\n\nParamters\n \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\n[market]\n\n\nAn ISO 3166-1 alpha-2 country code. Provide this parameter if you want to apply Track Relinking.\n\n\n\"DE\"\n\n\n\n\n\n\n\n\nUsage\n \n\n\nPlaybackContext context = _spotify.GetPlayback();\nif(contex.Item != null)\n Console.WriteLine(context.Item.Name)); //Print the current song\n\n\n\n\n\n\nGetPlayingTrack\n\n\n\n\nGet the object currently being played on the user\u2019s Spotify account.\n\n\n\n\nParamters\n \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\n[market]\n\n\nAn ISO 3166-1 alpha-2 country code. Provide this parameter if you want to apply Track Relinking.\n\n\n\"DE\"\n\n\n\n\n\n\n\n\nThis is a simpler (less data) version of \nGetPlayback\n\n\nUsage\n \n\n\nPlaybackContext context = _spotify.GetPlayingTrack();\nif(contex.Item != null)\n Console.WriteLine(context.Item.Name)); //Print the current song\n\n\n\n\n\n\nTransferPlayback\n\n\n\n\nTransfer playback to a new device and determine if it should start playing.\n\n\n\n\nParamters\n \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\ndeviceIds or deviceId\n\n\nA JSON array containing the ID of the device on which playback should be started/transferred\n\n\n\"XXXX-XXXX-XXXX-XXXX\"\n\n\n\n\n\n\nplay\n\n\ntrue: ensure playback happens on new device, false: keep current playback state\n\n\ntrue\n\n\n\n\n\n\n\n\nUsage\n \n\n\nErrorResponse error = _spotify.TransferPlayback(\nXXXX-XXXX-XXXX-XXXX\n);\n\n\n\n\n\n\nResumePlayback\n\n\n\n\nStart a new context or resume current playback on the user\u2019s active device.\n\n\n\n\nParamters\n \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\n[deviceId]\n\n\nThe id of the device this command is targeting. If not supplied, the user's currently active device is the target.\n\n\n\"XXXX-XXXX-XXXX-XXXX\"\n\n\n\n\n\n\ncontextUri\n\n\nSpotify URI of the context to play\n\n\n\"spotify:album:1Je1IMUlBXcx1Fz0WE7oPT\"\n\n\n\n\n\n\nuris\n\n\nAn array of the Spotify track URIs to play.\n\n\nnew List\nstring\n { \"spotify:track:4iV5W9uYEdYUVa79Axb7Rh\" }\n\n\n\n\n\n\noffset\n\n\nIndicates from where in the context playback should start. Only available when context_uri corresponds to an album or playlist object, or when the uris parameter is used.\n\n\n0\n\n\n\n\n\n\n\n\nUsage\n \n\n\nErrorResponse error = _spotify.ResumePlayback(uris: new List\nstring\n { \nspotify:track:4iV5W9uYEdYUVa79Axb7Rh\n });\n\n\n\n\n\n\nPausePlayback\n\n\n\n\nPause playback on the user\u2019s account.\n\n\n\n\nParamters\n \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\n[deviceId]\n\n\nThe id of the device this command is targeting. If not supplied, the user's currently active device is the target.\n\n\n\"XXXX-XXXX-XXXX-XXXX\"\n\n\n\n\n\n\n\n\nUsage\n \n\n\nErrorResponse error = _spotify.PausePlayback();\n\n\n\n\n\n\nSkipPlaybackToNext\n\n\n\n\nSkips to next track in the user\u2019s queue.\n\n\n\n\nParamters\n \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\n[deviceId]\n\n\nThe id of the device this command is targeting. If not supplied, the user's currently active device is the target.\n\n\n\"XXXX-XXXX-XXXX-XXXX\"\n\n\n\n\n\n\n\n\nUsage\n \n\n\nErrorResponse error = _spotify.SkipPlaybackToNext();\n\n\n\n\n\n\nSkipPlaybackToPrevious\n\n\n\n\nSkips to previous track in the user\u2019s queue.\nNote that this will ALWAYS skip to the previous track, regardless of the current track\u2019s progress.\nReturning to the start of the current track should be performed using the https://api.spotify.com/v1/me/player/seek endpoint.\n\n\n\n\nParamters\n \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\n[deviceId]\n\n\nThe id of the device this command is targeting. If not supplied, the user's currently active device is the target.\n\n\n\"XXXX-XXXX-XXXX-XXXX\"\n\n\n\n\n\n\n\n\nUsage\n \n\n\nErrorResponse error = _spotify.SkipPlaybackToPrevious();\n\n\n\n\n\n\nSeekPlayback\n\n\n\n\nSeeks to the given position in the user\u2019s currently playing track.\n\n\n\n\nParamters\n \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\npositionMs\n\n\nThe position in milliseconds to seek to. Must be a positive number. Passing in a position that is greater than the length of the track will cause the player to start playing the next song.\n\n\n50\n\n\n\n\n\n\n[deviceId]\n\n\nThe id of the device this command is targeting. If not supplied, the user's currently active device is the target.\n\n\n\"XXXX-XXXX-XXXX-XXXX\"\n\n\n\n\n\n\n\n\nUsage\n \n\n\nErrorResponse error = _spotify.SeekPlayback(50);\n\n\n\n\n\n\nSetRepeatMode\n\n\n\n\nSet the repeat mode for the user\u2019s playback. Options are repeat-track, repeat-context, and off.\n\n\n\n\nParamters\n \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\nstate\n\n\ntrack, context or off.\n\n\nRepeatState.Track\n\n\n\n\n\n\n[deviceId]\n\n\nThe id of the device this command is targeting. If not supplied, the user's currently active device is the target.\n\n\n\"XXXX-XXXX-XXXX-XXXX\"\n\n\n\n\n\n\n\n\nUsage\n \n\n\nErrorResponse error = _spotify.SetRepeatMode(RepeatState.Track);\n\n\n\n\n\n\nSetVolume\n\n\n\n\nSet the volume for the user\u2019s current playback device.\n\n\n\n\nParamters\n \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\nvolumePercent\n\n\nInteger. The volume to set. Must be a value from 0 to 100 inclusive.\n\n\n50\n\n\n\n\n\n\n[deviceId]\n\n\nThe id of the device this command is targeting. If not supplied, the user's currently active device is the target.\n\n\n\"XXXX-XXXX-XXXX-XXXX\"\n\n\n\n\n\n\n\n\nUsage\n \n\n\nErrorResponse error = _spotify.SetVolume(50);\n\n\n\n\n\n\nSetShuffle\n\n\n\n\nToggle shuffle on or off for user\u2019s playback.\n\n\n\n\nParamters\n \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\nshuffle\n\n\nTrue or False\n\n\nfalse\n\n\n\n\n\n\n[deviceId]\n\n\nThe id of the device this command is targeting. If not supplied, the user's currently active device is the target.\n\n\n\"XXXX-XXXX-XXXX-XXXX\"\n\n\n\n\n\n\n\n\nUsage\n \n\n\nErrorResponse error = _spotify.SetShuffle(false);",
"title": "- Player"
},
{
"location": "/SpotifyWebAPI/player/#getdevices",
- "text": "Get information about a user\u2019s available devices. Paramters Name Description Example Usage AvailabeDevices devices = _spotify.GetDevices();\ndevices.Devices.ForEach(device = Console.WriteLine(device.Name));",
+ "text": "Get information about a user\u2019s available devices. Paramters Name Description Example Usage AvailabeDevices devices = _spotify.GetDevices();\ndevices.Devices.ForEach(device = Console.WriteLine(device.Name));",
"title": "GetDevices"
},
{
@@ -457,12 +457,12 @@
},
{
"location": "/SpotifyWebAPI/profiles/",
- "text": "GetPrivateProfile\n\n\nAUTH REQUIRED\n\n\n\n\nGet detailed profile information about the current user (including the current user\u2019s username).\n\n\n\n\nParamters\n \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\nReturns a \nPrivateProfile\n\n\nUsage\n \n\n\nPrivateUser user = _spotify.GetPrivateProfile();\nConsole.WriteLine(user.DisplayName);\n\n\n\n\n\n\nGetPublicProfile\n\n\n\n\nGet public profile information about a Spotify user.\n\n\n\n\nParamters\n \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\nuserId\n\n\nThe user's Spotify user ID.\n\n\nEXAMPLE\n\n\n\n\n\n\n\n\nReturns a \nPublicProfile\n\n\nUsage",
+ "text": "GetPrivateProfile\n\n\nAUTH REQUIRED\n\n\n\n\nGet detailed profile information about the current user (including the current user\u2019s username).\n\n\n\n\nParamters\n \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\n\n\n\n\n\n\n\n\n\n\n\n\nReturns a \nPrivateProfile\n\n\nUsage\n \n\n\nPrivateUser user = _spotify.GetPrivateProfile();\nConsole.WriteLine(user.DisplayName);\n\n\n\n\n\n\nGetPublicProfile\n\n\n\n\nGet public profile information about a Spotify user.\n\n\n\n\nParamters\n \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\nuserId\n\n\nThe user's Spotify user ID.\n\n\nEXAMPLE\n\n\n\n\n\n\n\n\nReturns a \nPublicProfile\n\n\nUsage",
"title": "- Profiles"
},
{
"location": "/SpotifyWebAPI/profiles/#getprivateprofile",
- "text": "AUTH REQUIRED Get detailed profile information about the current user (including the current user\u2019s username). Paramters Name Description Example Returns a PrivateProfile Usage PrivateUser user = _spotify.GetPrivateProfile();\nConsole.WriteLine(user.DisplayName);",
+ "text": "AUTH REQUIRED Get detailed profile information about the current user (including the current user\u2019s username). Paramters Name Description Example Returns a PrivateProfile Usage PrivateUser user = _spotify.GetPrivateProfile();\nConsole.WriteLine(user.DisplayName);",
"title": "GetPrivateProfile"
},
{
diff --git a/sitemap.xml b/sitemap.xml
index 99d94d12..2bc8bd5a 100644
--- a/sitemap.xml
+++ b/sitemap.xml
@@ -4,7 +4,7 @@
/
- 2017-07-16
+ 2017-08-29
daily
@@ -13,85 +13,85 @@
/SpotifyWebAPI/gettingstarted/
- 2017-07-16
+ 2017-08-29
daily
/SpotifyWebAPI/examples/
- 2017-07-16
+ 2017-08-29
daily
/SpotifyWebAPI/auth/
- 2017-07-16
+ 2017-08-29
daily
/SpotifyWebAPI/albums/
- 2017-07-16
+ 2017-08-29
daily
/SpotifyWebAPI/artists/
- 2017-07-16
+ 2017-08-29
daily
/SpotifyWebAPI/browse/
- 2017-07-16
+ 2017-08-29
daily
/SpotifyWebAPI/follow/
- 2017-07-16
+ 2017-08-29
daily
/SpotifyWebAPI/library/
- 2017-07-16
+ 2017-08-29
daily
/SpotifyWebAPI/player/
- 2017-07-16
+ 2017-08-29
daily
/SpotifyWebAPI/playlists/
- 2017-07-16
+ 2017-08-29
daily
/SpotifyWebAPI/profiles/
- 2017-07-16
+ 2017-08-29
daily
/SpotifyWebAPI/search/
- 2017-07-16
+ 2017-08-29
daily
/SpotifyWebAPI/tracks/
- 2017-07-16
+ 2017-08-29
daily
/SpotifyWebAPI/util/
- 2017-07-16
+ 2017-08-29
daily
@@ -100,7 +100,7 @@
/SpotifyLocalAPI/
- 2017-07-16
+ 2017-08-29
daily