Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation updates #4287

Merged
merged 6 commits into from
Aug 8, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion src/client/Microsoft.Identity.Client/Account.cs
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

using System;
using System.Collections.Generic;
using System.Globalization;

Expand Down
4 changes: 0 additions & 4 deletions src/client/Microsoft.Identity.Client/AccountExtensions.cs
Original file line number Diff line number Diff line change
@@ -1,11 +1,7 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace Microsoft.Identity.Client
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

namespace Microsoft.Identity.Client
{
/// <inheritdoc />
/// <inheritdoc/>
/// <typeparam name="T"></typeparam>
public abstract class AbstractAcquireTokenParameterBuilder<T> : BaseAbstractAcquireTokenParameterBuilder<T>
where T : BaseAbstractAcquireTokenParameterBuilder<T>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ internal AbstractClientAppBaseAcquireTokenParameterBuilder(IClientApplicationBas

internal abstract Task<AuthenticationResult> ExecuteInternalAsync(CancellationToken cancellationToken);

/// <inheritdoc />
/// <inheritdoc/>
public override Task<AuthenticationResult> ExecuteAsync(CancellationToken cancellationToken)
{
ValidateAndCalculateApiId();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ internal AbstractConfidentialClientAcquireTokenParameterBuilder(IConfidentialCli

internal abstract Task<AuthenticationResult> ExecuteInternalAsync(CancellationToken cancellationToken);

/// <inheritdoc />
/// <inheritdoc/>
public override Task<AuthenticationResult> ExecuteAsync(CancellationToken cancellationToken)
{
ClientApplicationBase.GuardMobileFrameworks();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ internal AbstractManagedIdentityAcquireTokenParameterBuilder(IManagedIdentityApp

internal abstract Task<AuthenticationResult> ExecuteInternalAsync(CancellationToken cancellationToken);

/// <inheritdoc />
/// <inheritdoc/>
public override Task<AuthenticationResult> ExecuteAsync(CancellationToken cancellationToken)
{
ApplicationBase.GuardMobileFrameworks();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ internal AbstractPublicClientAcquireTokenParameterBuilder(IPublicClientApplicati

internal abstract Task<AuthenticationResult> ExecuteInternalAsync(CancellationToken cancellationToken);

/// <inheritdoc />
/// <inheritdoc/>
public override Task<AuthenticationResult> ExecuteAsync(CancellationToken cancellationToken)
{
ValidateAndCalculateApiId();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,13 +49,13 @@ private AcquireTokenByAuthorizationCodeParameterBuilder WithAuthorizationCode(st
return this;
}

/// <inheritdoc />
/// <inheritdoc/>
internal override ApiEvent.ApiIds CalculateApiEventId()
{
return ApiEvent.ApiIds.AcquireTokenByAuthorizationCode;
}

/// <inheritdoc />
/// <inheritdoc/>
protected override void Validate()
{
base.Validate();
Expand All @@ -71,7 +71,7 @@ protected override void Validate()
}
}

/// <inheritdoc />
/// <inheritdoc/>
internal override Task<AuthenticationResult> ExecuteInternalAsync(CancellationToken cancellationToken)
{
return ConfidentialClientApplicationExecutor.ExecuteAsync(CommonParameters, Parameters, cancellationToken);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ public sealed class AcquireTokenByIntegratedWindowsAuthParameterBuilder :
{
private AcquireTokenByIntegratedWindowsAuthParameters Parameters { get; } = new AcquireTokenByIntegratedWindowsAuthParameters();

/// <inheritdoc />
/// <inheritdoc/>
internal AcquireTokenByIntegratedWindowsAuthParameterBuilder(IPublicClientApplicationExecutor publicClientApplicationExecutor)
: base(publicClientApplicationExecutor)
{
Expand Down Expand Up @@ -60,7 +60,7 @@ internal override Task<AuthenticationResult> ExecuteInternalAsync(CancellationTo
return PublicClientApplicationExecutor.ExecuteAsync(CommonParameters, Parameters, cancellationToken);
}

/// <inheritdoc />
/// <inheritdoc/>
internal override ApiEvent.ApiIds CalculateApiEventId()
{
return ApiEvent.ApiIds.AcquireTokenByIntegratedWindowsAuth;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ public sealed class AcquireTokenByRefreshTokenParameterBuilder :
{
private AcquireTokenByRefreshTokenParameters Parameters { get; } = new AcquireTokenByRefreshTokenParameters();

/// <inheritdoc />
/// <inheritdoc/>
internal AcquireTokenByRefreshTokenParameterBuilder(IClientApplicationBaseExecutor clientApplicationBaseExecutor)
: base(clientApplicationBaseExecutor)
{
Expand All @@ -40,7 +40,7 @@ internal AcquireTokenByRefreshTokenParameterBuilder WithRefreshToken(string refr
return this;
}

/// <inheritdoc />
/// <inheritdoc/>
internal override Task<AuthenticationResult> ExecuteInternalAsync(CancellationToken cancellationToken)
{
return ClientApplicationBaseExecutor.ExecuteAsync(CommonParameters, Parameters, cancellationToken);
Expand All @@ -56,7 +56,7 @@ protected override void Validate()
}
}

/// <inheritdoc />
/// <inheritdoc/>
internal override ApiEvent.ApiIds CalculateApiEventId()
{
return ApiEvent.ApiIds.AcquireTokenByRefreshToken;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -119,13 +119,13 @@ private AcquireTokenByUsernamePasswordParameterBuilder WithPassword(string passw
return this;
}

/// <inheritdoc />
/// <inheritdoc/>
internal override Task<AuthenticationResult> ExecuteInternalAsync(CancellationToken cancellationToken)
{
return PublicClientApplicationExecutor.ExecuteAsync(CommonParameters, Parameters, cancellationToken);
}

/// <inheritdoc />
/// <inheritdoc/>
internal override ApiEvent.ApiIds CalculateApiEventId()
{
return ApiEvent.ApiIds.AcquireTokenByUsernamePassword;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ public sealed class AcquireTokenForClientParameterBuilder :
{
private AcquireTokenForClientParameters Parameters { get; } = new AcquireTokenForClientParameters();

/// <inheritdoc />
/// <inheritdoc/>
internal AcquireTokenForClientParameterBuilder(IConfidentialClientApplicationExecutor confidentialClientApplicationExecutor)
: base(confidentialClientApplicationExecutor)
{
Expand Down Expand Up @@ -90,7 +90,7 @@ public AcquireTokenForClientParameterBuilder WithPreferredAzureRegion(bool useAz
throw new NotImplementedException();
}

/// <inheritdoc />
/// <inheritdoc/>
internal override Task<AuthenticationResult> ExecuteInternalAsync(CancellationToken cancellationToken)
{
return ConfidentialClientApplicationExecutor.ExecuteAsync(CommonParameters, Parameters, cancellationToken);
Expand All @@ -106,7 +106,7 @@ protected override void Validate()
}
}

/// <inheritdoc />
/// <inheritdoc/>
internal override ApiEvent.ApiIds CalculateApiEventId()
{
return ApiEvent.ApiIds.AcquireTokenForClient;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ public sealed class AcquireTokenForManagedIdentityParameterBuilder :
{
private AcquireTokenForManagedIdentityParameters Parameters { get; } = new AcquireTokenForManagedIdentityParameters();

/// <inheritdoc />
/// <inheritdoc/>
internal AcquireTokenForManagedIdentityParameterBuilder(IManagedIdentityApplicationExecutor managedIdentityApplicationExecutor)
: base(managedIdentityApplicationExecutor)
{
Expand Down Expand Up @@ -59,13 +59,13 @@ public AcquireTokenForManagedIdentityParameterBuilder WithForceRefresh(bool forc
return this;
}

/// <inheritdoc />
/// <inheritdoc/>
internal override Task<AuthenticationResult> ExecuteInternalAsync(CancellationToken cancellationToken)
{
return ManagedIdentityApplicationExecutor.ExecuteAsync(CommonParameters, Parameters, cancellationToken);
}

/// <inheritdoc />
/// <inheritdoc/>
internal override ApiEvent.ApiIds CalculateApiEventId()
{
if (ServiceBundle.Config.ManagedIdentityId.IdType == AppConfig.ManagedIdentityIdType.SystemAssigned)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -388,7 +388,7 @@ public AcquireTokenInteractiveParameterBuilder WithProofOfPossession(string nonc
return this;
}

/// <inheritdoc />
/// <inheritdoc/>
protected override void Validate()
{
base.Validate();
Expand Down Expand Up @@ -417,7 +417,7 @@ protected override void Validate()
: Parameters.LoginHint;
}

/// <inheritdoc />
/// <inheritdoc/>
internal override Task<AuthenticationResult> ExecuteInternalAsync(CancellationToken cancellationToken)
{
return PublicClientApplicationExecutor.ExecuteAsync(CommonParameters, Parameters, cancellationToken);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ public sealed class AcquireTokenOnBehalfOfParameterBuilder :
{
internal AcquireTokenOnBehalfOfParameters Parameters { get; } = new AcquireTokenOnBehalfOfParameters();

/// <inheritdoc />
/// <inheritdoc/>
internal AcquireTokenOnBehalfOfParameterBuilder(IConfidentialClientApplicationExecutor confidentialClientApplicationExecutor)
: base(confidentialClientApplicationExecutor)
{
Expand Down Expand Up @@ -163,7 +163,7 @@ public AcquireTokenOnBehalfOfParameterBuilder WithCcsRoutingHint(string userName
return this;
}

/// <inheritdoc />
/// <inheritdoc/>
internal override Task<AuthenticationResult> ExecuteInternalAsync(CancellationToken cancellationToken)
{
return ConfidentialClientApplicationExecutor.ExecuteAsync(CommonParameters, Parameters, cancellationToken);
Expand All @@ -178,7 +178,7 @@ protected override void Validate()
Parameters.SendX5C = this.ServiceBundle.Config?.SendX5C ?? false;
}
}
/// <inheritdoc />
/// <inheritdoc/>
internal override ApiEvent.ApiIds CalculateApiEventId()
{
if (string.IsNullOrEmpty(Parameters.LongRunningOboCacheKey))
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

namespace Microsoft.Identity.Client
{
/// <inheritdoc />
/// <inheritdoc/>
/// <summary>
/// Parameter builder for the <see cref="IClientApplicationBase.AcquireTokenSilent(IEnumerable{string}, IAccount)"/>
/// operation. See https://aka.ms/msal-net-acquiretokensilent
Expand Down Expand Up @@ -88,7 +88,7 @@ public AcquireTokenSilentParameterBuilder WithForceRefresh(bool forceRefresh)
return this;
}

/// <inheritdoc />
/// <inheritdoc/>
internal override Task<AuthenticationResult> ExecuteInternalAsync(CancellationToken cancellationToken)
{
return ClientApplicationBaseExecutor.ExecuteAsync(CommonParameters, Parameters, cancellationToken);
Expand Down Expand Up @@ -118,7 +118,7 @@ protected override void Validate()
}
}

/// <inheritdoc />
/// <inheritdoc/>
internal override ApiEvent.ApiIds CalculateApiEventId()
{
return ApiEvent.ApiIds.AcquireTokenSilent;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ public sealed class AcquireTokenWithDeviceCodeParameterBuilder :
{
private AcquireTokenWithDeviceCodeParameters Parameters { get; } = new AcquireTokenWithDeviceCodeParameters();

/// <inheritdoc />
/// <inheritdoc/>
internal AcquireTokenWithDeviceCodeParameterBuilder(IPublicClientApplicationExecutor publicClientApplicationExecutor)
: base(publicClientApplicationExecutor)
{
Expand Down Expand Up @@ -49,13 +49,13 @@ public AcquireTokenWithDeviceCodeParameterBuilder WithDeviceCodeResultCallback(
return this;
}

/// <inheritdoc />
/// <inheritdoc/>
internal override Task<AuthenticationResult> ExecuteInternalAsync(CancellationToken cancellationToken)
{
return PublicClientApplicationExecutor.ExecuteAsync(CommonParameters, Parameters, cancellationToken);
}

/// <inheritdoc />
/// <inheritdoc/>
internal override ApiEvent.ApiIds CalculateApiEventId()
{
return ApiEvent.ApiIds.AcquireTokenByDeviceCode;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ public GetAuthorizationRequestUrlParameterBuilder WithPrompt(Prompt prompt)
return this;
}

/// <inheritdoc />
/// <inheritdoc/>
internal override Task<AuthenticationResult> ExecuteInternalAsync(CancellationToken cancellationToken)
{
throw new InvalidOperationException("This is a developer BUG. This should never get executed.");
Expand Down Expand Up @@ -155,7 +155,7 @@ internal override Task<AuthenticationResult> ExecuteInternalAsync(CancellationTo
return ExecuteAsync(CancellationToken.None);
}

/// <inheritdoc />
/// <inheritdoc/>
internal override ApiEvent.ApiIds CalculateApiEventId()
{
return ApiEvent.ApiIds.GetAuthorizationRequestUrl;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ namespace Microsoft.Identity.Client.ApiConfig.Parameters
/// </summary>
internal class AcquireTokenByIntegratedWindowsAuthParameters : AbstractAcquireTokenByUsernameParameters, IAcquireTokenParameters
{
/// <inheritdoc />
/// <inheritdoc/>
public void LogParameters(ILoggerAdapter logger)
{
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ internal class AcquireTokenByUsernamePasswordParameters : AbstractAcquireTokenBy
{
public string Password { get; set; }

/// <inheritdoc />
/// <inheritdoc/>
public void LogParameters(ILoggerAdapter logger)
{
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ internal class AcquireTokenForClientParameters : AbstractAcquireTokenConfidentia
/// </summary>
public bool ForceRefresh { get; set; }

/// <inheritdoc />
/// <inheritdoc/>
public void LogParameters(ILoggerAdapter logger)
{
if (logger.IsLoggingEnabled(LogLevel.Info))
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ internal class AcquireTokenOnBehalfOfParameters : AbstractAcquireTokenConfidenti

public bool ForceRefresh { get; set; }

/// <inheritdoc />
/// <inheritdoc/>
public void LogParameters(ILoggerAdapter logger)
{
if (logger.IsLoggingEnabled(LogLevel.Info))
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ internal class AcquireTokenSilentParameters : IAcquireTokenParameters
public IAccount Account { get; set; }
public bool? SendX5C { get; set; }

/// <inheritdoc />
/// <inheritdoc/>
public void LogParameters(ILoggerAdapter logger)
{
if (logger.IsLoggingEnabled(LogLevel.Info))
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ internal class AcquireTokenWithDeviceCodeParameters : IAcquireTokenParameters
{
public Func<DeviceCodeResult, Task> DeviceCodeResultCallback { get; set; }

/// <inheritdoc />
/// <inheritdoc/>
public void LogParameters(ILoggerAdapter logger)
{
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ public AcquireTokenInteractiveParameters ToInteractiveParameters()
};
}

/// <inheritdoc />
/// <inheritdoc/>
public void LogParameters(ILoggerAdapter logger)
{
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ namespace Microsoft.Identity.Client
#endif
public class ConfidentialClientApplicationBuilder : AbstractApplicationBuilder<ConfidentialClientApplicationBuilder>
{
/// <inheritdoc />
/// <inheritdoc/>
internal ConfidentialClientApplicationBuilder(ApplicationConfiguration configuration)
: base(configuration)
{
Expand Down Expand Up @@ -384,7 +384,7 @@ internal ConfidentialClientApplicationBuilder WithAppTokenCacheInternalForTest(I
return this;
}

/// <inheritdoc />
/// <inheritdoc/>
internal override void Validate()
{
base.Validate();
Expand Down
Loading
Loading