File: Redaction\IRedactionBuilder.cs
Web Access
Project: src\src\Libraries\Microsoft.Extensions.Compliance.Abstractions\Microsoft.Extensions.Compliance.Abstractions.csproj (Microsoft.Extensions.Compliance.Abstractions)
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
 
using System;
using System.Diagnostics.CodeAnalysis;
using Microsoft.Extensions.Compliance.Classification;
using Microsoft.Extensions.DependencyInjection;
 
namespace Microsoft.Extensions.Compliance.Redaction;
 
/// <summary>
/// Adds redactors to the application.
/// </summary>
public interface IRedactionBuilder
{
    /// <summary>
    /// Gets the service collection into which the redactor instances are registered.
    /// </summary>
    IServiceCollection Services { get; }
 
    /// <summary>
    /// Sets the redactor to use for a set of data classifications.
    /// </summary>
    /// <typeparam name="T">Redactor type.</typeparam>
    /// <param name="classifications">The data classifications for which the redactor type should be used.</param>
    /// <returns>The value of this instance.</returns>
    /// <exception cref="ArgumentNullException"><paramref name="classifications" /> is <see langword="null" />.</exception>
    IRedactionBuilder SetRedactor<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicConstructors)] T>(params DataClassificationSet[] classifications)
        where T : Redactor;
 
    /// <summary>
    /// Sets the redactor to use when processing classified data for which no specific redactor has been registered.
    /// </summary>
    /// <typeparam name="T">Redactor type.</typeparam>
    /// <returns>The value of this instance.</returns>
    IRedactionBuilder SetFallbackRedactor<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicConstructors)] T>()
        where T : Redactor;
}