FakeRedactionServiceProviderExtensions.xml

<Type Name="FakeRedactionServiceProviderExtensions" FullName="System.FakeRedactionServiceProviderExtensions">
  <TypeSignature Language="C#" Value="public static class FakeRedactionServiceProviderExtensions" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit FakeRedactionServiceProviderExtensions extends System.Object" />
  <TypeSignature Language="DocId" Value="T:System.FakeRedactionServiceProviderExtensions" />
  <TypeSignature Language="VB.NET" Value="Public Module FakeRedactionServiceProviderExtensions" />
  <TypeSignature Language="F#" Value="type FakeRedactionServiceProviderExtensions = class" />
  <TypeSignature Language="C++ CLI" Value="public ref class FakeRedactionServiceProviderExtensions abstract sealed" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.Extensions.Compliance.Testing</AssemblyName>
    <AssemblyVersion>8.0.0.0</AssemblyVersion>
    <AssemblyVersion>8.4.0.0</AssemblyVersion>
    <AssemblyVersion>8.5.0.0</AssemblyVersion>
    <AssemblyVersion>8.6.0.0</AssemblyVersion>
    <AssemblyVersion>8.7.0.0</AssemblyVersion>
    <AssemblyVersion>8.8.0.0</AssemblyVersion>
    <AssemblyVersion>9.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            Extensions that allow registering a fake redactor in the application.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName="GetFakeRedactionCollector">
      <MemberSignature Language="C#" Value="public static Microsoft.Extensions.Compliance.Testing.FakeRedactionCollector GetFakeRedactionCollector (this IServiceProvider serviceProvider);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Extensions.Compliance.Testing.FakeRedactionCollector GetFakeRedactionCollector(class System.IServiceProvider serviceProvider) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.FakeRedactionServiceProviderExtensions.GetFakeRedactionCollector(System.IServiceProvider)" />
      <MemberSignature Language="VB.NET" Value="&lt;Extension()&gt;&#xA;Public Function GetFakeRedactionCollector (serviceProvider As IServiceProvider) As FakeRedactionCollector" />
      <MemberSignature Language="F#" Value="static member GetFakeRedactionCollector : IServiceProvider -&gt; Microsoft.Extensions.Compliance.Testing.FakeRedactionCollector" Usage="System.FakeRedactionServiceProviderExtensions.GetFakeRedactionCollector serviceProvider" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA;[System::Runtime::CompilerServices::Extension]&#xA; static Microsoft::Extensions::Compliance::Testing::FakeRedactionCollector ^ GetFakeRedactionCollector(IServiceProvider ^ serviceProvider);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Extensions.Compliance.Testing</AssemblyName>
        <AssemblyVersion>8.8.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute FrameworkAlternate="net-8.0;net-9.0">
          <AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(1)]</AttributeName>
          <AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.NullableContext(1)&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>Microsoft.Extensions.Compliance.Testing.FakeRedactionCollector</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="serviceProvider" Type="System.IServiceProvider" RefType="this" />
      </Parameters>
      <Docs>
        <param name="serviceProvider">The container used to obtain the collector instance.</param>
        <summary>
            Gets the fake redactor collector instance from the dependency injection container.
            </summary>
        <returns>The obtained collector.</returns>
        <remarks>
          <see cref="T:Microsoft.Extensions.Compliance.Testing.FakeRedactionCollector" /> should be registered and used only with fake redaction implementation.
            </remarks>
        <exception cref="T:System.InvalidOperationException">The collector is not in the container.</exception>
        <exception cref="T:System.ArgumentNullException">
          <paramref name="serviceProvider" /> is <see langword="null" />.</exception>
      </Docs>
    </Member>
  </Members>
</Type>