mirror of
https://github.com/zoriya/octokit.net.git
synced 2025-12-19 21:55:12 +00:00
93dd16f829
I was running into an issue where i wanted more information from the
TwoFactorChallengeFailedException. It turns out, the exception could
easily provide both the TwoFactorType AND the authentication code
provided. So 💥!
70 lines
2.4 KiB
C#
70 lines
2.4 KiB
C#
using System;
|
|
using System.Diagnostics;
|
|
using System.Diagnostics.CodeAnalysis;
|
|
using System.Net;
|
|
using System.Runtime.Serialization;
|
|
|
|
namespace Octokit
|
|
{
|
|
/// <summary>
|
|
///
|
|
/// </summary>
|
|
#if !NETFX_CORE
|
|
[Serializable]
|
|
#endif
|
|
[SuppressMessage("Microsoft.Design", "CA1032:ImplementStandardExceptionConstructors",
|
|
Justification = "These exceptions are specific to the GitHub API and not general purpose exceptions")]
|
|
public class TwoFactorRequiredException : TwoFactorAuthorizationException
|
|
{
|
|
/// <summary>
|
|
/// Constructs an instance of TwoFactorRequiredException.
|
|
/// </summary>
|
|
public TwoFactorRequiredException() : this(TwoFactorType.None)
|
|
{
|
|
}
|
|
|
|
/// <summary>
|
|
/// Constructs an instance of TwoFactorRequiredException.
|
|
/// </summary>
|
|
/// <param name="twoFactorType">Expected 2FA response type</param>
|
|
public TwoFactorRequiredException(TwoFactorType twoFactorType) : base(twoFactorType, null)
|
|
{
|
|
}
|
|
|
|
/// <summary>
|
|
/// Constructs an instance of TwoFactorRequiredException.
|
|
/// </summary>
|
|
/// <param name="response">The HTTP payload from the server</param>
|
|
/// <param name="twoFactorType">Expected 2FA response type</param>
|
|
public TwoFactorRequiredException(IResponse response, TwoFactorType twoFactorType)
|
|
: base(response, twoFactorType)
|
|
{
|
|
Debug.Assert(response != null && response.StatusCode == HttpStatusCode.Unauthorized,
|
|
"TwoFactorRequiredException status code should be 401");
|
|
}
|
|
|
|
public override string Message
|
|
{
|
|
get { return ApiErrorMessageSafe ?? "Two-factor authentication code is required"; }
|
|
}
|
|
|
|
#if !NETFX_CORE
|
|
/// <summary>
|
|
/// Constructs an instance of TwoFactorRequiredException.
|
|
/// </summary>
|
|
/// <param name="info">
|
|
/// The <see cref="SerializationInfo"/> that holds the
|
|
/// serialized object data about the exception being thrown.
|
|
/// </param>
|
|
/// <param name="context">
|
|
/// The <see cref="StreamingContext"/> that contains
|
|
/// contextual information about the source or destination.
|
|
/// </param>
|
|
protected TwoFactorRequiredException(SerializationInfo info, StreamingContext context)
|
|
: base(info, context)
|
|
{
|
|
}
|
|
#endif
|
|
}
|
|
}
|