using System;

namespace axXez.TS3.Protocol
{
    /// <summary>Represents a ban entry returned by <c>banlist</c>.</summary>
    public class BanInfo : TsEntity
    {
        /// <summary>Numeric ban rule ID.</summary>
        [TsField("banid")]
        public int BanID { get; protected set; }

        /// <summary>IP address regex pattern of the ban rule; empty if not banning by IP.</summary>
        [TsField("ip")]
        public string IP { get; protected set; }

        /// <summary>Nickname regex pattern of the ban rule; empty if not banning by name.</summary>
        [TsField("name")]
        public string Name { get; protected set; }

        /// <summary>Unique identifier of the banned client; empty if not banning by UID.</summary>
        [TsField("uid")]
        public string UID { get; protected set; }

        /// <summary>MyTeamSpeak ID of the banned client; empty if not banning by mytsid.</summary>
        [TsField("mytsid")]
        public string MyTsID { get; protected set; }

        /// <summary>Last known nickname of the banned client at the time the ban was created.</summary>
        [TsField("lastnickname")]
        public string LastNickname { get; protected set; }

        /// <summary>Date and time when the ban was created.</summary>
        [TsField("created")]
        public DateTime Created { get; protected set; }

        /// <summary>Ban duration in seconds; 0 means permanent.</summary>
        [TsField("duration")]
        public int Duration { get; protected set; }

        /// <summary>Nickname of the client who created this ban rule.</summary>
        [TsField("invokername")]
        public string InvokerName { get; protected set; }

        /// <summary>Database ID of the client who created this ban rule.</summary>
        [TsField("invokercldbid")]
        public int InvokerDBID { get; protected set; }

        /// <summary>Unique identifier of the client who created this ban rule.</summary>
        [TsField("invokeruid")]
        public string InvokerUID { get; protected set; }

        /// <summary>Reason message provided when the ban was created.</summary>
        [TsField("reason")]
        public string Reason { get; protected set; }

        /// <summary>Number of times this ban rule has been enforced (i.e. clients rejected).</summary>
        [TsField("enforcements")]
        public int Enforcements { get; protected set; }

        internal BanInfo(TsDataEntry data) : base(data) { }
    }
}