namespace axXez.TS3.Protocol
{
    /// <summary>Represents a channel group returned by <c>channelgrouplist</c>.</summary>
    public class ChannelGroupInfo : TsEntity, IGroupInfo
    {
        /// <summary>Channel group ID.</summary>
        [TsField("cgid")]
        public int ID { get; protected set; }

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

        /// <summary>Type of this channel group.</summary>
        [TsField("type")]
        public GroupType Type { get; protected set; }

        /// <summary>Icon ID displayed next to the group name; negative values are signed representations of unsigned icon IDs.</summary>
        [TsField("iconid")]
        public int IconID { get; protected set; }

        /// <summary>Whether group membership is stored in the database.</summary>
        [TsField("savedb")]
        public bool SaveDB { get; protected set; }

        /// <summary>Sort position used when displaying the group in the client; lower values appear first.</summary>
        [TsField("sortid")]
        public int SortID { get; protected set; }

        /// <summary>How the group name is displayed relative to a client's nickname.</summary>
        [TsField("namemode")]
        public GroupNameMode NameMode { get; protected set; }

        /// <summary>Minimum modify power required to edit this group.</summary>
        [TsField("n_modifyp")]
        public int NeededPowerToModify { get; protected set; }

        /// <summary>Minimum member add power required to assign clients to this group.</summary>
        [TsField("n_member_addp")]
        public int NeededPowerToAddClient { get; protected set; }

        /// <summary>Minimum member remove power required to remove clients from this group.</summary>
        [TsField("n_member_removep")]
        public int NeededPowerToRemoveClient { get; protected set; }

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

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