From 3e0c4e479b5742b22e7c7cd7fe9c54febbf1e9e5 Mon Sep 17 00:00:00 2001 From: Jonas Dellinger Date: Sun, 7 Jun 2020 13:30:58 +0200 Subject: [PATCH] documentation for credentials authenticator --- .../ClientCredentialsAuthenticator.cs | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/SpotifyAPI.Web/Authenticators/ClientCredentialsAuthenticator.cs b/SpotifyAPI.Web/Authenticators/ClientCredentialsAuthenticator.cs index 0f6d96a8..00e42ede 100644 --- a/SpotifyAPI.Web/Authenticators/ClientCredentialsAuthenticator.cs +++ b/SpotifyAPI.Web/Authenticators/ClientCredentialsAuthenticator.cs @@ -10,16 +10,28 @@ namespace SpotifyAPI.Web public class ClientCredentialsAuthenticator : IAuthenticator { /// - /// Initiate a new instance. The first token will be fetched when the first API call occurs + /// Initiate a new instance. The initial token will be fetched when the first API call occurs. /// /// - /// The ClientID, defined in a spotify application in your Spotify Developer Dashboard + /// The ClientID, defined in a spotify application in your Spotify Developer Dashboard. /// /// - /// The ClientID, defined in a spotify application in your Spotify Developer Dashboard + /// The ClientSecret, defined in a spotify application in your Spotify Developer Dashboard. /// public ClientCredentialsAuthenticator(string clientId, string clientSecret) : this(clientId, clientSecret, null) { } + /// + /// Initiate a new instance. The initial token is provided and will be used if not expired + /// + /// + /// The ClientID, defined in a spotify application in your Spotify Developer Dashboard. + /// + /// + /// The ClientSecret, defined in a spotify application in your Spotify Developer Dashboard. + /// + /// + /// An optional inital token received earlier. + /// public ClientCredentialsAuthenticator(string clientId, string clientSecret, ClientCredentialsTokenResponse? token) { Ensure.ArgumentNotNullOrEmptyString(clientId, nameof(clientId));