File: Copilot\ICopilotOptionsService.cs
Web Access
Project: src\src\Features\Core\Portable\Microsoft.CodeAnalysis.Features.csproj (Microsoft.CodeAnalysis.Features)
// 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.
 
using System.Threading.Tasks;
using Microsoft.CodeAnalysis.Host;
 
namespace Microsoft.CodeAnalysis.Copilot;
 
/// <summary>
/// Provides options for Copilot features.
/// Created seperately from ICopilotCodeAnalysisService to avoid additiona; assembly load just for checking option values.
/// </summary>
internal interface ICopilotOptionsService : ILanguageService
{
    /// <summary>
    /// Returns true if we should show 'Refine using Copilot' hyperlink in the lightbulb
    /// preview for code actions.
    /// </summary>
    Task<bool> IsRefineOptionEnabledAsync();
 
    /// <summary>
    /// Returns true if Copilot background code analysis feature is enabled.
    /// </summary>
    Task<bool> IsCodeAnalysisOptionEnabledAsync();
 
    /// <summary>
    /// Returns true if Copilot on-the-fly docs feature is enabled.
    /// </summary>
    /// <returns></returns>
    Task<bool> IsOnTheFlyDocsOptionEnabledAsync();
}