CreatedAtRoute.xml

<Type Name="CreatedAtRoute" FullName="Microsoft.AspNetCore.Http.HttpResults.CreatedAtRoute">
  <TypeSignature Language="C#" Value="public sealed class CreatedAtRoute : Microsoft.AspNetCore.Http.IResult, Microsoft.AspNetCore.Http.IStatusCodeHttpResult, Microsoft.AspNetCore.Http.Metadata.IEndpointMetadataProvider" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit CreatedAtRoute extends System.Object implements class Microsoft.AspNetCore.Http.IResult, class Microsoft.AspNetCore.Http.IStatusCodeHttpResult, class Microsoft.AspNetCore.Http.Metadata.IEndpointMetadataProvider" />
  <TypeSignature Language="DocId" Value="T:Microsoft.AspNetCore.Http.HttpResults.CreatedAtRoute" />
  <TypeSignature Language="VB.NET" Value="Public NotInheritable Class CreatedAtRoute&#xA;Implements IEndpointMetadataProvider, IResult, IStatusCodeHttpResult" />
  <TypeSignature Language="F#" Value="type CreatedAtRoute = class&#xA;    interface IResult&#xA;    interface IEndpointMetadataProvider&#xA;    interface IStatusCodeHttpResult" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.AspNetCore.Http.Results</AssemblyName>
    <AssemblyVersion>7.0.0.0</AssemblyVersion>
    <AssemblyVersion>8.0.0.0</AssemblyVersion>
    <AssemblyVersion>9.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces>
    <Interface>
      <InterfaceName>Microsoft.AspNetCore.Http.IResult</InterfaceName>
    </Interface>
    <Interface>
      <InterfaceName>Microsoft.AspNetCore.Http.IStatusCodeHttpResult</InterfaceName>
    </Interface>
    <Interface>
      <InterfaceName>Microsoft.AspNetCore.Http.Metadata.IEndpointMetadataProvider</InterfaceName>
    </Interface>
  </Interfaces>
  <Attributes>
    <Attribute FrameworkAlternate="aspnetcore-8.0;aspnetcore-9.0">
      <AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
      <AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.Nullable(0)&gt;]</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <summary>
            An <see cref="T:Microsoft.AspNetCore.Http.IResult" /> that on execution will write an object to the response
            with status code Created (201) and Location header.
            Targets a registered route.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName="ExecuteAsync">
      <MemberSignature Language="C#" Value="public System.Threading.Tasks.Task ExecuteAsync (Microsoft.AspNetCore.Http.HttpContext httpContext);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task ExecuteAsync(class Microsoft.AspNetCore.Http.HttpContext httpContext) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Http.HttpResults.CreatedAtRoute.ExecuteAsync(Microsoft.AspNetCore.Http.HttpContext)" />
      <MemberSignature Language="VB.NET" Value="Public Function ExecuteAsync (httpContext As HttpContext) As Task" />
      <MemberSignature Language="F#" Value="abstract member ExecuteAsync : Microsoft.AspNetCore.Http.HttpContext -&gt; System.Threading.Tasks.Task&#xA;override this.ExecuteAsync : Microsoft.AspNetCore.Http.HttpContext -&gt; System.Threading.Tasks.Task" Usage="createdAtRoute.ExecuteAsync httpContext" />
      <MemberType>Method</MemberType>
      <Implements>
        <InterfaceMember>M:Microsoft.AspNetCore.Http.IResult.ExecuteAsync(Microsoft.AspNetCore.Http.HttpContext)</InterfaceMember>
      </Implements>
      <AssemblyInfo>
        <AssemblyName>Microsoft.AspNetCore.Http.Results</AssemblyName>
        <AssemblyVersion>7.0.0.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Threading.Tasks.Task</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="httpContext" Type="Microsoft.AspNetCore.Http.HttpContext" />
      </Parameters>
      <Docs>
        <param name="httpContext">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
        <inheritdoc />
      </Docs>
    </Member>
    <Member MemberName="Microsoft.AspNetCore.Http.IStatusCodeHttpResult.StatusCode">
      <MemberSignature Language="C#" Value="int? Microsoft.AspNetCore.Http.IStatusCodeHttpResult.StatusCode { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;int32&gt; Microsoft.AspNetCore.Http.IStatusCodeHttpResult.StatusCode" />
      <MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Http.HttpResults.CreatedAtRoute.Microsoft#AspNetCore#Http#IStatusCodeHttpResult#StatusCode" />
      <MemberSignature Language="VB.NET" Value=" ReadOnly Property StatusCode As Nullable(Of Integer) Implements IStatusCodeHttpResult.StatusCode" />
      <MemberSignature Language="F#" Value="member this.Microsoft.AspNetCore.Http.IStatusCodeHttpResult.StatusCode : Nullable&lt;int&gt;" Usage="Microsoft.AspNetCore.Http.IStatusCodeHttpResult.StatusCode" />
      <MemberType>Property</MemberType>
      <Implements>
        <InterfaceMember>P:Microsoft.AspNetCore.Http.IStatusCodeHttpResult.StatusCode</InterfaceMember>
      </Implements>
      <AssemblyInfo>
        <AssemblyName>Microsoft.AspNetCore.Http.Results</AssemblyName>
        <AssemblyVersion>7.0.0.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;System.Int32&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Microsoft.AspNetCore.Http.Metadata.IEndpointMetadataProvider.PopulateMetadata">
      <MemberSignature Language="C#" Value="static void IEndpointMetadataProvider.PopulateMetadata (System.Reflection.MethodInfo method, Microsoft.AspNetCore.Builder.EndpointBuilder builder);" FrameworkAlternate="aspnetcore-7.0" />
      <MemberSignature Language="ILAsm" Value=".method static hidebysig void Microsoft.AspNetCore.Http.Metadata.IEndpointMetadataProvider.PopulateMetadata(class System.Reflection.MethodInfo method, class Microsoft.AspNetCore.Builder.EndpointBuilder builder) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Http.HttpResults.CreatedAtRoute.Microsoft#AspNetCore#Http#Metadata#IEndpointMetadataProvider#PopulateMetadata(System.Reflection.MethodInfo,Microsoft.AspNetCore.Builder.EndpointBuilder)" />
      <MemberSignature Language="VB.NET" Value=" Shared Sub PopulateMetadata (method As MethodInfo, builder As EndpointBuilder) Implements IEndpointMetadataProvider.PopulateMetadata" />
      <MemberSignature Language="F#" Value="static member Microsoft.AspNetCore.Http.Metadata.IEndpointMetadataProvider.PopulateMetadata : System.Reflection.MethodInfo * Microsoft.AspNetCore.Builder.EndpointBuilder -&gt; unit" Usage="Microsoft.AspNetCore.Http.HttpResults.CreatedAtRoute.Microsoft.AspNetCore.Http.Metadata.IEndpointMetadataProvider.PopulateMetadata (method, builder)" />
      <MemberSignature Language="C#" Value="static void IEndpointMetadataProvider.PopulateMetadata (System.Reflection.MethodInfo? method, Microsoft.AspNetCore.Builder.EndpointBuilder? builder);" FrameworkAlternate="aspnetcore-8.0;aspnetcore-9.0" />
      <MemberType>Method</MemberType>
      <Implements>
        <InterfaceMember>M:Microsoft.AspNetCore.Http.Metadata.IEndpointMetadataProvider.PopulateMetadata(System.Reflection.MethodInfo,Microsoft.AspNetCore.Builder.EndpointBuilder)</InterfaceMember>
      </Implements>
      <AssemblyInfo>
        <AssemblyName>Microsoft.AspNetCore.Http.Results</AssemblyName>
        <AssemblyVersion>7.0.0.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="method" Type="System.Reflection.MethodInfo" />
        <Parameter Name="builder" Type="Microsoft.AspNetCore.Builder.EndpointBuilder" />
      </Parameters>
      <Docs>
        <param name="method">To be added.</param>
        <param name="builder">To be added.</param>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
        <inheritdoc />
      </Docs>
    </Member>
    <Member MemberName="RouteName">
      <MemberSignature Language="C#" Value="public string? RouteName { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string RouteName" />
      <MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Http.HttpResults.CreatedAtRoute.RouteName" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property RouteName As String" />
      <MemberSignature Language="F#" Value="member this.RouteName : string" Usage="Microsoft.AspNetCore.Http.HttpResults.CreatedAtRoute.RouteName" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.AspNetCore.Http.Results</AssemblyName>
        <AssemblyVersion>7.0.0.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the name of the route to use for generating the URL.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="RouteValues">
      <MemberSignature Language="C#" Value="public Microsoft.AspNetCore.Routing.RouteValueDictionary RouteValues { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class Microsoft.AspNetCore.Routing.RouteValueDictionary RouteValues" />
      <MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Http.HttpResults.CreatedAtRoute.RouteValues" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property RouteValues As RouteValueDictionary" />
      <MemberSignature Language="F#" Value="member this.RouteValues : Microsoft.AspNetCore.Routing.RouteValueDictionary" Usage="Microsoft.AspNetCore.Http.HttpResults.CreatedAtRoute.RouteValues" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.AspNetCore.Http.Results</AssemblyName>
        <AssemblyVersion>7.0.0.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute FrameworkAlternate="aspnetcore-8.0;aspnetcore-9.0">
          <AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(1)]</AttributeName>
          <AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.Nullable(1)&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>Microsoft.AspNetCore.Routing.RouteValueDictionary</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the route data to use for generating the URL.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="StatusCode">
      <MemberSignature Language="C#" Value="public int StatusCode { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance int32 StatusCode" />
      <MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Http.HttpResults.CreatedAtRoute.StatusCode" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property StatusCode As Integer" />
      <MemberSignature Language="F#" Value="member this.StatusCode : int" Usage="Microsoft.AspNetCore.Http.HttpResults.CreatedAtRoute.StatusCode" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.AspNetCore.Http.Results</AssemblyName>
        <AssemblyVersion>7.0.0.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the HTTP status code: <see cref="F:Microsoft.AspNetCore.Http.StatusCodes.Status201Created" /></summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>