|
3 | 3 |
|
4 | 4 | namespace SpotifyNet |
5 | 5 | { |
| 6 | + /// <summary> |
| 7 | + /// Scopes provide Spotify users using third-party apps the confidence that only the |
| 8 | + /// information they choose to share will be shared, and nothing more. |
| 9 | + /// </summary> |
6 | 10 | [Flags] |
7 | 11 | public enum Scope : uint |
8 | 12 | { |
9 | | - //None = 0, |
10 | | - |
11 | | - All = ~0u, |
12 | | - |
| 13 | + /// <summary> |
| 14 | + /// No scopes |
| 15 | + /// </summary> |
| 16 | + None = 0, |
| 17 | + |
| 18 | + /// <summary> |
| 19 | + /// Read access to user’s subscription details (type of user account). |
| 20 | + /// </summary> |
13 | 21 | [Description("user-read-private")] |
14 | 22 | UserReadPrivate = 1, |
15 | 23 |
|
| 24 | + /// <summary> |
| 25 | + /// Read access to user’s email address. |
| 26 | + /// </summary> |
16 | 27 | [Description("user-read-email")] |
17 | 28 | UserReadEmail = 2 << 0, |
18 | 29 |
|
| 30 | + /// <summary> |
| 31 | + /// Read access to user’s birthdate. |
| 32 | + /// </summary> |
| 33 | + [Obsolete("Does not exist anymore")] |
19 | 34 | [Description("user-read-birthdate")] |
20 | 35 | UserReadBirthday = 2 << 1, |
21 | 36 |
|
| 37 | + /// <summary> |
| 38 | + /// Read access to user's private playlists. |
| 39 | + /// </summary> |
22 | 40 | [Description("playlist-read-private")] |
23 | 41 | PlaylistReadPrivate = 2 << 2, |
24 | 42 |
|
| 43 | + /// <summary> |
| 44 | + /// Write access to a user's private playlists. |
| 45 | + /// </summary> |
25 | 46 | [Description("playlist-modify-private")] |
26 | 47 | PlaylistModifyPrivate = 2 << 3, |
27 | 48 |
|
| 49 | + /// <summary> |
| 50 | + /// Write access to a user's public playlists. |
| 51 | + /// </summary> |
28 | 52 | [Description("playlist-modify-public")] |
29 | 53 | PlaylistModifyPublic = 2 << 4, |
30 | 54 |
|
| 55 | + /// <summary> |
| 56 | + /// Include collaborative playlists when requesting a user's playlists. |
| 57 | + /// </summary> |
31 | 58 | [Description("playlist-read-collaborative")] |
32 | 59 | PlaylistReadCollaborative = 2 << 5, |
33 | 60 |
|
| 61 | + /// <summary> |
| 62 | + /// Read access to a user's top artists and tracks. |
| 63 | + /// </summary> |
34 | 64 | [Description("user-top-read")] |
35 | 65 | UserTopRead = 2 << 6, |
36 | 66 |
|
| 67 | + /// <summary> |
| 68 | + /// Read access to a user’s recently played tracks. |
| 69 | + /// </summary> |
37 | 70 | [Description("user-read-recently-played")] |
38 | 71 | UserReadRecentlyPlayed = 2 << 7, |
39 | 72 |
|
| 73 | + /// <summary> |
| 74 | + /// Read access to a user's "Your Music" library. |
| 75 | + /// </summary> |
40 | 76 | [Description("user-library-read")] |
41 | 77 | UserLibraryRead = 2 << 8, |
42 | 78 |
|
| 79 | + /// <summary> |
| 80 | + /// Write/delete access to a user's "Your Music" library. |
| 81 | + /// </summary> |
43 | 82 | [Description("user-library-modify")] |
44 | 83 | UserLibraryModify = 2 << 9, |
45 | 84 |
|
| 85 | + /// <summary> |
| 86 | + /// Read access to a user’s currently playing content. |
| 87 | + /// </summary> |
46 | 88 | [Description("user-read-currently-playing")] |
47 | 89 | UserReadCurrentlyPlaying = 2 << 10, |
48 | 90 |
|
| 91 | + /// <summary> |
| 92 | + /// Write access to a user’s playback state. |
| 93 | + /// </summary> |
49 | 94 | [Description("user-modify-playback-state")] |
50 | 95 | UserModifyPlaybackState = 2 << 11, |
51 | 96 |
|
| 97 | + /// <summary> |
| 98 | + /// Read access to a user’s player state. |
| 99 | + /// </summary> |
52 | 100 | [Description("user-read-playback-state")] |
53 | 101 | UserReadPlaybackState = 2 << 12, |
54 | 102 |
|
| 103 | + /// <summary> |
| 104 | + /// Write/delete access to the list of artists and other users that the user follows. |
| 105 | + /// </summary> |
55 | 106 | [Description("user-follow-modify")] |
56 | 107 | UserFollowModify = 2 << 13, |
57 | 108 |
|
| 109 | + /// <summary> |
| 110 | + /// Read access to the list of artists and other users that the user follows. |
| 111 | + /// </summary> |
58 | 112 | [Description("user-follow-read")] |
59 | 113 | UserFollowRead = 2 << 14, |
60 | 114 |
|
| 115 | + /// <summary> |
| 116 | + /// Control playback of a Spotify track. This scope is currently available to the Web Playback SDK. |
| 117 | + /// The user must have a Spotify Premium account. |
| 118 | + /// </summary> |
61 | 119 | [Description("streaming")] |
62 | | - Streaming = 2 << 15 |
| 120 | + Streaming = 2 << 15, |
| 121 | + |
| 122 | + /// <summary> |
| 123 | + /// All scopes which are inside <see cref="Scope"/>. |
| 124 | + /// </summary> |
| 125 | + All = ~0u |
63 | 126 | } |
64 | 127 | } |
0 commit comments