namespace axXez.TS3.Protocol
{
    /// <summary>Represents a TeamSpeak channel returned by <c>channellist</c> or <c>channelinfo</c>.</summary>
    public class ChannelInfo : TsEntity, INamedEntity
    {
        /// <summary>Channel ID.</summary>
        [TsField("cid")]
        public int ID { get; protected set; }

        /// <summary>Unique identifier of the channel.</summary>
        [TsField("channel_unique_identifier")]
        public string UID { get; protected set; }

        /// <summary>ID of the parent channel; 0 if this is a top-level channel.</summary>
        [TsField("pid", "cpid")]
        public int ParentID { get; protected set; }

        /// <summary>Phonetic pronunciation of the channel name, used by text-to-speech.</summary>
        [TsField("channel_name_phonetic")]
        public string PhoneticName { get; protected set; }

        /// <summary>Display name of the channel.</summary>
        [TsField("channel_name")]
        public string Name { get; protected set; }

        /// <summary>Topic line shown below the channel name.</summary>
        [TsField("channel_topic")]
        public string Topic { get; protected set; }

        /// <summary>Full description text of the channel.</summary>
        [TsField("channel_description")]
        public string Description { get; protected set; }

        /// <summary>Hashed channel password; empty if no password is set.</summary>
        [TsField("channel_password")]
        public string PasswordHash { get; protected set; }

        /// <summary>Codec used in this channel.</summary>
        [TsField("channel_codec")]
        public ChannelCodec Codec { get; protected set; }

        /// <summary>Codec quality level from 0 (lowest) to 10 (highest).</summary>
        [TsField("channel_codec_quality")]
        public int CodecQuality { get; protected set; }

        /// <summary>Codec latency factor; higher values increase audio latency.</summary>
        [TsField("channel_codec_latency_factor")]
        public int CodecLatencyFactor { get; protected set; }

        /// <summary>Whether the channel's codec is unencrypted.</summary>
        [TsField("channel_codec_is_unencrypted")]
        public bool CodecIsUnencrypted { get; protected set; }

        /// <summary>Security salt used for channel encryption.</summary>
        [TsField("channel_security_salt")]
        public string SecuritySalt { get; protected set; }

        /// <summary>Maximum number of clients allowed in the channel; -1 means unlimited.</summary>
        [TsField("channel_maxclients")]
        public int MaxClients { get; protected set; }

        /// <summary>Maximum number of clients allowed in this channel and all its sub-channels; -1 means unlimited.</summary>
        [TsField("channel_maxfamilyclients")]
        public int MaxFamilyClients { get; protected set; }

        /// <summary>Sort order position relative to sibling channels; 0 means first.</summary>
        [TsField("channel_order", "order")]
        public int Order { get; protected set; }

        /// <summary>Whether the channel persists after the last client leaves.</summary>
        [TsField("channel_flag_permanent")]
        public bool PermanentFlag { get; protected set; }

        /// <summary>Whether the channel persists only until the server restarts.</summary>
        [TsField("channel_flag_semi_permanent")]
        public bool SemiPermanentFlag { get; protected set; }

        /// <summary>Whether this is the default channel clients connect to on join.</summary>
        [TsField("channel_flag_default")]
        public bool DefaultFlag { get; protected set; }

        /// <summary>Whether the channel is password protected.</summary>
        [TsField("channel_flag_password")]
        public bool PasswordFlag { get; protected set; }

        /// <summary>Delay in seconds before a temporary channel is deleted after becoming empty.</summary>
        [TsField("channel_delete_delay")]
        public int DeleteDelay { get; protected set; }

        /// <summary>Whether the client limit for this channel is unlimited.</summary>
        [TsField("channel_flag_maxclients_unlimited")]
        public bool UnlimitedClientsFlag { get; protected set; }

        /// <summary>Whether the family client limit for this channel is unlimited.</summary>
        [TsField("channel_flag_maxfamilyclients_unlimited")]
        public bool UnlimitedFamilyClientsFlag { get; protected set; }

        /// <summary>Whether the family client limit is inherited from the parent channel.</summary>
        [TsField("channel_flag_maxfamilyclients_inherited")]
        public bool MaxFamilyClientsInherited { get; protected set; }

        /// <summary>Server-side file storage path for this channel.</summary>
        [TsField("channel_filepath")]
        public string FilePath { get; protected set; }

        /// <summary>Minimum talk power a client must have to speak in this channel.</summary>
        [TsField("channel_needed_talk_power")]
        public int NeededTalkPower { get; protected set; }

        /// <summary>Whether clients without sufficient talk power are force-silenced.</summary>
        [TsField("channel_forced_silence")]
        public bool ForcedSilence { get; protected set; }

        /// <summary>Icon ID displayed next to the channel name.</summary>
        [TsField("channel_icon_id")]
        public ulong Icon { get; protected set; }

        /// <summary>URL of the channel banner image.</summary>
        [TsField("channel_banner_gfx_url")]
        public string BannerGFXUrl { get; protected set; }

        /// <summary>How the banner image is scaled in the client.</summary>
        [TsField("channel_banner_mode")]
        public BannerMode BannerMode { get; protected set; }

        /// <summary>Seconds the channel has been empty; -1 if currently occupied or permanent.</summary>
        [TsField("seconds_empty")]
        public int SecondsEmpty { get; protected set; }

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

        /// <inheritdoc/>
        public override string ToString() => $"Channel[{ID}] {Name}";
        /// <inheritdoc/>
        public override int GetHashCode() => ID.GetHashCode();
        /// <inheritdoc/>
        public override bool Equals(object obj) => obj is ChannelInfo && ID.Equals((obj as ChannelInfo).ID);
    }
}