// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
 
namespace Roslyn.LanguageServer.Protocol
{
    using System.Text.Json.Serialization;
 
    /// <summary>
    /// Class representing a streaming pull request parameter used.
    ///
    /// TODO: Deprecate VSInternalDiagnosticParams.cs to use this merged param instead.
    /// </summary>
    internal class VSInternalStreamingParams : ITextDocumentParams
    {
        /// <summary>
        /// Gets or sets the document for which the feature is being requested for.
        /// </summary>
        [JsonPropertyName("_vs_textDocument")]
        [JsonRequired]
        public TextDocumentIdentifier TextDocument { get; set; }
 
        /// <summary>
        /// Gets or sets the server-generated version number for the feature request.
        /// </summary>
        /// <remarks>
        /// <para>
        /// This is treated as a black box by the client: it is stored on the client
        /// for each textDocument and sent back to the server when requesting
        /// the feature. The server can use this result ID to avoid resending
        /// feature results that had previously been sent.</para>
        ///
        /// <para>Note that if a client does request results that haven’t changed, the
        /// language server should not reply with any results for that document.
        /// If the client requests results for a file that has been renamed or
        /// deleted, then the language service should respond with null for the
        /// results.
        /// Also, if a service is reporting multiple reports for the same
        /// document, then all reports are expected to have the same
        /// previousResultId.</para>
        /// </remarks>
        [JsonPropertyName("_vs_previousResultId")]
        [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
        public string? PreviousResultId { get; set; }
    }
}