Skip to content

Commit 366e3b1

Browse files
committed
Adds sumnmaries to sope enum #minor
1 parent 3146d8c commit 366e3b1

File tree

1 file changed

+68
-5
lines changed

1 file changed

+68
-5
lines changed

SpotifyNet/Scope.cs

Lines changed: 68 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,62 +3,125 @@
33

44
namespace SpotifyNet
55
{
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>
610
[Flags]
711
public enum Scope : uint
812
{
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>
1321
[Description("user-read-private")]
1422
UserReadPrivate = 1,
1523

24+
/// <summary>
25+
/// Read access to user’s email address.
26+
/// </summary>
1627
[Description("user-read-email")]
1728
UserReadEmail = 2 << 0,
1829

30+
/// <summary>
31+
/// Read access to user’s birthdate.
32+
/// </summary>
33+
[Obsolete("Does not exist anymore")]
1934
[Description("user-read-birthdate")]
2035
UserReadBirthday = 2 << 1,
2136

37+
/// <summary>
38+
/// Read access to user's private playlists.
39+
/// </summary>
2240
[Description("playlist-read-private")]
2341
PlaylistReadPrivate = 2 << 2,
2442

43+
/// <summary>
44+
/// Write access to a user's private playlists.
45+
/// </summary>
2546
[Description("playlist-modify-private")]
2647
PlaylistModifyPrivate = 2 << 3,
2748

49+
/// <summary>
50+
/// Write access to a user's public playlists.
51+
/// </summary>
2852
[Description("playlist-modify-public")]
2953
PlaylistModifyPublic = 2 << 4,
3054

55+
/// <summary>
56+
/// Include collaborative playlists when requesting a user's playlists.
57+
/// </summary>
3158
[Description("playlist-read-collaborative")]
3259
PlaylistReadCollaborative = 2 << 5,
3360

61+
/// <summary>
62+
/// Read access to a user's top artists and tracks.
63+
/// </summary>
3464
[Description("user-top-read")]
3565
UserTopRead = 2 << 6,
3666

67+
/// <summary>
68+
/// Read access to a user’s recently played tracks.
69+
/// </summary>
3770
[Description("user-read-recently-played")]
3871
UserReadRecentlyPlayed = 2 << 7,
3972

73+
/// <summary>
74+
/// Read access to a user's "Your Music" library.
75+
/// </summary>
4076
[Description("user-library-read")]
4177
UserLibraryRead = 2 << 8,
4278

79+
/// <summary>
80+
/// Write/delete access to a user's "Your Music" library.
81+
/// </summary>
4382
[Description("user-library-modify")]
4483
UserLibraryModify = 2 << 9,
4584

85+
/// <summary>
86+
/// Read access to a user’s currently playing content.
87+
/// </summary>
4688
[Description("user-read-currently-playing")]
4789
UserReadCurrentlyPlaying = 2 << 10,
4890

91+
/// <summary>
92+
/// Write access to a user’s playback state.
93+
/// </summary>
4994
[Description("user-modify-playback-state")]
5095
UserModifyPlaybackState = 2 << 11,
5196

97+
/// <summary>
98+
/// Read access to a user’s player state.
99+
/// </summary>
52100
[Description("user-read-playback-state")]
53101
UserReadPlaybackState = 2 << 12,
54102

103+
/// <summary>
104+
/// Write/delete access to the list of artists and other users that the user follows.
105+
/// </summary>
55106
[Description("user-follow-modify")]
56107
UserFollowModify = 2 << 13,
57108

109+
/// <summary>
110+
/// Read access to the list of artists and other users that the user follows.
111+
/// </summary>
58112
[Description("user-follow-read")]
59113
UserFollowRead = 2 << 14,
60114

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>
61119
[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
63126
}
64127
}

0 commit comments

Comments
 (0)