RegexBot/Kerobot/Services/CommonFunctions/BanKickResult.cs

using Discord.Net;

namespace Kerobot
{
    // Instances of this are created by CommonFunctionService and by ModuleBase on behalf of CommonFunctionService,
    // and are meant to be sent to modules. This class has therefore been put within the Kerobot namespace.

    /// <summary>
    /// Contains information on various success/failure outcomes for a ban or kick operation.
    /// </summary>
    public class BanKickResult
    {
        private readonly bool _userNotFound;

        internal BanKickResult(HttpException error, bool notificationSuccess, bool errorNotFound)
        {
            OperationError = error;
            MessageSendSuccess = notificationSuccess;
            _userNotFound = errorNotFound;
        }

        /// <summary>
        /// Gets a value indicating whether the kick or ban succeeded.
        /// </summary>
        public bool OperationSuccess {
            get {
                if (ErrorNotFound) return false;
                if (OperationError == null) return false;
                return true;
            }
        }

        /// <summary>
        /// The exception thrown, if any, when attempting to kick or ban the target.
        /// </summary>
        public HttpException OperationError { get; }

        /// <summary>
        /// Indicates if the operation failed due to being unable to find the user.
        /// </summary>
        public bool ErrorNotFound
        {
            get
            {
                if (_userNotFound) return true; // TODO I don't like this.
                if (OperationSuccess) return false;
                return OperationError.HttpCode == System.Net.HttpStatusCode.NotFound;
            }
        }

        /// <summary>
        /// Indicates if the operation failed due to a permissions issue.
        /// </summary>
        public bool ErrorForbidden
        {
            get
            {
                if (OperationSuccess) return false;
                return OperationError.HttpCode == System.Net.HttpStatusCode.Forbidden;
            }
        }

        /// <summary>
        /// Gets a value indicating whether the user was able to receive the ban or kick message.
        /// </summary>
        /// <value>
        /// <see langword="false"/> if an error was encountered when attempting to send the target a DM. Will always
        /// return <see langword="true"/> otherwise, including cases in which no message was sent.
        /// </value>
        public bool MessageSendSuccess { get; }
    }
}