namespace axXez.TS3.Protocol
{
    /// <summary>Fired when a client uses a privilege key (token).</summary>
    public class TokenUsedArgs : TsEntity
    {
        /// <summary>Session-based client ID of the client who used the token.</summary>
        [TsField("clid")]
        public int ClientID { get; private set; }

        /// <summary>Permanent database ID of the client who used the token.</summary>
        [TsField("cldbid")]
        public int ClientDBID { get; private set; }

        /// <summary>Unique identifier of the client who used the token.</summary>
        [TsField("cluid")]
        public string ClientUID { get; private set; }

        /// <summary>The privilege key string that was used.</summary>
        [TsField("token")]
        public string Token { get; private set; }

        /// <summary>Custom data string associated with the token.</summary>
        [TsField("tokencustomset")]
        public string TokenCustomSet { get; private set; }

        /// <summary>First token group identifier (server group ID or channel group ID).</summary>
        [TsField("token1")]
        public string Token1 { get; private set; }

        /// <summary>Second token group identifier (channel ID for channel group tokens; 0 for server group tokens).</summary>
        [TsField("token2")]
        public string Token2 { get; private set; }

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