TwoFactorResult.cs

// This file is part of the DisCatSharp project.
//
// Copyright (c) 2021-2023 AITSYS
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

namespace DisCatSharp.Extensions.TwoFactorCommands.Enums;

/// <summary>
///     Represents two factor responses.
/// </summary>
public enum TwoFactorResult
{
	/// <summary>
	///     Code is invalid.
	/// </summary>
	InvalidCode = 1,

	/// <summary>
	///     Code is valid.
	/// </summary>
	ValidCode = 2,

	/// <summary>
	///     User is not enrolled.
	/// </summary>
	NotEnrolled = 3,

	/// <summary>
	///     Two factor input timed out.
	/// </summary>
	TimedOut = 4,

	/// <summary>
	///		Indicates that the enrollment process has been completed successfully.
	/// </summary>
	Enrolled = 5,

	/// <summary>
	///		Indicates that the unenrollment process has been completed successfully.
	/// </summary>
	Unenrolled = 6,

	/// <summary>
	///     This function is not implemented.
	/// </summary>
	NotImplemented = int.MaxValue
}