Initial commit
This commit is contained in:
Binary file not shown.
@@ -0,0 +1,19 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<configuration>
|
||||
<runtime>
|
||||
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
|
||||
<dependentAssembly>
|
||||
<assemblyIdentity name="System.Numerics.Vectors" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
|
||||
<bindingRedirect oldVersion="0.0.0.0-4.1.4.0" newVersion="4.1.4.0" />
|
||||
</dependentAssembly>
|
||||
<dependentAssembly>
|
||||
<assemblyIdentity name="System.Buffers" publicKeyToken="cc7b13ffcd2ddd51" culture="neutral" />
|
||||
<bindingRedirect oldVersion="0.0.0.0-4.0.3.0" newVersion="4.0.3.0" />
|
||||
</dependentAssembly>
|
||||
<dependentAssembly>
|
||||
<assemblyIdentity name="System.Security.Cryptography.Cng" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
|
||||
<bindingRedirect oldVersion="0.0.0.0-4.3.1.0" newVersion="4.3.1.0" />
|
||||
</dependentAssembly>
|
||||
</assemblyBinding>
|
||||
</runtime>
|
||||
</configuration>
|
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
@@ -0,0 +1,821 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.AspNetCore.Authentication.Abstractions</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.AspNetCore.Authentication.AuthenticateResult">
|
||||
<summary>
|
||||
Contains the result of an Authenticate call
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticateResult.Succeeded">
|
||||
<summary>
|
||||
If a ticket was produced, authenticate was successful.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticateResult.Ticket">
|
||||
<summary>
|
||||
The authentication ticket.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticateResult.Principal">
|
||||
<summary>
|
||||
Gets the claims-principal with authenticated user identities.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticateResult.Properties">
|
||||
<summary>
|
||||
Additional state values for the authentication session.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticateResult.Failure">
|
||||
<summary>
|
||||
Holds failure information from the authentication.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticateResult.None">
|
||||
<summary>
|
||||
Indicates that there was no information returned for this authentication scheme.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticateResult.Success(Microsoft.AspNetCore.Authentication.AuthenticationTicket)">
|
||||
<summary>
|
||||
Indicates that authentication was successful.
|
||||
</summary>
|
||||
<param name="ticket">The ticket representing the authentication result.</param>
|
||||
<returns>The result.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticateResult.NoResult">
|
||||
<summary>
|
||||
Indicates that there was no information returned for this authentication scheme.
|
||||
</summary>
|
||||
<returns>The result.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticateResult.Fail(System.Exception)">
|
||||
<summary>
|
||||
Indicates that there was a failure during authentication.
|
||||
</summary>
|
||||
<param name="failure">The failure exception.</param>
|
||||
<returns>The result.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticateResult.Fail(System.Exception,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
|
||||
<summary>
|
||||
Indicates that there was a failure during authentication.
|
||||
</summary>
|
||||
<param name="failure">The failure exception.</param>
|
||||
<param name="properties">Additional state values for the authentication session.</param>
|
||||
<returns>The result.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticateResult.Fail(System.String)">
|
||||
<summary>
|
||||
Indicates that there was a failure during authentication.
|
||||
</summary>
|
||||
<param name="failureMessage">The failure message.</param>
|
||||
<returns>The result.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticateResult.Fail(System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
|
||||
<summary>
|
||||
Indicates that there was a failure during authentication.
|
||||
</summary>
|
||||
<param name="failureMessage">The failure message.</param>
|
||||
<param name="properties">Additional state values for the authentication session.</param>
|
||||
<returns>The result.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions">
|
||||
<summary>
|
||||
Extension methods to expose Authentication on HttpContext.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.AuthenticateAsync(Microsoft.AspNetCore.Http.HttpContext)">
|
||||
<summary>
|
||||
Extension method for authenticate using the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultAuthenticateScheme"/> scheme.
|
||||
</summary>
|
||||
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
|
||||
<returns>The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticateResult"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.AuthenticateAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)">
|
||||
<summary>
|
||||
Extension method for authenticate.
|
||||
</summary>
|
||||
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
|
||||
<param name="scheme">The name of the authentication scheme.</param>
|
||||
<returns>The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticateResult"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.ChallengeAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)">
|
||||
<summary>
|
||||
Extension method for Challenge.
|
||||
</summary>
|
||||
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
|
||||
<param name="scheme">The name of the authentication scheme.</param>
|
||||
<returns>The result.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.ChallengeAsync(Microsoft.AspNetCore.Http.HttpContext)">
|
||||
<summary>
|
||||
Extension method for authenticate using the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultChallengeScheme"/> scheme.
|
||||
</summary>
|
||||
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
|
||||
<returns>The task.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.ChallengeAsync(Microsoft.AspNetCore.Http.HttpContext,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
|
||||
<summary>
|
||||
Extension method for authenticate using the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultChallengeScheme"/> scheme.
|
||||
</summary>
|
||||
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
|
||||
<param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> properties.</param>
|
||||
<returns>The task.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.ChallengeAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
|
||||
<summary>
|
||||
Extension method for Challenge.
|
||||
</summary>
|
||||
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
|
||||
<param name="scheme">The name of the authentication scheme.</param>
|
||||
<param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> properties.</param>
|
||||
<returns>The task.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.ForbidAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)">
|
||||
<summary>
|
||||
Extension method for Forbid.
|
||||
</summary>
|
||||
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
|
||||
<param name="scheme">The name of the authentication scheme.</param>
|
||||
<returns>The task.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.ForbidAsync(Microsoft.AspNetCore.Http.HttpContext)">
|
||||
<summary>
|
||||
Extension method for Forbid using the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultForbidScheme"/> scheme..
|
||||
</summary>
|
||||
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
|
||||
<returns>The task.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.ForbidAsync(Microsoft.AspNetCore.Http.HttpContext,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
|
||||
<summary>
|
||||
Extension method for Forbid.
|
||||
</summary>
|
||||
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
|
||||
<param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> properties.</param>
|
||||
<returns>The task.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.ForbidAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
|
||||
<summary>
|
||||
Extension method for Forbid.
|
||||
</summary>
|
||||
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
|
||||
<param name="scheme">The name of the authentication scheme.</param>
|
||||
<param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> properties.</param>
|
||||
<returns>The task.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.SignInAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,System.Security.Claims.ClaimsPrincipal)">
|
||||
<summary>
|
||||
Extension method for SignIn.
|
||||
</summary>
|
||||
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
|
||||
<param name="scheme">The name of the authentication scheme.</param>
|
||||
<param name="principal">The user.</param>
|
||||
<returns>The task.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.SignInAsync(Microsoft.AspNetCore.Http.HttpContext,System.Security.Claims.ClaimsPrincipal)">
|
||||
<summary>
|
||||
Extension method for SignIn using the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultSignInScheme"/>.
|
||||
</summary>
|
||||
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
|
||||
<param name="principal">The user.</param>
|
||||
<returns>The task.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.SignInAsync(Microsoft.AspNetCore.Http.HttpContext,System.Security.Claims.ClaimsPrincipal,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
|
||||
<summary>
|
||||
Extension method for SignIn using the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultSignInScheme"/>.
|
||||
</summary>
|
||||
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
|
||||
<param name="principal">The user.</param>
|
||||
<param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> properties.</param>
|
||||
<returns>The task.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.SignInAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,System.Security.Claims.ClaimsPrincipal,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
|
||||
<summary>
|
||||
Extension method for SignIn.
|
||||
</summary>
|
||||
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
|
||||
<param name="scheme">The name of the authentication scheme.</param>
|
||||
<param name="principal">The user.</param>
|
||||
<param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> properties.</param>
|
||||
<returns>The task.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.SignOutAsync(Microsoft.AspNetCore.Http.HttpContext)">
|
||||
<summary>
|
||||
Extension method for SignOut using the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultSignOutScheme"/>.
|
||||
</summary>
|
||||
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
|
||||
<returns>The task.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.SignOutAsync(Microsoft.AspNetCore.Http.HttpContext,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
|
||||
<summary>
|
||||
Extension method for SignOut using the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultSignOutScheme"/>.
|
||||
</summary>
|
||||
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
|
||||
<param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> properties.</param>
|
||||
<returns>The task.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.SignOutAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)">
|
||||
<summary>
|
||||
Extension method for SignOut.
|
||||
</summary>
|
||||
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
|
||||
<param name="scheme">The name of the authentication scheme.</param>
|
||||
<returns>The task.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.SignOutAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
|
||||
<summary>
|
||||
Extension method for SignOut.
|
||||
</summary>
|
||||
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
|
||||
<param name="scheme">The name of the authentication scheme.</param>
|
||||
<param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> properties.</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.GetTokenAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,System.String)">
|
||||
<summary>
|
||||
Extension method for getting the value of an authentication token.
|
||||
</summary>
|
||||
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
|
||||
<param name="scheme">The name of the authentication scheme.</param>
|
||||
<param name="tokenName">The name of the token.</param>
|
||||
<returns>The value of the token.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.GetTokenAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)">
|
||||
<summary>
|
||||
Extension method for getting the value of an authentication token.
|
||||
</summary>
|
||||
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
|
||||
<param name="tokenName">The name of the token.</param>
|
||||
<returns>The value of the token.</returns>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.Schemes">
|
||||
<summary>
|
||||
Returns the schemes in the order they were added (important for request handling priority)
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.SchemeMap">
|
||||
<summary>
|
||||
Maps schemes by name.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationOptions.AddScheme(System.String,System.Action{Microsoft.AspNetCore.Authentication.AuthenticationSchemeBuilder})">
|
||||
<summary>
|
||||
Adds an <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme"/>.
|
||||
</summary>
|
||||
<param name="name">The name of the scheme being added.</param>
|
||||
<param name="configureBuilder">Configures the scheme.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationOptions.AddScheme``1(System.String,System.String)">
|
||||
<summary>
|
||||
Adds an <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme"/>.
|
||||
</summary>
|
||||
<typeparam name="THandler">The <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationHandler"/> responsible for the scheme.</typeparam>
|
||||
<param name="name">The name of the scheme being added.</param>
|
||||
<param name="displayName">The display name for the scheme.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultScheme">
|
||||
<summary>
|
||||
Used as the fallback default scheme for all the other defaults.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultAuthenticateScheme">
|
||||
<summary>
|
||||
Used as the default scheme by <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.AuthenticateAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultSignInScheme">
|
||||
<summary>
|
||||
Used as the default scheme by <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.SignInAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,System.Security.Claims.ClaimsPrincipal,Microsoft.AspNetCore.Authentication.AuthenticationProperties)"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultSignOutScheme">
|
||||
<summary>
|
||||
Used as the default scheme by <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.SignOutAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultChallengeScheme">
|
||||
<summary>
|
||||
Used as the default scheme by <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.ChallengeAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultForbidScheme">
|
||||
<summary>
|
||||
Used as the default scheme by <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.ForbidAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties">
|
||||
<summary>
|
||||
Dictionary used to store state values about the authentication session.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationProperties.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationProperties.#ctor(System.Collections.Generic.IDictionary{System.String,System.String})">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> class.
|
||||
</summary>
|
||||
<param name="items">State values dictionary to use.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationProperties.#ctor(System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.Object})">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> class.
|
||||
</summary>
|
||||
<param name="items">State values dictionary to use.</param>
|
||||
<param name="parameters">Parameters dictionary to use.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.Items">
|
||||
<summary>
|
||||
State values about the authentication session.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.Parameters">
|
||||
<summary>
|
||||
Collection of parameters that are passed to the authentication handler. These are not intended for
|
||||
serialization or persistence, only for flowing data between call sites.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.IsPersistent">
|
||||
<summary>
|
||||
Gets or sets whether the authentication session is persisted across multiple requests.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.RedirectUri">
|
||||
<summary>
|
||||
Gets or sets the full path or absolute URI to be used as an http redirect response value.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.IssuedUtc">
|
||||
<summary>
|
||||
Gets or sets the time at which the authentication ticket was issued.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.ExpiresUtc">
|
||||
<summary>
|
||||
Gets or sets the time at which the authentication ticket expires.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.AllowRefresh">
|
||||
<summary>
|
||||
Gets or sets if refreshing the authentication session should be allowed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationProperties.GetString(System.String)">
|
||||
<summary>
|
||||
Get a string value from the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.Items"/> collection.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<returns>Retrieved value or <c>null</c> if the property is not set.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationProperties.SetString(System.String,System.String)">
|
||||
<summary>
|
||||
Set a string value in the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.Items"/> collection.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<param name="value">Value to set or <c>null</c> to remove the property.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationProperties.GetParameter``1(System.String)">
|
||||
<summary>
|
||||
Get a parameter from the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.Parameters"/> collection.
|
||||
</summary>
|
||||
<typeparam name="T">Parameter type.</typeparam>
|
||||
<param name="key">Parameter key.</param>
|
||||
<returns>Retrieved value or the default value if the property is not set.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationProperties.SetParameter``1(System.String,``0)">
|
||||
<summary>
|
||||
Set a parameter value in the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.Parameters"/> collection.
|
||||
</summary>
|
||||
<typeparam name="T">Parameter type.</typeparam>
|
||||
<param name="key">Parameter key.</param>
|
||||
<param name="value">Value to set.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationProperties.GetBool(System.String)">
|
||||
<summary>
|
||||
Get a bool value from the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.Items"/> collection.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<returns>Retrieved value or <c>null</c> if the property is not set.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationProperties.SetBool(System.String,System.Nullable{System.Boolean})">
|
||||
<summary>
|
||||
Set a bool value in the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.Items"/> collection.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<param name="value">Value to set or <c>null</c> to remove the property.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationProperties.GetDateTimeOffset(System.String)">
|
||||
<summary>
|
||||
Get a DateTimeOffset value from the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.Items"/> collection.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<returns>Retrieved value or <c>null</c> if the property is not set.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationProperties.SetDateTimeOffset(System.String,System.Nullable{System.DateTimeOffset})">
|
||||
<summary>
|
||||
Set a DateTimeOffset value in the <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationProperties.Items"/> collection.
|
||||
</summary>
|
||||
<param name="key">Property key.</param>
|
||||
<param name="value">Value to set or <c>null</c> to remove the property.</param>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme">
|
||||
<summary>
|
||||
AuthenticationSchemes assign a name to a specific <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationHandler"/>
|
||||
handlerType.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationScheme.#ctor(System.String,System.String,System.Type)">
|
||||
<summary>
|
||||
Constructor.
|
||||
</summary>
|
||||
<param name="name">The name for the authentication scheme.</param>
|
||||
<param name="displayName">The display name for the authentication scheme.</param>
|
||||
<param name="handlerType">The <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationHandler"/> type that handles this scheme.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationScheme.Name">
|
||||
<summary>
|
||||
The name of the authentication scheme.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationScheme.DisplayName">
|
||||
<summary>
|
||||
The display name for the scheme. Null is valid and used for non user facing schemes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationScheme.HandlerType">
|
||||
<summary>
|
||||
The <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationHandler"/> type that handles this scheme.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Authentication.AuthenticationSchemeBuilder">
|
||||
<summary>
|
||||
Used to build <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme"/>s.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeBuilder.#ctor(System.String)">
|
||||
<summary>
|
||||
Constructor.
|
||||
</summary>
|
||||
<param name="name">The name of the scheme being built.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationSchemeBuilder.Name">
|
||||
<summary>
|
||||
The name of the scheme being built.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationSchemeBuilder.DisplayName">
|
||||
<summary>
|
||||
The display name for the scheme being built.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationSchemeBuilder.HandlerType">
|
||||
<summary>
|
||||
The <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationHandler"/> type responsible for this scheme.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeBuilder.Build">
|
||||
<summary>
|
||||
Builds the <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme"/> instance.
|
||||
</summary>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Authentication.AuthenticationTicket">
|
||||
<summary>
|
||||
Contains user identity information as well as additional authentication state.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationTicket.#ctor(System.Security.Claims.ClaimsPrincipal,Microsoft.AspNetCore.Authentication.AuthenticationProperties,System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationTicket"/> class
|
||||
</summary>
|
||||
<param name="principal">the <see cref="T:System.Security.Claims.ClaimsPrincipal"/> that represents the authenticated user.</param>
|
||||
<param name="properties">additional properties that can be consumed by the user or runtime.</param>
|
||||
<param name="authenticationScheme">the authentication middleware that was responsible for this ticket.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationTicket.#ctor(System.Security.Claims.ClaimsPrincipal,System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationTicket"/> class
|
||||
</summary>
|
||||
<param name="principal">the <see cref="T:System.Security.Claims.ClaimsPrincipal"/> that represents the authenticated user.</param>
|
||||
<param name="authenticationScheme">the authentication middleware that was responsible for this ticket.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationTicket.AuthenticationScheme">
|
||||
<summary>
|
||||
Gets the authentication type.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationTicket.Principal">
|
||||
<summary>
|
||||
Gets the claims-principal with authenticated user identities.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationTicket.Properties">
|
||||
<summary>
|
||||
Additional state values for the authentication session.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Authentication.AuthenticationToken">
|
||||
<summary>
|
||||
Name/Value representing an token.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationToken.Name">
|
||||
<summary>
|
||||
Name.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationToken.Value">
|
||||
<summary>
|
||||
Value.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Authentication.IAuthenticationFeature">
|
||||
<summary>
|
||||
Used to capture path info so redirects can be computed properly within an app.Map().
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.IAuthenticationFeature.OriginalPathBase">
|
||||
<summary>
|
||||
The original path base.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.IAuthenticationFeature.OriginalPath">
|
||||
<summary>
|
||||
The original path.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Authentication.IAuthenticationHandler">
|
||||
<summary>
|
||||
Created per request to handle authentication for to a particular scheme.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationHandler.InitializeAsync(Microsoft.AspNetCore.Authentication.AuthenticationScheme,Microsoft.AspNetCore.Http.HttpContext)">
|
||||
<summary>
|
||||
The handler should initialize anything it needs from the request and scheme here.
|
||||
</summary>
|
||||
<param name="scheme">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme"/> scheme.</param>
|
||||
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationHandler.AuthenticateAsync">
|
||||
<summary>
|
||||
Authentication behavior.
|
||||
</summary>
|
||||
<returns>The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticateResult"/> result.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationHandler.ChallengeAsync(Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
|
||||
<summary>
|
||||
Challenge behavior.
|
||||
</summary>
|
||||
<param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> that contains the extra meta-data arriving with the authentication.</param>
|
||||
<returns>A task.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationHandler.ForbidAsync(Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
|
||||
<summary>
|
||||
Forbid behavior.
|
||||
</summary>
|
||||
<param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> that contains the extra meta-data arriving with the authentication.</param>
|
||||
<returns>A task.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Authentication.IAuthenticationHandlerProvider">
|
||||
<summary>
|
||||
Provides the appropriate IAuthenticationHandler instance for the authenticationScheme and request.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationHandlerProvider.GetHandlerAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)">
|
||||
<summary>
|
||||
Returns the handler instance that will be used.
|
||||
</summary>
|
||||
<param name="context">The context.</param>
|
||||
<param name="authenticationScheme">The name of the authentication scheme being handled.</param>
|
||||
<returns>The handler instance.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Authentication.IAuthenticationRequestHandler">
|
||||
<summary>
|
||||
Used to determine if a handler wants to participate in request processing.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationRequestHandler.HandleRequestAsync">
|
||||
<summary>
|
||||
Returns true if request processing should stop.
|
||||
</summary>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider">
|
||||
<summary>
|
||||
Responsible for managing what authenticationSchemes are supported.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.GetAllSchemesAsync">
|
||||
<summary>
|
||||
Returns all currently registered <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme"/>s.
|
||||
</summary>
|
||||
<returns>All currently registered <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme"/>s.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.GetSchemeAsync(System.String)">
|
||||
<summary>
|
||||
Returns the <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme"/> matching the name, or null.
|
||||
</summary>
|
||||
<param name="name">The name of the authenticationScheme.</param>
|
||||
<returns>The scheme or null if not found.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.GetDefaultAuthenticateSchemeAsync">
|
||||
<summary>
|
||||
Returns the scheme that will be used by default for <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.AuthenticateAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)"/>.
|
||||
This is typically specified via <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultAuthenticateScheme"/>.
|
||||
Otherwise, this will fallback to <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultScheme"/>.
|
||||
</summary>
|
||||
<returns>The scheme that will be used by default for <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.AuthenticateAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.GetDefaultChallengeSchemeAsync">
|
||||
<summary>
|
||||
Returns the scheme that will be used by default for <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.ChallengeAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)"/>.
|
||||
This is typically specified via <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultChallengeScheme"/>.
|
||||
Otherwise, this will fallback to <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultScheme"/>.
|
||||
</summary>
|
||||
<returns>The scheme that will be used by default for <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.ChallengeAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.GetDefaultForbidSchemeAsync">
|
||||
<summary>
|
||||
Returns the scheme that will be used by default for <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.ForbidAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)"/>.
|
||||
This is typically specified via <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultForbidScheme"/>.
|
||||
Otherwise, this will fallback to <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.GetDefaultChallengeSchemeAsync"/> .
|
||||
</summary>
|
||||
<returns>The scheme that will be used by default for <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.ForbidAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.GetDefaultSignInSchemeAsync">
|
||||
<summary>
|
||||
Returns the scheme that will be used by default for <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.SignInAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,System.Security.Claims.ClaimsPrincipal,Microsoft.AspNetCore.Authentication.AuthenticationProperties)"/>.
|
||||
This is typically specified via <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultSignInScheme"/>.
|
||||
Otherwise, this will fallback to <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultScheme"/>.
|
||||
</summary>
|
||||
<returns>The scheme that will be used by default for <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.SignInAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,System.Security.Claims.ClaimsPrincipal,Microsoft.AspNetCore.Authentication.AuthenticationProperties)"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.GetDefaultSignOutSchemeAsync">
|
||||
<summary>
|
||||
Returns the scheme that will be used by default for <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.SignOutAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)"/>.
|
||||
This is typically specified via <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultSignOutScheme"/>.
|
||||
Otherwise, this will fallback to <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.GetDefaultSignInSchemeAsync"/> .
|
||||
</summary>
|
||||
<returns>The scheme that will be used by default for <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.SignOutAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.AddScheme(Microsoft.AspNetCore.Authentication.AuthenticationScheme)">
|
||||
<summary>
|
||||
Registers a scheme for use by <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationService"/>.
|
||||
</summary>
|
||||
<param name="scheme">The scheme.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.RemoveScheme(System.String)">
|
||||
<summary>
|
||||
Removes a scheme, preventing it from being used by <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationService"/>.
|
||||
</summary>
|
||||
<param name="name">The name of the authenticationScheme being removed.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider.GetRequestHandlerSchemesAsync">
|
||||
<summary>
|
||||
Returns the schemes in priority order for request handling.
|
||||
</summary>
|
||||
<returns>The schemes in priority order for request handling</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Authentication.IAuthenticationService">
|
||||
<summary>
|
||||
Used to provide authentication.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.AuthenticateAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)">
|
||||
<summary>
|
||||
Authenticate for the specified authentication scheme.
|
||||
</summary>
|
||||
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>
|
||||
<param name="scheme">The name of the authentication scheme.</param>
|
||||
<returns>The result.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.ChallengeAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
|
||||
<summary>
|
||||
Challenge the specified authentication scheme.
|
||||
</summary>
|
||||
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>
|
||||
<param name="scheme">The name of the authentication scheme.</param>
|
||||
<param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/>.</param>
|
||||
<returns>A task.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.ForbidAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
|
||||
<summary>
|
||||
Forbids the specified authentication scheme.
|
||||
</summary>
|
||||
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>
|
||||
<param name="scheme">The name of the authentication scheme.</param>
|
||||
<param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/>.</param>
|
||||
<returns>A task.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.SignInAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,System.Security.Claims.ClaimsPrincipal,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
|
||||
<summary>
|
||||
Sign a principal in for the specified authentication scheme.
|
||||
</summary>
|
||||
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>
|
||||
<param name="scheme">The name of the authentication scheme.</param>
|
||||
<param name="principal">The <see cref="T:System.Security.Claims.ClaimsPrincipal"/> to sign in.</param>
|
||||
<param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/>.</param>
|
||||
<returns>A task.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.SignOutAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
|
||||
<summary>
|
||||
Sign out the specified authentication scheme.
|
||||
</summary>
|
||||
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>
|
||||
<param name="scheme">The name of the authentication scheme.</param>
|
||||
<param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/>.</param>
|
||||
<returns>A task.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Authentication.IAuthenticationSignInHandler">
|
||||
<summary>
|
||||
Used to determine if a handler supports SignIn.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSignInHandler.SignInAsync(System.Security.Claims.ClaimsPrincipal,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
|
||||
<summary>
|
||||
Handle sign in.
|
||||
</summary>
|
||||
<param name="user">The <see cref="T:System.Security.Claims.ClaimsPrincipal"/> user.</param>
|
||||
<param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> that contains the extra meta-data arriving with the authentication.</param>
|
||||
<returns>A task.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Authentication.IAuthenticationSignOutHandler">
|
||||
<summary>
|
||||
Used to determine if a handler supports SignOut.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.IAuthenticationSignOutHandler.SignOutAsync(Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
|
||||
<summary>
|
||||
Signout behavior.
|
||||
</summary>
|
||||
<param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> that contains the extra meta-data arriving with the authentication.</param>
|
||||
<returns>A task.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Authentication.IClaimsTransformation">
|
||||
<summary>
|
||||
Used by the <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationService"/> for claims transformation.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.IClaimsTransformation.TransformAsync(System.Security.Claims.ClaimsPrincipal)">
|
||||
<summary>
|
||||
Provides a central transformation point to change the specified principal.
|
||||
Note: this will be run on each AuthenticateAsync call, so its safer to
|
||||
return a new ClaimsPrincipal if your transformation is not idempotent.
|
||||
</summary>
|
||||
<param name="principal">The <see cref="T:System.Security.Claims.ClaimsPrincipal"/> to transform.</param>
|
||||
<returns>The transformed principal.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Authentication.AuthenticationTokenExtensions">
|
||||
<summary>
|
||||
Extension methods for storing authentication tokens in <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationTokenExtensions.StoreTokens(Microsoft.AspNetCore.Authentication.AuthenticationProperties,System.Collections.Generic.IEnumerable{Microsoft.AspNetCore.Authentication.AuthenticationToken})">
|
||||
<summary>
|
||||
Stores a set of authentication tokens, after removing any old tokens.
|
||||
</summary>
|
||||
<param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> properties.</param>
|
||||
<param name="tokens">The tokens to store.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationTokenExtensions.GetTokenValue(Microsoft.AspNetCore.Authentication.AuthenticationProperties,System.String)">
|
||||
<summary>
|
||||
Returns the value of a token.
|
||||
</summary>
|
||||
<param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> properties.</param>
|
||||
<param name="tokenName">The token name.</param>
|
||||
<returns>The token value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationTokenExtensions.GetTokens(Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
|
||||
<summary>
|
||||
Returns all of the AuthenticationTokens contained in the properties.
|
||||
</summary>
|
||||
<param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> properties.</param>
|
||||
<returns>The authentication tokens.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationTokenExtensions.GetTokenAsync(Microsoft.AspNetCore.Authentication.IAuthenticationService,Microsoft.AspNetCore.Http.HttpContext,System.String)">
|
||||
<summary>
|
||||
Extension method for getting the value of an authentication token.
|
||||
</summary>
|
||||
<param name="auth">The <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationService"/>.</param>
|
||||
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
|
||||
<param name="tokenName">The name of the token.</param>
|
||||
<returns>The value of the token.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationTokenExtensions.GetTokenAsync(Microsoft.AspNetCore.Authentication.IAuthenticationService,Microsoft.AspNetCore.Http.HttpContext,System.String,System.String)">
|
||||
<summary>
|
||||
Extension method for getting the value of an authentication token.
|
||||
</summary>
|
||||
<param name="auth">The <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationService"/>.</param>
|
||||
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> context.</param>
|
||||
<param name="scheme">The name of the authentication scheme.</param>
|
||||
<param name="tokenName">The name of the token.</param>
|
||||
<returns>The value of the token.</returns>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1,237 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.AspNetCore.Authentication.Core</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.DependencyInjection.AuthenticationCoreServiceCollectionExtensions">
|
||||
<summary>
|
||||
Extension methods for setting up authentication services in an <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.AuthenticationCoreServiceCollectionExtensions.AddAuthenticationCore(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
|
||||
<summary>
|
||||
Add core authentication services needed for <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationService"/>.
|
||||
</summary>
|
||||
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
|
||||
<returns>The service collection.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.AuthenticationCoreServiceCollectionExtensions.AddAuthenticationCore(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{Microsoft.AspNetCore.Authentication.AuthenticationOptions})">
|
||||
<summary>
|
||||
Add core authentication services needed for <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationService"/>.
|
||||
</summary>
|
||||
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
|
||||
<param name="configureOptions">Used to configure the <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationOptions"/>.</param>
|
||||
<returns>The service collection.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Authentication.AuthenticationFeature">
|
||||
<summary>
|
||||
Used to capture path info so redirects can be computed properly within an app.Map().
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationFeature.OriginalPathBase">
|
||||
<summary>
|
||||
The original path base.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationFeature.OriginalPath">
|
||||
<summary>
|
||||
The original path.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Authentication.AuthenticationHandlerProvider">
|
||||
<summary>
|
||||
Implementation of <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationHandlerProvider"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHandlerProvider.#ctor(Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider)">
|
||||
<summary>
|
||||
Constructor.
|
||||
</summary>
|
||||
<param name="schemes">The <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationHandlerProvider"/>.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationHandlerProvider.Schemes">
|
||||
<summary>
|
||||
The <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationHandlerProvider"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationHandlerProvider.GetHandlerAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)">
|
||||
<summary>
|
||||
Returns the handler instance that will be used.
|
||||
</summary>
|
||||
<param name="context">The context.</param>
|
||||
<param name="authenticationScheme">The name of the authentication scheme being handled.</param>
|
||||
<returns>The handler instance.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider">
|
||||
<summary>
|
||||
Implements <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.#ctor(Microsoft.Extensions.Options.IOptions{Microsoft.AspNetCore.Authentication.AuthenticationOptions})">
|
||||
<summary>
|
||||
Creates an instance of <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider"/>
|
||||
using the specified <paramref name="options"/>,
|
||||
</summary>
|
||||
<param name="options">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationOptions"/> options.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.#ctor(Microsoft.Extensions.Options.IOptions{Microsoft.AspNetCore.Authentication.AuthenticationOptions},System.Collections.Generic.IDictionary{System.String,Microsoft.AspNetCore.Authentication.AuthenticationScheme})">
|
||||
<summary>
|
||||
Creates an instance of <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider"/>
|
||||
using the specified <paramref name="options"/> and <paramref name="schemes"/>.
|
||||
</summary>
|
||||
<param name="options">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationOptions"/> options.</param>
|
||||
<param name="schemes">The dictionary used to store authentication schemes.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.GetDefaultAuthenticateSchemeAsync">
|
||||
<summary>
|
||||
Returns the scheme that will be used by default for <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.AuthenticateAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)"/>.
|
||||
This is typically specified via <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultAuthenticateScheme"/>.
|
||||
Otherwise, this will fallback to <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultScheme"/>.
|
||||
</summary>
|
||||
<returns>The scheme that will be used by default for <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.AuthenticateAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.GetDefaultChallengeSchemeAsync">
|
||||
<summary>
|
||||
Returns the scheme that will be used by default for <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.ChallengeAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)"/>.
|
||||
This is typically specified via <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultChallengeScheme"/>.
|
||||
Otherwise, this will fallback to <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultScheme"/>.
|
||||
</summary>
|
||||
<returns>The scheme that will be used by default for <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.ChallengeAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.GetDefaultForbidSchemeAsync">
|
||||
<summary>
|
||||
Returns the scheme that will be used by default for <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.ForbidAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)"/>.
|
||||
This is typically specified via <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultForbidScheme"/>.
|
||||
Otherwise, this will fallback to <see cref="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.GetDefaultChallengeSchemeAsync"/> .
|
||||
</summary>
|
||||
<returns>The scheme that will be used by default for <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.ForbidAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.GetDefaultSignInSchemeAsync">
|
||||
<summary>
|
||||
Returns the scheme that will be used by default for <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.SignInAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,System.Security.Claims.ClaimsPrincipal,Microsoft.AspNetCore.Authentication.AuthenticationProperties)"/>.
|
||||
This is typically specified via <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultSignInScheme"/>.
|
||||
Otherwise, this will fallback to <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultScheme"/>.
|
||||
</summary>
|
||||
<returns>The scheme that will be used by default for <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.SignInAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,System.Security.Claims.ClaimsPrincipal,Microsoft.AspNetCore.Authentication.AuthenticationProperties)"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.GetDefaultSignOutSchemeAsync">
|
||||
<summary>
|
||||
Returns the scheme that will be used by default for <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.SignOutAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)"/>.
|
||||
This is typically specified via <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultSignOutScheme"/>.
|
||||
Otherwise this will fallback to <see cref="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.GetDefaultSignInSchemeAsync"/> if that supports sign out.
|
||||
</summary>
|
||||
<returns>The scheme that will be used by default for <see cref="M:Microsoft.AspNetCore.Authentication.IAuthenticationService.SignOutAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.GetSchemeAsync(System.String)">
|
||||
<summary>
|
||||
Returns the <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme"/> matching the name, or null.
|
||||
</summary>
|
||||
<param name="name">The name of the authenticationScheme.</param>
|
||||
<returns>The scheme or null if not found.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.GetRequestHandlerSchemesAsync">
|
||||
<summary>
|
||||
Returns the schemes in priority order for request handling.
|
||||
</summary>
|
||||
<returns>The schemes in priority order for request handling</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.AddScheme(Microsoft.AspNetCore.Authentication.AuthenticationScheme)">
|
||||
<summary>
|
||||
Registers a scheme for use by <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationService"/>.
|
||||
</summary>
|
||||
<param name="scheme">The scheme.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationSchemeProvider.RemoveScheme(System.String)">
|
||||
<summary>
|
||||
Removes a scheme, preventing it from being used by <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationService"/>.
|
||||
</summary>
|
||||
<param name="name">The name of the authenticationScheme being removed.</param>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Authentication.AuthenticationService">
|
||||
<summary>
|
||||
Implements <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationService"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationService.#ctor(Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider,Microsoft.AspNetCore.Authentication.IAuthenticationHandlerProvider,Microsoft.AspNetCore.Authentication.IClaimsTransformation)">
|
||||
<summary>
|
||||
Constructor.
|
||||
</summary>
|
||||
<param name="schemes">The <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider"/>.</param>
|
||||
<param name="handlers">The <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationRequestHandler"/>.</param>
|
||||
<param name="transform">The <see cref="T:Microsoft.AspNetCore.Authentication.IClaimsTransformation"/>.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationService.Schemes">
|
||||
<summary>
|
||||
Used to lookup AuthenticationSchemes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationService.Handlers">
|
||||
<summary>
|
||||
Used to resolve IAuthenticationHandler instances.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.AuthenticationService.Transform">
|
||||
<summary>
|
||||
Used for claims transformation.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationService.AuthenticateAsync(Microsoft.AspNetCore.Http.HttpContext,System.String)">
|
||||
<summary>
|
||||
Authenticate for the specified authentication scheme.
|
||||
</summary>
|
||||
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>
|
||||
<param name="scheme">The name of the authentication scheme.</param>
|
||||
<returns>The result.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationService.ChallengeAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
|
||||
<summary>
|
||||
Challenge the specified authentication scheme.
|
||||
</summary>
|
||||
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>
|
||||
<param name="scheme">The name of the authentication scheme.</param>
|
||||
<param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/>.</param>
|
||||
<returns>A task.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationService.ForbidAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
|
||||
<summary>
|
||||
Forbid the specified authentication scheme.
|
||||
</summary>
|
||||
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>
|
||||
<param name="scheme">The name of the authentication scheme.</param>
|
||||
<param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/>.</param>
|
||||
<returns>A task.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationService.SignInAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,System.Security.Claims.ClaimsPrincipal,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
|
||||
<summary>
|
||||
Sign a principal in for the specified authentication scheme.
|
||||
</summary>
|
||||
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>
|
||||
<param name="scheme">The name of the authentication scheme.</param>
|
||||
<param name="principal">The <see cref="T:System.Security.Claims.ClaimsPrincipal"/> to sign in.</param>
|
||||
<param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/>.</param>
|
||||
<returns>A task.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.AuthenticationService.SignOutAsync(Microsoft.AspNetCore.Http.HttpContext,System.String,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
|
||||
<summary>
|
||||
Sign out the specified authentication scheme.
|
||||
</summary>
|
||||
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>
|
||||
<param name="scheme">The name of the authentication scheme.</param>
|
||||
<param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/>.</param>
|
||||
<returns>A task.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Authentication.NoopClaimsTransformation">
|
||||
<summary>
|
||||
Default claims transformation is a no-op.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.NoopClaimsTransformation.TransformAsync(System.Security.Claims.ClaimsPrincipal)">
|
||||
<summary>
|
||||
Returns the principal unchanged.
|
||||
</summary>
|
||||
<param name="principal">The user.</param>
|
||||
<returns>The principal unchanged.</returns>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1,105 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.AspNetCore.Connections.Abstractions</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Internal.ActivatorUtilities">
|
||||
<summary>
|
||||
Helper code for the various activator services.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Internal.ActivatorUtilities.CreateInstance(System.IServiceProvider,System.Type,System.Object[])">
|
||||
<summary>
|
||||
Instantiate a type with constructor arguments provided directly and/or from an <see cref="T:System.IServiceProvider"/>.
|
||||
</summary>
|
||||
<param name="provider">The service provider used to resolve dependencies</param>
|
||||
<param name="instanceType">The type to activate</param>
|
||||
<param name="parameters">Constructor arguments not provided by the <paramref name="provider"/>.</param>
|
||||
<returns>An activated object of type instanceType</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Internal.ActivatorUtilities.CreateFactory(System.Type,System.Type[])">
|
||||
<summary>
|
||||
Create a delegate that will instantiate a type with constructor arguments provided directly
|
||||
and/or from an <see cref="T:System.IServiceProvider"/>.
|
||||
</summary>
|
||||
<param name="instanceType">The type to activate</param>
|
||||
<param name="argumentTypes">
|
||||
The types of objects, in order, that will be passed to the returned function as its second parameter
|
||||
</param>
|
||||
<returns>
|
||||
A factory that will instantiate instanceType using an <see cref="T:System.IServiceProvider"/>
|
||||
and an argument array containing objects matching the types defined in argumentTypes
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Internal.ActivatorUtilities.CreateInstance``1(System.IServiceProvider,System.Object[])">
|
||||
<summary>
|
||||
Instantiate a type with constructor arguments provided directly and/or from an <see cref="T:System.IServiceProvider"/>.
|
||||
</summary>
|
||||
<typeparam name="T">The type to activate</typeparam>
|
||||
<param name="provider">The service provider used to resolve dependencies</param>
|
||||
<param name="parameters">Constructor arguments not provided by the <paramref name="provider"/>.</param>
|
||||
<returns>An activated object of type T</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Internal.ActivatorUtilities.GetServiceOrCreateInstance``1(System.IServiceProvider)">
|
||||
<summary>
|
||||
Retrieve an instance of the given type from the service provider. If one is not found then instantiate it directly.
|
||||
</summary>
|
||||
<typeparam name="T">The type of the service</typeparam>
|
||||
<param name="provider">The service provider used to resolve dependencies</param>
|
||||
<returns>The resolved service or created instance</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Internal.ActivatorUtilities.GetServiceOrCreateInstance(System.IServiceProvider,System.Type)">
|
||||
<summary>
|
||||
Retrieve an instance of the given type from the service provider. If one is not found then instantiate it directly.
|
||||
</summary>
|
||||
<param name="provider">The service provider</param>
|
||||
<param name="type">The type of the service</param>
|
||||
<returns>The resolved service or created instance</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Internal.ActivatorUtilitiesConstructorAttribute">
|
||||
<summary>
|
||||
Marks the constructor to be used when activating type using <see cref="T:Microsoft.Extensions.Internal.ActivatorUtilities"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Internal.ObjectFactory">
|
||||
<summary>
|
||||
The result of <see cref="M:Microsoft.Extensions.Internal.ActivatorUtilities.CreateFactory(System.Type,System.Type[])"/>.
|
||||
</summary>
|
||||
<param name="serviceProvider">The <see cref="T:System.IServiceProvider"/> to get service arguments from.</param>
|
||||
<param name="arguments">Additional constructor arguments.</param>
|
||||
<returns>The instantiated type.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Connections.ConnectionHandler">
|
||||
<summary>
|
||||
Represents an end point that multiple connections connect to. For HTTP, endpoints are URLs, for non HTTP it can be a TCP listener (or similar)
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Connections.ConnectionHandler.OnConnectedAsync(Microsoft.AspNetCore.Connections.ConnectionContext)">
|
||||
<summary>
|
||||
Called when a new connection is accepted to the endpoint
|
||||
</summary>
|
||||
<param name="connection">The new <see cref="T:Microsoft.AspNetCore.Connections.ConnectionContext"/></param>
|
||||
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the connection lifetime. When the task completes, the connection is complete.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Connections.DefaultConnectionContext.#ctor(System.String)">
|
||||
<summary>
|
||||
Creates the DefaultConnectionContext without Pipes to avoid upfront allocations.
|
||||
The caller is expected to set the <see cref="P:Microsoft.AspNetCore.Connections.DefaultConnectionContext.Transport"/> and <see cref="P:Microsoft.AspNetCore.Connections.DefaultConnectionContext.Application"/> pipes manually.
|
||||
</summary>
|
||||
<param name="id"></param>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Connections.Features.IConnectionInherentKeepAliveFeature">
|
||||
<summary>
|
||||
Indicates if the connection transport has an "inherent keep-alive", which means that the transport will automatically
|
||||
inform the client that it is still present.
|
||||
</summary>
|
||||
<remarks>
|
||||
The most common example of this feature is the Long Polling HTTP transport, which must (due to HTTP limitations) terminate
|
||||
each poll within a particular interval and return a signal indicating "the server is still here, but there is no data yet".
|
||||
This feature allows applications to add keep-alive functionality, but limit it only to transports that don't have some kind
|
||||
of inherent keep-alive.
|
||||
</remarks>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1,139 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.AspNetCore.Diagnostics.Abstractions</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.AspNetCore.Diagnostics.CompilationFailure">
|
||||
<summary>
|
||||
Describes a failure compiling a specific file.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Diagnostics.CompilationFailure.#ctor(System.String,System.String,System.String,System.Collections.Generic.IEnumerable{Microsoft.AspNetCore.Diagnostics.DiagnosticMessage})">
|
||||
<summary>
|
||||
Initializes a new instance of <see cref="T:Microsoft.AspNetCore.Diagnostics.CompilationFailure"/>.
|
||||
</summary>
|
||||
<param name="sourceFilePath">Path for the file that produced the compilation failure.</param>
|
||||
<param name="sourceFileContent">Contents of the file being compiled.</param>
|
||||
<param name="compiledContent">For templated languages (such as Asp.Net Core Razor), the generated content.
|
||||
</param>
|
||||
<param name="messages">One or or more <see cref="T:Microsoft.AspNetCore.Diagnostics.DiagnosticMessage"/> instances.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Diagnostics.CompilationFailure.#ctor(System.String,System.String,System.String,System.Collections.Generic.IEnumerable{Microsoft.AspNetCore.Diagnostics.DiagnosticMessage},System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of <see cref="T:Microsoft.AspNetCore.Diagnostics.CompilationFailure"/>.
|
||||
</summary>
|
||||
<param name="sourceFilePath">Path for the file that produced the compilation failure.</param>
|
||||
<param name="sourceFileContent">Contents of the file being compiled.</param>
|
||||
<param name="compiledContent">For templated languages (such as Asp.Net Core Razor), the generated content.
|
||||
</param>
|
||||
<param name="messages">One or or more <see cref="T:Microsoft.AspNetCore.Diagnostics.DiagnosticMessage"/> instances.</param>
|
||||
<param name="failureSummary">Summary message or instructions to fix the failure.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Diagnostics.CompilationFailure.SourceFilePath">
|
||||
<summary>
|
||||
Path of the file that produced the compilation failure.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Diagnostics.CompilationFailure.SourceFileContent">
|
||||
<summary>
|
||||
Contents of the file.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Diagnostics.CompilationFailure.CompiledContent">
|
||||
<summary>
|
||||
Contents being compiled.
|
||||
</summary>
|
||||
<remarks>
|
||||
For templated files, the <see cref="P:Microsoft.AspNetCore.Diagnostics.CompilationFailure.SourceFileContent"/> represents the original content and
|
||||
<see cref="P:Microsoft.AspNetCore.Diagnostics.CompilationFailure.CompiledContent"/> represents the transformed content. This property can be null if
|
||||
the exception is encountered during transformation.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Diagnostics.CompilationFailure.Messages">
|
||||
<summary>
|
||||
Gets a sequence of <see cref="T:Microsoft.AspNetCore.Diagnostics.DiagnosticMessage"/> produced as a result of compilation.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Diagnostics.CompilationFailure.FailureSummary">
|
||||
<summary>
|
||||
Summary message or instructions to fix the failure.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Diagnostics.DiagnosticMessage">
|
||||
<summary>
|
||||
A single diagnostic message.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Diagnostics.DiagnosticMessage.SourceFilePath">
|
||||
<summary>
|
||||
Path of the file that produced the message.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Diagnostics.DiagnosticMessage.Message">
|
||||
<summary>
|
||||
Gets the error message.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Diagnostics.DiagnosticMessage.StartLine">
|
||||
<summary>
|
||||
Gets the one-based line index for the start of the compilation error.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Diagnostics.DiagnosticMessage.StartColumn">
|
||||
<summary>
|
||||
Gets the zero-based column index for the start of the compilation error.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Diagnostics.DiagnosticMessage.EndLine">
|
||||
<summary>
|
||||
Gets the one-based line index for the end of the compilation error.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Diagnostics.DiagnosticMessage.EndColumn">
|
||||
<summary>
|
||||
Gets the zero-based column index for the end of the compilation error.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Diagnostics.DiagnosticMessage.FormattedMessage">
|
||||
<summary>
|
||||
Gets the formatted error message.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Diagnostics.ICompilationException">
|
||||
<summary>
|
||||
Specifies the contract for an exception representing compilation failure.
|
||||
</summary>
|
||||
<remarks>
|
||||
This interface is implemented on exceptions thrown during compilation to enable consumers
|
||||
to read compilation-related data out of the exception
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Diagnostics.ICompilationException.CompilationFailures">
|
||||
<summary>
|
||||
Gets a sequence of <see cref="T:Microsoft.AspNetCore.Diagnostics.CompilationFailure"/> with compilation failures.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Diagnostics.IExceptionHandlerPathFeature">
|
||||
<summary>
|
||||
Represents an exception handler with the original path of the request.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Diagnostics.IExceptionHandlerPathFeature.Path">
|
||||
<summary>
|
||||
The portion of the request path that identifies the requested resource. The value
|
||||
is un-escaped.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Diagnostics.IStatusCodePagesFeature">
|
||||
<summary>
|
||||
Represents the Status code pages feature.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Diagnostics.IStatusCodePagesFeature.Enabled">
|
||||
<summary>
|
||||
Indicates if the status code middleware will handle responses.
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
File diff suppressed because it is too large
Load Diff
Binary file not shown.
@@ -0,0 +1,88 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.AspNetCore.HostFiltering</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.AspNetCore.Builder.HostFilteringBuilderExtensions">
|
||||
<summary>
|
||||
Extension methods for the HostFiltering middleware.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Builder.HostFilteringBuilderExtensions.UseHostFiltering(Microsoft.AspNetCore.Builder.IApplicationBuilder)">
|
||||
<summary>
|
||||
Adds middleware for filtering requests by allowed host headers. Invalid requests will be rejected with a
|
||||
400 status code.
|
||||
</summary>
|
||||
<param name="app">The <see cref="T:Microsoft.AspNetCore.Builder.IApplicationBuilder"/> instance this method extends.</param>
|
||||
<returns>The original <see cref="T:Microsoft.AspNetCore.Builder.IApplicationBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Builder.HostFilteringServicesExtensions">
|
||||
<summary>
|
||||
Extension methods for the host filtering middleware.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Builder.HostFilteringServicesExtensions.AddHostFiltering(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{Microsoft.AspNetCore.HostFiltering.HostFilteringOptions})">
|
||||
<summary>
|
||||
Adds services and options for the host filtering middleware.
|
||||
</summary>
|
||||
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> for adding services.</param>
|
||||
<param name="configureOptions">A delegate to configure the <see cref="T:Microsoft.AspNetCore.HostFiltering.HostFilteringOptions"/>.</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.HostFiltering.HostFilteringMiddleware">
|
||||
<summary>
|
||||
A middleware used to filter requests by their Host header.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.HostFiltering.HostFilteringMiddleware.#ctor(Microsoft.AspNetCore.Http.RequestDelegate,Microsoft.Extensions.Logging.ILogger{Microsoft.AspNetCore.HostFiltering.HostFilteringMiddleware},Microsoft.Extensions.Options.IOptionsMonitor{Microsoft.AspNetCore.HostFiltering.HostFilteringOptions})">
|
||||
<summary>
|
||||
A middleware used to filter requests by their Host header.
|
||||
</summary>
|
||||
<param name="next"></param>
|
||||
<param name="logger"></param>
|
||||
<param name="optionsMonitor"></param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.HostFiltering.HostFilteringMiddleware.Invoke(Microsoft.AspNetCore.Http.HttpContext)">
|
||||
<summary>
|
||||
Processes requests
|
||||
</summary>
|
||||
<param name="context"></param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.HostFiltering.HostFilteringOptions">
|
||||
<summary>
|
||||
Options for the HostFiltering middleware
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.HostFiltering.HostFilteringOptions.AllowedHosts">
|
||||
<summary>
|
||||
The hosts headers that are allowed to access this site. At least one value is required.
|
||||
</summary>
|
||||
<remarks>
|
||||
<list type="bullet">
|
||||
<item><description>Port numbers must be excluded.</description></item>
|
||||
<item><description>A top level wildcard "*" allows all non-empty hosts.</description></item>
|
||||
<item><description>Subdomain wildcards are permitted. E.g. "*.example.com" matches subdomains like foo.example.com,
|
||||
but not the parent domain example.com.</description></item>
|
||||
<item><description>Unicode host names are allowed but will be converted to punycode for matching.</description></item>
|
||||
<item><description>IPv6 addresses must include their bounding brackets and be in their normalized form.</description></item>
|
||||
</list>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.HostFiltering.HostFilteringOptions.AllowEmptyHosts">
|
||||
<summary>
|
||||
Indicates if requests without hosts are allowed. The default is true.
|
||||
</summary>
|
||||
<remarks>
|
||||
HTTP/1.0 does not require a host header.
|
||||
Http/1.1 requires a host header, but says the value may be empty.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.HostFiltering.HostFilteringOptions.IncludeFailureMessage">
|
||||
<summary>
|
||||
Indicates if the 400 response should include a default message or be empty. This is enabled by default.
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1,353 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.AspNetCore.Hosting.Abstractions</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.AspNetCore.Hosting.EnvironmentName">
|
||||
<summary>
|
||||
Commonly used environment names.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.HostingAbstractionsWebHostBuilderExtensions.UseConfiguration(Microsoft.AspNetCore.Hosting.IWebHostBuilder,Microsoft.Extensions.Configuration.IConfiguration)">
|
||||
<summary>
|
||||
Use the given configuration settings on the web host.
|
||||
</summary>
|
||||
<param name="hostBuilder">The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/> to configure.</param>
|
||||
<param name="configuration">The <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> containing settings to be used.</param>
|
||||
<returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.HostingAbstractionsWebHostBuilderExtensions.CaptureStartupErrors(Microsoft.AspNetCore.Hosting.IWebHostBuilder,System.Boolean)">
|
||||
<summary>
|
||||
Set whether startup errors should be captured in the configuration settings of the web host.
|
||||
When enabled, startup exceptions will be caught and an error page will be returned. If disabled, startup exceptions will be propagated.
|
||||
</summary>
|
||||
<param name="hostBuilder">The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/> to configure.</param>
|
||||
<param name="captureStartupErrors"><c>true</c> to use startup error page; otherwise <c>false</c>.</param>
|
||||
<returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.HostingAbstractionsWebHostBuilderExtensions.UseStartup(Microsoft.AspNetCore.Hosting.IWebHostBuilder,System.String)">
|
||||
<summary>
|
||||
Specify the assembly containing the startup type to be used by the web host.
|
||||
</summary>
|
||||
<param name="hostBuilder">The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/> to configure.</param>
|
||||
<param name="startupAssemblyName">The name of the assembly containing the startup type.</param>
|
||||
<returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.HostingAbstractionsWebHostBuilderExtensions.UseServer(Microsoft.AspNetCore.Hosting.IWebHostBuilder,Microsoft.AspNetCore.Hosting.Server.IServer)">
|
||||
<summary>
|
||||
Specify the server to be used by the web host.
|
||||
</summary>
|
||||
<param name="hostBuilder">The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/> to configure.</param>
|
||||
<param name="server">The <see cref="T:Microsoft.AspNetCore.Hosting.Server.IServer"/> to be used.</param>
|
||||
<returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.HostingAbstractionsWebHostBuilderExtensions.UseEnvironment(Microsoft.AspNetCore.Hosting.IWebHostBuilder,System.String)">
|
||||
<summary>
|
||||
Specify the environment to be used by the web host.
|
||||
</summary>
|
||||
<param name="hostBuilder">The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/> to configure.</param>
|
||||
<param name="environment">The environment to host the application in.</param>
|
||||
<returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.HostingAbstractionsWebHostBuilderExtensions.UseContentRoot(Microsoft.AspNetCore.Hosting.IWebHostBuilder,System.String)">
|
||||
<summary>
|
||||
Specify the content root directory to be used by the web host.
|
||||
</summary>
|
||||
<param name="hostBuilder">The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/> to configure.</param>
|
||||
<param name="contentRoot">Path to root directory of the application.</param>
|
||||
<returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.HostingAbstractionsWebHostBuilderExtensions.UseWebRoot(Microsoft.AspNetCore.Hosting.IWebHostBuilder,System.String)">
|
||||
<summary>
|
||||
Specify the webroot directory to be used by the web host.
|
||||
</summary>
|
||||
<param name="hostBuilder">The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/> to configure.</param>
|
||||
<param name="webRoot">Path to the root directory used by the web server.</param>
|
||||
<returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.HostingAbstractionsWebHostBuilderExtensions.UseUrls(Microsoft.AspNetCore.Hosting.IWebHostBuilder,System.String[])">
|
||||
<summary>
|
||||
Specify the urls the web host will listen on.
|
||||
</summary>
|
||||
<param name="hostBuilder">The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/> to configure.</param>
|
||||
<param name="urls">The urls the hosted application will listen on.</param>
|
||||
<returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.HostingAbstractionsWebHostBuilderExtensions.PreferHostingUrls(Microsoft.AspNetCore.Hosting.IWebHostBuilder,System.Boolean)">
|
||||
<summary>
|
||||
Indicate whether the host should listen on the URLs configured on the <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>
|
||||
instead of those configured on the <see cref="T:Microsoft.AspNetCore.Hosting.Server.IServer"/>.
|
||||
</summary>
|
||||
<param name="hostBuilder">The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/> to configure.</param>
|
||||
<param name="preferHostingUrls"><c>true</c> to prefer URLs configured on the <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>; otherwise <c>false</c>.</param>
|
||||
<returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.HostingAbstractionsWebHostBuilderExtensions.SuppressStatusMessages(Microsoft.AspNetCore.Hosting.IWebHostBuilder,System.Boolean)">
|
||||
<summary>
|
||||
Specify if startup status messages should be suppressed.
|
||||
</summary>
|
||||
<param name="hostBuilder">The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/> to configure.</param>
|
||||
<param name="suppressStatusMessages"><c>true</c> to suppress writing of hosting startup status messages; otherwise <c>false</c>.</param>
|
||||
<returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.HostingAbstractionsWebHostBuilderExtensions.UseShutdownTimeout(Microsoft.AspNetCore.Hosting.IWebHostBuilder,System.TimeSpan)">
|
||||
<summary>
|
||||
Specify the amount of time to wait for the web host to shutdown.
|
||||
</summary>
|
||||
<param name="hostBuilder">The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/> to configure.</param>
|
||||
<param name="timeout">The amount of time to wait for server shutdown.</param>
|
||||
<returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.HostingAbstractionsWebHostBuilderExtensions.Start(Microsoft.AspNetCore.Hosting.IWebHostBuilder,System.String[])">
|
||||
<summary>
|
||||
Start the web host and listen on the specified urls.
|
||||
</summary>
|
||||
<param name="hostBuilder">The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/> to start.</param>
|
||||
<param name="urls">The urls the hosted application will listen on.</param>
|
||||
<returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Hosting.HostingEnvironmentExtensions">
|
||||
<summary>
|
||||
Extension methods for <see cref="T:Microsoft.AspNetCore.Hosting.IHostingEnvironment"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.HostingEnvironmentExtensions.IsDevelopment(Microsoft.AspNetCore.Hosting.IHostingEnvironment)">
|
||||
<summary>
|
||||
Checks if the current hosting environment name is <see cref="F:Microsoft.AspNetCore.Hosting.EnvironmentName.Development"/>.
|
||||
</summary>
|
||||
<param name="hostingEnvironment">An instance of <see cref="T:Microsoft.AspNetCore.Hosting.IHostingEnvironment"/>.</param>
|
||||
<returns>True if the environment name is <see cref="F:Microsoft.AspNetCore.Hosting.EnvironmentName.Development"/>, otherwise false.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.HostingEnvironmentExtensions.IsStaging(Microsoft.AspNetCore.Hosting.IHostingEnvironment)">
|
||||
<summary>
|
||||
Checks if the current hosting environment name is <see cref="F:Microsoft.AspNetCore.Hosting.EnvironmentName.Staging"/>.
|
||||
</summary>
|
||||
<param name="hostingEnvironment">An instance of <see cref="T:Microsoft.AspNetCore.Hosting.IHostingEnvironment"/>.</param>
|
||||
<returns>True if the environment name is <see cref="F:Microsoft.AspNetCore.Hosting.EnvironmentName.Staging"/>, otherwise false.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.HostingEnvironmentExtensions.IsProduction(Microsoft.AspNetCore.Hosting.IHostingEnvironment)">
|
||||
<summary>
|
||||
Checks if the current hosting environment name is <see cref="F:Microsoft.AspNetCore.Hosting.EnvironmentName.Production"/>.
|
||||
</summary>
|
||||
<param name="hostingEnvironment">An instance of <see cref="T:Microsoft.AspNetCore.Hosting.IHostingEnvironment"/>.</param>
|
||||
<returns>True if the environment name is <see cref="F:Microsoft.AspNetCore.Hosting.EnvironmentName.Production"/>, otherwise false.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.HostingEnvironmentExtensions.IsEnvironment(Microsoft.AspNetCore.Hosting.IHostingEnvironment,System.String)">
|
||||
<summary>
|
||||
Compares the current hosting environment name against the specified value.
|
||||
</summary>
|
||||
<param name="hostingEnvironment">An instance of <see cref="T:Microsoft.AspNetCore.Hosting.IHostingEnvironment"/>.</param>
|
||||
<param name="environmentName">Environment name to validate against.</param>
|
||||
<returns>True if the specified name is the same as the current environment, otherwise false.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Hosting.HostingStartupAttribute">
|
||||
<summary>
|
||||
Marker attribute indicating an implementation of <see cref="T:Microsoft.AspNetCore.Hosting.IHostingStartup"/> that will be loaded and executed when building an <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.HostingStartupAttribute.#ctor(System.Type)">
|
||||
<summary>
|
||||
Constructs the <see cref="T:Microsoft.AspNetCore.Hosting.HostingStartupAttribute"/> with the specified type.
|
||||
</summary>
|
||||
<param name="hostingStartupType">A type that implements <see cref="T:Microsoft.AspNetCore.Hosting.IHostingStartup"/>.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Hosting.HostingStartupAttribute.HostingStartupType">
|
||||
<summary>
|
||||
The implementation of <see cref="T:Microsoft.AspNetCore.Hosting.IHostingStartup"/> that should be loaded when
|
||||
starting an application.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Hosting.IApplicationLifetime">
|
||||
<summary>
|
||||
Allows consumers to perform cleanup during a graceful shutdown.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Hosting.IApplicationLifetime.ApplicationStarted">
|
||||
<summary>
|
||||
Triggered when the application host has fully started and is about to wait
|
||||
for a graceful shutdown.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Hosting.IApplicationLifetime.ApplicationStopping">
|
||||
<summary>
|
||||
Triggered when the application host is performing a graceful shutdown.
|
||||
Requests may still be in flight. Shutdown will block until this event completes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Hosting.IApplicationLifetime.ApplicationStopped">
|
||||
<summary>
|
||||
Triggered when the application host is performing a graceful shutdown.
|
||||
All requests should be complete at this point. Shutdown will block
|
||||
until this event completes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.IApplicationLifetime.StopApplication">
|
||||
<summary>
|
||||
Requests termination of the current application.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Hosting.IHostingEnvironment">
|
||||
<summary>
|
||||
Provides information about the web hosting environment an application is running in.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Hosting.IHostingEnvironment.EnvironmentName">
|
||||
<summary>
|
||||
Gets or sets the name of the environment. The host automatically sets this property to the value
|
||||
of the "ASPNETCORE_ENVIRONMENT" environment variable, or "environment" as specified in any other configuration source.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Hosting.IHostingEnvironment.ApplicationName">
|
||||
<summary>
|
||||
Gets or sets the name of the application. This property is automatically set by the host to the assembly containing
|
||||
the application entry point.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Hosting.IHostingEnvironment.WebRootPath">
|
||||
<summary>
|
||||
Gets or sets the absolute path to the directory that contains the web-servable application content files.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Hosting.IHostingEnvironment.WebRootFileProvider">
|
||||
<summary>
|
||||
Gets or sets an <see cref="T:Microsoft.Extensions.FileProviders.IFileProvider"/> pointing at <see cref="P:Microsoft.AspNetCore.Hosting.IHostingEnvironment.WebRootPath"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Hosting.IHostingEnvironment.ContentRootPath">
|
||||
<summary>
|
||||
Gets or sets the absolute path to the directory that contains the application content files.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Hosting.IHostingEnvironment.ContentRootFileProvider">
|
||||
<summary>
|
||||
Gets or sets an <see cref="T:Microsoft.Extensions.FileProviders.IFileProvider"/> pointing at <see cref="P:Microsoft.AspNetCore.Hosting.IHostingEnvironment.ContentRootPath"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Hosting.IHostingStartup">
|
||||
<summary>
|
||||
Represents platform specific configuration that will be applied to a <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/> when building an <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.IHostingStartup.Configure(Microsoft.AspNetCore.Hosting.IWebHostBuilder)">
|
||||
<summary>
|
||||
Configure the <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
Configure is intended to be called before user code, allowing a user to overwrite any changes made.
|
||||
</remarks>
|
||||
<param name="builder"></param>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Hosting.Internal.IStartupConfigureContainerFilter`1">
|
||||
<summary>
|
||||
This API supports the ASP.NET Core infrastructure and is not intended to be used
|
||||
directly from your code. This API may change or be removed in future releases.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Hosting.Internal.IStartupConfigureServicesFilter">
|
||||
<summary>
|
||||
This API supports the ASP.NET Core infrastructure and is not intended to be used
|
||||
directly from your code. This API may change or be removed in future releases.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Hosting.IWebHost">
|
||||
<summary>
|
||||
Represents a configured web host.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Hosting.IWebHost.ServerFeatures">
|
||||
<summary>
|
||||
The <see cref="T:Microsoft.AspNetCore.Http.Features.IFeatureCollection"/> exposed by the configured server.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Hosting.IWebHost.Services">
|
||||
<summary>
|
||||
The <see cref="T:System.IServiceProvider"/> for the host.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.IWebHost.Start">
|
||||
<summary>
|
||||
Starts listening on the configured addresses.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.IWebHost.StartAsync(System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Starts listening on the configured addresses.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.IWebHost.StopAsync(System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Attempt to gracefully stop the host.
|
||||
</summary>
|
||||
<param name="cancellationToken"></param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder">
|
||||
<summary>
|
||||
A builder for <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.IWebHostBuilder.Build">
|
||||
<summary>
|
||||
Builds an <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost"/> which hosts a web application.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.IWebHostBuilder.ConfigureAppConfiguration(System.Action{Microsoft.AspNetCore.Hosting.WebHostBuilderContext,Microsoft.Extensions.Configuration.IConfigurationBuilder})">
|
||||
<summary>
|
||||
Adds a delegate for configuring the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> that will construct an <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/>.
|
||||
</summary>
|
||||
<param name="configureDelegate">The delegate for configuring the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder" /> that will be used to construct an <see cref="T:Microsoft.Extensions.Configuration.IConfiguration" />.</param>
|
||||
<returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
|
||||
<remarks>
|
||||
The <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> and <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/> on the <see cref="T:Microsoft.AspNetCore.Hosting.WebHostBuilderContext"/> are uninitialized at this stage.
|
||||
The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> is pre-populated with the settings of the <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.IWebHostBuilder.ConfigureServices(System.Action{Microsoft.Extensions.DependencyInjection.IServiceCollection})">
|
||||
<summary>
|
||||
Adds a delegate for configuring additional services for the host or web application. This may be called
|
||||
multiple times.
|
||||
</summary>
|
||||
<param name="configureServices">A delegate for configuring the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
|
||||
<returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.IWebHostBuilder.ConfigureServices(System.Action{Microsoft.AspNetCore.Hosting.WebHostBuilderContext,Microsoft.Extensions.DependencyInjection.IServiceCollection})">
|
||||
<summary>
|
||||
Adds a delegate for configuring additional services for the host or web application. This may be called
|
||||
multiple times.
|
||||
</summary>
|
||||
<param name="configureServices">A delegate for configuring the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
|
||||
<returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.IWebHostBuilder.GetSetting(System.String)">
|
||||
<summary>
|
||||
Get the setting value from the configuration.
|
||||
</summary>
|
||||
<param name="key">The key of the setting to look up.</param>
|
||||
<returns>The value the setting currently contains.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.IWebHostBuilder.UseSetting(System.String,System.String)">
|
||||
<summary>
|
||||
Add or replace a setting in the configuration.
|
||||
</summary>
|
||||
<param name="key">The key of the setting to add or replace.</param>
|
||||
<param name="value">The value of the setting to add or replace.</param>
|
||||
<returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Hosting.WebHostBuilderContext">
|
||||
<summary>
|
||||
Context containing the common services on the <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost" />. Some properties may be null until set by the <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost" />.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Hosting.WebHostBuilderContext.HostingEnvironment">
|
||||
<summary>
|
||||
The <see cref="T:Microsoft.AspNetCore.Hosting.IHostingEnvironment" /> initialized by the <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost" />.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Hosting.WebHostBuilderContext.Configuration">
|
||||
<summary>
|
||||
The <see cref="T:Microsoft.Extensions.Configuration.IConfiguration" /> containing the merged configuration of the application and the <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost" />.
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1,58 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.AspNetCore.Hosting.Server.Abstractions</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.AspNetCore.Hosting.Server.IHttpApplication`1">
|
||||
<summary>
|
||||
Represents an application.
|
||||
</summary>
|
||||
<typeparam name="TContext">The context associated with the application.</typeparam>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.Server.IHttpApplication`1.CreateContext(Microsoft.AspNetCore.Http.Features.IFeatureCollection)">
|
||||
<summary>
|
||||
Create a TContext given a collection of HTTP features.
|
||||
</summary>
|
||||
<param name="contextFeatures">A collection of HTTP features to be used for creating the TContext.</param>
|
||||
<returns>The created TContext.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.Server.IHttpApplication`1.ProcessRequestAsync(`0)">
|
||||
<summary>
|
||||
Asynchronously processes an TContext.
|
||||
</summary>
|
||||
<param name="context">The TContext that the operation will process.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.Server.IHttpApplication`1.DisposeContext(`0,System.Exception)">
|
||||
<summary>
|
||||
Dispose a given TContext.
|
||||
</summary>
|
||||
<param name="context">The TContext to be disposed.</param>
|
||||
<param name="exception">The Exception thrown when processing did not complete successfully, otherwise null.</param>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Hosting.Server.IServer">
|
||||
<summary>
|
||||
Represents a server.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Hosting.Server.IServer.Features">
|
||||
<summary>
|
||||
A collection of HTTP features of the server.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.Server.IServer.StartAsync``1(Microsoft.AspNetCore.Hosting.Server.IHttpApplication{``0},System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Start the server with an application.
|
||||
</summary>
|
||||
<param name="application">An instance of <see cref="T:Microsoft.AspNetCore.Hosting.Server.IHttpApplication`1"/>.</param>
|
||||
<typeparam name="TContext">The context associated with the application.</typeparam>
|
||||
<param name="cancellationToken">Indicates if the server startup should be aborted.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.Server.IServer.StopAsync(System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Stop processing requests and shut down the server, gracefully if possible.
|
||||
</summary>
|
||||
<param name="cancellationToken">Indicates if the graceful shutdown should be aborted.</param>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1,443 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.AspNetCore.Hosting</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="M:Microsoft.Extensions.Internal.TypeNameHelper.GetTypeDisplayName(System.Type,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
Pretty print a type name.
|
||||
</summary>
|
||||
<param name="type">The <see cref="T:System.Type"/>.</param>
|
||||
<param name="fullName"><c>true</c> to print a fully qualified name.</param>
|
||||
<param name="includeGenericParameterNames"><c>true</c> to include generic parameter names.</param>
|
||||
<returns>The pretty printed type name.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.StackTrace.Sources.ExceptionDetails">
|
||||
<summary>
|
||||
Contains details for individual exception messages.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.StackTrace.Sources.ExceptionDetails.Error">
|
||||
<summary>
|
||||
An individual exception
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.StackTrace.Sources.ExceptionDetails.StackFrames">
|
||||
<summary>
|
||||
The generated stack frames
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.StackTrace.Sources.ExceptionDetails.ErrorMessage">
|
||||
<summary>
|
||||
Gets or sets the summary message.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.StackTrace.Sources.StackFrameSourceCodeInfo">
|
||||
<summary>
|
||||
Contains the source code where the exception occurred.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.StackTrace.Sources.StackFrameSourceCodeInfo.Function">
|
||||
<summary>
|
||||
Function containing instruction
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.StackTrace.Sources.StackFrameSourceCodeInfo.File">
|
||||
<summary>
|
||||
File containing the instruction
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.StackTrace.Sources.StackFrameSourceCodeInfo.Line">
|
||||
<summary>
|
||||
The line number of the instruction
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.StackTrace.Sources.StackFrameSourceCodeInfo.PreContextLine">
|
||||
<summary>
|
||||
The line preceding the frame line
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.StackTrace.Sources.StackFrameSourceCodeInfo.PreContextCode">
|
||||
<summary>
|
||||
Lines of code before the actual error line(s).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.StackTrace.Sources.StackFrameSourceCodeInfo.ContextCode">
|
||||
<summary>
|
||||
Line(s) of code responsible for the error.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.StackTrace.Sources.StackFrameSourceCodeInfo.PostContextCode">
|
||||
<summary>
|
||||
Lines of code after the actual error line(s).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.StackTrace.Sources.StackFrameSourceCodeInfo.ErrorDetails">
|
||||
<summary>
|
||||
Specific error details for this stack frame.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.RazorViews.BaseView">
|
||||
<summary>
|
||||
Infrastructure
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.RazorViews.BaseView.Context">
|
||||
<summary>
|
||||
The request context
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.RazorViews.BaseView.Request">
|
||||
<summary>
|
||||
The request
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.RazorViews.BaseView.Response">
|
||||
<summary>
|
||||
The response
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.RazorViews.BaseView.Output">
|
||||
<summary>
|
||||
The output stream
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.RazorViews.BaseView.HtmlEncoder">
|
||||
<summary>
|
||||
Html encoder used to encode content.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.RazorViews.BaseView.UrlEncoder">
|
||||
<summary>
|
||||
Url encoder used to encode content.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.RazorViews.BaseView.JavaScriptEncoder">
|
||||
<summary>
|
||||
JavaScript encoder used to encode content.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.RazorViews.BaseView.ExecuteAsync(Microsoft.AspNetCore.Http.HttpContext)">
|
||||
<summary>
|
||||
Execute an individual request
|
||||
</summary>
|
||||
<param name="context"></param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.RazorViews.BaseView.ExecuteAsync">
|
||||
<summary>
|
||||
Execute an individual request
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.RazorViews.BaseView.WriteLiteral(System.Object)">
|
||||
<summary>
|
||||
Write the given value without HTML encoding directly to <see cref="P:Microsoft.Extensions.RazorViews.BaseView.Output"/>.
|
||||
</summary>
|
||||
<param name="value">The <see cref="T:System.Object"/> to write.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.RazorViews.BaseView.WriteLiteral(System.String)">
|
||||
<summary>
|
||||
Write the given value without HTML encoding directly to <see cref="P:Microsoft.Extensions.RazorViews.BaseView.Output"/>.
|
||||
</summary>
|
||||
<param name="value">The <see cref="T:System.String"/> to write.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.RazorViews.BaseView.WriteAttribute(System.String,System.String,System.String,Microsoft.Extensions.RazorViews.AttributeValue[])">
|
||||
<summary>
|
||||
Writes the given attribute to the given writer
|
||||
</summary>
|
||||
<param name="name">The name of the attribute to write</param>
|
||||
<param name="leader">The value of the prefix</param>
|
||||
<param name="trailer">The value of the suffix</param>
|
||||
<param name="values">The <see cref="T:Microsoft.Extensions.RazorViews.AttributeValue"/>s to write.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.RazorViews.BaseView.Write(Microsoft.Extensions.RazorViews.HelperResult)">
|
||||
<summary>
|
||||
<see cref="M:Microsoft.Extensions.RazorViews.HelperResult.WriteTo(System.IO.TextWriter)"/> is invoked
|
||||
</summary>
|
||||
<param name="result">The <see cref="T:Microsoft.Extensions.RazorViews.HelperResult"/> to invoke</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.RazorViews.BaseView.Write(System.Object)">
|
||||
<summary>
|
||||
Writes the specified <paramref name="value"/> to <see cref="P:Microsoft.Extensions.RazorViews.BaseView.Output"/>.
|
||||
</summary>
|
||||
<param name="value">The <see cref="T:System.Object"/> to write.</param>
|
||||
<remarks>
|
||||
<see cref="M:Microsoft.Extensions.RazorViews.HelperResult.WriteTo(System.IO.TextWriter)"/> is invoked for <see cref="T:Microsoft.Extensions.RazorViews.HelperResult"/> types.
|
||||
For all other types, the encoded result of <see cref="M:System.Object.ToString"/> is written to
|
||||
<see cref="P:Microsoft.Extensions.RazorViews.BaseView.Output"/>.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.RazorViews.BaseView.Write(System.String)">
|
||||
<summary>
|
||||
Writes the specified <paramref name="value"/> with HTML encoding to <see cref="P:Microsoft.Extensions.RazorViews.BaseView.Output"/>.
|
||||
</summary>
|
||||
<param name="value">The <see cref="T:System.String"/> to write.</param>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.RazorViews.HelperResult">
|
||||
<summary>
|
||||
Represents a deferred write operation in a <see cref="T:Microsoft.Extensions.RazorViews.BaseView"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.RazorViews.HelperResult.#ctor(System.Action{System.IO.TextWriter})">
|
||||
<summary>
|
||||
Creates a new instance of <see cref="T:Microsoft.Extensions.RazorViews.HelperResult"/>.
|
||||
</summary>
|
||||
<param name="action">The delegate to invoke when <see cref="M:Microsoft.Extensions.RazorViews.HelperResult.WriteTo(System.IO.TextWriter)"/> is called.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.RazorViews.HelperResult.WriteTo(System.IO.TextWriter)">
|
||||
<summary>
|
||||
Method invoked to produce content from the <see cref="T:Microsoft.Extensions.RazorViews.HelperResult"/>.
|
||||
</summary>
|
||||
<param name="writer">The <see cref="T:System.IO.TextWriter"/> instance to write to.</param>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Hosting.Internal.ApplicationLifetime">
|
||||
<summary>
|
||||
Allows consumers to perform cleanup during a graceful shutdown.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Hosting.Internal.ApplicationLifetime.ApplicationStarted">
|
||||
<summary>
|
||||
Triggered when the application host has fully started and is about to wait
|
||||
for a graceful shutdown.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Hosting.Internal.ApplicationLifetime.ApplicationStopping">
|
||||
<summary>
|
||||
Triggered when the application host is performing a graceful shutdown.
|
||||
Request may still be in flight. Shutdown will block until this event completes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Hosting.Internal.ApplicationLifetime.ApplicationStopped">
|
||||
<summary>
|
||||
Triggered when the application host is performing a graceful shutdown.
|
||||
All requests should be complete at this point. Shutdown will block
|
||||
until this event completes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.Internal.ApplicationLifetime.StopApplication">
|
||||
<summary>
|
||||
Signals the ApplicationStopping event and blocks until it completes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.Internal.ApplicationLifetime.NotifyStarted">
|
||||
<summary>
|
||||
Signals the ApplicationStarted event and blocks until it completes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.Internal.ApplicationLifetime.NotifyStopped">
|
||||
<summary>
|
||||
Signals the ApplicationStopped event and blocks until it completes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Hosting.Resources.ErrorPageHtml_Title">
|
||||
<summary>
|
||||
Internal Server Error
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.Resources.FormatErrorPageHtml_Title">
|
||||
<summary>
|
||||
Internal Server Error
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Hosting.Resources.ErrorPageHtml_UnhandledException">
|
||||
<summary>
|
||||
An error occurred while starting the application.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.Resources.FormatErrorPageHtml_UnhandledException">
|
||||
<summary>
|
||||
An error occurred while starting the application.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Hosting.Resources.ErrorPageHtml_UnknownLocation">
|
||||
<summary>
|
||||
Unknown location
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.Resources.FormatErrorPageHtml_UnknownLocation">
|
||||
<summary>
|
||||
Unknown location
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Hosting.Resources.WebHostBuilder_SingleInstance">
|
||||
<summary>
|
||||
WebHostBuilder allows creation only of a single instance of WebHost
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.Resources.FormatWebHostBuilder_SingleInstance">
|
||||
<summary>
|
||||
WebHostBuilder allows creation only of a single instance of WebHost
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Hosting.Views.ErrorPageModel">
|
||||
<summary>
|
||||
Holds data to be displayed on the error page.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Hosting.Views.ErrorPageModel.ErrorDetails">
|
||||
<summary>
|
||||
Detailed information about each exception in the stack.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Hosting.WebHostBuilder">
|
||||
<summary>
|
||||
A builder for <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost"/>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.WebHostBuilder.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Microsoft.AspNetCore.Hosting.WebHostBuilder"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.WebHostBuilder.GetSetting(System.String)">
|
||||
<summary>
|
||||
Get the setting value from the configuration.
|
||||
</summary>
|
||||
<param name="key">The key of the setting to look up.</param>
|
||||
<returns>The value the setting currently contains.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.WebHostBuilder.UseSetting(System.String,System.String)">
|
||||
<summary>
|
||||
Add or replace a setting in the configuration.
|
||||
</summary>
|
||||
<param name="key">The key of the setting to add or replace.</param>
|
||||
<param name="value">The value of the setting to add or replace.</param>
|
||||
<returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.WebHostBuilder.ConfigureServices(System.Action{Microsoft.Extensions.DependencyInjection.IServiceCollection})">
|
||||
<summary>
|
||||
Adds a delegate for configuring additional services for the host or web application. This may be called
|
||||
multiple times.
|
||||
</summary>
|
||||
<param name="configureServices">A delegate for configuring the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
|
||||
<returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.WebHostBuilder.ConfigureServices(System.Action{Microsoft.AspNetCore.Hosting.WebHostBuilderContext,Microsoft.Extensions.DependencyInjection.IServiceCollection})">
|
||||
<summary>
|
||||
Adds a delegate for configuring additional services for the host or web application. This may be called
|
||||
multiple times.
|
||||
</summary>
|
||||
<param name="configureServices">A delegate for configuring the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
|
||||
<returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.WebHostBuilder.ConfigureAppConfiguration(System.Action{Microsoft.AspNetCore.Hosting.WebHostBuilderContext,Microsoft.Extensions.Configuration.IConfigurationBuilder})">
|
||||
<summary>
|
||||
Adds a delegate for configuring the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> that will construct an <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/>.
|
||||
</summary>
|
||||
<param name="configureDelegate">The delegate for configuring the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder" /> that will be used to construct an <see cref="T:Microsoft.Extensions.Configuration.IConfiguration" />.</param>
|
||||
<returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
|
||||
<remarks>
|
||||
The <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> and <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/> on the <see cref="T:Microsoft.AspNetCore.Hosting.WebHostBuilderContext"/> are uninitialized at this stage.
|
||||
The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> is pre-populated with the settings of the <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.WebHostBuilder.Build">
|
||||
<summary>
|
||||
Builds the required services and an <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost"/> which hosts a web application.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.WebHostBuilderExtensions.Configure(Microsoft.AspNetCore.Hosting.IWebHostBuilder,System.Action{Microsoft.AspNetCore.Builder.IApplicationBuilder})">
|
||||
<summary>
|
||||
Specify the startup method to be used to configure the web application.
|
||||
</summary>
|
||||
<param name="hostBuilder">The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/> to configure.</param>
|
||||
<param name="configureApp">The delegate that configures the <see cref="T:Microsoft.AspNetCore.Builder.IApplicationBuilder"/>.</param>
|
||||
<returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.WebHostBuilderExtensions.UseStartup(Microsoft.AspNetCore.Hosting.IWebHostBuilder,System.Type)">
|
||||
<summary>
|
||||
Specify the startup type to be used by the web host.
|
||||
</summary>
|
||||
<param name="hostBuilder">The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/> to configure.</param>
|
||||
<param name="startupType">The <see cref="T:System.Type"/> to be used.</param>
|
||||
<returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.WebHostBuilderExtensions.UseStartup``1(Microsoft.AspNetCore.Hosting.IWebHostBuilder)">
|
||||
<summary>
|
||||
Specify the startup type to be used by the web host.
|
||||
</summary>
|
||||
<param name="hostBuilder">The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/> to configure.</param>
|
||||
<typeparam name ="TStartup">The type containing the startup methods for the application.</typeparam>
|
||||
<returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.WebHostBuilderExtensions.UseDefaultServiceProvider(Microsoft.AspNetCore.Hosting.IWebHostBuilder,System.Action{Microsoft.Extensions.DependencyInjection.ServiceProviderOptions})">
|
||||
<summary>
|
||||
Configures the default service provider
|
||||
</summary>
|
||||
<param name="hostBuilder">The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/> to configure.</param>
|
||||
<param name="configure">A callback used to configure the <see cref="T:Microsoft.Extensions.DependencyInjection.ServiceProviderOptions"/> for the default <see cref="T:System.IServiceProvider"/>.</param>
|
||||
<returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.WebHostBuilderExtensions.UseDefaultServiceProvider(Microsoft.AspNetCore.Hosting.IWebHostBuilder,System.Action{Microsoft.AspNetCore.Hosting.WebHostBuilderContext,Microsoft.Extensions.DependencyInjection.ServiceProviderOptions})">
|
||||
<summary>
|
||||
Configures the default service provider
|
||||
</summary>
|
||||
<param name="hostBuilder">The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/> to configure.</param>
|
||||
<param name="configure">A callback used to configure the <see cref="T:Microsoft.Extensions.DependencyInjection.ServiceProviderOptions"/> for the default <see cref="T:System.IServiceProvider"/>.</param>
|
||||
<returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.WebHostBuilderExtensions.ConfigureAppConfiguration(Microsoft.AspNetCore.Hosting.IWebHostBuilder,System.Action{Microsoft.Extensions.Configuration.IConfigurationBuilder})">
|
||||
<summary>
|
||||
Adds a delegate for configuring the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> that will construct an <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/>.
|
||||
</summary>
|
||||
<param name="hostBuilder">The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/> to configure.</param>
|
||||
<param name="configureDelegate">The delegate for configuring the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder" /> that will be used to construct an <see cref="T:Microsoft.Extensions.Configuration.IConfiguration" />.</param>
|
||||
<returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
|
||||
<remarks>
|
||||
The <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> and <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/> on the <see cref="T:Microsoft.AspNetCore.Hosting.WebHostBuilderContext"/> are uninitialized at this stage.
|
||||
The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> is pre-populated with the settings of the <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.WebHostBuilderExtensions.ConfigureLogging(Microsoft.AspNetCore.Hosting.IWebHostBuilder,System.Action{Microsoft.Extensions.Logging.ILoggingBuilder})">
|
||||
<summary>
|
||||
Adds a delegate for configuring the provided <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/>. This may be called multiple times.
|
||||
</summary>
|
||||
<param name="hostBuilder">The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder" /> to configure.</param>
|
||||
<param name="configureLogging">The delegate that configures the <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/>.</param>
|
||||
<returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.WebHostBuilderExtensions.ConfigureLogging(Microsoft.AspNetCore.Hosting.IWebHostBuilder,System.Action{Microsoft.AspNetCore.Hosting.WebHostBuilderContext,Microsoft.Extensions.Logging.ILoggingBuilder})">
|
||||
<summary>
|
||||
Adds a delegate for configuring the provided <see cref="T:Microsoft.Extensions.Logging.LoggerFactory"/>. This may be called multiple times.
|
||||
</summary>
|
||||
<param name="hostBuilder">The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder" /> to configure.</param>
|
||||
<param name="configureLogging">The delegate that configures the <see cref="T:Microsoft.Extensions.Logging.LoggerFactory"/>.</param>
|
||||
<returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.WebHostExtensions.StopAsync(Microsoft.AspNetCore.Hosting.IWebHost,System.TimeSpan)">
|
||||
<summary>
|
||||
Attempts to gracefully stop the host with the given timeout.
|
||||
</summary>
|
||||
<param name="host"></param>
|
||||
<param name="timeout">The timeout for stopping gracefully. Once expired the
|
||||
server may terminate any remaining active connections.</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.WebHostExtensions.WaitForShutdown(Microsoft.AspNetCore.Hosting.IWebHost)">
|
||||
<summary>
|
||||
Block the calling thread until shutdown is triggered via Ctrl+C or SIGTERM.
|
||||
</summary>
|
||||
<param name="host">The running <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost"/>.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.WebHostExtensions.WaitForShutdownAsync(Microsoft.AspNetCore.Hosting.IWebHost,System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Returns a Task that completes when shutdown is triggered via the given token, Ctrl+C or SIGTERM.
|
||||
</summary>
|
||||
<param name="host">The running <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost"/>.</param>
|
||||
<param name="token">The token to trigger shutdown.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.WebHostExtensions.Run(Microsoft.AspNetCore.Hosting.IWebHost)">
|
||||
<summary>
|
||||
Runs a web application and block the calling thread until host shutdown.
|
||||
</summary>
|
||||
<param name="host">The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost"/> to run.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.WebHostExtensions.RunAsync(Microsoft.AspNetCore.Hosting.IWebHost,System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Runs a web application and returns a Task that only completes when the token is triggered or shutdown is triggered.
|
||||
</summary>
|
||||
<param name="host">The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost"/> to run.</param>
|
||||
<param name="token">The token to trigger shutdown.</param>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
File diff suppressed because it is too large
Load Diff
Binary file not shown.
@@ -0,0 +1,139 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.AspNetCore.Http.Extensions</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="M:Microsoft.AspNetCore.Http.Extensions.StreamCopyOperation.CopyToAsync(System.IO.Stream,System.IO.Stream,System.Nullable{System.Int64},System.Threading.CancellationToken)">
|
||||
<summary>Asynchronously reads the bytes from the source stream and writes them to another stream.</summary>
|
||||
<returns>A task that represents the asynchronous copy operation.</returns>
|
||||
<param name="source">The stream from which the contents will be copied.</param>
|
||||
<param name="destination">The stream to which the contents of the current stream will be copied.</param>
|
||||
<param name="count">The count of bytes to be copied.</param>
|
||||
<param name="cancel">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.Extensions.StreamCopyOperation.CopyToAsync(System.IO.Stream,System.IO.Stream,System.Nullable{System.Int64},System.Int32,System.Threading.CancellationToken)">
|
||||
<summary>Asynchronously reads the bytes from the source stream and writes them to another stream, using a specified buffer size.</summary>
|
||||
<returns>A task that represents the asynchronous copy operation.</returns>
|
||||
<param name="source">The stream from which the contents will be copied.</param>
|
||||
<param name="destination">The stream to which the contents of the current stream will be copied.</param>
|
||||
<param name="count">The count of bytes to be copied.</param>
|
||||
<param name="bufferSize">The size, in bytes, of the buffer. This value must be greater than zero. The default size is 4096.</param>
|
||||
<param name="cancel">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Http.Extensions.UriHelper">
|
||||
<summary>
|
||||
A helper class for constructing encoded Uris for use in headers and other Uris.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.Extensions.UriHelper.BuildRelative(Microsoft.AspNetCore.Http.PathString,Microsoft.AspNetCore.Http.PathString,Microsoft.AspNetCore.Http.QueryString,Microsoft.AspNetCore.Http.FragmentString)">
|
||||
<summary>
|
||||
Combines the given URI components into a string that is properly encoded for use in HTTP headers.
|
||||
</summary>
|
||||
<param name="pathBase">The first portion of the request path associated with application root.</param>
|
||||
<param name="path">The portion of the request path that identifies the requested resource.</param>
|
||||
<param name="query">The query, if any.</param>
|
||||
<param name="fragment">The fragment, if any.</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.Extensions.UriHelper.BuildAbsolute(System.String,Microsoft.AspNetCore.Http.HostString,Microsoft.AspNetCore.Http.PathString,Microsoft.AspNetCore.Http.PathString,Microsoft.AspNetCore.Http.QueryString,Microsoft.AspNetCore.Http.FragmentString)">
|
||||
<summary>
|
||||
Combines the given URI components into a string that is properly encoded for use in HTTP headers.
|
||||
Note that unicode in the HostString will be encoded as punycode.
|
||||
</summary>
|
||||
<param name="scheme">http, https, etc.</param>
|
||||
<param name="host">The host portion of the uri normally included in the Host header. This may include the port.</param>
|
||||
<param name="pathBase">The first portion of the request path associated with application root.</param>
|
||||
<param name="path">The portion of the request path that identifies the requested resource.</param>
|
||||
<param name="query">The query, if any.</param>
|
||||
<param name="fragment">The fragment, if any.</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.Extensions.UriHelper.FromAbsolute(System.String,System.String@,Microsoft.AspNetCore.Http.HostString@,Microsoft.AspNetCore.Http.PathString@,Microsoft.AspNetCore.Http.QueryString@,Microsoft.AspNetCore.Http.FragmentString@)">
|
||||
<summary>
|
||||
Separates the given absolute URI string into components. Assumes no PathBase.
|
||||
</summary>
|
||||
<param name="uri">A string representation of the uri.</param>
|
||||
<param name="scheme">http, https, etc.</param>
|
||||
<param name="host">The host portion of the uri normally included in the Host header. This may include the port.</param>
|
||||
<param name="path">The portion of the request path that identifies the requested resource.</param>
|
||||
<param name="query">The query, if any.</param>
|
||||
<param name="fragment">The fragment, if any.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.Extensions.UriHelper.Encode(System.Uri)">
|
||||
<summary>
|
||||
Generates a string from the given absolute or relative Uri that is appropriately encoded for use in
|
||||
HTTP headers. Note that a unicode host name will be encoded as punycode.
|
||||
</summary>
|
||||
<param name="uri">The Uri to encode.</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.Extensions.UriHelper.GetEncodedUrl(Microsoft.AspNetCore.Http.HttpRequest)">
|
||||
<summary>
|
||||
Returns the combined components of the request URL in a fully escaped form suitable for use in HTTP headers
|
||||
and other HTTP operations.
|
||||
</summary>
|
||||
<param name="request">The request to assemble the uri pieces from.</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.Extensions.UriHelper.GetEncodedPathAndQuery(Microsoft.AspNetCore.Http.HttpRequest)">
|
||||
<summary>
|
||||
Returns the relative url
|
||||
</summary>
|
||||
<param name="request">The request to assemble the uri pieces from.</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.Extensions.UriHelper.GetDisplayUrl(Microsoft.AspNetCore.Http.HttpRequest)">
|
||||
<summary>
|
||||
Returns the combined components of the request URL in a fully un-escaped form (except for the QueryString)
|
||||
suitable only for display. This format should not be used in HTTP headers or other HTTP operations.
|
||||
</summary>
|
||||
<param name="request">The request to assemble the uri pieces from.</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Http.SendFileResponseExtensions">
|
||||
<summary>
|
||||
Provides extensions for HttpResponse exposing the SendFile extension.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.SendFileResponseExtensions.SendFileAsync(Microsoft.AspNetCore.Http.HttpResponse,Microsoft.Extensions.FileProviders.IFileInfo,System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Sends the given file using the SendFile extension.
|
||||
</summary>
|
||||
<param name="response"></param>
|
||||
<param name="file">The file.</param>
|
||||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/>.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.SendFileResponseExtensions.SendFileAsync(Microsoft.AspNetCore.Http.HttpResponse,Microsoft.Extensions.FileProviders.IFileInfo,System.Int64,System.Nullable{System.Int64},System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Sends the given file using the SendFile extension.
|
||||
</summary>
|
||||
<param name="response"></param>
|
||||
<param name="file">The file.</param>
|
||||
<param name="offset">The offset in the file.</param>
|
||||
<param name="count">The number of bytes to send, or null to send the remainder of the file.</param>
|
||||
<param name="cancellationToken"></param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.SendFileResponseExtensions.SendFileAsync(Microsoft.AspNetCore.Http.HttpResponse,System.String,System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Sends the given file using the SendFile extension.
|
||||
</summary>
|
||||
<param name="response"></param>
|
||||
<param name="fileName">The full path to the file.</param>
|
||||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/>.</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.SendFileResponseExtensions.SendFileAsync(Microsoft.AspNetCore.Http.HttpResponse,System.String,System.Int64,System.Nullable{System.Int64},System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Sends the given file using the SendFile extension.
|
||||
</summary>
|
||||
<param name="response"></param>
|
||||
<param name="fileName">The full path to the file.</param>
|
||||
<param name="offset">The offset in the file.</param>
|
||||
<param name="count">The number of bytes to send, or null to send the remainder of the file.</param>
|
||||
<param name="cancellationToken"></param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1,869 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.AspNetCore.Http.Features</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.AspNetCore.Http.Features.IFeatureCollection">
|
||||
<summary>
|
||||
Represents a collection of HTTP features.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.IFeatureCollection.IsReadOnly">
|
||||
<summary>
|
||||
Indicates if the collection can be modified.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.IFeatureCollection.Revision">
|
||||
<summary>
|
||||
Incremented for each modification and can be used to verify cached results.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.IFeatureCollection.Item(System.Type)">
|
||||
<summary>
|
||||
Gets or sets a given feature. Setting a null value removes the feature.
|
||||
</summary>
|
||||
<param name="key"></param>
|
||||
<returns>The requested feature, or null if it is not present.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.Features.IFeatureCollection.Get``1">
|
||||
<summary>
|
||||
Retrieves the requested feature from the collection.
|
||||
</summary>
|
||||
<typeparam name="TFeature">The feature key.</typeparam>
|
||||
<returns>The requested feature, or null if it is not present.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.Features.IFeatureCollection.Set``1(``0)">
|
||||
<summary>
|
||||
Sets the given feature in the collection.
|
||||
</summary>
|
||||
<typeparam name="TFeature">The feature key.</typeparam>
|
||||
<param name="instance">The feature value.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.IFormFeature.HasFormContentType">
|
||||
<summary>
|
||||
Indicates if the request has a supported form content-type.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.IFormFeature.Form">
|
||||
<summary>
|
||||
The parsed form, if any.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.Features.IFormFeature.ReadForm">
|
||||
<summary>
|
||||
Parses the request body as a form.
|
||||
</summary>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.Features.IFormFeature.ReadFormAsync(System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Parses the request body as a form.
|
||||
</summary>
|
||||
<param name="cancellationToken"></param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Http.Features.IHttpBodyControlFeature">
|
||||
<summary>
|
||||
Controls the IO behavior for the <see cref="P:Microsoft.AspNetCore.Http.Features.IHttpRequestFeature.Body"/> and <see cref="P:Microsoft.AspNetCore.Http.Features.IHttpResponseFeature.Body"/>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.IHttpBodyControlFeature.AllowSynchronousIO">
|
||||
<summary>
|
||||
Gets or sets a value that controls whether synchronous IO is allowed for the <see cref="P:Microsoft.AspNetCore.Http.Features.IHttpRequestFeature.Body"/> and <see cref="P:Microsoft.AspNetCore.Http.Features.IHttpResponseFeature.Body"/>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Http.Features.IHttpConnectionFeature">
|
||||
<summary>
|
||||
Information regarding the TCP/IP connection carrying the request.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.IHttpConnectionFeature.ConnectionId">
|
||||
<summary>
|
||||
The unique identifier for the connection the request was received on. This is primarily for diagnostic purposes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.IHttpConnectionFeature.RemoteIpAddress">
|
||||
<summary>
|
||||
The IPAddress of the client making the request. Note this may be for a proxy rather than the end user.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.IHttpConnectionFeature.LocalIpAddress">
|
||||
<summary>
|
||||
The local IPAddress on which the request was received.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.IHttpConnectionFeature.RemotePort">
|
||||
<summary>
|
||||
The remote port of the client making the request.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.IHttpConnectionFeature.LocalPort">
|
||||
<summary>
|
||||
The local port on which the request was received.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Http.Features.IHttpMaxRequestBodySizeFeature">
|
||||
<summary>
|
||||
Feature to inspect and modify the maximum request body size for a single request.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.IHttpMaxRequestBodySizeFeature.IsReadOnly">
|
||||
<summary>
|
||||
Indicates whether <see cref="P:Microsoft.AspNetCore.Http.Features.IHttpMaxRequestBodySizeFeature.MaxRequestBodySize"/> is read-only.
|
||||
If true, this could mean that the request body has already been read from
|
||||
or that <see cref="M:Microsoft.AspNetCore.Http.Features.IHttpUpgradeFeature.UpgradeAsync"/> was called.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.IHttpMaxRequestBodySizeFeature.MaxRequestBodySize">
|
||||
<summary>
|
||||
The maximum allowed size of the current request body in bytes.
|
||||
When set to null, the maximum request body size is unlimited.
|
||||
This cannot be modified after the reading the request body has started.
|
||||
This limit does not affect upgraded connections which are always unlimited.
|
||||
</summary>
|
||||
<remarks>
|
||||
Defaults to the server's global max request body size limit.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Http.Features.IHttpRequestFeature">
|
||||
<summary>
|
||||
Contains the details of a given request. These properties should all be mutable.
|
||||
None of these properties should ever be set to null.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.IHttpRequestFeature.Protocol">
|
||||
<summary>
|
||||
The HTTP-version as defined in RFC 7230. E.g. "HTTP/1.1"
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.IHttpRequestFeature.Scheme">
|
||||
<summary>
|
||||
The request uri scheme. E.g. "http" or "https". Note this value is not included
|
||||
in the original request, it is inferred by checking if the transport used a TLS
|
||||
connection or not.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.IHttpRequestFeature.Method">
|
||||
<summary>
|
||||
The request method as defined in RFC 7230. E.g. "GET", "HEAD", "POST", etc..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.IHttpRequestFeature.PathBase">
|
||||
<summary>
|
||||
The first portion of the request path associated with application root. The value
|
||||
is un-escaped. The value may be string.Empty.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.IHttpRequestFeature.Path">
|
||||
<summary>
|
||||
The portion of the request path that identifies the requested resource. The value
|
||||
is un-escaped. The value may be string.Empty if <see cref="P:Microsoft.AspNetCore.Http.Features.IHttpRequestFeature.PathBase"/> contains the
|
||||
full path.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.IHttpRequestFeature.QueryString">
|
||||
<summary>
|
||||
The query portion of the request-target as defined in RFC 7230. The value
|
||||
may be string.Empty. If not empty then the leading '?' will be included. The value
|
||||
is in its original form, without un-escaping.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.IHttpRequestFeature.RawTarget">
|
||||
<summary>
|
||||
The request target as it was sent in the HTTP request. This property contains the
|
||||
raw path and full query, as well as other request targets such as * for OPTIONS
|
||||
requests (https://tools.ietf.org/html/rfc7230#section-5.3).
|
||||
</summary>
|
||||
<remarks>
|
||||
This property is not used internally for routing or authorization decisions. It has not
|
||||
been UrlDecoded and care should be taken in its use.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.IHttpRequestFeature.Headers">
|
||||
<summary>
|
||||
Headers included in the request, aggregated by header name. The values are not split
|
||||
or merged across header lines. E.g. The following headers:
|
||||
HeaderA: value1, value2
|
||||
HeaderA: value3
|
||||
Result in Headers["HeaderA"] = { "value1, value2", "value3" }
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.IHttpRequestFeature.Body">
|
||||
<summary>
|
||||
A <see cref="T:System.IO.Stream"/> representing the request body, if any. Stream.Null may be used
|
||||
to represent an empty request body.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Http.Features.IHttpRequestIdentifierFeature">
|
||||
<summary>
|
||||
Feature to identify a request.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.IHttpRequestIdentifierFeature.TraceIdentifier">
|
||||
<summary>
|
||||
Identifier to trace a request.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.IHttpRequestLifetimeFeature.RequestAborted">
|
||||
<summary>
|
||||
A <see cref="T:System.Threading.CancellationToken"/> that fires if the request is aborted and
|
||||
the application should cease processing. The token will not fire if the request
|
||||
completes successfully.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.Features.IHttpRequestLifetimeFeature.Abort">
|
||||
<summary>
|
||||
Forcefully aborts the request if it has not already completed. This will result in
|
||||
RequestAborted being triggered.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Http.Features.IHttpResponseFeature">
|
||||
<summary>
|
||||
Represents the fields and state of an HTTP response.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.IHttpResponseFeature.StatusCode">
|
||||
<summary>
|
||||
The status-code as defined in RFC 7230. The default value is 200.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.IHttpResponseFeature.ReasonPhrase">
|
||||
<summary>
|
||||
The reason-phrase as defined in RFC 7230. Note this field is no longer supported by HTTP/2.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.IHttpResponseFeature.Headers">
|
||||
<summary>
|
||||
The response headers to send. Headers with multiple values will be emitted as multiple headers.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.IHttpResponseFeature.Body">
|
||||
<summary>
|
||||
The <see cref="T:System.IO.Stream"/> for writing the response body.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.IHttpResponseFeature.HasStarted">
|
||||
<summary>
|
||||
Indicates if the response has started. If true, the <see cref="P:Microsoft.AspNetCore.Http.Features.IHttpResponseFeature.StatusCode"/>,
|
||||
<see cref="P:Microsoft.AspNetCore.Http.Features.IHttpResponseFeature.ReasonPhrase"/>, and <see cref="P:Microsoft.AspNetCore.Http.Features.IHttpResponseFeature.Headers"/> are now immutable, and
|
||||
OnStarting should no longer be called.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.Features.IHttpResponseFeature.OnStarting(System.Func{System.Object,System.Threading.Tasks.Task},System.Object)">
|
||||
<summary>
|
||||
Registers a callback to be invoked just before the response starts. This is the
|
||||
last chance to modify the <see cref="P:Microsoft.AspNetCore.Http.Features.IHttpResponseFeature.Headers"/>, <see cref="P:Microsoft.AspNetCore.Http.Features.IHttpResponseFeature.StatusCode"/>, or
|
||||
<see cref="P:Microsoft.AspNetCore.Http.Features.IHttpResponseFeature.ReasonPhrase"/>.
|
||||
</summary>
|
||||
<param name="callback">The callback to invoke when starting the response.</param>
|
||||
<param name="state">The state to pass into the callback.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.Features.IHttpResponseFeature.OnCompleted(System.Func{System.Object,System.Threading.Tasks.Task},System.Object)">
|
||||
<summary>
|
||||
Registers a callback to be invoked after a response has fully completed. This is
|
||||
intended for resource cleanup.
|
||||
</summary>
|
||||
<param name="callback">The callback to invoke after the response has completed.</param>
|
||||
<param name="state">The state to pass into the callback.</param>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Http.Features.IHttpSendFileFeature">
|
||||
<summary>
|
||||
Provides an efficient mechanism for transferring files from disk to the network.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.Features.IHttpSendFileFeature.SendFileAsync(System.String,System.Int64,System.Nullable{System.Int64},System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Sends the requested file in the response body. This may bypass the IHttpResponseFeature.Body
|
||||
<see cref="T:System.IO.Stream"/>. A response may include multiple writes.
|
||||
</summary>
|
||||
<param name="path">The full disk path to the file.</param>
|
||||
<param name="offset">The offset in the file to start at.</param>
|
||||
<param name="count">The number of bytes to send, or null to send the remainder of the file.</param>
|
||||
<param name="cancellation">A <see cref="T:System.Threading.CancellationToken"/> used to abort the transmission.</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.IHttpUpgradeFeature.IsUpgradableRequest">
|
||||
<summary>
|
||||
Indicates if the server can upgrade this request to an opaque, bidirectional stream.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.Features.IHttpUpgradeFeature.UpgradeAsync">
|
||||
<summary>
|
||||
Attempt to upgrade the request to an opaque, bidirectional stream. The response status code
|
||||
and headers need to be set before this is invoked. Check <see cref="P:Microsoft.AspNetCore.Http.Features.IHttpUpgradeFeature.IsUpgradableRequest"/>
|
||||
before invoking.
|
||||
</summary>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.IHttpWebSocketFeature.IsWebSocketRequest">
|
||||
<summary>
|
||||
Indicates if this is a WebSocket upgrade request.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.Features.IHttpWebSocketFeature.AcceptAsync(Microsoft.AspNetCore.Http.WebSocketAcceptContext)">
|
||||
<summary>
|
||||
Attempts to upgrade the request to a <see cref="T:System.Net.WebSockets.WebSocket"/>. Check <see cref="P:Microsoft.AspNetCore.Http.Features.IHttpWebSocketFeature.IsWebSocketRequest"/>
|
||||
before invoking this.
|
||||
</summary>
|
||||
<param name="context"></param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Http.Features.IResponseCookiesFeature">
|
||||
<summary>
|
||||
A helper for creating the response Set-Cookie header.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.IResponseCookiesFeature.Cookies">
|
||||
<summary>
|
||||
Gets the wrapper for the response Set-Cookie header.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.ITlsConnectionFeature.ClientCertificate">
|
||||
<summary>
|
||||
Synchronously retrieves the client certificate, if any.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.Features.ITlsConnectionFeature.GetClientCertificateAsync(System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Asynchronously retrieves the client certificate, if any.
|
||||
</summary>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Http.Features.ITlsTokenBindingFeature">
|
||||
<summary>
|
||||
Provides information regarding TLS token binding parameters.
|
||||
</summary>
|
||||
<remarks>
|
||||
TLS token bindings help mitigate the risk of impersonation by an attacker in the
|
||||
event an authenticated client's bearer tokens are somehow exfiltrated from the
|
||||
client's machine. See https://datatracker.ietf.org/doc/draft-popov-token-binding/
|
||||
for more information.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.Features.ITlsTokenBindingFeature.GetProvidedTokenBindingId">
|
||||
<summary>
|
||||
Gets the 'provided' token binding identifier associated with the request.
|
||||
</summary>
|
||||
<returns>The token binding identifier, or null if the client did not
|
||||
supply a 'provided' token binding or valid proof of possession of the
|
||||
associated private key. The caller should treat this identifier as an
|
||||
opaque blob and should not try to parse it.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.Features.ITlsTokenBindingFeature.GetReferredTokenBindingId">
|
||||
<summary>
|
||||
Gets the 'referred' token binding identifier associated with the request.
|
||||
</summary>
|
||||
<returns>The token binding identifier, or null if the client did not
|
||||
supply a 'referred' token binding or valid proof of possession of the
|
||||
associated private key. The caller should treat this identifier as an
|
||||
opaque blob and should not try to parse it.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Http.Features.ITrackingConsentFeature">
|
||||
<summary>
|
||||
Used to query, grant, and withdraw user consent regarding the storage of user
|
||||
information related to site activity and functionality.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.ITrackingConsentFeature.IsConsentNeeded">
|
||||
<summary>
|
||||
Indicates if consent is required for the given request.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.ITrackingConsentFeature.HasConsent">
|
||||
<summary>
|
||||
Indicates if consent was given.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.ITrackingConsentFeature.CanTrack">
|
||||
<summary>
|
||||
Indicates either if consent has been given or if consent is not required.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.Features.ITrackingConsentFeature.GrantConsent">
|
||||
<summary>
|
||||
Grants consent for this request. If the response has not yet started then
|
||||
this will also grant consent for future requests.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.Features.ITrackingConsentFeature.WithdrawConsent">
|
||||
<summary>
|
||||
Withdraws consent for this request. If the response has not yet started then
|
||||
this will also withdraw consent for future requests.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.Features.ITrackingConsentFeature.CreateConsentCookie">
|
||||
<summary>
|
||||
Creates a consent cookie for use when granting consent from a javascript client.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Http.CookieOptions">
|
||||
<summary>
|
||||
Options used to create a new cookie.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.CookieOptions.#ctor">
|
||||
<summary>
|
||||
Creates a default cookie with a path of '/'.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.CookieOptions.Domain">
|
||||
<summary>
|
||||
Gets or sets the domain to associate the cookie with.
|
||||
</summary>
|
||||
<returns>The domain to associate the cookie with.</returns>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.CookieOptions.Path">
|
||||
<summary>
|
||||
Gets or sets the cookie path.
|
||||
</summary>
|
||||
<returns>The cookie path.</returns>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.CookieOptions.Expires">
|
||||
<summary>
|
||||
Gets or sets the expiration date and time for the cookie.
|
||||
</summary>
|
||||
<returns>The expiration date and time for the cookie.</returns>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.CookieOptions.Secure">
|
||||
<summary>
|
||||
Gets or sets a value that indicates whether to transmit the cookie using Secure Sockets Layer (SSL)--that is, over HTTPS only.
|
||||
</summary>
|
||||
<returns>true to transmit the cookie only over an SSL connection (HTTPS); otherwise, false.</returns>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.CookieOptions.SameSite">
|
||||
<summary>
|
||||
Gets or sets the value for the SameSite attribute of the cookie. The default value is <see cref="F:Microsoft.AspNetCore.Http.SameSiteMode.Lax"/>
|
||||
</summary>
|
||||
<returns>The <see cref="T:Microsoft.AspNetCore.Http.SameSiteMode"/> representing the enforcement mode of the cookie.</returns>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.CookieOptions.HttpOnly">
|
||||
<summary>
|
||||
Gets or sets a value that indicates whether a cookie is accessible by client-side script.
|
||||
</summary>
|
||||
<returns>true if a cookie must not be accessible by client-side script; otherwise, false.</returns>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.CookieOptions.MaxAge">
|
||||
<summary>
|
||||
Gets or sets the max-age for the cookie.
|
||||
</summary>
|
||||
<returns>The max-age date and time for the cookie.</returns>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.CookieOptions.IsEssential">
|
||||
<summary>
|
||||
Indicates if this cookie is essential for the application to function correctly. If true then
|
||||
consent policy checks may be bypassed. The default value is false.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Http.IFormCollection">
|
||||
<summary>
|
||||
Represents the parsed form values sent with the HttpRequest.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.IFormCollection.Count">
|
||||
<summary>
|
||||
Gets the number of elements contained in the <see cref="T:Microsoft.AspNetCore.Http.IFormCollection" />.
|
||||
</summary>
|
||||
<returns>
|
||||
The number of elements contained in the <see cref="T:Microsoft.AspNetCore.Http.IFormCollection" />.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.IFormCollection.Keys">
|
||||
<summary>
|
||||
Gets an <see cref="T:System.Collections.Generic.ICollection`1" /> containing the keys of the
|
||||
<see cref="T:Microsoft.AspNetCore.Http.IFormCollection" />.
|
||||
</summary>
|
||||
<returns>
|
||||
An <see cref="T:System.Collections.Generic.ICollection`1" /> containing the keys of the object
|
||||
that implements <see cref="T:Microsoft.AspNetCore.Http.IFormCollection" />.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.IFormCollection.ContainsKey(System.String)">
|
||||
<summary>
|
||||
Determines whether the <see cref="T:Microsoft.AspNetCore.Http.IFormCollection" /> contains an element
|
||||
with the specified key.
|
||||
</summary>
|
||||
<param name="key">
|
||||
The key to locate in the <see cref="T:Microsoft.AspNetCore.Http.IFormCollection" />.
|
||||
</param>
|
||||
<returns>
|
||||
true if the <see cref="T:Microsoft.AspNetCore.Http.IFormCollection" /> contains an element with
|
||||
the key; otherwise, false.
|
||||
</returns>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
key is null.
|
||||
</exception>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.IFormCollection.TryGetValue(System.String,Microsoft.Extensions.Primitives.StringValues@)">
|
||||
<summary>
|
||||
Gets the value associated with the specified key.
|
||||
</summary>
|
||||
<param name="key">
|
||||
The key of the value to get.
|
||||
</param>
|
||||
<param name="value">
|
||||
The key of the value to get.
|
||||
When this method returns, the value associated with the specified key, if the
|
||||
key is found; otherwise, the default value for the type of the value parameter.
|
||||
This parameter is passed uninitialized.
|
||||
</param>
|
||||
<returns>
|
||||
true if the object that implements <see cref="T:Microsoft.AspNetCore.Http.IFormCollection" /> contains
|
||||
an element with the specified key; otherwise, false.
|
||||
</returns>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
key is null.
|
||||
</exception>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.IFormCollection.Item(System.String)">
|
||||
<summary>
|
||||
Gets the value with the specified key.
|
||||
</summary>
|
||||
<param name="key">
|
||||
The key of the value to get.
|
||||
</param>
|
||||
<returns>
|
||||
The element with the specified key, or <c>StringValues.Empty</c> if the key is not present.
|
||||
</returns>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
key is null.
|
||||
</exception>
|
||||
<remarks>
|
||||
<see cref="T:Microsoft.AspNetCore.Http.IFormCollection" /> has a different indexer contract than
|
||||
<see cref="T:System.Collections.Generic.IDictionary`2" />, as it will return <c>StringValues.Empty</c> for missing entries
|
||||
rather than throwing an Exception.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.IFormCollection.Files">
|
||||
<summary>
|
||||
The file collection sent with the request.
|
||||
</summary>
|
||||
<returns>The files included with the request.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Http.IFormFile">
|
||||
<summary>
|
||||
Represents a file sent with the HttpRequest.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.IFormFile.ContentType">
|
||||
<summary>
|
||||
Gets the raw Content-Type header of the uploaded file.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.IFormFile.ContentDisposition">
|
||||
<summary>
|
||||
Gets the raw Content-Disposition header of the uploaded file.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.IFormFile.Headers">
|
||||
<summary>
|
||||
Gets the header dictionary of the uploaded file.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.IFormFile.Length">
|
||||
<summary>
|
||||
Gets the file length in bytes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.IFormFile.Name">
|
||||
<summary>
|
||||
Gets the form field name from the Content-Disposition header.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.IFormFile.FileName">
|
||||
<summary>
|
||||
Gets the file name from the Content-Disposition header.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.IFormFile.OpenReadStream">
|
||||
<summary>
|
||||
Opens the request stream for reading the uploaded file.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.IFormFile.CopyTo(System.IO.Stream)">
|
||||
<summary>
|
||||
Copies the contents of the uploaded file to the <paramref name="target"/> stream.
|
||||
</summary>
|
||||
<param name="target">The stream to copy the file contents to.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.IFormFile.CopyToAsync(System.IO.Stream,System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Asynchronously copies the contents of the uploaded file to the <paramref name="target"/> stream.
|
||||
</summary>
|
||||
<param name="target">The stream to copy the file contents to.</param>
|
||||
<param name="cancellationToken"></param>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Http.IFormFileCollection">
|
||||
<summary>
|
||||
Represents the collection of files sent with the HttpRequest.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Http.IHeaderDictionary">
|
||||
<summary>
|
||||
Represents HttpRequest and HttpResponse headers
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.IHeaderDictionary.Item(System.String)">
|
||||
<summary>
|
||||
IHeaderDictionary has a different indexer contract than IDictionary, where it will return StringValues.Empty for missing entries.
|
||||
</summary>
|
||||
<param name="key"></param>
|
||||
<returns>The stored value, or StringValues.Empty if the key is not present.</returns>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.IHeaderDictionary.ContentLength">
|
||||
<summary>
|
||||
Strongly typed access to the Content-Length header. Implementations must keep this in sync with the string representation.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Http.IQueryCollection">
|
||||
<summary>
|
||||
Represents the HttpRequest query string collection
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.IQueryCollection.Count">
|
||||
<summary>
|
||||
Gets the number of elements contained in the <see cref="T:Microsoft.AspNetCore.Http.IQueryCollection" />.
|
||||
</summary>
|
||||
<returns>
|
||||
The number of elements contained in the <see cref="T:Microsoft.AspNetCore.Http.IQueryCollection" />.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.IQueryCollection.Keys">
|
||||
<summary>
|
||||
Gets an <see cref="T:System.Collections.Generic.ICollection`1" /> containing the keys of the
|
||||
<see cref="T:Microsoft.AspNetCore.Http.IQueryCollection" />.
|
||||
</summary>
|
||||
<returns>
|
||||
An <see cref="T:System.Collections.Generic.ICollection`1" /> containing the keys of the object
|
||||
that implements <see cref="T:Microsoft.AspNetCore.Http.IQueryCollection" />.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.IQueryCollection.ContainsKey(System.String)">
|
||||
<summary>
|
||||
Determines whether the <see cref="T:Microsoft.AspNetCore.Http.IQueryCollection" /> contains an element
|
||||
with the specified key.
|
||||
</summary>
|
||||
<param name="key">
|
||||
The key to locate in the <see cref="T:Microsoft.AspNetCore.Http.IQueryCollection" />.
|
||||
</param>
|
||||
<returns>
|
||||
true if the <see cref="T:Microsoft.AspNetCore.Http.IQueryCollection" /> contains an element with
|
||||
the key; otherwise, false.
|
||||
</returns>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
key is null.
|
||||
</exception>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.IQueryCollection.TryGetValue(System.String,Microsoft.Extensions.Primitives.StringValues@)">
|
||||
<summary>
|
||||
Gets the value associated with the specified key.
|
||||
</summary>
|
||||
<param name="key">
|
||||
The key of the value to get.
|
||||
</param>
|
||||
<param name="value">
|
||||
The key of the value to get.
|
||||
When this method returns, the value associated with the specified key, if the
|
||||
key is found; otherwise, the default value for the type of the value parameter.
|
||||
This parameter is passed uninitialized.
|
||||
</param>
|
||||
<returns>
|
||||
true if the object that implements <see cref="T:Microsoft.AspNetCore.Http.IQueryCollection" /> contains
|
||||
an element with the specified key; otherwise, false.
|
||||
</returns>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
key is null.
|
||||
</exception>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.IQueryCollection.Item(System.String)">
|
||||
<summary>
|
||||
Gets the value with the specified key.
|
||||
</summary>
|
||||
<param name="key">
|
||||
The key of the value to get.
|
||||
</param>
|
||||
<returns>
|
||||
The element with the specified key, or <c>StringValues.Empty</c> if the key is not present.
|
||||
</returns>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
key is null.
|
||||
</exception>
|
||||
<remarks>
|
||||
<see cref="T:Microsoft.AspNetCore.Http.IQueryCollection" /> has a different indexer contract than
|
||||
<see cref="T:System.Collections.Generic.IDictionary`2" />, as it will return <c>StringValues.Empty</c> for missing entries
|
||||
rather than throwing an Exception.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Http.IRequestCookieCollection">
|
||||
<summary>
|
||||
Represents the HttpRequest cookie collection
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.IRequestCookieCollection.Count">
|
||||
<summary>
|
||||
Gets the number of elements contained in the <see cref="T:Microsoft.AspNetCore.Http.IRequestCookieCollection" />.
|
||||
</summary>
|
||||
<returns>
|
||||
The number of elements contained in the <see cref="T:Microsoft.AspNetCore.Http.IRequestCookieCollection" />.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.IRequestCookieCollection.Keys">
|
||||
<summary>
|
||||
Gets an <see cref="T:System.Collections.Generic.ICollection`1" /> containing the keys of the
|
||||
<see cref="T:Microsoft.AspNetCore.Http.IRequestCookieCollection" />.
|
||||
</summary>
|
||||
<returns>
|
||||
An <see cref="T:System.Collections.Generic.ICollection`1" /> containing the keys of the object
|
||||
that implements <see cref="T:Microsoft.AspNetCore.Http.IRequestCookieCollection" />.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.IRequestCookieCollection.ContainsKey(System.String)">
|
||||
<summary>
|
||||
Determines whether the <see cref="T:Microsoft.AspNetCore.Http.IRequestCookieCollection" /> contains an element
|
||||
with the specified key.
|
||||
</summary>
|
||||
<param name="key">
|
||||
The key to locate in the <see cref="T:Microsoft.AspNetCore.Http.IRequestCookieCollection" />.
|
||||
</param>
|
||||
<returns>
|
||||
true if the <see cref="T:Microsoft.AspNetCore.Http.IRequestCookieCollection" /> contains an element with
|
||||
the key; otherwise, false.
|
||||
</returns>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
key is null.
|
||||
</exception>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.IRequestCookieCollection.TryGetValue(System.String,System.String@)">
|
||||
<summary>
|
||||
Gets the value associated with the specified key.
|
||||
</summary>
|
||||
<param name="key">
|
||||
The key of the value to get.
|
||||
</param>
|
||||
<param name="value">
|
||||
The key of the value to get.
|
||||
When this method returns, the value associated with the specified key, if the
|
||||
key is found; otherwise, the default value for the type of the value parameter.
|
||||
This parameter is passed uninitialized.
|
||||
</param>
|
||||
<returns>
|
||||
true if the object that implements <see cref="T:Microsoft.AspNetCore.Http.IRequestCookieCollection" /> contains
|
||||
an element with the specified key; otherwise, false.
|
||||
</returns>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
key is null.
|
||||
</exception>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.IRequestCookieCollection.Item(System.String)">
|
||||
<summary>
|
||||
Gets the value with the specified key.
|
||||
</summary>
|
||||
<param name="key">
|
||||
The key of the value to get.
|
||||
</param>
|
||||
<returns>
|
||||
The element with the specified key, or <c>string.Empty</c> if the key is not present.
|
||||
</returns>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
key is null.
|
||||
</exception>
|
||||
<remarks>
|
||||
<see cref="T:Microsoft.AspNetCore.Http.IRequestCookieCollection" /> has a different indexer contract than
|
||||
<see cref="T:System.Collections.Generic.IDictionary`2" />, as it will return <c>string.Empty</c> for missing entries
|
||||
rather than throwing an Exception.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Http.IResponseCookies">
|
||||
<summary>
|
||||
A wrapper for the response Set-Cookie header.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.IResponseCookies.Append(System.String,System.String)">
|
||||
<summary>
|
||||
Add a new cookie and value.
|
||||
</summary>
|
||||
<param name="key">Name of the new cookie.</param>
|
||||
<param name="value">Value of the new cookie.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.IResponseCookies.Append(System.String,System.String,Microsoft.AspNetCore.Http.CookieOptions)">
|
||||
<summary>
|
||||
Add a new cookie.
|
||||
</summary>
|
||||
<param name="key">Name of the new cookie.</param>
|
||||
<param name="value">Value of the new cookie.</param>
|
||||
<param name="options"><see cref="T:Microsoft.AspNetCore.Http.CookieOptions"/> included in the new cookie setting.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.IResponseCookies.Delete(System.String)">
|
||||
<summary>
|
||||
Sets an expired cookie.
|
||||
</summary>
|
||||
<param name="key">Name of the cookie to expire.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.IResponseCookies.Delete(System.String,Microsoft.AspNetCore.Http.CookieOptions)">
|
||||
<summary>
|
||||
Sets an expired cookie.
|
||||
</summary>
|
||||
<param name="key">Name of the cookie to expire.</param>
|
||||
<param name="options">
|
||||
<see cref="T:Microsoft.AspNetCore.Http.CookieOptions"/> used to discriminate the particular cookie to expire. The
|
||||
<see cref="P:Microsoft.AspNetCore.Http.CookieOptions.Domain"/> and <see cref="P:Microsoft.AspNetCore.Http.CookieOptions.Path"/> values are especially important.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.ISession.IsAvailable">
|
||||
<summary>
|
||||
Indicate whether the current session has loaded.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.ISession.Id">
|
||||
<summary>
|
||||
A unique identifier for the current session. This is not the same as the session cookie
|
||||
since the cookie lifetime may not be the same as the session entry lifetime in the data store.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.ISession.Keys">
|
||||
<summary>
|
||||
Enumerates all the keys, if any.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.ISession.LoadAsync(System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Load the session from the data store. This may throw if the data store is unavailable.
|
||||
</summary>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.ISession.CommitAsync(System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Store the session in the data store. This may throw if the data store is unavailable.
|
||||
</summary>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.ISession.TryGetValue(System.String,System.Byte[]@)">
|
||||
<summary>
|
||||
Retrieve the value of the given key, if present.
|
||||
</summary>
|
||||
<param name="key"></param>
|
||||
<param name="value"></param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.ISession.Set(System.String,System.Byte[])">
|
||||
<summary>
|
||||
Set the given key and value in the current session. This will throw if the session
|
||||
was not established prior to sending the response.
|
||||
</summary>
|
||||
<param name="key"></param>
|
||||
<param name="value"></param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.ISession.Remove(System.String)">
|
||||
<summary>
|
||||
Remove the given key from the session if present.
|
||||
</summary>
|
||||
<param name="key"></param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.ISession.Clear">
|
||||
<summary>
|
||||
Remove all entries from the current session, if any.
|
||||
The session cookie is not removed.
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1,513 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.AspNetCore.Http</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.DependencyInjection.HttpServiceCollectionExtensions">
|
||||
<summary>
|
||||
Extension methods for configuring HttpContext services.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.HttpServiceCollectionExtensions.AddHttpContextAccessor(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
|
||||
<summary>
|
||||
Adds a default implementation for the <see cref="T:Microsoft.AspNetCore.Http.IHttpContextAccessor"/> service.
|
||||
</summary>
|
||||
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
|
||||
<returns>The service collection.</returns>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.DefaultHttpContext.Authentication">
|
||||
<summary>
|
||||
This is obsolete and will be removed in a future version.
|
||||
The recommended alternative is to use Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions.
|
||||
See https://go.microsoft.com/fwlink/?linkid=845470.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Http.HttpRequestRewindExtensions">
|
||||
<summary>
|
||||
Extension methods for enabling buffering in an <see cref="T:Microsoft.AspNetCore.Http.HttpRequest"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.HttpRequestRewindExtensions.EnableBuffering(Microsoft.AspNetCore.Http.HttpRequest)">
|
||||
<summary>
|
||||
Ensure the <paramref name="request"/> <see cref="P:Microsoft.AspNetCore.Http.HttpRequest.Body"/> can be read multiple times. Normally
|
||||
buffers request bodies in memory; writes requests larger than 30K bytes to disk.
|
||||
</summary>
|
||||
<param name="request">The <see cref="T:Microsoft.AspNetCore.Http.HttpRequest"/> to prepare.</param>
|
||||
<remarks>
|
||||
Temporary files for larger requests are written to the location named in the <c>ASPNETCORE_TEMP</c>
|
||||
environment variable, if any. If that environment variable is not defined, these files are written to the
|
||||
current user's temporary folder. Files are automatically deleted at the end of their associated requests.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.HttpRequestRewindExtensions.EnableBuffering(Microsoft.AspNetCore.Http.HttpRequest,System.Int32)">
|
||||
<summary>
|
||||
Ensure the <paramref name="request"/> <see cref="P:Microsoft.AspNetCore.Http.HttpRequest.Body"/> can be read multiple times. Normally
|
||||
buffers request bodies in memory; writes requests larger than <paramref name="bufferThreshold"/> bytes to
|
||||
disk.
|
||||
</summary>
|
||||
<param name="request">The <see cref="T:Microsoft.AspNetCore.Http.HttpRequest"/> to prepare.</param>
|
||||
<param name="bufferThreshold">
|
||||
The maximum size in bytes of the in-memory <see cref="T:System.Buffers.ArrayPool`1"/> used to buffer the
|
||||
stream. Larger request bodies are written to disk.
|
||||
</param>
|
||||
<remarks>
|
||||
Temporary files for larger requests are written to the location named in the <c>ASPNETCORE_TEMP</c>
|
||||
environment variable, if any. If that environment variable is not defined, these files are written to the
|
||||
current user's temporary folder. Files are automatically deleted at the end of their associated requests.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.HttpRequestRewindExtensions.EnableBuffering(Microsoft.AspNetCore.Http.HttpRequest,System.Int64)">
|
||||
<summary>
|
||||
Ensure the <paramref name="request"/> <see cref="P:Microsoft.AspNetCore.Http.HttpRequest.Body"/> can be read multiple times. Normally
|
||||
buffers request bodies in memory; writes requests larger than 30K bytes to disk.
|
||||
</summary>
|
||||
<param name="request">The <see cref="T:Microsoft.AspNetCore.Http.HttpRequest"/> to prepare.</param>
|
||||
<param name="bufferLimit">
|
||||
The maximum size in bytes of the request body. An attempt to read beyond this limit will cause an
|
||||
<see cref="T:System.IO.IOException"/>.
|
||||
</param>
|
||||
<remarks>
|
||||
Temporary files for larger requests are written to the location named in the <c>ASPNETCORE_TEMP</c>
|
||||
environment variable, if any. If that environment variable is not defined, these files are written to the
|
||||
current user's temporary folder. Files are automatically deleted at the end of their associated requests.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.HttpRequestRewindExtensions.EnableBuffering(Microsoft.AspNetCore.Http.HttpRequest,System.Int32,System.Int64)">
|
||||
<summary>
|
||||
Ensure the <paramref name="request"/> <see cref="P:Microsoft.AspNetCore.Http.HttpRequest.Body"/> can be read multiple times. Normally
|
||||
buffers request bodies in memory; writes requests larger than <paramref name="bufferThreshold"/> bytes to
|
||||
disk.
|
||||
</summary>
|
||||
<param name="request">The <see cref="T:Microsoft.AspNetCore.Http.HttpRequest"/> to prepare.</param>
|
||||
<param name="bufferThreshold">
|
||||
The maximum size in bytes of the in-memory <see cref="T:System.Buffers.ArrayPool`1"/> used to buffer the
|
||||
stream. Larger request bodies are written to disk.
|
||||
</param>
|
||||
<param name="bufferLimit">
|
||||
The maximum size in bytes of the request body. An attempt to read beyond this limit will cause an
|
||||
<see cref="T:System.IO.IOException"/>.
|
||||
</param>
|
||||
<remarks>
|
||||
Temporary files for larger requests are written to the location named in the <c>ASPNETCORE_TEMP</c>
|
||||
environment variable, if any. If that environment variable is not defined, these files are written to the
|
||||
current user's temporary folder. Files are automatically deleted at the end of their associated requests.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Http.Features.DefaultSessionFeature">
|
||||
<summary>
|
||||
This type exists only for the purpose of unit testing where the user can directly set the
|
||||
<see cref="P:Microsoft.AspNetCore.Http.HttpContext.Session"/> property without the need for creating a <see cref="T:Microsoft.AspNetCore.Http.Features.ISessionFeature"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.FormOptions.BufferBody">
|
||||
<summary>
|
||||
Enables full request body buffering. Use this if multiple components need to read the raw stream.
|
||||
The default value is false.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.FormOptions.MemoryBufferThreshold">
|
||||
<summary>
|
||||
If <see cref="P:Microsoft.AspNetCore.Http.Features.FormOptions.BufferBody"/> is enabled, this many bytes of the body will be buffered in memory.
|
||||
If this threshold is exceeded then the buffer will be moved to a temp file on disk instead.
|
||||
This also applies when buffering individual multipart section bodies.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.FormOptions.BufferBodyLengthLimit">
|
||||
<summary>
|
||||
If <see cref="P:Microsoft.AspNetCore.Http.Features.FormOptions.BufferBody"/> is enabled, this is the limit for the total number of bytes that will
|
||||
be buffered. Forms that exceed this limit will throw an <see cref="T:System.IO.InvalidDataException"/> when parsed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.FormOptions.ValueCountLimit">
|
||||
<summary>
|
||||
A limit for the number of form entries to allow.
|
||||
Forms that exceed this limit will throw an <see cref="T:System.IO.InvalidDataException"/> when parsed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.FormOptions.KeyLengthLimit">
|
||||
<summary>
|
||||
A limit on the length of individual keys. Forms containing keys that exceed this limit will
|
||||
throw an <see cref="T:System.IO.InvalidDataException"/> when parsed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.FormOptions.ValueLengthLimit">
|
||||
<summary>
|
||||
A limit on the length of individual form values. Forms containing values that exceed this
|
||||
limit will throw an <see cref="T:System.IO.InvalidDataException"/> when parsed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.FormOptions.MultipartBoundaryLengthLimit">
|
||||
<summary>
|
||||
A limit for the length of the boundary identifier. Forms with boundaries that exceed this
|
||||
limit will throw an <see cref="T:System.IO.InvalidDataException"/> when parsed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.FormOptions.MultipartHeadersCountLimit">
|
||||
<summary>
|
||||
A limit for the number of headers to allow in each multipart section. Headers with the same name will
|
||||
be combined. Form sections that exceed this limit will throw an <see cref="T:System.IO.InvalidDataException"/>
|
||||
when parsed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.FormOptions.MultipartHeadersLengthLimit">
|
||||
<summary>
|
||||
A limit for the total length of the header keys and values in each multipart section.
|
||||
Form sections that exceed this limit will throw an <see cref="T:System.IO.InvalidDataException"/> when parsed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.FormOptions.MultipartBodyLengthLimit">
|
||||
<summary>
|
||||
A limit for the length of each multipart body. Forms sections that exceed this limit will throw an
|
||||
<see cref="T:System.IO.InvalidDataException"/> when parsed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Http.Features.ResponseCookiesFeature">
|
||||
<summary>
|
||||
Default implementation of <see cref="T:Microsoft.AspNetCore.Http.Features.IResponseCookiesFeature"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.Features.ResponseCookiesFeature.#ctor(Microsoft.AspNetCore.Http.Features.IFeatureCollection)">
|
||||
<summary>
|
||||
Initializes a new <see cref="T:Microsoft.AspNetCore.Http.Features.ResponseCookiesFeature"/> instance.
|
||||
</summary>
|
||||
<param name="features">
|
||||
<see cref="T:Microsoft.AspNetCore.Http.Features.IFeatureCollection"/> containing all defined features, including this
|
||||
<see cref="T:Microsoft.AspNetCore.Http.Features.IResponseCookiesFeature"/> and the <see cref="T:Microsoft.AspNetCore.Http.Features.IHttpResponseFeature"/>.
|
||||
</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.Features.ResponseCookiesFeature.#ctor(Microsoft.AspNetCore.Http.Features.IFeatureCollection,Microsoft.Extensions.ObjectPool.ObjectPool{System.Text.StringBuilder})">
|
||||
<summary>
|
||||
Initializes a new <see cref="T:Microsoft.AspNetCore.Http.Features.ResponseCookiesFeature"/> instance.
|
||||
</summary>
|
||||
<param name="features">
|
||||
<see cref="T:Microsoft.AspNetCore.Http.Features.IFeatureCollection"/> containing all defined features, including this
|
||||
<see cref="T:Microsoft.AspNetCore.Http.Features.IResponseCookiesFeature"/> and the <see cref="T:Microsoft.AspNetCore.Http.Features.IHttpResponseFeature"/>.
|
||||
</param>
|
||||
<param name="builderPool">The <see cref="T:Microsoft.Extensions.ObjectPool.ObjectPool`1"/>, if available.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.ResponseCookiesFeature.Cookies">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Http.FormCollection">
|
||||
<summary>
|
||||
Contains the parsed form values.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.FormCollection.Item(System.String)">
|
||||
<summary>
|
||||
Get or sets the associated value from the collection as a single string.
|
||||
</summary>
|
||||
<param name="key">The header name.</param>
|
||||
<returns>the associated value from the collection as a StringValues or StringValues.Empty if the key is not present.</returns>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.FormCollection.Count">
|
||||
<summary>
|
||||
Gets the number of elements contained in the <see cref="T:Microsoft.AspNetCore.Http.HeaderDictionary" />;.
|
||||
</summary>
|
||||
<returns>The number of elements contained in the <see cref="T:Microsoft.AspNetCore.Http.HeaderDictionary" />.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.FormCollection.ContainsKey(System.String)">
|
||||
<summary>
|
||||
Determines whether the <see cref="T:Microsoft.AspNetCore.Http.HeaderDictionary" /> contains a specific key.
|
||||
</summary>
|
||||
<param name="key">The key.</param>
|
||||
<returns>true if the <see cref="T:Microsoft.AspNetCore.Http.HeaderDictionary" /> contains a specific key; otherwise, false.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.FormCollection.TryGetValue(System.String,Microsoft.Extensions.Primitives.StringValues@)">
|
||||
<summary>
|
||||
Retrieves a value from the dictionary.
|
||||
</summary>
|
||||
<param name="key">The header name.</param>
|
||||
<param name="value">The value.</param>
|
||||
<returns>true if the <see cref="T:Microsoft.AspNetCore.Http.HeaderDictionary" /> contains the key; otherwise, false.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.FormCollection.GetEnumerator">
|
||||
<summary>
|
||||
Returns an struct enumerator that iterates through a collection without boxing and is also used via the <see cref="T:Microsoft.AspNetCore.Http.IFormCollection" /> interface.
|
||||
</summary>
|
||||
<returns>An <see cref="T:Microsoft.AspNetCore.Http.FormCollection.Enumerator" /> object that can be used to iterate through the collection.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.FormCollection.System#Collections#Generic#IEnumerable{System#Collections#Generic#KeyValuePair{System#String,Microsoft#Extensions#Primitives#StringValues}}#GetEnumerator">
|
||||
<summary>
|
||||
Returns an enumerator that iterates through a collection, boxes in non-empty path.
|
||||
</summary>
|
||||
<returns>An <see cref="T:System.Collections.IEnumerator" /> object that can be used to iterate through the collection.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.FormCollection.System#Collections#IEnumerable#GetEnumerator">
|
||||
<summary>
|
||||
Returns an enumerator that iterates through a collection, boxes in non-empty path.
|
||||
</summary>
|
||||
<returns>An <see cref="T:System.Collections.IEnumerator" /> object that can be used to iterate through the collection.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Http.HeaderDictionary">
|
||||
<summary>
|
||||
Represents a wrapper for RequestHeaders and ResponseHeaders.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.HeaderDictionary.Item(System.String)">
|
||||
<summary>
|
||||
Get or sets the associated value from the collection as a single string.
|
||||
</summary>
|
||||
<param name="key">The header name.</param>
|
||||
<returns>the associated value from the collection as a StringValues or StringValues.Empty if the key is not present.</returns>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.HeaderDictionary.System#Collections#Generic#IDictionary{System#String,Microsoft#Extensions#Primitives#StringValues}#Item(System.String)">
|
||||
<summary>
|
||||
Throws KeyNotFoundException if the key is not present.
|
||||
</summary>
|
||||
<param name="key">The header name.</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.HeaderDictionary.Count">
|
||||
<summary>
|
||||
Gets the number of elements contained in the <see cref="T:Microsoft.AspNetCore.Http.HeaderDictionary" />;.
|
||||
</summary>
|
||||
<returns>The number of elements contained in the <see cref="T:Microsoft.AspNetCore.Http.HeaderDictionary" />.</returns>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.HeaderDictionary.IsReadOnly">
|
||||
<summary>
|
||||
Gets a value that indicates whether the <see cref="T:Microsoft.AspNetCore.Http.HeaderDictionary" /> is in read-only mode.
|
||||
</summary>
|
||||
<returns>true if the <see cref="T:Microsoft.AspNetCore.Http.HeaderDictionary" /> is in read-only mode; otherwise, false.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.HeaderDictionary.Add(System.Collections.Generic.KeyValuePair{System.String,Microsoft.Extensions.Primitives.StringValues})">
|
||||
<summary>
|
||||
Adds a new list of items to the collection.
|
||||
</summary>
|
||||
<param name="item">The item to add.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.HeaderDictionary.Add(System.String,Microsoft.Extensions.Primitives.StringValues)">
|
||||
<summary>
|
||||
Adds the given header and values to the collection.
|
||||
</summary>
|
||||
<param name="key">The header name.</param>
|
||||
<param name="value">The header values.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.HeaderDictionary.Clear">
|
||||
<summary>
|
||||
Clears the entire list of objects.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.HeaderDictionary.Contains(System.Collections.Generic.KeyValuePair{System.String,Microsoft.Extensions.Primitives.StringValues})">
|
||||
<summary>
|
||||
Returns a value indicating whether the specified object occurs within this collection.
|
||||
</summary>
|
||||
<param name="item">The item.</param>
|
||||
<returns>true if the specified object occurs within this collection; otherwise, false.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.HeaderDictionary.ContainsKey(System.String)">
|
||||
<summary>
|
||||
Determines whether the <see cref="T:Microsoft.AspNetCore.Http.HeaderDictionary" /> contains a specific key.
|
||||
</summary>
|
||||
<param name="key">The key.</param>
|
||||
<returns>true if the <see cref="T:Microsoft.AspNetCore.Http.HeaderDictionary" /> contains a specific key; otherwise, false.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.HeaderDictionary.CopyTo(System.Collections.Generic.KeyValuePair{System.String,Microsoft.Extensions.Primitives.StringValues}[],System.Int32)">
|
||||
<summary>
|
||||
Copies the <see cref="T:Microsoft.AspNetCore.Http.HeaderDictionary" /> elements to a one-dimensional Array instance at the specified index.
|
||||
</summary>
|
||||
<param name="array">The one-dimensional Array that is the destination of the specified objects copied from the <see cref="T:Microsoft.AspNetCore.Http.HeaderDictionary" />.</param>
|
||||
<param name="arrayIndex">The zero-based index in <paramref name="array" /> at which copying begins.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.HeaderDictionary.Remove(System.Collections.Generic.KeyValuePair{System.String,Microsoft.Extensions.Primitives.StringValues})">
|
||||
<summary>
|
||||
Removes the given item from the the collection.
|
||||
</summary>
|
||||
<param name="item">The item.</param>
|
||||
<returns>true if the specified object was removed from the collection; otherwise, false.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.HeaderDictionary.Remove(System.String)">
|
||||
<summary>
|
||||
Removes the given header from the collection.
|
||||
</summary>
|
||||
<param name="key">The header name.</param>
|
||||
<returns>true if the specified object was removed from the collection; otherwise, false.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.HeaderDictionary.TryGetValue(System.String,Microsoft.Extensions.Primitives.StringValues@)">
|
||||
<summary>
|
||||
Retrieves a value from the dictionary.
|
||||
</summary>
|
||||
<param name="key">The header name.</param>
|
||||
<param name="value">The value.</param>
|
||||
<returns>true if the <see cref="T:Microsoft.AspNetCore.Http.HeaderDictionary" /> contains the key; otherwise, false.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.HeaderDictionary.GetEnumerator">
|
||||
<summary>
|
||||
Returns an enumerator that iterates through a collection.
|
||||
</summary>
|
||||
<returns>An <see cref="T:Microsoft.AspNetCore.Http.HeaderDictionary.Enumerator" /> object that can be used to iterate through the collection.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.HeaderDictionary.System#Collections#Generic#IEnumerable{System#Collections#Generic#KeyValuePair{System#String,Microsoft#Extensions#Primitives#StringValues}}#GetEnumerator">
|
||||
<summary>
|
||||
Returns an enumerator that iterates through a collection.
|
||||
</summary>
|
||||
<returns>An <see cref="T:System.Collections.IEnumerator" /> object that can be used to iterate through the collection.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.HeaderDictionary.System#Collections#IEnumerable#GetEnumerator">
|
||||
<summary>
|
||||
Returns an enumerator that iterates through a collection.
|
||||
</summary>
|
||||
<returns>An <see cref="T:System.Collections.IEnumerator" /> object that can be used to iterate through the collection.</returns>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Internal.DefaultConnectionInfo.Id">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Internal.FormFile.ContentDisposition">
|
||||
<summary>
|
||||
Gets the raw Content-Disposition header of the uploaded file.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Internal.FormFile.ContentType">
|
||||
<summary>
|
||||
Gets the raw Content-Type header of the uploaded file.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Internal.FormFile.Headers">
|
||||
<summary>
|
||||
Gets the header dictionary of the uploaded file.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Internal.FormFile.Length">
|
||||
<summary>
|
||||
Gets the file length in bytes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Internal.FormFile.Name">
|
||||
<summary>
|
||||
Gets the name from the Content-Disposition header.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Internal.FormFile.FileName">
|
||||
<summary>
|
||||
Gets the file name from the Content-Disposition header.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.Internal.FormFile.OpenReadStream">
|
||||
<summary>
|
||||
Opens the request stream for reading the uploaded file.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.Internal.FormFile.CopyTo(System.IO.Stream)">
|
||||
<summary>
|
||||
Copies the contents of the uploaded file to the <paramref name="target"/> stream.
|
||||
</summary>
|
||||
<param name="target">The stream to copy the file contents to.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.Internal.FormFile.CopyToAsync(System.IO.Stream,System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Asynchronously copies the contents of the uploaded file to the <paramref name="target"/> stream.
|
||||
</summary>
|
||||
<param name="target">The stream to copy the file contents to.</param>
|
||||
<param name="cancellationToken"></param>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Http.Internal.QueryCollection">
|
||||
<summary>
|
||||
The HttpRequest query string collection
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Internal.QueryCollection.Item(System.String)">
|
||||
<summary>
|
||||
Get or sets the associated value from the collection as a single string.
|
||||
</summary>
|
||||
<param name="key">The key name.</param>
|
||||
<returns>the associated value from the collection as a StringValues or StringValues.Empty if the key is not present.</returns>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Internal.QueryCollection.Count">
|
||||
<summary>
|
||||
Gets the number of elements contained in the <see cref="T:Microsoft.AspNetCore.Http.Internal.QueryCollection" />;.
|
||||
</summary>
|
||||
<returns>The number of elements contained in the <see cref="T:Microsoft.AspNetCore.Http.Internal.QueryCollection" />.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.Internal.QueryCollection.ContainsKey(System.String)">
|
||||
<summary>
|
||||
Determines whether the <see cref="T:Microsoft.AspNetCore.Http.Internal.QueryCollection" /> contains a specific key.
|
||||
</summary>
|
||||
<param name="key">The key.</param>
|
||||
<returns>true if the <see cref="T:Microsoft.AspNetCore.Http.Internal.QueryCollection" /> contains a specific key; otherwise, false.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.Internal.QueryCollection.TryGetValue(System.String,Microsoft.Extensions.Primitives.StringValues@)">
|
||||
<summary>
|
||||
Retrieves a value from the collection.
|
||||
</summary>
|
||||
<param name="key">The key.</param>
|
||||
<param name="value">The value.</param>
|
||||
<returns>true if the <see cref="T:Microsoft.AspNetCore.Http.Internal.QueryCollection" /> contains the key; otherwise, false.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.Internal.QueryCollection.GetEnumerator">
|
||||
<summary>
|
||||
Returns an enumerator that iterates through a collection.
|
||||
</summary>
|
||||
<returns>An <see cref="T:Microsoft.AspNetCore.Http.Internal.QueryCollection.Enumerator" /> object that can be used to iterate through the collection.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.Internal.QueryCollection.System#Collections#Generic#IEnumerable{System#Collections#Generic#KeyValuePair{System#String,Microsoft#Extensions#Primitives#StringValues}}#GetEnumerator">
|
||||
<summary>
|
||||
Returns an enumerator that iterates through a collection.
|
||||
</summary>
|
||||
<returns>An <see cref="T:System.Collections.Generic.IEnumerator`1" /> object that can be used to iterate through the collection.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.Internal.QueryCollection.System#Collections#IEnumerable#GetEnumerator">
|
||||
<summary>
|
||||
Returns an enumerator that iterates through a collection.
|
||||
</summary>
|
||||
<returns>An <see cref="T:System.Collections.IEnumerator" /> object that can be used to iterate through the collection.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Http.Internal.ReferenceReadStream">
|
||||
<summary>
|
||||
A Stream that wraps another stream starting at a certain offset and reading for the given length.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.Internal.RequestCookieCollection.GetEnumerator">
|
||||
<summary>
|
||||
Returns an struct enumerator that iterates through a collection without boxing.
|
||||
</summary>
|
||||
<returns>An <see cref="T:Microsoft.AspNetCore.Http.Internal.RequestCookieCollection.Enumerator" /> object that can be used to iterate through the collection.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.Internal.RequestCookieCollection.System#Collections#Generic#IEnumerable{System#Collections#Generic#KeyValuePair{System#String,System#String}}#GetEnumerator">
|
||||
<summary>
|
||||
Returns an enumerator that iterates through a collection, boxes in non-empty path.
|
||||
</summary>
|
||||
<returns>An <see cref="T:System.Collections.Generic.IEnumerator`1" /> object that can be used to iterate through the collection.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.Internal.RequestCookieCollection.System#Collections#IEnumerable#GetEnumerator">
|
||||
<summary>
|
||||
Returns an enumerator that iterates through a collection, boxes in non-empty path.
|
||||
</summary>
|
||||
<returns>An <see cref="T:System.Collections.IEnumerator" /> object that can be used to iterate through the collection.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Http.Internal.ResponseCookies">
|
||||
<summary>
|
||||
A wrapper for the response Set-Cookie header.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.Internal.ResponseCookies.#ctor(Microsoft.AspNetCore.Http.IHeaderDictionary,Microsoft.Extensions.ObjectPool.ObjectPool{System.Text.StringBuilder})">
|
||||
<summary>
|
||||
Create a new wrapper.
|
||||
</summary>
|
||||
<param name="headers">The <see cref="T:Microsoft.AspNetCore.Http.IHeaderDictionary"/> for the response.</param>
|
||||
<param name="builderPool">The <see cref="T:Microsoft.Extensions.ObjectPool.ObjectPool`1"/>, if available.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.Internal.ResponseCookies.Append(System.String,System.String)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.Internal.ResponseCookies.Append(System.String,System.String,Microsoft.AspNetCore.Http.CookieOptions)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.Internal.ResponseCookies.Delete(System.String)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.Internal.ResponseCookies.Delete(System.String,Microsoft.AspNetCore.Http.CookieOptions)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.RequestFormReaderExtensions.ReadFormAsync(Microsoft.AspNetCore.Http.HttpRequest,Microsoft.AspNetCore.Http.Features.FormOptions,System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Read the request body as a form with the given options. These options will only be used
|
||||
if the form has not already been read.
|
||||
</summary>
|
||||
<param name="request">The request.</param>
|
||||
<param name="options">Options for reading the form.</param>
|
||||
<param name="cancellationToken"></param>
|
||||
<returns>The parsed form.</returns>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1,163 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.AspNetCore.HttpOverrides</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.AspNetCore.HttpOverrides.ForwardedHeadersDefaults">
|
||||
<summary>
|
||||
Default values related to <see cref="T:Microsoft.AspNetCore.HttpOverrides.ForwardedHeadersMiddleware"/> middleware
|
||||
</summary>
|
||||
<seealso cref="T:Microsoft.AspNetCore.Builder.ForwardedHeadersOptions"/>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.HttpOverrides.ForwardedHeadersDefaults.XForwardedForHeaderName">
|
||||
<summary>
|
||||
X-Forwarded-For
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.HttpOverrides.ForwardedHeadersDefaults.XForwardedHostHeaderName">
|
||||
<summary>
|
||||
X-Forwarded-Host
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.HttpOverrides.ForwardedHeadersDefaults.XForwardedProtoHeaderName">
|
||||
<summary>
|
||||
X-Forwarded-Proto
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.HttpOverrides.ForwardedHeadersDefaults.XOriginalForHeaderName">
|
||||
<summary>
|
||||
X-Original-For
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.HttpOverrides.ForwardedHeadersDefaults.XOriginalHostHeaderName">
|
||||
<summary>
|
||||
X-Original-Host
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.HttpOverrides.ForwardedHeadersDefaults.XOriginalProtoHeaderName">
|
||||
<summary>
|
||||
X-Original-Proto
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.HttpOverrides.IPNetwork.PrefixLength">
|
||||
<summary>
|
||||
The CIDR notation of the subnet mask
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Builder.ForwardedHeadersExtensions.UseForwardedHeaders(Microsoft.AspNetCore.Builder.IApplicationBuilder)">
|
||||
<summary>
|
||||
Forwards proxied headers onto current request
|
||||
</summary>
|
||||
<param name="builder"></param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Builder.ForwardedHeadersExtensions.UseForwardedHeaders(Microsoft.AspNetCore.Builder.IApplicationBuilder,Microsoft.AspNetCore.Builder.ForwardedHeadersOptions)">
|
||||
<summary>
|
||||
Forwards proxied headers onto current request
|
||||
</summary>
|
||||
<param name="builder"></param>
|
||||
<param name="options">Enables the different forwarding options.</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Builder.ForwardedHeadersOptions.ForwardedForHeaderName">
|
||||
<summary>
|
||||
Use this header instead of <see cref="P:Microsoft.AspNetCore.HttpOverrides.ForwardedHeadersDefaults.XForwardedForHeaderName"/>
|
||||
</summary>
|
||||
<seealso cref="T:Microsoft.AspNetCore.HttpOverrides.ForwardedHeadersDefaults"/>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Builder.ForwardedHeadersOptions.ForwardedHostHeaderName">
|
||||
<summary>
|
||||
Use this header instead of <see cref="P:Microsoft.AspNetCore.HttpOverrides.ForwardedHeadersDefaults.XForwardedHostHeaderName"/>
|
||||
</summary>
|
||||
<seealso cref="T:Microsoft.AspNetCore.HttpOverrides.ForwardedHeadersDefaults"/>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Builder.ForwardedHeadersOptions.ForwardedProtoHeaderName">
|
||||
<summary>
|
||||
Use this header instead of <see cref="P:Microsoft.AspNetCore.HttpOverrides.ForwardedHeadersDefaults.XForwardedProtoHeaderName"/>
|
||||
</summary>
|
||||
<seealso cref="T:Microsoft.AspNetCore.HttpOverrides.ForwardedHeadersDefaults"/>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Builder.ForwardedHeadersOptions.OriginalForHeaderName">
|
||||
<summary>
|
||||
Use this header instead of <see cref="P:Microsoft.AspNetCore.HttpOverrides.ForwardedHeadersDefaults.XOriginalForHeaderName"/>
|
||||
</summary>
|
||||
<seealso cref="T:Microsoft.AspNetCore.HttpOverrides.ForwardedHeadersDefaults"/>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Builder.ForwardedHeadersOptions.OriginalHostHeaderName">
|
||||
<summary>
|
||||
Use this header instead of <see cref="P:Microsoft.AspNetCore.HttpOverrides.ForwardedHeadersDefaults.XOriginalHostHeaderName"/>
|
||||
</summary>
|
||||
<seealso cref="T:Microsoft.AspNetCore.HttpOverrides.ForwardedHeadersDefaults"/>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Builder.ForwardedHeadersOptions.OriginalProtoHeaderName">
|
||||
<summary>
|
||||
Use this header instead of <see cref="P:Microsoft.AspNetCore.HttpOverrides.ForwardedHeadersDefaults.XOriginalProtoHeaderName"/>
|
||||
</summary>
|
||||
<seealso cref="T:Microsoft.AspNetCore.HttpOverrides.ForwardedHeadersDefaults"/>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Builder.ForwardedHeadersOptions.ForwardedHeaders">
|
||||
<summary>
|
||||
Identifies which forwarders should be processed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Builder.ForwardedHeadersOptions.ForwardLimit">
|
||||
<summary>
|
||||
Limits the number of entries in the headers that will be processed. The default value is 1.
|
||||
Set to null to disable the limit, but this should only be done if
|
||||
KnownProxies or KnownNetworks are configured.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Builder.ForwardedHeadersOptions.KnownProxies">
|
||||
<summary>
|
||||
Addresses of known proxies to accept forwarded headers from.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Builder.ForwardedHeadersOptions.KnownNetworks">
|
||||
<summary>
|
||||
Address ranges of known proxies to accept forwarded headers from.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Builder.ForwardedHeadersOptions.AllowedHosts">
|
||||
<summary>
|
||||
The allowed values from x-forwarded-host. If the list is empty then all hosts are allowed.
|
||||
Failing to restrict this these values may allow an attacker to spoof links generated by your service.
|
||||
</summary>
|
||||
<remarks>
|
||||
<list type="bullet">
|
||||
<item><description>Port numbers must be excluded.</description></item>
|
||||
<item><description>A top level wildcard "*" allows all non-empty hosts.</description></item>
|
||||
<item><description>Subdomain wildcards are permitted. E.g. "*.example.com" matches subdomains like foo.example.com,
|
||||
but not the parent domain example.com.</description></item>
|
||||
<item><description>Unicode host names are allowed but will be converted to punycode for matching.</description></item>
|
||||
<item><description>IPv6 addresses must include their bounding brackets and be in their normalized form.</description></item>
|
||||
</list>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Builder.ForwardedHeadersOptions.RequireHeaderSymmetry">
|
||||
<summary>
|
||||
Require the number of header values to be in sync between the different headers being processed.
|
||||
The default is 'false'.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Builder.HttpMethodOverrideExtensions.UseHttpMethodOverride(Microsoft.AspNetCore.Builder.IApplicationBuilder)">
|
||||
<summary>
|
||||
Allows incoming POST request to override method type with type specified in header.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.AspNetCore.Builder.IApplicationBuilder"/> instance this method extends.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Builder.HttpMethodOverrideExtensions.UseHttpMethodOverride(Microsoft.AspNetCore.Builder.IApplicationBuilder,Microsoft.AspNetCore.Builder.HttpMethodOverrideOptions)">
|
||||
<summary>
|
||||
Allows incoming POST request to override method type with type specified in form.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.AspNetCore.Builder.IApplicationBuilder"/> instance this method extends.</param>
|
||||
<param name="options">The <see cref="T:Microsoft.AspNetCore.Builder.HttpMethodOverrideOptions"/>.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Builder.HttpMethodOverrideOptions.FormFieldName">
|
||||
<summary>
|
||||
Denotes the form element that contains the name of the resulting method type.
|
||||
If not set the X-Http-Method-Override header will be used.
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1,847 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.AspNetCore.Routing.Abstractions</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="M:Microsoft.Extensions.Internal.PropertyHelper.#ctor(System.Reflection.PropertyInfo)">
|
||||
<summary>
|
||||
Initializes a fast <see cref="T:Microsoft.Extensions.Internal.PropertyHelper"/>.
|
||||
This constructor does not cache the helper. For caching, use <see cref="M:Microsoft.Extensions.Internal.PropertyHelper.GetProperties(System.Type)"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Internal.PropertyHelper.Property">
|
||||
<summary>
|
||||
Gets the backing <see cref="T:System.Reflection.PropertyInfo"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Internal.PropertyHelper.Name">
|
||||
<summary>
|
||||
Gets (or sets in derived types) the property name.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Internal.PropertyHelper.ValueGetter">
|
||||
<summary>
|
||||
Gets the property value getter.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Internal.PropertyHelper.ValueSetter">
|
||||
<summary>
|
||||
Gets the property value setter.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Internal.PropertyHelper.GetValue(System.Object)">
|
||||
<summary>
|
||||
Returns the property value for the specified <paramref name="instance"/>.
|
||||
</summary>
|
||||
<param name="instance">The object whose property value will be returned.</param>
|
||||
<returns>The property value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Internal.PropertyHelper.SetValue(System.Object,System.Object)">
|
||||
<summary>
|
||||
Sets the property value for the specified <paramref name="instance" />.
|
||||
</summary>
|
||||
<param name="instance">The object whose property value will be set.</param>
|
||||
<param name="value">The property value.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Internal.PropertyHelper.GetProperties(System.Reflection.TypeInfo)">
|
||||
<summary>
|
||||
Creates and caches fast property helpers that expose getters for every public get property on the
|
||||
underlying type.
|
||||
</summary>
|
||||
<param name="typeInfo">The type info to extract property accessors for.</param>
|
||||
<returns>A cached array of all public properties of the specified type.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Internal.PropertyHelper.GetProperties(System.Type)">
|
||||
<summary>
|
||||
Creates and caches fast property helpers that expose getters for every public get property on the
|
||||
specified type.
|
||||
</summary>
|
||||
<param name="type">The type to extract property accessors for.</param>
|
||||
<returns>A cached array of all public properties of the specified type.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Internal.PropertyHelper.GetVisibleProperties(System.Reflection.TypeInfo)">
|
||||
<summary>
|
||||
<para>
|
||||
Creates and caches fast property helpers that expose getters for every non-hidden get property
|
||||
on the specified type.
|
||||
</para>
|
||||
<para>
|
||||
<see cref="M:GetVisibleProperties"/> excludes properties defined on base types that have been
|
||||
hidden by definitions using the <c>new</c> keyword.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="typeInfo">The type info to extract property accessors for.</param>
|
||||
<returns>
|
||||
A cached array of all public properties of the specified type.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Internal.PropertyHelper.GetVisibleProperties(System.Type)">
|
||||
<summary>
|
||||
<para>
|
||||
Creates and caches fast property helpers that expose getters for every non-hidden get property
|
||||
on the specified type.
|
||||
</para>
|
||||
<para>
|
||||
<see cref="M:GetVisibleProperties"/> excludes properties defined on base types that have been
|
||||
hidden by definitions using the <c>new</c> keyword.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="type">The type to extract property accessors for.</param>
|
||||
<returns>
|
||||
A cached array of all public properties of the specified type.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Internal.PropertyHelper.MakeFastPropertyGetter(System.Reflection.PropertyInfo)">
|
||||
<summary>
|
||||
Creates a single fast property getter. The result is not cached.
|
||||
</summary>
|
||||
<param name="propertyInfo">propertyInfo to extract the getter for.</param>
|
||||
<returns>a fast getter.</returns>
|
||||
<remarks>
|
||||
This method is more memory efficient than a dynamically compiled lambda, and about the
|
||||
same speed.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Internal.PropertyHelper.MakeNullSafeFastPropertyGetter(System.Reflection.PropertyInfo)">
|
||||
<summary>
|
||||
Creates a single fast property getter which is safe for a null input object. The result is not cached.
|
||||
</summary>
|
||||
<param name="propertyInfo">propertyInfo to extract the getter for.</param>
|
||||
<returns>a fast getter.</returns>
|
||||
<remarks>
|
||||
This method is more memory efficient than a dynamically compiled lambda, and about the
|
||||
same speed.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Internal.PropertyHelper.MakeFastPropertySetter(System.Reflection.PropertyInfo)">
|
||||
<summary>
|
||||
Creates a single fast property setter for reference types. The result is not cached.
|
||||
</summary>
|
||||
<param name="propertyInfo">propertyInfo to extract the setter for.</param>
|
||||
<returns>a fast getter.</returns>
|
||||
<remarks>
|
||||
This method is more memory efficient than a dynamically compiled lambda, and about the
|
||||
same speed. This only works for reference types.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Internal.PropertyHelper.ObjectToDictionary(System.Object)">
|
||||
<summary>
|
||||
Given an object, adds each instance property with a public get method as a key and its
|
||||
associated value to a dictionary.
|
||||
|
||||
If the object is already an <see cref="T:System.Collections.Generic.IDictionary`2"/> instance, then a copy
|
||||
is returned.
|
||||
</summary>
|
||||
<remarks>
|
||||
The implementation of PropertyHelper will cache the property accessors per-type. This is
|
||||
faster when the same type is used multiple times with ObjectToDictionary.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Http.Endpoint">
|
||||
<summary>
|
||||
Respresents a logical endpoint in an application.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.Endpoint.#ctor(Microsoft.AspNetCore.Http.RequestDelegate,Microsoft.AspNetCore.Http.EndpointMetadataCollection,System.String)">
|
||||
<summary>
|
||||
Creates a new instance of <see cref="T:Microsoft.AspNetCore.Http.Endpoint"/>.
|
||||
</summary>
|
||||
<param name="requestDelegate">The delegate used to process requests for the endpoint.</param>
|
||||
<param name="metadata">
|
||||
The endpoint <see cref="T:Microsoft.AspNetCore.Http.EndpointMetadataCollection"/>. May be null.
|
||||
</param>
|
||||
<param name="displayName">
|
||||
The informational display name of the endpoint. May be null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Endpoint.DisplayName">
|
||||
<summary>
|
||||
Gets the informational display name of this endpoint.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Endpoint.Metadata">
|
||||
<summary>
|
||||
Gets the collection of metadata associated with this endpoint.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Endpoint.RequestDelegate">
|
||||
<summary>
|
||||
Gets the delegate used to process requests for the endpoint.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Http.EndpointMetadataCollection">
|
||||
<summary>
|
||||
A collection of arbitrary metadata associated with an endpoint.
|
||||
</summary>
|
||||
<remarks>
|
||||
<see cref="T:Microsoft.AspNetCore.Http.EndpointMetadataCollection"/> instances contain a list of metadata items
|
||||
of arbitrary types. The metadata items are stored as an ordered collection with
|
||||
items arranged in ascending order of precedence.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="F:Microsoft.AspNetCore.Http.EndpointMetadataCollection.Empty">
|
||||
<summary>
|
||||
An empty <see cref="T:Microsoft.AspNetCore.Http.EndpointMetadataCollection"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.EndpointMetadataCollection.#ctor(System.Collections.Generic.IEnumerable{System.Object})">
|
||||
<summary>
|
||||
Creates a new instance of <see cref="T:Microsoft.AspNetCore.Http.EndpointMetadataCollection"/>.
|
||||
</summary>
|
||||
<param name="items">The metadata items.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.EndpointMetadataCollection.#ctor(System.Object[])">
|
||||
<summary>
|
||||
Creates a new instance of <see cref="T:Microsoft.AspNetCore.Http.EndpointMetadataCollection"/>.
|
||||
</summary>
|
||||
<param name="items">The metadata items.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.EndpointMetadataCollection.Item(System.Int32)">
|
||||
<summary>
|
||||
Gets the item at <paramref name="index"/>.
|
||||
</summary>
|
||||
<param name="index">The index of the item to retrieve.</param>
|
||||
<returns>The item at <paramref name="index"/>.</returns>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.EndpointMetadataCollection.Count">
|
||||
<summary>
|
||||
Gets the count of metadata items.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.EndpointMetadataCollection.GetMetadata``1">
|
||||
<summary>
|
||||
Gets the most significant metadata item of type <typeparamref name="T"/>.
|
||||
</summary>
|
||||
<typeparam name="T">The type of metadata to retrieve.</typeparam>
|
||||
<returns>
|
||||
The most significant metadata of type <typeparamref name="T"/> or <c>null</c>.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.EndpointMetadataCollection.GetOrderedMetadata``1">
|
||||
<summary>
|
||||
Gets the metadata items of type <typeparamref name="T"/> in ascending
|
||||
order of precedence.
|
||||
</summary>
|
||||
<typeparam name="T">The type of metadata.</typeparam>
|
||||
<returns>A sequence of metadata items of <typeparamref name="T"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.EndpointMetadataCollection.GetEnumerator">
|
||||
<summary>
|
||||
Gets an <see cref="T:System.Collections.IEnumerator"/> of all metadata items.
|
||||
</summary>
|
||||
<returns>An <see cref="T:System.Collections.IEnumerator"/> of all metadata items.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.EndpointMetadataCollection.System#Collections#Generic#IEnumerable{System#Object}#GetEnumerator">
|
||||
<summary>
|
||||
Gets an <see cref="T:System.Collections.Generic.IEnumerator`1"/> of all metadata items.
|
||||
</summary>
|
||||
<returns>An <see cref="T:System.Collections.Generic.IEnumerator`1"/> of all metadata items.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.EndpointMetadataCollection.System#Collections#IEnumerable#GetEnumerator">
|
||||
<summary>
|
||||
Gets an <see cref="T:System.Collections.IEnumerator"/> of all metadata items.
|
||||
</summary>
|
||||
<returns>An <see cref="T:System.Collections.IEnumerator"/> of all metadata items.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Http.EndpointMetadataCollection.Enumerator">
|
||||
<summary>
|
||||
Enumerates the elements of an <see cref="T:Microsoft.AspNetCore.Http.EndpointMetadataCollection"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.EndpointMetadataCollection.Enumerator.Current">
|
||||
<summary>
|
||||
Gets the element at the current position of the enumerator
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.EndpointMetadataCollection.Enumerator.Dispose">
|
||||
<summary>
|
||||
Releases all resources used by the <see cref="T:Microsoft.AspNetCore.Http.EndpointMetadataCollection.Enumerator"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.EndpointMetadataCollection.Enumerator.MoveNext">
|
||||
<summary>
|
||||
Advances the enumerator to the next element of the <see cref="T:Microsoft.AspNetCore.Http.EndpointMetadataCollection.Enumerator"/>.
|
||||
</summary>
|
||||
<returns>
|
||||
<c>true</c> if the enumerator was successfully advanced to the next element;
|
||||
<c>false</c> if the enumerator has passed the end of the collection.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Http.EndpointMetadataCollection.Enumerator.Reset">
|
||||
<summary>
|
||||
Sets the enumerator to its initial position, which is before the first element in the collection.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Http.Features.IEndpointFeature">
|
||||
<summary>
|
||||
A feature interface for endpoint routing. Use <see cref="P:Microsoft.AspNetCore.Http.HttpContext.Features"/>
|
||||
to access an instance associated with the current request.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.IEndpointFeature.Endpoint">
|
||||
<summary>
|
||||
Gets or sets the selected <see cref="T:Microsoft.AspNetCore.Http.Endpoint"/> for the current
|
||||
request.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.IRouteValuesFeature.RouteValues">
|
||||
<summary>
|
||||
Gets or sets the <see cref="T:Microsoft.AspNetCore.Routing.RouteValueDictionary"/> associated with the currrent
|
||||
request.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Routing.IOutboundParameterTransformer">
|
||||
<summary>
|
||||
Defines the contract that a class must implement to transform route values while building
|
||||
a URI.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Routing.IOutboundParameterTransformer.TransformOutbound(System.Object)">
|
||||
<summary>
|
||||
Transforms the specified route value to a string for inclusion in a URI.
|
||||
</summary>
|
||||
<param name="value">The route value to transform.</param>
|
||||
<returns>The transformed value.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Routing.IParameterPolicy">
|
||||
<summary>
|
||||
A marker interface for types that are associated with route parameters.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Routing.IRouteConstraint">
|
||||
<summary>
|
||||
Defines the contract that a class must implement in order to check whether a URL parameter
|
||||
value is valid for a constraint.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Routing.IRouteConstraint.Match(Microsoft.AspNetCore.Http.HttpContext,Microsoft.AspNetCore.Routing.IRouter,System.String,Microsoft.AspNetCore.Routing.RouteValueDictionary,Microsoft.AspNetCore.Routing.RouteDirection)">
|
||||
<summary>
|
||||
Determines whether the URL parameter contains a valid value for this constraint.
|
||||
</summary>
|
||||
<param name="httpContext">An object that encapsulates information about the HTTP request.</param>
|
||||
<param name="route">The router that this constraint belongs to.</param>
|
||||
<param name="routeKey">The name of the parameter that is being checked.</param>
|
||||
<param name="values">A dictionary that contains the parameters for the URL.</param>
|
||||
<param name="routeDirection">
|
||||
An object that indicates whether the constraint check is being performed
|
||||
when an incoming request is being handled or when a URL is being generated.
|
||||
</param>
|
||||
<returns><c>true</c> if the URL parameter contains a valid value; otherwise, <c>false</c>.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Routing.IRouteHandler">
|
||||
<summary>
|
||||
Defines a contract for a handler of a route.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Routing.IRouteHandler.GetRequestHandler(Microsoft.AspNetCore.Http.HttpContext,Microsoft.AspNetCore.Routing.RouteData)">
|
||||
<summary>
|
||||
Gets a <see cref="T:Microsoft.AspNetCore.Http.RequestDelegate"/> to handle the request, based on the provided
|
||||
<paramref name="routeData"/>.
|
||||
</summary>
|
||||
<param name="httpContext">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> associated with the current request.</param>
|
||||
<param name="routeData">The <see cref="T:Microsoft.AspNetCore.Routing.RouteData"/> associated with the current routing match.</param>
|
||||
<returns>
|
||||
A <see cref="T:Microsoft.AspNetCore.Http.RequestDelegate"/>, or <c>null</c> if the handler cannot handle this request.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Routing.IRoutingFeature">
|
||||
<summary>
|
||||
A feature interface for routing functionality.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Routing.IRoutingFeature.RouteData">
|
||||
<summary>
|
||||
Gets or sets the <see cref="T:Microsoft.AspNetCore.Routing.RouteData"/> associated with the current request.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Routing.LinkGenerator">
|
||||
<summary>
|
||||
Defines a contract to generate absolute and related URIs based on endpoint routing.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>
|
||||
Generating URIs in endpoint routing occurs in two phases. First, an address is bound to a list of
|
||||
endpoints that match the address. Secondly, each endpoint's <c>RoutePattern</c> is evaluated, until
|
||||
a route pattern that matches the supplied values is found. The resulting output is combined with
|
||||
the other URI parts supplied to the link generator and returned.
|
||||
</para>
|
||||
<para>
|
||||
The methods provided by the <see cref="T:Microsoft.AspNetCore.Routing.LinkGenerator"/> type are general infrastructure, and support
|
||||
the standard link generator functionality for any type of address. The most convenient way to use
|
||||
<see cref="T:Microsoft.AspNetCore.Routing.LinkGenerator"/> is through extension methods that perform operations for a specific
|
||||
address type.
|
||||
</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Routing.LinkGenerator.GetPathByAddress``1(Microsoft.AspNetCore.Http.HttpContext,``0,Microsoft.AspNetCore.Routing.RouteValueDictionary,Microsoft.AspNetCore.Routing.RouteValueDictionary,System.Nullable{Microsoft.AspNetCore.Http.PathString},Microsoft.AspNetCore.Http.FragmentString,Microsoft.AspNetCore.Routing.LinkOptions)">
|
||||
<summary>
|
||||
Generates a URI with an absolute path based on the provided values and <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.
|
||||
</summary>
|
||||
<typeparam name="TAddress">The address type.</typeparam>
|
||||
<param name="httpContext">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> associated with the current request.</param>
|
||||
<param name="address">The address value. Used to resolve endpoints.</param>
|
||||
<param name="values">The route values. Used to expand parameters in the route template. Optional.</param>
|
||||
<param name="ambientValues">The values associated with the current request. Optional.</param>
|
||||
<param name="pathBase">
|
||||
An optional URI path base. Prepended to the path in the resulting URI. If not provided, the value of <see cref="P:Microsoft.AspNetCore.Http.HttpRequest.PathBase"/> will be used.
|
||||
</param>
|
||||
<param name="fragment">An optional URI fragment. Appended to the resulting URI.</param>
|
||||
<param name="options">
|
||||
An optional <see cref="T:Microsoft.AspNetCore.Routing.LinkOptions"/>. Settings on provided object override the settings with matching
|
||||
names from <c>RouteOptions</c>.
|
||||
</param>
|
||||
<returns>A URI with an absolute path, or <c>null</c>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Routing.LinkGenerator.GetPathByAddress``1(``0,Microsoft.AspNetCore.Routing.RouteValueDictionary,Microsoft.AspNetCore.Http.PathString,Microsoft.AspNetCore.Http.FragmentString,Microsoft.AspNetCore.Routing.LinkOptions)">
|
||||
<summary>
|
||||
Generates a URI with an absolute path based on the provided values.
|
||||
</summary>
|
||||
<typeparam name="TAddress">The address type.</typeparam>
|
||||
<param name="address">The address value. Used to resolve endpoints.</param>
|
||||
<param name="values">The route values. Used to expand parameters in the route template. Optional.</param>
|
||||
<param name="pathBase">An optional URI path base. Prepended to the path in the resulting URI.</param>
|
||||
<param name="fragment">An optional URI fragment. Appended to the resulting URI.</param>
|
||||
<param name="options">
|
||||
An optional <see cref="T:Microsoft.AspNetCore.Routing.LinkOptions"/>. Settings on provided object override the settings with matching
|
||||
names from <c>RouteOptions</c>.
|
||||
</param>
|
||||
<returns>A URI with an absolute path, or <c>null</c>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Routing.LinkGenerator.GetUriByAddress``1(Microsoft.AspNetCore.Http.HttpContext,``0,Microsoft.AspNetCore.Routing.RouteValueDictionary,Microsoft.AspNetCore.Routing.RouteValueDictionary,System.String,System.Nullable{Microsoft.AspNetCore.Http.HostString},System.Nullable{Microsoft.AspNetCore.Http.PathString},Microsoft.AspNetCore.Http.FragmentString,Microsoft.AspNetCore.Routing.LinkOptions)">
|
||||
<summary>
|
||||
Generates an absolute URI based on the provided values and <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.
|
||||
</summary>
|
||||
<typeparam name="TAddress">The address type.</typeparam>
|
||||
<param name="httpContext">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> associated with the current request.</param>
|
||||
<param name="address">The address value. Used to resolve endpoints.</param>
|
||||
<param name="values">The route values. Used to expand parameters in the route template. Optional.</param>
|
||||
<param name="ambientValues">The values associated with the current request. Optional.</param>
|
||||
<param name="scheme">
|
||||
The URI scheme, applied to the resulting URI. Optional. If not provided, the value of <see cref="P:Microsoft.AspNetCore.Http.HttpRequest.Scheme"/> will be used.
|
||||
</param>
|
||||
<param name="host">
|
||||
The URI host/authority, applied to the resulting URI. Optional. If not provided, the value <see cref="P:Microsoft.AspNetCore.Http.HttpRequest.Host"/> will be used.
|
||||
See the remarks section for details about the security implications of the <paramref name="host"/>.
|
||||
</param>
|
||||
<param name="pathBase">
|
||||
An optional URI path base. Prepended to the path in the resulting URI. If not provided, the value of <see cref="P:Microsoft.AspNetCore.Http.HttpRequest.PathBase"/> will be used.
|
||||
</param>
|
||||
<param name="fragment">An optional URI fragment. Appended to the resulting URI.</param>
|
||||
<param name="options">
|
||||
An optional <see cref="T:Microsoft.AspNetCore.Routing.LinkOptions"/>. Settings on provided object override the settings with matching
|
||||
names from <c>RouteOptions</c>.
|
||||
</param>
|
||||
<returns>A URI with an absolute path, or <c>null</c>.</returns>
|
||||
<remarks>
|
||||
<para>
|
||||
The value of <paramref name="host" /> should be a trusted value. Relying on the value of the current request
|
||||
can allow untrusted input to influence the resulting URI unless the <c>Host</c> header has been validated.
|
||||
See the deployment documentation for instructions on how to properly validate the <c>Host</c> header in
|
||||
your deployment environment.
|
||||
</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Routing.LinkGenerator.GetUriByAddress``1(``0,Microsoft.AspNetCore.Routing.RouteValueDictionary,System.String,Microsoft.AspNetCore.Http.HostString,Microsoft.AspNetCore.Http.PathString,Microsoft.AspNetCore.Http.FragmentString,Microsoft.AspNetCore.Routing.LinkOptions)">
|
||||
<summary>
|
||||
Generates an absolute URI based on the provided values.
|
||||
</summary>
|
||||
<typeparam name="TAddress">The address type.</typeparam>
|
||||
<param name="address">The address value. Used to resolve endpoints.</param>
|
||||
<param name="values">The route values. Used to expand parameters in the route template. Optional.</param>
|
||||
<param name="scheme">The URI scheme, applied to the resulting URI.</param>
|
||||
<param name="host">
|
||||
The URI host/authority, applied to the resulting URI.
|
||||
See the remarks section for details about the security implications of the <paramref name="host"/>.
|
||||
</param>
|
||||
<param name="pathBase">An optional URI path base. Prepended to the path in the resulting URI.</param>
|
||||
<param name="fragment">An optional URI fragment. Appended to the resulting URI.</param>
|
||||
<param name="options">
|
||||
An optional <see cref="T:Microsoft.AspNetCore.Routing.LinkOptions"/>. Settings on provided object override the settings with matching
|
||||
names from <c>RouteOptions</c>.
|
||||
</param>
|
||||
<returns>An absolute URI, or <c>null</c>.</returns>
|
||||
<remarks>
|
||||
<para>
|
||||
The value of <paramref name="host" /> should be a trusted value. Relying on the value of the current request
|
||||
can allow untrusted input to influence the resulting URI unless the <c>Host</c> header has been validated.
|
||||
See the deployment documentation for instructions on how to properly validate the <c>Host</c> header in
|
||||
your deployment environment.
|
||||
</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Routing.LinkOptions.LowercaseUrls">
|
||||
<summary>
|
||||
Gets or sets a value indicating whether all generated paths URLs are lower-case.
|
||||
Use <see cref="P:Microsoft.AspNetCore.Routing.LinkOptions.LowercaseQueryStrings" /> to configure the behavior for query strings.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Routing.LinkOptions.LowercaseQueryStrings">
|
||||
<summary>
|
||||
Gets or sets a value indicating whether a generated query strings are lower-case.
|
||||
This property will be unless <see cref="P:Microsoft.AspNetCore.Routing.LinkOptions.LowercaseUrls" /> is also <c>true</c>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Routing.LinkOptions.AppendTrailingSlash">
|
||||
<summary>
|
||||
Gets or sets a value indicating whether a trailing slash should be appended to the generated URLs.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Routing.Abstractions.Resources.RouteValueDictionary_DuplicateKey">
|
||||
<summary>
|
||||
An element with the key '{0}' already exists in the {1}.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Routing.Abstractions.Resources.FormatRouteValueDictionary_DuplicateKey(System.Object,System.Object)">
|
||||
<summary>
|
||||
An element with the key '{0}' already exists in the {1}.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Routing.Abstractions.Resources.RouteValueDictionary_DuplicatePropertyName">
|
||||
<summary>
|
||||
The type '{0}' defines properties '{1}' and '{2}' which differ only by casing. This is not supported by {3} which uses case-insensitive comparisons.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Routing.Abstractions.Resources.FormatRouteValueDictionary_DuplicatePropertyName(System.Object,System.Object,System.Object,System.Object)">
|
||||
<summary>
|
||||
The type '{0}' defines properties '{1}' and '{2}' which differ only by casing. This is not supported by {3} which uses case-insensitive comparisons.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Routing.RouteContext">
|
||||
<summary>
|
||||
A context object for <see cref="M:Microsoft.AspNetCore.Routing.IRouter.RouteAsync(Microsoft.AspNetCore.Routing.RouteContext)"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Routing.RouteContext.#ctor(Microsoft.AspNetCore.Http.HttpContext)">
|
||||
<summary>
|
||||
Creates a new instance of <see cref="T:Microsoft.AspNetCore.Routing.RouteContext"/> for the provided <paramref name="httpContext"/>.
|
||||
</summary>
|
||||
<param name="httpContext">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> associated with the current request.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Routing.RouteContext.Handler">
|
||||
<summary>
|
||||
Gets or sets the handler for the request. An <see cref="T:Microsoft.AspNetCore.Routing.IRouter"/> should set <see cref="P:Microsoft.AspNetCore.Routing.RouteContext.Handler"/>
|
||||
when it matches.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Routing.RouteContext.HttpContext">
|
||||
<summary>
|
||||
Gets the <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> associated with the current request.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Routing.RouteContext.RouteData">
|
||||
<summary>
|
||||
Gets or sets the <see cref="T:Microsoft.AspNetCore.Routing.RouteData"/> associated with the current context.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Routing.RouteData">
|
||||
<summary>
|
||||
Information about the current routing path.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Routing.RouteData.#ctor">
|
||||
<summary>
|
||||
Creates a new instance of <see cref="T:Microsoft.AspNetCore.Routing.RouteData"/> instance.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Routing.RouteData.#ctor(Microsoft.AspNetCore.Routing.RouteData)">
|
||||
<summary>
|
||||
Creates a new instance of <see cref="T:Microsoft.AspNetCore.Routing.RouteData"/> instance with values copied from <paramref name="other"/>.
|
||||
</summary>
|
||||
<param name="other">The other <see cref="T:Microsoft.AspNetCore.Routing.RouteData"/> instance to copy.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Routing.RouteData.#ctor(Microsoft.AspNetCore.Routing.RouteValueDictionary)">
|
||||
<summary>
|
||||
Creates a new instance of <see cref="T:Microsoft.AspNetCore.Routing.RouteData"/> instance with the specified values.
|
||||
</summary>
|
||||
<param name="values">The <see cref="T:Microsoft.AspNetCore.Routing.RouteValueDictionary"/> values.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Routing.RouteData.DataTokens">
|
||||
<summary>
|
||||
Gets the data tokens produced by routes on the current routing path.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Routing.RouteData.Routers">
|
||||
<summary>
|
||||
Gets the list of <see cref="T:Microsoft.AspNetCore.Routing.IRouter"/> instances on the current routing path.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Routing.RouteData.Values">
|
||||
<summary>
|
||||
Gets the values produced by routes on the current routing path.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Routing.RouteData.PushState(Microsoft.AspNetCore.Routing.IRouter,Microsoft.AspNetCore.Routing.RouteValueDictionary,Microsoft.AspNetCore.Routing.RouteValueDictionary)">
|
||||
<summary>
|
||||
<para>
|
||||
Creates a snapshot of the current state of the <see cref="T:Microsoft.AspNetCore.Routing.RouteData"/> before appending
|
||||
<paramref name="router"/> to <see cref="P:Microsoft.AspNetCore.Routing.RouteData.Routers"/>, merging <paramref name="values"/> into
|
||||
<see cref="P:Microsoft.AspNetCore.Routing.RouteData.Values"/>, and merging <paramref name="dataTokens"/> into <see cref="P:Microsoft.AspNetCore.Routing.RouteData.DataTokens"/>.
|
||||
</para>
|
||||
<para>
|
||||
Call <see cref="M:Microsoft.AspNetCore.Routing.RouteData.RouteDataSnapshot.Restore"/> to restore the state of this <see cref="T:Microsoft.AspNetCore.Routing.RouteData"/>
|
||||
to the state at the time of calling
|
||||
<see cref="M:Microsoft.AspNetCore.Routing.RouteData.PushState(Microsoft.AspNetCore.Routing.IRouter,Microsoft.AspNetCore.Routing.RouteValueDictionary,Microsoft.AspNetCore.Routing.RouteValueDictionary)"/>.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="router">
|
||||
An <see cref="T:Microsoft.AspNetCore.Routing.IRouter"/> to append to <see cref="P:Microsoft.AspNetCore.Routing.RouteData.Routers"/>. If <c>null</c>, then <see cref="P:Microsoft.AspNetCore.Routing.RouteData.Routers"/>
|
||||
will not be changed.
|
||||
</param>
|
||||
<param name="values">
|
||||
A <see cref="T:Microsoft.AspNetCore.Routing.RouteValueDictionary"/> to merge into <see cref="P:Microsoft.AspNetCore.Routing.RouteData.Values"/>. If <c>null</c>, then
|
||||
<see cref="P:Microsoft.AspNetCore.Routing.RouteData.Values"/> will not be changed.
|
||||
</param>
|
||||
<param name="dataTokens">
|
||||
A <see cref="T:Microsoft.AspNetCore.Routing.RouteValueDictionary"/> to merge into <see cref="P:Microsoft.AspNetCore.Routing.RouteData.DataTokens"/>. If <c>null</c>, then
|
||||
<see cref="P:Microsoft.AspNetCore.Routing.RouteData.DataTokens"/> will not be changed.
|
||||
</param>
|
||||
<returns>A <see cref="T:Microsoft.AspNetCore.Routing.RouteData.RouteDataSnapshot"/> that captures the current state.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Routing.RouteData.RouteDataSnapshot">
|
||||
<summary>
|
||||
A snapshot of the state of a <see cref="T:Microsoft.AspNetCore.Routing.RouteData"/> instance.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Routing.RouteData.RouteDataSnapshot.#ctor(Microsoft.AspNetCore.Routing.RouteData,Microsoft.AspNetCore.Routing.RouteValueDictionary,System.Collections.Generic.IList{Microsoft.AspNetCore.Routing.IRouter},Microsoft.AspNetCore.Routing.RouteValueDictionary)">
|
||||
<summary>
|
||||
Creates a new instance of <see cref="T:Microsoft.AspNetCore.Routing.RouteData.RouteDataSnapshot"/> for <paramref name="routeData"/>.
|
||||
</summary>
|
||||
<param name="routeData">The <see cref="T:Microsoft.AspNetCore.Routing.RouteData"/>.</param>
|
||||
<param name="dataTokens">The data tokens.</param>
|
||||
<param name="routers">The routers.</param>
|
||||
<param name="values">The route values.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Routing.RouteData.RouteDataSnapshot.Restore">
|
||||
<summary>
|
||||
Restores the <see cref="T:Microsoft.AspNetCore.Routing.RouteData"/> to the captured state.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Routing.RouteDirection">
|
||||
<summary>
|
||||
Indicates whether ASP.NET routing is processing a URL from an HTTP request or generating a URL.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.AspNetCore.Routing.RouteDirection.IncomingRequest">
|
||||
<summary>
|
||||
A URL from a client is being processed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.AspNetCore.Routing.RouteDirection.UrlGeneration">
|
||||
<summary>
|
||||
A URL is being created based on the route definition.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Routing.RouteValueDictionary">
|
||||
<summary>
|
||||
An <see cref="T:System.Collections.Generic.IDictionary`2"/> type for route values.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Routing.RouteValueDictionary.FromArray(System.Collections.Generic.KeyValuePair{System.String,System.Object}[])">
|
||||
<summary>
|
||||
Creates a new instance of <see cref="T:Microsoft.AspNetCore.Routing.RouteValueDictionary"/> from the provided array.
|
||||
The new instance will take ownership of the array, and may mutate it.
|
||||
</summary>
|
||||
<param name="items">The items array.</param>
|
||||
<returns>A new <see cref="T:Microsoft.AspNetCore.Routing.RouteValueDictionary"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Routing.RouteValueDictionary.#ctor">
|
||||
<summary>
|
||||
Creates an empty <see cref="T:Microsoft.AspNetCore.Routing.RouteValueDictionary"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Routing.RouteValueDictionary.#ctor(System.Object)">
|
||||
<summary>
|
||||
Creates a <see cref="T:Microsoft.AspNetCore.Routing.RouteValueDictionary"/> initialized with the specified <paramref name="values"/>.
|
||||
</summary>
|
||||
<param name="values">An object to initialize the dictionary. The value can be of type
|
||||
<see cref="T:System.Collections.Generic.IDictionary`2"/> or <see cref="T:System.Collections.Generic.IReadOnlyDictionary`2"/>
|
||||
or an object with public properties as key-value pairs.
|
||||
</param>
|
||||
<remarks>
|
||||
If the value is a dictionary or other <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:System.Collections.Generic.KeyValuePair`2"/>,
|
||||
then its entries are copied. Otherwise the object is interpreted as a set of key-value pairs where the
|
||||
property names are keys, and property values are the values, and copied into the dictionary.
|
||||
Only public instance non-index properties are considered.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Routing.RouteValueDictionary.Item(System.String)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Routing.RouteValueDictionary.Comparer">
|
||||
<summary>
|
||||
Gets the comparer for this dictionary.
|
||||
</summary>
|
||||
<remarks>
|
||||
This will always be a reference to <see cref="P:System.StringComparer.OrdinalIgnoreCase"/>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Routing.RouteValueDictionary.Count">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Routing.RouteValueDictionary.System#Collections#Generic#ICollection{System#Collections#Generic#KeyValuePair{System#String,System#Object}}#IsReadOnly">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Routing.RouteValueDictionary.Keys">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Routing.RouteValueDictionary.Values">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Routing.RouteValueDictionary.System#Collections#Generic#ICollection{System#Collections#Generic#KeyValuePair{System#String,System#Object}}#Add(System.Collections.Generic.KeyValuePair{System.String,System.Object})">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Routing.RouteValueDictionary.Add(System.String,System.Object)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Routing.RouteValueDictionary.Clear">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Routing.RouteValueDictionary.System#Collections#Generic#ICollection{System#Collections#Generic#KeyValuePair{System#String,System#Object}}#Contains(System.Collections.Generic.KeyValuePair{System.String,System.Object})">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Routing.RouteValueDictionary.ContainsKey(System.String)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Routing.RouteValueDictionary.System#Collections#Generic#ICollection{System#Collections#Generic#KeyValuePair{System#String,System#Object}}#CopyTo(System.Collections.Generic.KeyValuePair{System.String,System.Object}[],System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Routing.RouteValueDictionary.GetEnumerator">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Routing.RouteValueDictionary.System#Collections#Generic#IEnumerable{System#Collections#Generic#KeyValuePair{System#String,System#Object}}#GetEnumerator">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Routing.RouteValueDictionary.System#Collections#IEnumerable#GetEnumerator">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Routing.RouteValueDictionary.System#Collections#Generic#ICollection{System#Collections#Generic#KeyValuePair{System#String,System#Object}}#Remove(System.Collections.Generic.KeyValuePair{System.String,System.Object})">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Routing.RouteValueDictionary.Remove(System.String)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Routing.RouteValueDictionary.Remove(System.String,System.Object@)">
|
||||
<summary>
|
||||
Attempts to remove and return the value that has the specified key from the <see cref="T:Microsoft.AspNetCore.Routing.RouteValueDictionary"/>.
|
||||
</summary>
|
||||
<param name="key">The key of the element to remove and return.</param>
|
||||
<param name="value">When this method returns, contains the object removed from the <see cref="T:Microsoft.AspNetCore.Routing.RouteValueDictionary"/>, or <c>null</c> if key does not exist.</param>
|
||||
<returns>
|
||||
<c>true</c> if the object was removed successfully; otherwise, <c>false</c>.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Routing.RouteValueDictionary.TryAdd(System.String,System.Object)">
|
||||
<summary>
|
||||
Attempts to the add the provided <paramref name="key"/> and <paramref name="value"/> to the dictionary.
|
||||
</summary>
|
||||
<param name="key">The key.</param>
|
||||
<param name="value">The value.</param>
|
||||
<returns>Returns <c>true</c> if the value was added. Returns <c>false</c> if the key was already present.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Routing.RouteValueDictionary.TryGetValue(System.String,System.Object@)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Routing.RoutingHttpContextExtensions">
|
||||
<summary>
|
||||
Extension methods for <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> related to routing.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Routing.RoutingHttpContextExtensions.GetRouteData(Microsoft.AspNetCore.Http.HttpContext)">
|
||||
<summary>
|
||||
Gets the <see cref="T:Microsoft.AspNetCore.Routing.RouteData"/> associated with the provided <paramref name="httpContext"/>.
|
||||
</summary>
|
||||
<param name="httpContext">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> associated with the current request.</param>
|
||||
<returns>The <see cref="T:Microsoft.AspNetCore.Routing.RouteData"/>, or null.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Routing.RoutingHttpContextExtensions.GetRouteValue(Microsoft.AspNetCore.Http.HttpContext,System.String)">
|
||||
<summary>
|
||||
Gets a route value from <see cref="P:Microsoft.AspNetCore.Routing.RouteData.Values"/> associated with the provided
|
||||
<paramref name="httpContext"/>.
|
||||
</summary>
|
||||
<param name="httpContext">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> associated with the current request.</param>
|
||||
<param name="key">The key of the route value.</param>
|
||||
<returns>The corresponding route value, or null.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Routing.VirtualPathContext">
|
||||
<summary>
|
||||
A context for virtual path generation operations.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Routing.VirtualPathContext.#ctor(Microsoft.AspNetCore.Http.HttpContext,Microsoft.AspNetCore.Routing.RouteValueDictionary,Microsoft.AspNetCore.Routing.RouteValueDictionary)">
|
||||
<summary>
|
||||
Creates a new instance of <see cref="T:Microsoft.AspNetCore.Routing.VirtualPathContext"/>.
|
||||
</summary>
|
||||
<param name="httpContext">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> associated with the current request.</param>
|
||||
<param name="ambientValues">The set of route values associated with the current request.</param>
|
||||
<param name="values">The set of new values provided for virtual path generation.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Routing.VirtualPathContext.#ctor(Microsoft.AspNetCore.Http.HttpContext,Microsoft.AspNetCore.Routing.RouteValueDictionary,Microsoft.AspNetCore.Routing.RouteValueDictionary,System.String)">
|
||||
<summary>
|
||||
Creates a new instance of <see cref="T:Microsoft.AspNetCore.Routing.VirtualPathContext"/>.
|
||||
</summary>
|
||||
<param name="httpContext">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> associated with the current request.</param>
|
||||
<param name="ambientValues">The set of route values associated with the current request.</param>
|
||||
<param name="values">The set of new values provided for virtual path generation.</param>
|
||||
<param name="routeName">The name of the route to use for virtual path generation.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Routing.VirtualPathContext.AmbientValues">
|
||||
<summary>
|
||||
Gets the set of route values associated with the current request.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Routing.VirtualPathContext.HttpContext">
|
||||
<summary>
|
||||
Gets the <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> associated with the current request.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Routing.VirtualPathContext.RouteName">
|
||||
<summary>
|
||||
Gets the name of the route to use for virtual path generation.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Routing.VirtualPathContext.Values">
|
||||
<summary>
|
||||
Gets or sets the set of new values provided for virtual path generation.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Routing.VirtualPathData">
|
||||
<summary>
|
||||
Represents information about the route and virtual path that are the result of
|
||||
generating a URL with the ASP.NET routing middleware.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Routing.VirtualPathData.#ctor(Microsoft.AspNetCore.Routing.IRouter,System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Microsoft.AspNetCore.Routing.VirtualPathData"/> class.
|
||||
</summary>
|
||||
<param name="router">The object that is used to generate the URL.</param>
|
||||
<param name="virtualPath">The generated URL.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Routing.VirtualPathData.#ctor(Microsoft.AspNetCore.Routing.IRouter,System.String,Microsoft.AspNetCore.Routing.RouteValueDictionary)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Microsoft.AspNetCore.Routing.VirtualPathData"/> class.
|
||||
</summary>
|
||||
<param name="router">The object that is used to generate the URL.</param>
|
||||
<param name="virtualPath">The generated URL.</param>
|
||||
<param name="dataTokens">The collection of custom values.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Routing.VirtualPathData.DataTokens">
|
||||
<summary>
|
||||
Gets the collection of custom values for the <see cref="P:Microsoft.AspNetCore.Routing.VirtualPathData.Router"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Routing.VirtualPathData.Router">
|
||||
<summary>
|
||||
Gets or sets the <see cref="T:Microsoft.AspNetCore.Routing.IRouter"/> that was used to generate the URL.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Routing.VirtualPathData.VirtualPath">
|
||||
<summary>
|
||||
Gets or sets the URL that was generated from the <see cref="P:Microsoft.AspNetCore.Routing.VirtualPathData.Router"/>.
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
File diff suppressed because it is too large
Load Diff
Binary file not shown.
@@ -0,0 +1,415 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.AspNetCore.Server.IIS</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:System.Buffers.DiagnosticMemoryPool">
|
||||
<summary>
|
||||
Used to allocate and distribute re-usable blocks of memory.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Buffers.DiagnosticMemoryPool.AnySize">
|
||||
<summary>
|
||||
This default value passed in to Rent to use the default value for the pool.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Buffers.DiagnosticPoolBlock">
|
||||
<summary>
|
||||
Block tracking object used by the byte buffer memory pool. A slab is a large allocation which is divided into smaller blocks. The
|
||||
individual blocks are then treated as independent array segments.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Buffers.DiagnosticPoolBlock._pool">
|
||||
<summary>
|
||||
Back-reference to the memory pool which this block was allocated from. It may only be returned to this pool.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.Buffers.DiagnosticPoolBlock.#ctor(System.Buffers.DiagnosticMemoryPool,System.Buffers.IMemoryOwner{System.Byte})">
|
||||
<summary>
|
||||
This object cannot be instantiated outside of the static Create method
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Buffers.MemoryPoolBlock">
|
||||
<summary>
|
||||
Block tracking object used by the byte buffer memory pool. A slab is a large allocation which is divided into smaller blocks. The
|
||||
individual blocks are then treated as independent array segments.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.Buffers.MemoryPoolBlock.#ctor(System.Buffers.SlabMemoryPool,System.Buffers.MemoryPoolSlab,System.Int32,System.Int32)">
|
||||
<summary>
|
||||
This object cannot be instantiated outside of the static Create method
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Buffers.MemoryPoolBlock.Pool">
|
||||
<summary>
|
||||
Back-reference to the memory pool which this block was allocated from. It may only be returned to this pool.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Buffers.MemoryPoolBlock.Slab">
|
||||
<summary>
|
||||
Back-reference to the slab from which this block was taken, or null if it is one-time-use memory.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Buffers.MemoryPoolSlab">
|
||||
<summary>
|
||||
Slab tracking object used by the byte buffer memory pool. A slab is a large allocation which is divided into smaller blocks. The
|
||||
individual blocks are then treated as independent array segments.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Buffers.MemoryPoolSlab._gcHandle">
|
||||
<summary>
|
||||
This handle pins the managed array in memory until the slab is disposed. This prevents it from being
|
||||
relocated and enables any subsections of the array to be used as native memory pointers to P/Invoked API calls.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Buffers.MemoryPoolSlab.IsActive">
|
||||
<summary>
|
||||
True as long as the blocks from this slab are to be considered returnable to the pool. In order to shrink the
|
||||
memory pool size an entire slab must be removed. That is done by (1) setting IsActive to false and removing the
|
||||
slab from the pool's _slabs collection, (2) as each block currently in use is Return()ed to the pool it will
|
||||
be allowed to be garbage collected rather than re-pooled, and (3) when all block tracking objects are garbage
|
||||
collected and the slab is no longer references the slab will be garbage collected and the memory unpinned will
|
||||
be unpinned by the slab's Dispose.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Buffers.SlabMemoryPool">
|
||||
<summary>
|
||||
Used to allocate and distribute re-usable blocks of memory.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Buffers.SlabMemoryPool._blockSize">
|
||||
<summary>
|
||||
The size of a block. 4096 is chosen because most operating systems use 4k pages.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Buffers.SlabMemoryPool._blockCount">
|
||||
<summary>
|
||||
Allocating 32 contiguous blocks per slab makes the slab size 128k. This is larger than the 85k size which will place the memory
|
||||
in the large object heap. This means the GC will not try to relocate this array, so the fact it remains pinned does not negatively
|
||||
affect memory management's compactification.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Buffers.SlabMemoryPool.MaxBufferSize">
|
||||
<summary>
|
||||
Max allocation block size for pooled blocks,
|
||||
larger values can be leased but they will be disposed after use rather than returned to the pool.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Buffers.SlabMemoryPool._slabLength">
|
||||
<summary>
|
||||
4096 * 32 gives you a slabLength of 128k contiguous bytes allocated per slab
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Buffers.SlabMemoryPool._blocks">
|
||||
<summary>
|
||||
Thread-safe collection of blocks which are currently in the pool. A slab will pre-allocate all of the block tracking objects
|
||||
and add them to this collection. When memory is requested it is taken from here first, and when it is returned it is re-added.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Buffers.SlabMemoryPool._slabs">
|
||||
<summary>
|
||||
Thread-safe collection of slabs which have been allocated by this pool. As long as a slab is in this collection and slab.IsActive,
|
||||
the blocks will be added to _blocks when returned.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Buffers.SlabMemoryPool._isDisposed">
|
||||
<summary>
|
||||
This is part of implementing the IDisposable pattern.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Buffers.SlabMemoryPool.AnySize">
|
||||
<summary>
|
||||
This default value passed in to Rent to use the default value for the pool.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.Buffers.SlabMemoryPool.Lease">
|
||||
<summary>
|
||||
Called to take a block from the pool.
|
||||
</summary>
|
||||
<returns>The block that is reserved for the called. It must be passed to Return when it is no longer being used.</returns>
|
||||
</member>
|
||||
<member name="M:System.Buffers.SlabMemoryPool.AllocateSlab">
|
||||
<summary>
|
||||
Internal method called when a block is requested and the pool is empty. It allocates one additional slab, creates all of the
|
||||
block tracking objects, and adds them all to the pool.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.Buffers.SlabMemoryPool.Return(System.Buffers.MemoryPoolBlock)">
|
||||
<summary>
|
||||
Called to return a block to the pool. Once Return has been called the memory no longer belongs to the caller, and
|
||||
Very Bad Things will happen if the memory is read of modified subsequently. If a caller fails to call Return and the
|
||||
block tracking object is garbage collected, the block tracking object's finalizer will automatically re-create and return
|
||||
a new tracking object into the pool. This will only happen if there is a bug in the server, however it is necessary to avoid
|
||||
leaving "dead zones" in the slab due to lost block tracking objects.
|
||||
</summary>
|
||||
<param name="block">The block to return. It must have been acquired by calling Lease on the same memory pool instance.</param>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.HttpSys.Internal.SocketAddress">
|
||||
<devdoc>
|
||||
<para>
|
||||
This class is used when subclassing EndPoint, and provides indication
|
||||
on how to format the memory buffers that winsock uses for network addresses.
|
||||
</para>
|
||||
</devdoc>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.HttpSys.Internal.SocketAddress.#ctor(System.Net.Sockets.AddressFamily,System.Int32)">
|
||||
<devdoc>
|
||||
<para>[To be supplied.]</para>
|
||||
</devdoc>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.HttpSys.Internal.SocketAddress.Item(System.Int32)">
|
||||
<devdoc>
|
||||
<para>[To be supplied.]</para>
|
||||
</devdoc>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.HttpSys.Internal.RawUrlHelper.GetPath(System.Byte[])">
|
||||
<summary>
|
||||
Find the segment of the URI byte array which represents the path.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.HttpSys.Internal.RawUrlHelper.FindHttpOrHttps(System.Byte[])">
|
||||
<summary>
|
||||
Compare the beginning portion of the raw URL byte array to https:// and http://
|
||||
</summary>
|
||||
<param name="raw">The byte array represents the raw URI</param>
|
||||
<returns>Length of the matched bytes, 0 if it is not matched.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.HttpSys.Internal.RequestUriBuilder.Unescape(System.ArraySegment{System.Byte})">
|
||||
<summary>
|
||||
Unescape a given path string in place. The given path string may contain escaped char.
|
||||
</summary>
|
||||
<param name="rawPath">The raw path string to be unescaped</param>
|
||||
<returns>The unescaped path string</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.HttpSys.Internal.RequestUriBuilder.DecodeCore(System.Int32@,System.Int32@,System.Int32,System.Byte[])">
|
||||
<summary>
|
||||
Unescape the percent-encodings
|
||||
</summary>
|
||||
<param name="reader">The iterator point to the first % char</param>
|
||||
<param name="writer">The place to write to</param>
|
||||
<param name="end">The end of the buffer</param>
|
||||
<param name="buffer">The byte array</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.HttpSys.Internal.RequestUriBuilder.UnescapePercentEncoding(System.Int32@,System.Int32,System.Byte[])">
|
||||
<summary>
|
||||
Read the percent-encoding and try unescape it.
|
||||
|
||||
The operation first peek at the character the <paramref name="scan"/>
|
||||
iterator points at. If it is % the <paramref name="scan"/> is then
|
||||
moved on to scan the following to characters. If the two following
|
||||
characters are hexadecimal literals they will be unescaped and the
|
||||
value will be returned.
|
||||
|
||||
If the first character is not % the <paramref name="scan"/> iterator
|
||||
will be removed beyond the location of % and -1 will be returned.
|
||||
|
||||
If the following two characters can't be successfully unescaped the
|
||||
<paramref name="scan"/> iterator will be move behind the % and -1
|
||||
will be returned.
|
||||
</summary>
|
||||
<param name="scan">The value to read</param>
|
||||
<param name="end">The end of the buffer</param>
|
||||
<param name="buffer">The byte array</param>
|
||||
<returns>The unescaped byte if success. Otherwise return -1.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.HttpSys.Internal.RequestUriBuilder.ReadHex(System.Int32@,System.Int32,System.Byte[])">
|
||||
<summary>
|
||||
Read the next char and convert it into hexadecimal value.
|
||||
|
||||
The <paramref name="scan"/> iterator will be moved to the next
|
||||
byte no matter no matter whether the operation successes.
|
||||
</summary>
|
||||
<param name="scan">The value to read</param>
|
||||
<param name="end">The end of the buffer</param>
|
||||
<param name="buffer">The byte array</param>
|
||||
<returns>The hexadecimal value if successes, otherwise -1.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Server.IIS.Core.IISHttpContext.ReadAsync(System.Memory{System.Byte},System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Reads data from the Input pipe to the user.
|
||||
</summary>
|
||||
<param name="memory"></param>
|
||||
<param name="cancellationToken"></param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Server.IIS.Core.IISHttpContext.WriteAsync(System.ReadOnlyMemory{System.Byte},System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Writes data to the output pipe.
|
||||
</summary>
|
||||
<param name="memory"></param>
|
||||
<param name="cancellationToken"></param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Server.IIS.Core.IISHttpContext.FlushAsync(System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Flushes the data in the output pipe
|
||||
</summary>
|
||||
<param name="cancellationToken"></param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Server.IIS.HttpContextExtensions">
|
||||
<summary>
|
||||
Extensions to <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> that enable access to IIS features.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Server.IIS.HttpContextExtensions.GetIISServerVariable(Microsoft.AspNetCore.Http.HttpContext,System.String)">
|
||||
<summary>
|
||||
Gets the value of a server variable for the current request.
|
||||
</summary>
|
||||
<param name="context">The http context for the request.</param>
|
||||
<param name="variableName">The name of the variable.</param>
|
||||
<returns>
|
||||
<c>null</c> if the feature does not support the <see cref="T:Microsoft.AspNetCore.Http.Features.IServerVariablesFeature"/> feature.
|
||||
May return null or empty if the variable does not exist or is not set.
|
||||
</returns>
|
||||
<remarks>
|
||||
For a list of common server variables available in IIS, see http://go.microsoft.com/fwlink/?LinkId=52471.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Server.IIS.CoreStrings.ResponseStreamWasUpgraded">
|
||||
<summary>
|
||||
Cannot write to response body after connection has been upgraded.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Server.IIS.CoreStrings.FormatResponseStreamWasUpgraded">
|
||||
<summary>
|
||||
Cannot write to response body after connection has been upgraded.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Server.IIS.CoreStrings.UnhandledApplicationException">
|
||||
<summary>
|
||||
The response has been aborted due to an unhandled application exception.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Server.IIS.CoreStrings.FormatUnhandledApplicationException">
|
||||
<summary>
|
||||
The response has been aborted due to an unhandled application exception.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Server.IIS.CoreStrings.CannotUpgradeNonUpgradableRequest">
|
||||
<summary>
|
||||
Cannot upgrade a non-upgradable request. Check IHttpUpgradeFeature.IsUpgradableRequest to determine if a request can be upgraded.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Server.IIS.CoreStrings.FormatCannotUpgradeNonUpgradableRequest">
|
||||
<summary>
|
||||
Cannot upgrade a non-upgradable request. Check IHttpUpgradeFeature.IsUpgradableRequest to determine if a request can be upgraded.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Server.IIS.CoreStrings.UpgradeCannotBeCalledMultipleTimes">
|
||||
<summary>
|
||||
IHttpUpgradeFeature.UpgradeAsync was already called and can only be called once per connection.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Server.IIS.CoreStrings.FormatUpgradeCannotBeCalledMultipleTimes">
|
||||
<summary>
|
||||
IHttpUpgradeFeature.UpgradeAsync was already called and can only be called once per connection.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Server.IIS.CoreStrings.SynchronousReadsDisallowed">
|
||||
<summary>
|
||||
Synchronous operations are disallowed. Call ReadAsync or set AllowSynchronousIO to true instead.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Server.IIS.CoreStrings.FormatSynchronousReadsDisallowed">
|
||||
<summary>
|
||||
Synchronous operations are disallowed. Call ReadAsync or set AllowSynchronousIO to true instead.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Server.IIS.CoreStrings.SynchronousWritesDisallowed">
|
||||
<summary>
|
||||
Synchronous operations are disallowed. Call WriteAsync or set AllowSynchronousIO to true instead.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Server.IIS.CoreStrings.FormatSynchronousWritesDisallowed">
|
||||
<summary>
|
||||
Synchronous operations are disallowed. Call WriteAsync or set AllowSynchronousIO to true instead.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Server.IIS.CoreStrings.WritingToResponseBodyAfterResponseCompleted">
|
||||
<summary>
|
||||
Cannot write to the response body, the response has completed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Server.IIS.CoreStrings.FormatWritingToResponseBodyAfterResponseCompleted">
|
||||
<summary>
|
||||
Cannot write to the response body, the response has completed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Server.IIS.CoreStrings.ConnectionAbortedByApplication">
|
||||
<summary>
|
||||
The connection was aborted by the application.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Server.IIS.CoreStrings.FormatConnectionAbortedByApplication">
|
||||
<summary>
|
||||
The connection was aborted by the application.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Server.IIS.CoreStrings.ConnectionOrStreamAbortedByCancellationToken">
|
||||
<summary>
|
||||
The connection or stream was aborted because a write operation was aborted with a CancellationToken.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Server.IIS.CoreStrings.FormatConnectionOrStreamAbortedByCancellationToken">
|
||||
<summary>
|
||||
The connection or stream was aborted because a write operation was aborted with a CancellationToken.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Server.IIS.CoreStrings.ParameterReadOnlyAfterResponseStarted">
|
||||
<summary>
|
||||
{name} cannot be set because the response has already started.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Server.IIS.CoreStrings.FormatParameterReadOnlyAfterResponseStarted(System.Object)">
|
||||
<summary>
|
||||
{name} cannot be set because the response has already started.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Builder.IISServerOptions.AutomaticAuthentication">
|
||||
<summary>
|
||||
If true the server should set HttpContext.User. If false the server will only provide an
|
||||
identity when explicitly requested by the AuthenticationScheme.
|
||||
Note Windows Authentication must also be enabled in IIS for this to work.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Builder.IISServerOptions.AuthenticationDisplayName">
|
||||
<summary>
|
||||
Sets the display name shown to users on login pages. The default is null.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Builder.IISServerOptions.ForwardWindowsAuthentication">
|
||||
<summary>
|
||||
Used to indicate if the authentication handler should be registered. This is only done if ANCM indicates
|
||||
IIS has a non-anonymous authentication enabled, or for back compat with ANCMs that did not provide this information.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Http.Features.IServerVariablesFeature">
|
||||
<summary>
|
||||
This feature provides access to request server variables set.
|
||||
<para>
|
||||
This feature is only available when hosting ASP.NET Core in-process with IIS or IIS Express.
|
||||
</para>
|
||||
</summary>
|
||||
<remarks>
|
||||
For a list of common server variables available in IIS, see http://go.microsoft.com/fwlink/?LinkId=52471.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Http.Features.IServerVariablesFeature.Item(System.String)">
|
||||
<summary>
|
||||
Gets or sets the value of a server variable for the current request.
|
||||
</summary>
|
||||
<param name="variableName">The variable name</param>
|
||||
<returns>May return null or empty if the variable does not exist or is not set.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.WebHostBuilderIISExtensions.UseIIS(Microsoft.AspNetCore.Hosting.IWebHostBuilder)">
|
||||
<summary>
|
||||
Configures the port and base path the server should listen on when running behind AspNetCoreModule.
|
||||
The app will also be configured to capture startup errors.
|
||||
</summary>
|
||||
<param name="hostBuilder"></param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1,39 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.AspNetCore.Server.IISIntegration</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="P:Microsoft.AspNetCore.Builder.IISOptions.AutomaticAuthentication">
|
||||
<summary>
|
||||
If true the middleware should set HttpContext.User. If false the middleware will only provide an
|
||||
identity when explicitly requested by the AuthenticationScheme.
|
||||
Note Windows Authentication must also be enabled in IIS for this to work.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Builder.IISOptions.AuthenticationDisplayName">
|
||||
<summary>
|
||||
Sets the display name shown to users on login pages. The default is null.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Builder.IISOptions.ForwardWindowsAuthentication">
|
||||
<summary>
|
||||
Used to indicate if the authentication handler should be registered. This is only done if ANCM indicates
|
||||
IIS has a non-anonymous authentication enabled, or for back compat with ANCMs that did not provide this information.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Builder.IISOptions.ForwardClientCertificate">
|
||||
<summary>
|
||||
Populates the ITLSConnectionFeature if the MS-ASPNETCORE-CLIENTCERT request header is present.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.WebHostBuilderIISExtensions.UseIISIntegration(Microsoft.AspNetCore.Hosting.IWebHostBuilder)">
|
||||
<summary>
|
||||
Configures the port and base path the server should listen on when running behind AspNetCoreModule.
|
||||
The app will also be configured to capture startup errors.
|
||||
</summary>
|
||||
<param name="hostBuilder"></param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
File diff suppressed because it is too large
Load Diff
Binary file not shown.
@@ -0,0 +1,8 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.AspNetCore.Server.Kestrel.Https</name>
|
||||
</assembly>
|
||||
<members>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1,193 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.AspNetCore.Server.Kestrel.Transport.Abstractions</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.AspNetCore.Server.Kestrel.Transport.Abstractions.Internal.FileHandleType">
|
||||
<summary>
|
||||
Enumerates the <see cref="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Abstractions.Internal.IEndPointInformation.FileHandle"/> types.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Abstractions.Internal.IEndPointInformation.Type">
|
||||
<summary>
|
||||
The type of interface being described: either an <see cref="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Abstractions.Internal.IEndPointInformation.IPEndPoint"/>, Unix domain socket path, or a file descriptor.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Abstractions.Internal.IEndPointInformation.IPEndPoint">
|
||||
<summary>
|
||||
The <see cref="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Abstractions.Internal.IEndPointInformation.IPEndPoint"/> to bind to.
|
||||
Only set if <see cref="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Abstractions.Internal.IEndPointInformation.Type"/> is <see cref="F:Microsoft.AspNetCore.Server.Kestrel.Transport.Abstractions.Internal.ListenType.IPEndPoint"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Abstractions.Internal.IEndPointInformation.SocketPath">
|
||||
<summary>
|
||||
The absolute path to a Unix domain socket to bind to.
|
||||
Only set if <see cref="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Abstractions.Internal.IEndPointInformation.Type"/> is <see cref="F:Microsoft.AspNetCore.Server.Kestrel.Transport.Abstractions.Internal.ListenType.SocketPath"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Abstractions.Internal.IEndPointInformation.FileHandle">
|
||||
<summary>
|
||||
A file descriptor for the socket to open.
|
||||
Only set if <see cref="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Abstractions.Internal.IEndPointInformation.Type"/> is <see cref="F:Microsoft.AspNetCore.Server.Kestrel.Transport.Abstractions.Internal.ListenType.FileHandle"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Abstractions.Internal.IEndPointInformation.HandleType">
|
||||
<summary>
|
||||
The type of file descriptor being used.
|
||||
Only set if <see cref="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Abstractions.Internal.IEndPointInformation.Type"/> is <see cref="F:Microsoft.AspNetCore.Server.Kestrel.Transport.Abstractions.Internal.ListenType.FileHandle"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Abstractions.Internal.IEndPointInformation.NoDelay">
|
||||
<summary>
|
||||
Set to false to enable Nagle's algorithm for all connections.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Server.Kestrel.Transport.Abstractions.Internal.ListenType">
|
||||
<summary>
|
||||
Enumerates the <see cref="T:Microsoft.AspNetCore.Server.Kestrel.Transport.Abstractions.Internal.IEndPointInformation"/> types.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Buffers.DiagnosticMemoryPool">
|
||||
<summary>
|
||||
Used to allocate and distribute re-usable blocks of memory.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Buffers.DiagnosticMemoryPool.AnySize">
|
||||
<summary>
|
||||
This default value passed in to Rent to use the default value for the pool.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Buffers.DiagnosticPoolBlock">
|
||||
<summary>
|
||||
Block tracking object used by the byte buffer memory pool. A slab is a large allocation which is divided into smaller blocks. The
|
||||
individual blocks are then treated as independent array segments.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Buffers.DiagnosticPoolBlock._pool">
|
||||
<summary>
|
||||
Back-reference to the memory pool which this block was allocated from. It may only be returned to this pool.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.Buffers.DiagnosticPoolBlock.#ctor(System.Buffers.DiagnosticMemoryPool,System.Buffers.IMemoryOwner{System.Byte})">
|
||||
<summary>
|
||||
This object cannot be instantiated outside of the static Create method
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Buffers.MemoryPoolBlock">
|
||||
<summary>
|
||||
Block tracking object used by the byte buffer memory pool. A slab is a large allocation which is divided into smaller blocks. The
|
||||
individual blocks are then treated as independent array segments.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.Buffers.MemoryPoolBlock.#ctor(System.Buffers.SlabMemoryPool,System.Buffers.MemoryPoolSlab,System.Int32,System.Int32)">
|
||||
<summary>
|
||||
This object cannot be instantiated outside of the static Create method
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Buffers.MemoryPoolBlock.Pool">
|
||||
<summary>
|
||||
Back-reference to the memory pool which this block was allocated from. It may only be returned to this pool.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Buffers.MemoryPoolBlock.Slab">
|
||||
<summary>
|
||||
Back-reference to the slab from which this block was taken, or null if it is one-time-use memory.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Buffers.MemoryPoolSlab">
|
||||
<summary>
|
||||
Slab tracking object used by the byte buffer memory pool. A slab is a large allocation which is divided into smaller blocks. The
|
||||
individual blocks are then treated as independent array segments.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Buffers.MemoryPoolSlab._gcHandle">
|
||||
<summary>
|
||||
This handle pins the managed array in memory until the slab is disposed. This prevents it from being
|
||||
relocated and enables any subsections of the array to be used as native memory pointers to P/Invoked API calls.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Buffers.MemoryPoolSlab.IsActive">
|
||||
<summary>
|
||||
True as long as the blocks from this slab are to be considered returnable to the pool. In order to shrink the
|
||||
memory pool size an entire slab must be removed. That is done by (1) setting IsActive to false and removing the
|
||||
slab from the pool's _slabs collection, (2) as each block currently in use is Return()ed to the pool it will
|
||||
be allowed to be garbage collected rather than re-pooled, and (3) when all block tracking objects are garbage
|
||||
collected and the slab is no longer references the slab will be garbage collected and the memory unpinned will
|
||||
be unpinned by the slab's Dispose.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Buffers.SlabMemoryPool">
|
||||
<summary>
|
||||
Used to allocate and distribute re-usable blocks of memory.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Buffers.SlabMemoryPool._blockSize">
|
||||
<summary>
|
||||
The size of a block. 4096 is chosen because most operating systems use 4k pages.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Buffers.SlabMemoryPool._blockCount">
|
||||
<summary>
|
||||
Allocating 32 contiguous blocks per slab makes the slab size 128k. This is larger than the 85k size which will place the memory
|
||||
in the large object heap. This means the GC will not try to relocate this array, so the fact it remains pinned does not negatively
|
||||
affect memory management's compactification.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Buffers.SlabMemoryPool.MaxBufferSize">
|
||||
<summary>
|
||||
Max allocation block size for pooled blocks,
|
||||
larger values can be leased but they will be disposed after use rather than returned to the pool.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Buffers.SlabMemoryPool._slabLength">
|
||||
<summary>
|
||||
4096 * 32 gives you a slabLength of 128k contiguous bytes allocated per slab
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Buffers.SlabMemoryPool._blocks">
|
||||
<summary>
|
||||
Thread-safe collection of blocks which are currently in the pool. A slab will pre-allocate all of the block tracking objects
|
||||
and add them to this collection. When memory is requested it is taken from here first, and when it is returned it is re-added.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Buffers.SlabMemoryPool._slabs">
|
||||
<summary>
|
||||
Thread-safe collection of slabs which have been allocated by this pool. As long as a slab is in this collection and slab.IsActive,
|
||||
the blocks will be added to _blocks when returned.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Buffers.SlabMemoryPool._isDisposed">
|
||||
<summary>
|
||||
This is part of implementing the IDisposable pattern.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Buffers.SlabMemoryPool.AnySize">
|
||||
<summary>
|
||||
This default value passed in to Rent to use the default value for the pool.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.Buffers.SlabMemoryPool.Lease">
|
||||
<summary>
|
||||
Called to take a block from the pool.
|
||||
</summary>
|
||||
<returns>The block that is reserved for the called. It must be passed to Return when it is no longer being used.</returns>
|
||||
</member>
|
||||
<member name="M:System.Buffers.SlabMemoryPool.AllocateSlab">
|
||||
<summary>
|
||||
Internal method called when a block is requested and the pool is empty. It allocates one additional slab, creates all of the
|
||||
block tracking objects, and adds them all to the pool.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.Buffers.SlabMemoryPool.Return(System.Buffers.MemoryPoolBlock)">
|
||||
<summary>
|
||||
Called to return a block to the pool. Once Return has been called the memory no longer belongs to the caller, and
|
||||
Very Bad Things will happen if the memory is read of modified subsequently. If a caller fails to call Return and the
|
||||
block tracking object is garbage collected, the block tracking object's finalizer will automatically re-create and return
|
||||
a new tracking object into the pool. This will only happen if there is a bug in the server, however it is necessary to avoid
|
||||
leaving "dead zones" in the slab due to lost block tracking objects.
|
||||
</summary>
|
||||
<param name="block">The block to return. It must have been acquired by calling Lease on the same memory pool instance.</param>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1,61 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketsStrings.OnlyIPEndPointsSupported">
|
||||
<summary>
|
||||
Only ListenType.IPEndPoint is supported by the Socket Transport. https://go.microsoft.com/fwlink/?linkid=874850
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketsStrings.FormatOnlyIPEndPointsSupported">
|
||||
<summary>
|
||||
Only ListenType.IPEndPoint is supported by the Socket Transport. https://go.microsoft.com/fwlink/?linkid=874850
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketsStrings.TransportAlreadyBound">
|
||||
<summary>
|
||||
Transport is already bound.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketsStrings.FormatTransportAlreadyBound">
|
||||
<summary>
|
||||
Transport is already bound.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketTransportOptions.IOQueueCount">
|
||||
<summary>
|
||||
The number of I/O queues used to process requests. Set to 0 to directly schedule I/O to the ThreadPool.
|
||||
</summary>
|
||||
<remarks>
|
||||
Defaults to <see cref="P:System.Environment.ProcessorCount" /> rounded down and clamped between 1 and 16.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.WebHostBuilderSocketExtensions.UseSockets(Microsoft.AspNetCore.Hosting.IWebHostBuilder)">
|
||||
<summary>
|
||||
Specify Sockets as the transport to be used by Kestrel.
|
||||
</summary>
|
||||
<param name="hostBuilder">
|
||||
The Microsoft.AspNetCore.Hosting.IWebHostBuilder to configure.
|
||||
</param>
|
||||
<returns>
|
||||
The Microsoft.AspNetCore.Hosting.IWebHostBuilder.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.WebHostBuilderSocketExtensions.UseSockets(Microsoft.AspNetCore.Hosting.IWebHostBuilder,System.Action{Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketTransportOptions})">
|
||||
<summary>
|
||||
Specify Sockets as the transport to be used by Kestrel.
|
||||
</summary>
|
||||
<param name="hostBuilder">
|
||||
The Microsoft.AspNetCore.Hosting.IWebHostBuilder to configure.
|
||||
</param>
|
||||
<param name="configureOptions">
|
||||
A callback to configure Libuv options.
|
||||
</param>
|
||||
<returns>
|
||||
The Microsoft.AspNetCore.Hosting.IWebHostBuilder.
|
||||
</returns>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1,71 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.AspNetCore.Server.Kestrel</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.WebHostBuilderKestrelExtensions.UseKestrel(Microsoft.AspNetCore.Hosting.IWebHostBuilder)">
|
||||
<summary>
|
||||
Specify Kestrel as the server to be used by the web host.
|
||||
</summary>
|
||||
<param name="hostBuilder">
|
||||
The Microsoft.AspNetCore.Hosting.IWebHostBuilder to configure.
|
||||
</param>
|
||||
<returns>
|
||||
The Microsoft.AspNetCore.Hosting.IWebHostBuilder.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.WebHostBuilderKestrelExtensions.UseKestrel(Microsoft.AspNetCore.Hosting.IWebHostBuilder,System.Action{Microsoft.AspNetCore.Server.Kestrel.Core.KestrelServerOptions})">
|
||||
<summary>
|
||||
Specify Kestrel as the server to be used by the web host.
|
||||
</summary>
|
||||
<param name="hostBuilder">
|
||||
The Microsoft.AspNetCore.Hosting.IWebHostBuilder to configure.
|
||||
</param>
|
||||
<param name="options">
|
||||
A callback to configure Kestrel options.
|
||||
</param>
|
||||
<returns>
|
||||
The Microsoft.AspNetCore.Hosting.IWebHostBuilder.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.WebHostBuilderKestrelExtensions.ConfigureKestrel(Microsoft.AspNetCore.Hosting.IWebHostBuilder,System.Action{Microsoft.AspNetCore.Server.Kestrel.Core.KestrelServerOptions})">
|
||||
<summary>
|
||||
Configures Kestrel options but does not register an IServer. See <see cref="M:Microsoft.AspNetCore.Hosting.WebHostBuilderKestrelExtensions.UseKestrel(Microsoft.AspNetCore.Hosting.IWebHostBuilder)"/>.
|
||||
</summary>
|
||||
<param name="hostBuilder">
|
||||
The Microsoft.AspNetCore.Hosting.IWebHostBuilder to configure.
|
||||
</param>
|
||||
<param name="options">
|
||||
A callback to configure Kestrel options.
|
||||
</param>
|
||||
<returns>
|
||||
The Microsoft.AspNetCore.Hosting.IWebHostBuilder.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.WebHostBuilderKestrelExtensions.UseKestrel(Microsoft.AspNetCore.Hosting.IWebHostBuilder,System.Action{Microsoft.AspNetCore.Hosting.WebHostBuilderContext,Microsoft.AspNetCore.Server.Kestrel.Core.KestrelServerOptions})">
|
||||
<summary>
|
||||
Specify Kestrel as the server to be used by the web host.
|
||||
</summary>
|
||||
<param name="hostBuilder">
|
||||
The Microsoft.AspNetCore.Hosting.IWebHostBuilder to configure.
|
||||
</param>
|
||||
<param name="configureOptions">A callback to configure Kestrel options.</param>
|
||||
<returns>
|
||||
The Microsoft.AspNetCore.Hosting.IWebHostBuilder.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Hosting.WebHostBuilderKestrelExtensions.ConfigureKestrel(Microsoft.AspNetCore.Hosting.IWebHostBuilder,System.Action{Microsoft.AspNetCore.Hosting.WebHostBuilderContext,Microsoft.AspNetCore.Server.Kestrel.Core.KestrelServerOptions})">
|
||||
<summary>
|
||||
Configures Kestrel options but does not register an IServer. See <see cref="M:Microsoft.AspNetCore.Hosting.WebHostBuilderKestrelExtensions.UseKestrel(Microsoft.AspNetCore.Hosting.IWebHostBuilder)"/>.
|
||||
</summary>
|
||||
<param name="hostBuilder">
|
||||
The Microsoft.AspNetCore.Hosting.IWebHostBuilder to configure.
|
||||
</param>
|
||||
<param name="configureOptions">A callback to configure Kestrel options.</param>
|
||||
<returns>
|
||||
The Microsoft.AspNetCore.Hosting.IWebHostBuilder.
|
||||
</returns>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1,538 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.AspNetCore.WebUtilities</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="F:Microsoft.Extensions.WebEncoders.Sources.EncoderResources.WebEncoders_InvalidCountOffsetOrLength">
|
||||
<summary>
|
||||
Invalid {0}, {1} or {2} length.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.Extensions.WebEncoders.Sources.EncoderResources.WebEncoders_MalformedInput">
|
||||
<summary>
|
||||
Malformed input: {0} is an invalid input length.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.WebEncoders.Sources.EncoderResources.FormatWebEncoders_InvalidCountOffsetOrLength(System.Object,System.Object,System.Object)">
|
||||
<summary>
|
||||
Invalid {0}, {1} or {2} length.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.WebEncoders.Sources.EncoderResources.FormatWebEncoders_MalformedInput(System.Object)">
|
||||
<summary>
|
||||
Malformed input: {0} is an invalid input length.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.WebUtilities.WebEncoders">
|
||||
<summary>
|
||||
Contains utility APIs to assist with common encoding and decoding operations.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebUtilities.WebEncoders.Base64UrlDecode(System.String)">
|
||||
<summary>
|
||||
Decodes a base64url-encoded string.
|
||||
</summary>
|
||||
<param name="input">The base64url-encoded input to decode.</param>
|
||||
<returns>The base64url-decoded form of the input.</returns>
|
||||
<remarks>
|
||||
The input must not contain any whitespace or padding characters.
|
||||
Throws <see cref="T:System.FormatException"/> if the input is malformed.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebUtilities.WebEncoders.Base64UrlDecode(System.String,System.Int32,System.Int32)">
|
||||
<summary>
|
||||
Decodes a base64url-encoded substring of a given string.
|
||||
</summary>
|
||||
<param name="input">A string containing the base64url-encoded input to decode.</param>
|
||||
<param name="offset">The position in <paramref name="input"/> at which decoding should begin.</param>
|
||||
<param name="count">The number of characters in <paramref name="input"/> to decode.</param>
|
||||
<returns>The base64url-decoded form of the input.</returns>
|
||||
<remarks>
|
||||
The input must not contain any whitespace or padding characters.
|
||||
Throws <see cref="T:System.FormatException"/> if the input is malformed.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebUtilities.WebEncoders.Base64UrlDecode(System.String,System.Int32,System.Char[],System.Int32,System.Int32)">
|
||||
<summary>
|
||||
Decodes a base64url-encoded <paramref name="input"/> into a <c>byte[]</c>.
|
||||
</summary>
|
||||
<param name="input">A string containing the base64url-encoded input to decode.</param>
|
||||
<param name="offset">The position in <paramref name="input"/> at which decoding should begin.</param>
|
||||
<param name="buffer">
|
||||
Scratch buffer to hold the <see cref="T:System.Char"/>s to decode. Array must be large enough to hold
|
||||
<paramref name="bufferOffset"/> and <paramref name="count"/> characters as well as Base64 padding
|
||||
characters. Content is not preserved.
|
||||
</param>
|
||||
<param name="bufferOffset">
|
||||
The offset into <paramref name="buffer"/> at which to begin writing the <see cref="T:System.Char"/>s to decode.
|
||||
</param>
|
||||
<param name="count">The number of characters in <paramref name="input"/> to decode.</param>
|
||||
<returns>The base64url-decoded form of the <paramref name="input"/>.</returns>
|
||||
<remarks>
|
||||
The input must not contain any whitespace or padding characters.
|
||||
Throws <see cref="T:System.FormatException"/> if the input is malformed.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebUtilities.WebEncoders.GetArraySizeRequiredToDecode(System.Int32)">
|
||||
<summary>
|
||||
Gets the minimum <c>char[]</c> size required for decoding of <paramref name="count"/> characters
|
||||
with the <see cref="M:Microsoft.AspNetCore.WebUtilities.WebEncoders.Base64UrlDecode(System.String,System.Int32,System.Char[],System.Int32,System.Int32)"/> method.
|
||||
</summary>
|
||||
<param name="count">The number of characters to decode.</param>
|
||||
<returns>
|
||||
The minimum <c>char[]</c> size required for decoding of <paramref name="count"/> characters.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebUtilities.WebEncoders.Base64UrlEncode(System.Byte[])">
|
||||
<summary>
|
||||
Encodes <paramref name="input"/> using base64url encoding.
|
||||
</summary>
|
||||
<param name="input">The binary input to encode.</param>
|
||||
<returns>The base64url-encoded form of <paramref name="input"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebUtilities.WebEncoders.Base64UrlEncode(System.Byte[],System.Int32,System.Int32)">
|
||||
<summary>
|
||||
Encodes <paramref name="input"/> using base64url encoding.
|
||||
</summary>
|
||||
<param name="input">The binary input to encode.</param>
|
||||
<param name="offset">The offset into <paramref name="input"/> at which to begin encoding.</param>
|
||||
<param name="count">The number of bytes from <paramref name="input"/> to encode.</param>
|
||||
<returns>The base64url-encoded form of <paramref name="input"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebUtilities.WebEncoders.Base64UrlEncode(System.Byte[],System.Int32,System.Char[],System.Int32,System.Int32)">
|
||||
<summary>
|
||||
Encodes <paramref name="input"/> using base64url encoding.
|
||||
</summary>
|
||||
<param name="input">The binary input to encode.</param>
|
||||
<param name="offset">The offset into <paramref name="input"/> at which to begin encoding.</param>
|
||||
<param name="output">
|
||||
Buffer to receive the base64url-encoded form of <paramref name="input"/>. Array must be large enough to
|
||||
hold <paramref name="outputOffset"/> characters and the full base64-encoded form of
|
||||
<paramref name="input"/>, including padding characters.
|
||||
</param>
|
||||
<param name="outputOffset">
|
||||
The offset into <paramref name="output"/> at which to begin writing the base64url-encoded form of
|
||||
<paramref name="input"/>.
|
||||
</param>
|
||||
<param name="count">The number of <c>byte</c>s from <paramref name="input"/> to encode.</param>
|
||||
<returns>
|
||||
The number of characters written to <paramref name="output"/>, less any padding characters.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebUtilities.WebEncoders.GetArraySizeRequiredToEncode(System.Int32)">
|
||||
<summary>
|
||||
Get the minimum output <c>char[]</c> size required for encoding <paramref name="count"/>
|
||||
<see cref="T:System.Byte"/>s with the <see cref="M:Microsoft.AspNetCore.WebUtilities.WebEncoders.Base64UrlEncode(System.Byte[],System.Int32,System.Char[],System.Int32,System.Int32)"/> method.
|
||||
</summary>
|
||||
<param name="count">The number of characters to encode.</param>
|
||||
<returns>
|
||||
The minimum output <c>char[]</c> size required for encoding <paramref name="count"/> <see cref="T:System.Byte"/>s.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebUtilities.Base64UrlTextEncoder.Encode(System.Byte[])">
|
||||
<summary>
|
||||
Encodes supplied data into Base64 and replaces any URL encodable characters into non-URL encodable
|
||||
characters.
|
||||
</summary>
|
||||
<param name="data">Data to be encoded.</param>
|
||||
<returns>Base64 encoded string modified with non-URL encodable characters</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebUtilities.Base64UrlTextEncoder.Decode(System.String)">
|
||||
<summary>
|
||||
Decodes supplied string by replacing the non-URL encodable characters with URL encodable characters and
|
||||
then decodes the Base64 string.
|
||||
</summary>
|
||||
<param name="text">The string to be decoded.</param>
|
||||
<returns>The decoded data.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.WebUtilities.BufferedReadStream">
|
||||
<summary>
|
||||
A Stream that wraps another stream and allows reading lines.
|
||||
The data is buffered in memory.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.#ctor(System.IO.Stream,System.Int32)">
|
||||
<summary>
|
||||
Creates a new stream.
|
||||
</summary>
|
||||
<param name="inner">The stream to wrap.</param>
|
||||
<param name="bufferSize">Size of buffer in bytes.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.#ctor(System.IO.Stream,System.Int32,System.Buffers.ArrayPool{System.Byte})">
|
||||
<summary>
|
||||
Creates a new stream.
|
||||
</summary>
|
||||
<param name="inner">The stream to wrap.</param>
|
||||
<param name="bufferSize">Size of buffer in bytes.</param>
|
||||
<param name="bytePool">ArrayPool for the buffer.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.BufferedData">
|
||||
<summary>
|
||||
The currently buffered data.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.CanRead">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.CanSeek">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.CanTimeout">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.CanWrite">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.Length">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.Position">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.Seek(System.Int64,System.IO.SeekOrigin)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.SetLength(System.Int64)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.Dispose(System.Boolean)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.Flush">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.FlushAsync(System.Threading.CancellationToken)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.Write(System.Byte[],System.Int32,System.Int32)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.Read(System.Byte[],System.Int32,System.Int32)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.ReadAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.EnsureBuffered">
|
||||
<summary>
|
||||
Ensures that the buffer is not empty.
|
||||
</summary>
|
||||
<returns>Returns <c>true</c> if the buffer is not empty; <c>false</c> otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.EnsureBufferedAsync(System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Ensures that the buffer is not empty.
|
||||
</summary>
|
||||
<param name="cancellationToken">Cancellation token.</param>
|
||||
<returns>Returns <c>true</c> if the buffer is not empty; <c>false</c> otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.EnsureBuffered(System.Int32)">
|
||||
<summary>
|
||||
Ensures that a minimum amount of buffered data is available.
|
||||
</summary>
|
||||
<param name="minCount">Minimum amount of buffered data.</param>
|
||||
<returns>Returns <c>true</c> if the minimum amount of buffered data is available; <c>false</c> otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.EnsureBufferedAsync(System.Int32,System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Ensures that a minimum amount of buffered data is available.
|
||||
</summary>
|
||||
<param name="minCount">Minimum amount of buffered data.</param>
|
||||
<param name="cancellationToken">Cancellation token.</param>
|
||||
<returns>Returns <c>true</c> if the minimum amount of buffered data is available; <c>false</c> otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.ReadLine(System.Int32)">
|
||||
<summary>
|
||||
Reads a line. A line is defined as a sequence of characters followed by
|
||||
a carriage return immediately followed by a line feed. The resulting string does not
|
||||
contain the terminating carriage return and line feed.
|
||||
</summary>
|
||||
<param name="lengthLimit">Maximum allowed line length.</param>
|
||||
<returns>A line.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebUtilities.BufferedReadStream.ReadLineAsync(System.Int32,System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Reads a line. A line is defined as a sequence of characters followed by
|
||||
a carriage return immediately followed by a line feed. The resulting string does not
|
||||
contain the terminating carriage return and line feed.
|
||||
</summary>
|
||||
<param name="lengthLimit">Maximum allowed line length.</param>
|
||||
<param name="cancellationToken">Cancellation token.</param>
|
||||
<returns>A line.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.WebUtilities.FileBufferingReadStream">
|
||||
<summary>
|
||||
A Stream that wraps another stream and enables rewinding by buffering the content as it is read.
|
||||
The content is buffered in memory up to a certain size and then spooled to a temp file on disk.
|
||||
The temp file will be deleted on Dispose.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.WebUtilities.FileMultipartSection">
|
||||
<summary>
|
||||
Represents a file multipart section
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebUtilities.FileMultipartSection.#ctor(Microsoft.AspNetCore.WebUtilities.MultipartSection)">
|
||||
<summary>
|
||||
Creates a new instance of the <see cref="T:Microsoft.AspNetCore.WebUtilities.FileMultipartSection"/> class
|
||||
</summary>
|
||||
<param name="section">The section from which to create the <see cref="T:Microsoft.AspNetCore.WebUtilities.FileMultipartSection"/></param>
|
||||
<remarks>Reparses the content disposition header</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebUtilities.FileMultipartSection.#ctor(Microsoft.AspNetCore.WebUtilities.MultipartSection,Microsoft.Net.Http.Headers.ContentDispositionHeaderValue)">
|
||||
<summary>
|
||||
Creates a new instance of the <see cref="T:Microsoft.AspNetCore.WebUtilities.FileMultipartSection"/> class
|
||||
</summary>
|
||||
<param name="section">The section from which to create the <see cref="T:Microsoft.AspNetCore.WebUtilities.FileMultipartSection"/></param>
|
||||
<param name="header">An already parsed content disposition header</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.WebUtilities.FileMultipartSection.Section">
|
||||
<summary>
|
||||
Gets the original section from which this object was created
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.WebUtilities.FileMultipartSection.FileStream">
|
||||
<summary>
|
||||
Gets the file stream from the section body
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.WebUtilities.FileMultipartSection.Name">
|
||||
<summary>
|
||||
Gets the name of the section
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.WebUtilities.FileMultipartSection.FileName">
|
||||
<summary>
|
||||
Gets the name of the file from the section
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.WebUtilities.FormMultipartSection">
|
||||
<summary>
|
||||
Represents a form multipart section
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebUtilities.FormMultipartSection.#ctor(Microsoft.AspNetCore.WebUtilities.MultipartSection)">
|
||||
<summary>
|
||||
Creates a new instance of the <see cref="T:Microsoft.AspNetCore.WebUtilities.FormMultipartSection"/> class
|
||||
</summary>
|
||||
<param name="section">The section from which to create the <see cref="T:Microsoft.AspNetCore.WebUtilities.FormMultipartSection"/></param>
|
||||
<remarks>Reparses the content disposition header</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebUtilities.FormMultipartSection.#ctor(Microsoft.AspNetCore.WebUtilities.MultipartSection,Microsoft.Net.Http.Headers.ContentDispositionHeaderValue)">
|
||||
<summary>
|
||||
Creates a new instance of the <see cref="T:Microsoft.AspNetCore.WebUtilities.FormMultipartSection"/> class
|
||||
</summary>
|
||||
<param name="section">The section from which to create the <see cref="T:Microsoft.AspNetCore.WebUtilities.FormMultipartSection"/></param>
|
||||
<param name="header">An already parsed content disposition header</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.WebUtilities.FormMultipartSection.Section">
|
||||
<summary>
|
||||
Gets the original section from which this object was created
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.WebUtilities.FormMultipartSection.Name">
|
||||
<summary>
|
||||
The form name
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebUtilities.FormMultipartSection.GetValueAsync">
|
||||
<summary>
|
||||
Gets the form value
|
||||
</summary>
|
||||
<returns>The form value</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.WebUtilities.FormReader">
|
||||
<summary>
|
||||
Used to read an 'application/x-www-form-urlencoded' form.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.WebUtilities.FormReader.ValueCountLimit">
|
||||
<summary>
|
||||
The limit on the number of form values to allow in ReadForm or ReadFormAsync.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.WebUtilities.FormReader.KeyLengthLimit">
|
||||
<summary>
|
||||
The limit on the length of form keys.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.WebUtilities.FormReader.ValueLengthLimit">
|
||||
<summary>
|
||||
The limit on the length of form values.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebUtilities.FormReader.ReadNextPair">
|
||||
<summary>
|
||||
Reads the next key value pair from the form.
|
||||
For unbuffered data use the async overload instead.
|
||||
</summary>
|
||||
<returns>The next key value pair, or null when the end of the form is reached.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebUtilities.FormReader.ReadNextPairAsync(System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Asynchronously reads the next key value pair from the form.
|
||||
</summary>
|
||||
<param name="cancellationToken"></param>
|
||||
<returns>The next key value pair, or null when the end of the form is reached.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebUtilities.FormReader.ReadForm">
|
||||
<summary>
|
||||
Parses text from an HTTP form body.
|
||||
</summary>
|
||||
<returns>The collection containing the parsed HTTP form body.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebUtilities.FormReader.ReadFormAsync(System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Parses an HTTP form body.
|
||||
</summary>
|
||||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/>.</param>
|
||||
<returns>The collection containing the parsed HTTP form body.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.WebUtilities.HttpResponseStreamWriter">
|
||||
<summary>
|
||||
Writes to the <see cref="T:System.IO.Stream"/> using the supplied <see cref="P:Microsoft.AspNetCore.WebUtilities.HttpResponseStreamWriter.Encoding"/>.
|
||||
It does not write the BOM and also does not close the stream.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.WebUtilities.MultipartReader.HeadersCountLimit">
|
||||
<summary>
|
||||
The limit for the number of headers to read.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.WebUtilities.MultipartReader.HeadersLengthLimit">
|
||||
<summary>
|
||||
The combined size limit for headers per multipart section.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.WebUtilities.MultipartReader.BodyLengthLimit">
|
||||
<summary>
|
||||
The optional limit for the total response body length.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebUtilities.MultipartReaderStream.#ctor(Microsoft.AspNetCore.WebUtilities.BufferedReadStream,Microsoft.AspNetCore.WebUtilities.MultipartBoundary)">
|
||||
<summary>
|
||||
Creates a stream that reads until it reaches the given boundary pattern.
|
||||
</summary>
|
||||
<param name="stream">The <see cref="T:Microsoft.AspNetCore.WebUtilities.BufferedReadStream"/>.</param>
|
||||
<param name="boundary">The boundary pattern to use.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebUtilities.MultipartReaderStream.#ctor(Microsoft.AspNetCore.WebUtilities.BufferedReadStream,Microsoft.AspNetCore.WebUtilities.MultipartBoundary,System.Buffers.ArrayPool{System.Byte})">
|
||||
<summary>
|
||||
Creates a stream that reads until it reaches the given boundary pattern.
|
||||
</summary>
|
||||
<param name="stream">The <see cref="T:Microsoft.AspNetCore.WebUtilities.BufferedReadStream"/>.</param>
|
||||
<param name="boundary">The boundary pattern to use.</param>
|
||||
<param name="bytePool">The ArrayPool pool to use for temporary byte arrays.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.WebUtilities.MultipartSection.BaseStreamOffset">
|
||||
<summary>
|
||||
The position where the body starts in the total multipart body.
|
||||
This may not be available if the total multipart body is not seekable.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.WebUtilities.MultipartSectionConverterExtensions">
|
||||
<summary>
|
||||
Various extensions for converting multipart sections
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebUtilities.MultipartSectionConverterExtensions.AsFileSection(Microsoft.AspNetCore.WebUtilities.MultipartSection)">
|
||||
<summary>
|
||||
Converts the section to a file section
|
||||
</summary>
|
||||
<param name="section">The section to convert</param>
|
||||
<returns>A file section</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebUtilities.MultipartSectionConverterExtensions.AsFormDataSection(Microsoft.AspNetCore.WebUtilities.MultipartSection)">
|
||||
<summary>
|
||||
Converts the section to a form section
|
||||
</summary>
|
||||
<param name="section">The section to convert</param>
|
||||
<returns>A form section</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebUtilities.MultipartSectionConverterExtensions.GetContentDispositionHeader(Microsoft.AspNetCore.WebUtilities.MultipartSection)">
|
||||
<summary>
|
||||
Retrieves and parses the content disposition header from a section
|
||||
</summary>
|
||||
<param name="section">The section from which to retrieve</param>
|
||||
<returns>A <see cref="T:Microsoft.Net.Http.Headers.ContentDispositionHeaderValue"/> if the header was found, null otherwise</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.WebUtilities.MultipartSectionStreamExtensions">
|
||||
<summary>
|
||||
Various extension methods for dealing with the section body stream
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebUtilities.MultipartSectionStreamExtensions.ReadAsStringAsync(Microsoft.AspNetCore.WebUtilities.MultipartSection)">
|
||||
<summary>
|
||||
Reads the body of the section as a string
|
||||
</summary>
|
||||
<param name="section">The section to read from</param>
|
||||
<returns>The body steam as string</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebUtilities.QueryHelpers.AddQueryString(System.String,System.String,System.String)">
|
||||
<summary>
|
||||
Append the given query key and value to the URI.
|
||||
</summary>
|
||||
<param name="uri">The base URI.</param>
|
||||
<param name="name">The name of the query key.</param>
|
||||
<param name="value">The query value.</param>
|
||||
<returns>The combined result.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebUtilities.QueryHelpers.AddQueryString(System.String,System.Collections.Generic.IDictionary{System.String,System.String})">
|
||||
<summary>
|
||||
Append the given query keys and values to the uri.
|
||||
</summary>
|
||||
<param name="uri">The base uri.</param>
|
||||
<param name="queryString">A collection of name value query pairs to append.</param>
|
||||
<returns>The combined result.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebUtilities.QueryHelpers.ParseQuery(System.String)">
|
||||
<summary>
|
||||
Parse a query string into its component key and value parts.
|
||||
</summary>
|
||||
<param name="queryString">The raw query string value, with or without the leading '?'.</param>
|
||||
<returns>A collection of parsed keys and values.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebUtilities.QueryHelpers.ParseNullableQuery(System.String)">
|
||||
<summary>
|
||||
Parse a query string into its component key and value parts.
|
||||
</summary>
|
||||
<param name="queryString">The raw query string value, with or without the leading '?'.</param>
|
||||
<returns>A collection of parsed keys and values, null if there are no entries.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.WebUtilities.Resources">
|
||||
<summary>
|
||||
A strongly-typed resource class, for looking up localized strings, etc.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.WebUtilities.Resources.ResourceManager">
|
||||
<summary>
|
||||
Returns the cached ResourceManager instance used by this class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.WebUtilities.Resources.Culture">
|
||||
<summary>
|
||||
Overrides the current thread's CurrentUICulture property for all
|
||||
resource lookups using this strongly typed resource class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.WebUtilities.Resources.HttpRequestStreamReader_StreamNotReadable">
|
||||
<summary>
|
||||
Looks up a localized string similar to The stream must support reading..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.WebUtilities.Resources.HttpResponseStreamWriter_StreamNotWritable">
|
||||
<summary>
|
||||
Looks up a localized string similar to The stream must support writing..
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.WebUtilities.Resources.WebEncoders_InvalidCountOffsetOrLength">
|
||||
<summary>
|
||||
Looks up a localized string similar to Invalid {0}, {1} or {2} length..
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1,117 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.AspNetCore</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.AspNetCore.WebHost">
|
||||
<summary>
|
||||
Provides convenience methods for creating instances of <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost"/> and <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/> with pre-configured defaults.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebHost.Start(Microsoft.AspNetCore.Http.RequestDelegate)">
|
||||
<summary>
|
||||
Initializes and starts a new <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost"/> with pre-configured defaults.
|
||||
See <see cref="M:Microsoft.AspNetCore.WebHost.CreateDefaultBuilder"/> for details.
|
||||
</summary>
|
||||
<param name="app">A delegate that handles requests to the application.</param>
|
||||
<returns>A started <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost"/> that hosts the application.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebHost.Start(System.String,Microsoft.AspNetCore.Http.RequestDelegate)">
|
||||
<summary>
|
||||
Initializes and starts a new <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost"/> with pre-configured defaults.
|
||||
See <see cref="M:Microsoft.AspNetCore.WebHost.CreateDefaultBuilder"/> for details.
|
||||
</summary>
|
||||
<param name="url">The URL the hosted application will listen on.</param>
|
||||
<param name="app">A delegate that handles requests to the application.</param>
|
||||
<returns>A started <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost"/> that hosts the application.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebHost.Start(System.Action{Microsoft.AspNetCore.Routing.IRouteBuilder})">
|
||||
<summary>
|
||||
Initializes and starts a new <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost"/> with pre-configured defaults.
|
||||
See <see cref="M:Microsoft.AspNetCore.WebHost.CreateDefaultBuilder"/> for details.
|
||||
</summary>
|
||||
<param name="routeBuilder">A delegate that configures the router for handling requests to the application.</param>
|
||||
<returns>A started <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost"/> that hosts the application.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebHost.Start(System.String,System.Action{Microsoft.AspNetCore.Routing.IRouteBuilder})">
|
||||
<summary>
|
||||
Initializes and starts a new <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost"/> with pre-configured defaults.
|
||||
See <see cref="M:Microsoft.AspNetCore.WebHost.CreateDefaultBuilder"/> for details.
|
||||
</summary>
|
||||
<param name="url">The URL the hosted application will listen on.</param>
|
||||
<param name="routeBuilder">A delegate that configures the router for handling requests to the application.</param>
|
||||
<returns>A started <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost"/> that hosts the application.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebHost.StartWith(System.Action{Microsoft.AspNetCore.Builder.IApplicationBuilder})">
|
||||
<summary>
|
||||
Initializes and starts a new <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost"/> with pre-configured defaults.
|
||||
See <see cref="M:Microsoft.AspNetCore.WebHost.CreateDefaultBuilder"/> for details.
|
||||
</summary>
|
||||
<param name="app">The delegate that configures the <see cref="T:Microsoft.AspNetCore.Builder.IApplicationBuilder"/>.</param>
|
||||
<returns>A started <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost"/> that hosts the application.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebHost.StartWith(System.String,System.Action{Microsoft.AspNetCore.Builder.IApplicationBuilder})">
|
||||
<summary>
|
||||
Initializes and starts a new <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost"/> with pre-configured defaults.
|
||||
See <see cref="M:Microsoft.AspNetCore.WebHost.CreateDefaultBuilder"/> for details.
|
||||
</summary>
|
||||
<param name="url">The URL the hosted application will listen on.</param>
|
||||
<param name="app">The delegate that configures the <see cref="T:Microsoft.AspNetCore.Builder.IApplicationBuilder"/>.</param>
|
||||
<returns>A started <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost"/> that hosts the application.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebHost.CreateDefaultBuilder">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Microsoft.AspNetCore.Hosting.WebHostBuilder"/> class with pre-configured defaults.
|
||||
</summary>
|
||||
<remarks>
|
||||
The following defaults are applied to the returned <see cref="T:Microsoft.AspNetCore.Hosting.WebHostBuilder"/>:
|
||||
use Kestrel as the web server and configure it using the application's configuration providers,
|
||||
set the <see cref="P:Microsoft.AspNetCore.Hosting.IHostingEnvironment.ContentRootPath"/> to the result of <see cref="M:System.IO.Directory.GetCurrentDirectory"/>,
|
||||
load <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> from 'appsettings.json' and 'appsettings.[<see cref="P:Microsoft.AspNetCore.Hosting.IHostingEnvironment.EnvironmentName"/>].json',
|
||||
load <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> from User Secrets when <see cref="P:Microsoft.AspNetCore.Hosting.IHostingEnvironment.EnvironmentName"/> is 'Development' using the entry assembly,
|
||||
load <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> from environment variables,
|
||||
configure the <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/> to log to the console and debug output,
|
||||
and enable IIS integration.
|
||||
</remarks>
|
||||
<returns>The initialized <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebHost.CreateDefaultBuilder(System.String[])">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Microsoft.AspNetCore.Hosting.WebHostBuilder"/> class with pre-configured defaults.
|
||||
</summary>
|
||||
<remarks>
|
||||
The following defaults are applied to the returned <see cref="T:Microsoft.AspNetCore.Hosting.WebHostBuilder"/>:
|
||||
use Kestrel as the web server and configure it using the application's configuration providers,
|
||||
set the <see cref="P:Microsoft.AspNetCore.Hosting.IHostingEnvironment.ContentRootPath"/> to the result of <see cref="M:System.IO.Directory.GetCurrentDirectory"/>,
|
||||
load <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> from 'appsettings.json' and 'appsettings.[<see cref="P:Microsoft.AspNetCore.Hosting.IHostingEnvironment.EnvironmentName"/>].json',
|
||||
load <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> from User Secrets when <see cref="P:Microsoft.AspNetCore.Hosting.IHostingEnvironment.EnvironmentName"/> is 'Development' using the entry assembly,
|
||||
load <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> from environment variables,
|
||||
load <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> from supplied command line args,
|
||||
configure the <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/> to log to the console and debug output,
|
||||
and enable IIS integration.
|
||||
</remarks>
|
||||
<param name="args">The command line args.</param>
|
||||
<returns>The initialized <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.WebHost.CreateDefaultBuilder``1(System.String[])">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Microsoft.AspNetCore.Hosting.WebHostBuilder"/> class with pre-configured defaults using typed Startup.
|
||||
</summary>
|
||||
<remarks>
|
||||
The following defaults are applied to the returned <see cref="T:Microsoft.AspNetCore.Hosting.WebHostBuilder"/>:
|
||||
use Kestrel as the web server and configure it using the application's configuration providers,
|
||||
set the <see cref="P:Microsoft.AspNetCore.Hosting.IHostingEnvironment.ContentRootPath"/> to the result of <see cref="M:System.IO.Directory.GetCurrentDirectory"/>,
|
||||
load <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> from 'appsettings.json' and 'appsettings.[<see cref="P:Microsoft.AspNetCore.Hosting.IHostingEnvironment.EnvironmentName"/>].json',
|
||||
load <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> from User Secrets when <see cref="P:Microsoft.AspNetCore.Hosting.IHostingEnvironment.EnvironmentName"/> is 'Development' using the entry assembly,
|
||||
load <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> from environment variables,
|
||||
load <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> from supplied command line args,
|
||||
configure the <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/> to log to the console and debug output,
|
||||
enable IIS integration.
|
||||
</remarks>
|
||||
<typeparam name ="TStartup">The type containing the startup methods for the application.</typeparam>
|
||||
<param name="args">The command line args.</param>
|
||||
<returns>The initialized <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1,240 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Configuration.Abstractions</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Configuration.ConfigurationExtensions">
|
||||
<summary>
|
||||
Extension methods for configuration classes./>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.Add``1(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Action{``0})">
|
||||
<summary>
|
||||
Adds a new configuration source.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
||||
<param name="configureSource">Configures the source secrets.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.GetConnectionString(Microsoft.Extensions.Configuration.IConfiguration,System.String)">
|
||||
<summary>
|
||||
Shorthand for GetSection("ConnectionStrings")[name].
|
||||
</summary>
|
||||
<param name="configuration">The configuration.</param>
|
||||
<param name="name">The connection string key.</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.AsEnumerable(Microsoft.Extensions.Configuration.IConfiguration)">
|
||||
<summary>
|
||||
Get the enumeration of key value pairs within the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration" />
|
||||
</summary>
|
||||
<param name="configuration">The <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> to enumerate.</param>
|
||||
<returns>An enumeration of key value pairs.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.AsEnumerable(Microsoft.Extensions.Configuration.IConfiguration,System.Boolean)">
|
||||
<summary>
|
||||
Get the enumeration of key value pairs within the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration" />
|
||||
</summary>
|
||||
<param name="configuration">The <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> to enumerate.</param>
|
||||
<param name="makePathsRelative">If true, the child keys returned will have the current configuration's Path trimmed from the front.</param>
|
||||
<returns>An enumeration of key value pairs.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.Exists(Microsoft.Extensions.Configuration.IConfigurationSection)">
|
||||
<summary>
|
||||
Determines whether the section has a <see cref="P:Microsoft.Extensions.Configuration.IConfigurationSection.Value"/> or has children
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.ConfigurationPath">
|
||||
<summary>
|
||||
Utility methods and constants for manipulating Configuration paths
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.Extensions.Configuration.ConfigurationPath.KeyDelimiter">
|
||||
<summary>
|
||||
The delimiter ":" used to separate individual keys in a path.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.Combine(System.String[])">
|
||||
<summary>
|
||||
Combines path segments into one path.
|
||||
</summary>
|
||||
<param name="pathSegments">The path segments to combine.</param>
|
||||
<returns>The combined path.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.Combine(System.Collections.Generic.IEnumerable{System.String})">
|
||||
<summary>
|
||||
Combines path segments into one path.
|
||||
</summary>
|
||||
<param name="pathSegments">The path segments to combine.</param>
|
||||
<returns>The combined path.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.GetSectionKey(System.String)">
|
||||
<summary>
|
||||
Extracts the last path segment from the path.
|
||||
</summary>
|
||||
<param name="path">The path.</param>
|
||||
<returns>The last path segment of the path.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.GetParentPath(System.String)">
|
||||
<summary>
|
||||
Extracts the path corresponding to the parent node for a given path.
|
||||
</summary>
|
||||
<param name="path">The path.</param>
|
||||
<returns>The original path minus the last individual segment found in it. Null if the original path corresponds to a top level node.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.IConfiguration">
|
||||
<summary>
|
||||
Represents a set of key/value application configuration properties.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.IConfiguration.Item(System.String)">
|
||||
<summary>
|
||||
Gets or sets a configuration value.
|
||||
</summary>
|
||||
<param name="key">The configuration key.</param>
|
||||
<returns>The configuration value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfiguration.GetSection(System.String)">
|
||||
<summary>
|
||||
Gets a configuration sub-section with the specified key.
|
||||
</summary>
|
||||
<param name="key">The key of the configuration section.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSection"/>.</returns>
|
||||
<remarks>
|
||||
This method will never return <c>null</c>. If no matching sub-section is found with the specified key,
|
||||
an empty <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSection"/> will be returned.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfiguration.GetChildren">
|
||||
<summary>
|
||||
Gets the immediate descendant configuration sub-sections.
|
||||
</summary>
|
||||
<returns>The configuration sub-sections.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfiguration.GetReloadToken">
|
||||
<summary>
|
||||
Returns a <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> that can be used to observe when this configuration is reloaded.
|
||||
</summary>
|
||||
<returns>A <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/>.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.IConfigurationBuilder">
|
||||
<summary>
|
||||
Represents a type used to build application configuration.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.IConfigurationBuilder.Properties">
|
||||
<summary>
|
||||
Gets a key/value collection that can be used to share data between the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>
|
||||
and the registered <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSource"/>s.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.IConfigurationBuilder.Sources">
|
||||
<summary>
|
||||
Gets the sources used to obtain configuration values
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationBuilder.Add(Microsoft.Extensions.Configuration.IConfigurationSource)">
|
||||
<summary>
|
||||
Adds a new configuration source.
|
||||
</summary>
|
||||
<param name="source">The configuration source to add.</param>
|
||||
<returns>The same <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationBuilder.Build">
|
||||
<summary>
|
||||
Builds an <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> with keys and values from the set of sources registered in
|
||||
<see cref="P:Microsoft.Extensions.Configuration.IConfigurationBuilder.Sources"/>.
|
||||
</summary>
|
||||
<returns>An <see cref="T:Microsoft.Extensions.Configuration.IConfigurationRoot"/> with keys and values from the registered sources.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.IConfigurationProvider">
|
||||
<summary>
|
||||
Provides configuration key/values for an application.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.TryGet(System.String,System.String@)">
|
||||
<summary>
|
||||
Tries to get a configuration value for the specified key.
|
||||
</summary>
|
||||
<param name="key">The key.</param>
|
||||
<param name="value">The value.</param>
|
||||
<returns><c>True</c> if a value for the specified key was found, otherwise <c>false</c>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.Set(System.String,System.String)">
|
||||
<summary>
|
||||
Sets a configuration value for the specified key.
|
||||
</summary>
|
||||
<param name="key">The key.</param>
|
||||
<param name="value">The value.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.GetReloadToken">
|
||||
<summary>
|
||||
Returns a change token if this provider supports change tracking, null otherwise.
|
||||
</summary>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.Load">
|
||||
<summary>
|
||||
Loads configuration values from the source represented by this <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.GetChildKeys(System.Collections.Generic.IEnumerable{System.String},System.String)">
|
||||
<summary>
|
||||
Returns the immediate descendant configuration keys for a given parent path based on this
|
||||
<see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>'s data and the set of keys returned by all the preceding
|
||||
<see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>s.
|
||||
</summary>
|
||||
<param name="earlierKeys">The child keys returned by the preceding providers for the same parent path.</param>
|
||||
<param name="parentPath">The parent path.</param>
|
||||
<returns>The child keys.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.IConfigurationRoot">
|
||||
<summary>
|
||||
Represents the root of an <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> hierarchy.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationRoot.Reload">
|
||||
<summary>
|
||||
Force the configuration values to be reloaded from the underlying <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>s.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.IConfigurationRoot.Providers">
|
||||
<summary>
|
||||
The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>s for this configuration.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.IConfigurationSection">
|
||||
<summary>
|
||||
Represents a section of application configuration values.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.IConfigurationSection.Key">
|
||||
<summary>
|
||||
Gets the key this section occupies in its parent.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.IConfigurationSection.Path">
|
||||
<summary>
|
||||
Gets the full path to this section within the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.IConfigurationSection.Value">
|
||||
<summary>
|
||||
Gets or sets the section value.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.IConfigurationSource">
|
||||
<summary>
|
||||
Represents a source of configuration key/values for an application.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.IConfigurationSource.Build(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
|
||||
<summary>
|
||||
Builds the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> for this source.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
|
||||
<returns>An <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/></returns>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1,177 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Configuration.Binder</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Configuration.BinderOptions">
|
||||
<summary>
|
||||
Options class used by the <see cref="T:Microsoft.Extensions.Configuration.ConfigurationBinder"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.BinderOptions.BindNonPublicProperties">
|
||||
<summary>
|
||||
When false (the default), the binder will only attempt to set public properties.
|
||||
If true, the binder will attempt to set all non read-only properties.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.ConfigurationBinder">
|
||||
<summary>
|
||||
Static helper class that allows binding strongly typed objects to configuration values.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get``1(Microsoft.Extensions.Configuration.IConfiguration)">
|
||||
<summary>
|
||||
Attempts to bind the configuration instance to a new instance of type T.
|
||||
If this configuration section has a value, that will be used.
|
||||
Otherwise binding by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<typeparam name="T">The type of the new instance to bind.</typeparam>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<returns>The new instance of T if successful, default(T) otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get``1(Microsoft.Extensions.Configuration.IConfiguration,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
|
||||
<summary>
|
||||
Attempts to bind the configuration instance to a new instance of type T.
|
||||
If this configuration section has a value, that will be used.
|
||||
Otherwise binding by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<typeparam name="T">The type of the new instance to bind.</typeparam>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="configureOptions">Configures the binder options.</param>
|
||||
<returns>The new instance of T if successful, default(T) otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get(Microsoft.Extensions.Configuration.IConfiguration,System.Type)">
|
||||
<summary>
|
||||
Attempts to bind the configuration instance to a new instance of type T.
|
||||
If this configuration section has a value, that will be used.
|
||||
Otherwise binding by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="type">The type of the new instance to bind.</param>
|
||||
<returns>The new instance if successful, null otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
|
||||
<summary>
|
||||
Attempts to bind the configuration instance to a new instance of type T.
|
||||
If this configuration section has a value, that will be used.
|
||||
Otherwise binding by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="type">The type of the new instance to bind.</param>
|
||||
<param name="configureOptions">Configures the binder options.</param>
|
||||
<returns>The new instance if successful, null otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.String,System.Object)">
|
||||
<summary>
|
||||
Attempts to bind the given object instance to the configuration section specified by the key by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="key">The key of the configuration section to bind.</param>
|
||||
<param name="instance">The object to bind.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.Object)">
|
||||
<summary>
|
||||
Attempts to bind the given object instance to configuration values by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="instance">The object to bind.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.Object,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
|
||||
<summary>
|
||||
Attempts to bind the given object instance to configuration values by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="instance">The object to bind.</param>
|
||||
<param name="configureOptions">Configures the binder options.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue``1(Microsoft.Extensions.Configuration.IConfiguration,System.String)">
|
||||
<summary>
|
||||
Extracts the value with the specified key and converts it to type T.
|
||||
</summary>
|
||||
<typeparam name="T">The type to convert the value to.</typeparam>
|
||||
<param name="configuration">The configuration.</param>
|
||||
<param name="key">The key of the configuration section's value to convert.</param>
|
||||
<returns>The converted value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue``1(Microsoft.Extensions.Configuration.IConfiguration,System.String,``0)">
|
||||
<summary>
|
||||
Extracts the value with the specified key and converts it to type T.
|
||||
</summary>
|
||||
<typeparam name="T">The type to convert the value to.</typeparam>
|
||||
<param name="configuration">The configuration.</param>
|
||||
<param name="key">The key of the configuration section's value to convert.</param>
|
||||
<param name="defaultValue">The default value to use if no value is found.</param>
|
||||
<returns>The converted value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.String)">
|
||||
<summary>
|
||||
Extracts the value with the specified key and converts it to the specified type.
|
||||
</summary>
|
||||
<param name="configuration">The configuration.</param>
|
||||
<param name="type">The type to convert the value to.</param>
|
||||
<param name="key">The key of the configuration section's value to convert.</param>
|
||||
<returns>The converted value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.String,System.Object)">
|
||||
<summary>
|
||||
Extracts the value with the specified key and converts it to the specified type.
|
||||
</summary>
|
||||
<param name="configuration">The configuration.</param>
|
||||
<param name="type">The type to convert the value to.</param>
|
||||
<param name="key">The key of the configuration section's value to convert.</param>
|
||||
<param name="defaultValue">The default value to use if no value is found.</param>
|
||||
<returns>The converted value.</returns>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.Binder.Resources.Error_CannotActivateAbstractOrInterface">
|
||||
<summary>
|
||||
Cannot create instance of type '{0}' because it is either abstract or an interface.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.Binder.Resources.FormatError_CannotActivateAbstractOrInterface(System.Object)">
|
||||
<summary>
|
||||
Cannot create instance of type '{0}' because it is either abstract or an interface.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.Binder.Resources.Error_FailedBinding">
|
||||
<summary>
|
||||
Failed to convert '{0}' to type '{1}'.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.Binder.Resources.FormatError_FailedBinding(System.Object,System.Object)">
|
||||
<summary>
|
||||
Failed to convert '{0}' to type '{1}'.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.Binder.Resources.Error_FailedToActivate">
|
||||
<summary>
|
||||
Failed to create instance of type '{0}'.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.Binder.Resources.FormatError_FailedToActivate(System.Object)">
|
||||
<summary>
|
||||
Failed to create instance of type '{0}'.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.Binder.Resources.Error_MissingParameterlessConstructor">
|
||||
<summary>
|
||||
Cannot create instance of type '{0}' because it is missing a public parameterless constructor.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.Binder.Resources.FormatError_MissingParameterlessConstructor(System.Object)">
|
||||
<summary>
|
||||
Cannot create instance of type '{0}' because it is missing a public parameterless constructor.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.Binder.Resources.Error_UnsupportedMultidimensionalArray">
|
||||
<summary>
|
||||
Cannot create instance of type '{0}' because multidimensional arrays are not supported.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.Binder.Resources.FormatError_UnsupportedMultidimensionalArray(System.Object)">
|
||||
<summary>
|
||||
Cannot create instance of type '{0}' because multidimensional arrays are not supported.
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1,112 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Configuration.CommandLine</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Configuration.CommandLineConfigurationExtensions">
|
||||
<summary>
|
||||
Extension methods for registering <see cref="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider"/> with <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.CommandLineConfigurationExtensions.AddCommandLine(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String[])">
|
||||
<summary>
|
||||
Adds an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> that reads configuration values from the command line.
|
||||
</summary>
|
||||
<param name="configurationBuilder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
||||
<param name="args">The command line args.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.CommandLineConfigurationExtensions.AddCommandLine(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String[],System.Collections.Generic.IDictionary{System.String,System.String})">
|
||||
<summary>
|
||||
Adds an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> that reads configuration values from the command line using the specified switch mappings.
|
||||
</summary>
|
||||
<param name="configurationBuilder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
||||
<param name="args">The command line args.</param>
|
||||
<param name="switchMappings">The switch mappings.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.CommandLineConfigurationExtensions.AddCommandLine(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Action{Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationSource})">
|
||||
<summary>
|
||||
Adds an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> that reads configuration values from the command line.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
||||
<param name="configureSource">Configures the source.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider">
|
||||
<summary>
|
||||
A command line based <see cref="T:Microsoft.Extensions.Configuration.ConfigurationProvider"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider.#ctor(System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IDictionary{System.String,System.String})">
|
||||
<summary>
|
||||
Initializes a new instance.
|
||||
</summary>
|
||||
<param name="args">The command line args.</param>
|
||||
<param name="switchMappings">The switch mappings.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider.Args">
|
||||
<summary>
|
||||
The command line arguments.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider.Load">
|
||||
<summary>
|
||||
Loads the configuration data from the command line args.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationSource">
|
||||
<summary>
|
||||
Represents command line arguments as an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSource"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationSource.SwitchMappings">
|
||||
<summary>
|
||||
Gets or sets the switch mappings.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationSource.Args">
|
||||
<summary>
|
||||
Gets or sets the command line args.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationSource.Build(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
|
||||
<summary>
|
||||
Builds the <see cref="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider"/> for this source.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
|
||||
<returns>A <see cref="T:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationProvider"/></returns>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.CommandLine.Resources.Error_DuplicatedKeyInSwitchMappings">
|
||||
<summary>
|
||||
Keys in switch mappings are case-insensitive. A duplicated key '{0}' was found.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.CommandLine.Resources.FormatError_DuplicatedKeyInSwitchMappings(System.Object)">
|
||||
<summary>
|
||||
Keys in switch mappings are case-insensitive. A duplicated key '{0}' was found.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.CommandLine.Resources.Error_InvalidSwitchMapping">
|
||||
<summary>
|
||||
The switch mappings contain an invalid switch '{0}'.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.CommandLine.Resources.FormatError_InvalidSwitchMapping(System.Object)">
|
||||
<summary>
|
||||
The switch mappings contain an invalid switch '{0}'.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.CommandLine.Resources.Error_ShortSwitchNotDefined">
|
||||
<summary>
|
||||
The short switch '{0}' is not defined in the switch mappings.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.CommandLine.Resources.FormatError_ShortSwitchNotDefined(System.Object)">
|
||||
<summary>
|
||||
The short switch '{0}' is not defined in the switch mappings.
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1,75 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Configuration.EnvironmentVariables</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationProvider">
|
||||
<summary>
|
||||
An environment variable based <see cref="T:Microsoft.Extensions.Configuration.ConfigurationProvider"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationProvider.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationProvider.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance with the specified prefix.
|
||||
</summary>
|
||||
<param name="prefix">A prefix used to filter the environment variables.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationProvider.Load">
|
||||
<summary>
|
||||
Loads the environment variables.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationSource">
|
||||
<summary>
|
||||
Represents environment variables as an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSource"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationSource.Prefix">
|
||||
<summary>
|
||||
A prefix used to filter environment variables.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationSource.Build(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
|
||||
<summary>
|
||||
Builds the <see cref="T:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationProvider"/> for this source.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
|
||||
<returns>A <see cref="T:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationProvider"/></returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.EnvironmentVariablesExtensions">
|
||||
<summary>
|
||||
Extension methods for registering <see cref="T:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationProvider"/> with <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.EnvironmentVariablesExtensions.AddEnvironmentVariables(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
|
||||
<summary>
|
||||
Adds an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> that reads configuration values from environment variables.
|
||||
</summary>
|
||||
<param name="configurationBuilder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.EnvironmentVariablesExtensions.AddEnvironmentVariables(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String)">
|
||||
<summary>
|
||||
Adds an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> that reads configuration values from environment variables
|
||||
with a specified prefix.
|
||||
</summary>
|
||||
<param name="configurationBuilder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
||||
<param name="prefix">The prefix that environment variable names must start with. The prefix will be removed from the environment variable names.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.EnvironmentVariablesExtensions.AddEnvironmentVariables(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Action{Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationSource})">
|
||||
<summary>
|
||||
Adds an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> that reads configuration values from environment variables.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
||||
<param name="configureSource">Configures the source.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1,175 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Configuration.FileExtensions</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Configuration.FileConfigurationExtensions">
|
||||
<summary>
|
||||
Extension methods for <see cref="T:Microsoft.Extensions.Configuration.FileConfigurationProvider"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.FileConfigurationExtensions.SetFileProvider(Microsoft.Extensions.Configuration.IConfigurationBuilder,Microsoft.Extensions.FileProviders.IFileProvider)">
|
||||
<summary>
|
||||
Sets the default <see cref="T:Microsoft.Extensions.FileProviders.IFileProvider"/> to be used for file-based providers.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
||||
<param name="fileProvider">The default file provider instance.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.FileConfigurationExtensions.GetFileProvider(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
|
||||
<summary>
|
||||
Gets the default <see cref="T:Microsoft.Extensions.FileProviders.IFileProvider"/> to be used for file-based providers.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.FileConfigurationExtensions.SetBasePath(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String)">
|
||||
<summary>
|
||||
Sets the FileProvider for file-based providers to a PhysicalFileProvider with the base path.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
||||
<param name="basePath">The absolute path of file-based providers.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.FileConfigurationExtensions.SetFileLoadExceptionHandler(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Action{Microsoft.Extensions.Configuration.FileLoadExceptionContext})">
|
||||
<summary>
|
||||
Sets a default action to be invoked for file-based providers when an error occurs.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
||||
<param name="handler">The Action to be invoked on a file load exception.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.FileConfigurationExtensions.GetFileLoadExceptionHandler(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
|
||||
<summary>
|
||||
Gets the default <see cref="T:Microsoft.Extensions.FileProviders.IFileProvider"/> to be used for file-based providers.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.FileConfigurationProvider">
|
||||
<summary>
|
||||
Base class for file based <see cref="T:Microsoft.Extensions.Configuration.ConfigurationProvider"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.FileConfigurationProvider.#ctor(Microsoft.Extensions.Configuration.FileConfigurationSource)">
|
||||
<summary>
|
||||
Initializes a new instance with the specified source.
|
||||
</summary>
|
||||
<param name="source">The source settings.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.FileConfigurationProvider.Source">
|
||||
<summary>
|
||||
The source settings for this provider.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.FileConfigurationProvider.Load">
|
||||
<summary>
|
||||
Loads the contents of the file at <see cref="T:System.IO.Path"/>.
|
||||
</summary>
|
||||
<exception cref="T:System.IO.FileNotFoundException">If Optional is <c>false</c> on the source and a
|
||||
file does not exist at specified Path.</exception>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.FileConfigurationProvider.Load(System.IO.Stream)">
|
||||
<summary>
|
||||
Loads this provider's data from a stream.
|
||||
</summary>
|
||||
<param name="stream">The stream to read.</param>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.FileConfigurationSource">
|
||||
<summary>
|
||||
Represents a base class for file based <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSource"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.FileConfigurationSource.FileProvider">
|
||||
<summary>
|
||||
Used to access the contents of the file.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.FileConfigurationSource.Path">
|
||||
<summary>
|
||||
The path to the file.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.FileConfigurationSource.Optional">
|
||||
<summary>
|
||||
Determines if loading the file is optional.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.FileConfigurationSource.ReloadOnChange">
|
||||
<summary>
|
||||
Determines whether the source will be loaded if the underlying file changes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.FileConfigurationSource.ReloadDelay">
|
||||
<summary>
|
||||
Number of milliseconds that reload will wait before calling Load. This helps
|
||||
avoid triggering reload before a file is completely written. Default is 250.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.FileConfigurationSource.OnLoadException">
|
||||
<summary>
|
||||
Will be called if an uncaught exception occurs in FileConfigurationProvider.Load.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.FileConfigurationSource.Build(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
|
||||
<summary>
|
||||
Builds the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> for this source.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
|
||||
<returns>A <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/></returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.FileConfigurationSource.EnsureDefaults(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
|
||||
<summary>
|
||||
Called to use any default settings on the builder like the FileProvider or FileLoadExceptionHandler.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.FileConfigurationSource.ResolveFileProvider">
|
||||
<summary>
|
||||
If no file provider has been set, for absolute Path, this will creates a physical file provider
|
||||
for the nearest existing directory.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.FileLoadExceptionContext">
|
||||
<summary>
|
||||
Contains information about a file load exception.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.FileLoadExceptionContext.Provider">
|
||||
<summary>
|
||||
The <see cref="T:Microsoft.Extensions.Configuration.FileConfigurationProvider"/> that caused the exception.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.FileLoadExceptionContext.Exception">
|
||||
<summary>
|
||||
The exception that occured in Load.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.FileLoadExceptionContext.Ignore">
|
||||
<summary>
|
||||
If true, the exception will not be rethrown.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.FileExtensions.Resources.Error_ExpectedPhysicalPath">
|
||||
<summary>
|
||||
The expected physical path was '{0}'.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.FileExtensions.Resources.FormatError_ExpectedPhysicalPath(System.Object)">
|
||||
<summary>
|
||||
The expected physical path was '{0}'.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.FileExtensions.Resources.Error_FileNotFound">
|
||||
<summary>
|
||||
The configuration file '{0}' was not found and is not optional.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.FileExtensions.Resources.FormatError_FileNotFound(System.Object)">
|
||||
<summary>
|
||||
The configuration file '{0}' was not found and is not optional.
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1,132 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Configuration.Json</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Configuration.JsonConfigurationExtensions">
|
||||
<summary>
|
||||
Extension methods for adding <see cref="T:Microsoft.Extensions.Configuration.Json.JsonConfigurationProvider"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.JsonConfigurationExtensions.AddJsonFile(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String)">
|
||||
<summary>
|
||||
Adds the JSON configuration provider at <paramref name="path"/> to <paramref name="builder"/>.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
||||
<param name="path">Path relative to the base path stored in
|
||||
<see cref="P:Microsoft.Extensions.Configuration.IConfigurationBuilder.Properties"/> of <paramref name="builder"/>.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.JsonConfigurationExtensions.AddJsonFile(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String,System.Boolean)">
|
||||
<summary>
|
||||
Adds the JSON configuration provider at <paramref name="path"/> to <paramref name="builder"/>.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
||||
<param name="path">Path relative to the base path stored in
|
||||
<see cref="P:Microsoft.Extensions.Configuration.IConfigurationBuilder.Properties"/> of <paramref name="builder"/>.</param>
|
||||
<param name="optional">Whether the file is optional.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.JsonConfigurationExtensions.AddJsonFile(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
Adds the JSON configuration provider at <paramref name="path"/> to <paramref name="builder"/>.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
||||
<param name="path">Path relative to the base path stored in
|
||||
<see cref="P:Microsoft.Extensions.Configuration.IConfigurationBuilder.Properties"/> of <paramref name="builder"/>.</param>
|
||||
<param name="optional">Whether the file is optional.</param>
|
||||
<param name="reloadOnChange">Whether the configuration should be reloaded if the file changes.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.JsonConfigurationExtensions.AddJsonFile(Microsoft.Extensions.Configuration.IConfigurationBuilder,Microsoft.Extensions.FileProviders.IFileProvider,System.String,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
Adds a JSON configuration source to <paramref name="builder"/>.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
||||
<param name="provider">The <see cref="T:Microsoft.Extensions.FileProviders.IFileProvider"/> to use to access the file.</param>
|
||||
<param name="path">Path relative to the base path stored in
|
||||
<see cref="P:Microsoft.Extensions.Configuration.IConfigurationBuilder.Properties"/> of <paramref name="builder"/>.</param>
|
||||
<param name="optional">Whether the file is optional.</param>
|
||||
<param name="reloadOnChange">Whether the configuration should be reloaded if the file changes.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.JsonConfigurationExtensions.AddJsonFile(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Action{Microsoft.Extensions.Configuration.Json.JsonConfigurationSource})">
|
||||
<summary>
|
||||
Adds a JSON configuration source to <paramref name="builder"/>.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
||||
<param name="configureSource">Configures the source.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.Json.JsonConfigurationProvider">
|
||||
<summary>
|
||||
A JSON file based <see cref="T:Microsoft.Extensions.Configuration.FileConfigurationProvider"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.Json.JsonConfigurationProvider.#ctor(Microsoft.Extensions.Configuration.Json.JsonConfigurationSource)">
|
||||
<summary>
|
||||
Initializes a new instance with the specified source.
|
||||
</summary>
|
||||
<param name="source">The source settings.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.Json.JsonConfigurationProvider.Load(System.IO.Stream)">
|
||||
<summary>
|
||||
Loads the JSON data from a stream.
|
||||
</summary>
|
||||
<param name="stream">The stream to read.</param>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.Json.JsonConfigurationSource">
|
||||
<summary>
|
||||
Represents a JSON file as an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSource"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.Json.JsonConfigurationSource.Build(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
|
||||
<summary>
|
||||
Builds the <see cref="T:Microsoft.Extensions.Configuration.Json.JsonConfigurationProvider"/> for this source.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
|
||||
<returns>A <see cref="T:Microsoft.Extensions.Configuration.Json.JsonConfigurationProvider"/></returns>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.Json.Resources.Error_InvalidFilePath">
|
||||
<summary>
|
||||
File path must be a non-empty string.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.Json.Resources.FormatError_InvalidFilePath">
|
||||
<summary>
|
||||
File path must be a non-empty string.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.Json.Resources.Error_JSONParseError">
|
||||
<summary>
|
||||
Could not parse the JSON file. Error on line number '{0}': '{1}'.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.Json.Resources.FormatError_JSONParseError(System.Object,System.Object)">
|
||||
<summary>
|
||||
Could not parse the JSON file. Error on line number '{0}': '{1}'.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.Json.Resources.Error_KeyIsDuplicated">
|
||||
<summary>
|
||||
A duplicate key '{0}' was found.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.Json.Resources.FormatError_KeyIsDuplicated(System.Object)">
|
||||
<summary>
|
||||
A duplicate key '{0}' was found.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.Json.Resources.Error_UnsupportedJSONToken">
|
||||
<summary>
|
||||
Unsupported JSON token '{0}' was found. Path '{1}', line {2} position {3}.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.Json.Resources.FormatError_UnsupportedJSONToken(System.Object,System.Object,System.Object,System.Object)">
|
||||
<summary>
|
||||
Unsupported JSON token '{0}' was found. Path '{1}', line {2} position {3}.
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1,162 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Configuration.UserSecrets</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Configuration.UserSecrets.PathHelper">
|
||||
<summary>
|
||||
Provides paths for user secrets configuration files.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecrets.PathHelper.GetSecretsPathFromSecretsId(System.String)">
|
||||
<summary>
|
||||
<para>
|
||||
Returns the path to the JSON file that stores user secrets.
|
||||
</para>
|
||||
<para>
|
||||
This uses the current user profile to locate the secrets file on disk in a location outside of source control.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="userSecretsId">The user secret ID.</param>
|
||||
<returns>The full path to the secret file.</returns>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.UserSecrets.Resources.Common_StringNullOrEmpty">
|
||||
<summary>
|
||||
Value cannot be null or an empty string.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecrets.Resources.FormatCommon_StringNullOrEmpty">
|
||||
<summary>
|
||||
Value cannot be null or an empty string.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.UserSecrets.Resources.Error_Invalid_Character_In_UserSecrets_Id">
|
||||
<summary>
|
||||
Invalid character '{0}' found in the user secrets ID at index '{1}'.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecrets.Resources.FormatError_Invalid_Character_In_UserSecrets_Id(System.Object,System.Object)">
|
||||
<summary>
|
||||
Invalid character '{0}' found in the user secrets ID at index '{1}'.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.UserSecrets.Resources.Error_Missing_UserSecretsIdAttribute">
|
||||
<summary>
|
||||
Could not find 'UserSecretsIdAttribute' on assembly '{0}'.
|
||||
Check that the project for '{0}' has set the 'UserSecretsId' build property.
|
||||
If the 'UserSecretsId' property is already set then add a reference to the Microsoft.Extensions.Configuration.UserSecrets package.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecrets.Resources.FormatError_Missing_UserSecretsIdAttribute(System.Object)">
|
||||
<summary>
|
||||
Could not find 'UserSecretsIdAttribute' on assembly '{0}'.
|
||||
Check that the project for '{0}' has set the 'UserSecretsId' build property.
|
||||
If the 'UserSecretsId' property is already set then add a reference to the Microsoft.Extensions.Configuration.UserSecrets package.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute">
|
||||
<summary>
|
||||
<para>
|
||||
Represents the user secrets ID.
|
||||
</para>
|
||||
<para>
|
||||
In most cases, this attribute is automatically generated during compilation by MSBuild targets
|
||||
included in the UserSecrets NuGet package. These targets use the MSBuild property 'UserSecretsId'
|
||||
to set the value for <see cref="P:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute.UserSecretsId"/>.
|
||||
</para>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute" />.
|
||||
</summary>
|
||||
<param name="userSecretId">The user secrets ID.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute.UserSecretsId">
|
||||
<summary>
|
||||
The user secrets ID.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions">
|
||||
<summary>
|
||||
Configuration extensions for adding user secrets configuration source.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets``1(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
|
||||
<summary>
|
||||
<para>
|
||||
Adds the user secrets configuration source. Searches the assembly that contains type <typeparamref name="T"/>
|
||||
for an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>, which specifies a user secrets ID.
|
||||
</para>
|
||||
<para>
|
||||
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="configuration">The configuration builder.</param>
|
||||
<typeparam name="T">The type from the assembly to search for an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</typeparam>
|
||||
<exception cref="T:System.InvalidOperationException">Thrown when the assembly containing <typeparamref name="T"/> does not have <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</exception>
|
||||
<returns>The configuration builder.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets``1(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Boolean)">
|
||||
<summary>
|
||||
<para>
|
||||
Adds the user secrets configuration source. Searches the assembly that contains type <typeparamref name="T"/>
|
||||
for an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>, which specifies a user secrets ID.
|
||||
</para>
|
||||
<para>
|
||||
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="configuration">The configuration builder.</param>
|
||||
<param name="optional">Whether loading secrets is optional. When false, this method may throw.</param>
|
||||
<exception cref="T:System.InvalidOperationException">Thrown when <paramref name="optional"/> is false and the assembly containing <typeparamref name="T"/> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</exception>
|
||||
<typeparam name="T">The type from the assembly to search for an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</typeparam>
|
||||
<returns>The configuration builder.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Reflection.Assembly)">
|
||||
<summary>
|
||||
<para>
|
||||
Adds the user secrets configuration source. This searches <paramref name="assembly"/> for an instance
|
||||
of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>, which specifies a user secrets ID.
|
||||
</para>
|
||||
<para>
|
||||
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="configuration">The configuration builder.</param>
|
||||
<param name="assembly">The assembly with the <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute" />.</param>
|
||||
<exception cref="T:System.InvalidOperationException">Thrown when <paramref name="assembly"/> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/></exception>
|
||||
<returns>The configuration builder.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Reflection.Assembly,System.Boolean)">
|
||||
<summary>
|
||||
<para>
|
||||
Adds the user secrets configuration source. This searches <paramref name="assembly"/> for an instance
|
||||
of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>, which specifies a user secrets ID.
|
||||
</para>
|
||||
<para>
|
||||
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="configuration">The configuration builder.</param>
|
||||
<param name="assembly">The assembly with the <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute" />.</param>
|
||||
<param name="optional">Whether loading secrets is optional. When false, this method may throw.</param>
|
||||
<exception cref="T:System.InvalidOperationException">Thrown when <paramref name="optional"/> is false and <paramref name="assembly"/> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</exception>
|
||||
<returns>The configuration builder.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String)">
|
||||
<summary>
|
||||
<para>
|
||||
Adds the user secrets configuration source with specified user secrets ID.
|
||||
</para>
|
||||
<para>
|
||||
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="configuration">The configuration builder.</param>
|
||||
<param name="userSecretsId">The user secrets ID.</param>
|
||||
<returns>The configuration builder.</returns>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1,401 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Configuration</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Configuration.ChainedBuilderExtensions">
|
||||
<summary>
|
||||
IConfigurationBuilder extension methods for the chaind configuration provider.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ChainedBuilderExtensions.AddConfiguration(Microsoft.Extensions.Configuration.IConfigurationBuilder,Microsoft.Extensions.Configuration.IConfiguration)">
|
||||
<summary>
|
||||
Adds an existing configuration to <paramref name="configurationBuilder"/>.
|
||||
</summary>
|
||||
<param name="configurationBuilder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
||||
<param name="config">The <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> to add.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.ChainedConfigurationProvider">
|
||||
<summary>
|
||||
Chained implementation of <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ChainedConfigurationProvider.#ctor(Microsoft.Extensions.Configuration.ChainedConfigurationSource)">
|
||||
<summary>
|
||||
Initialize a new instance from the source configuration.
|
||||
</summary>
|
||||
<param name="source">The source configuration.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ChainedConfigurationProvider.TryGet(System.String,System.String@)">
|
||||
<summary>
|
||||
Tries to get a configuration value for the specified key.
|
||||
</summary>
|
||||
<param name="key">The key.</param>
|
||||
<param name="value">The value.</param>
|
||||
<returns><c>True</c> if a value for the specified key was found, otherwise <c>false</c>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ChainedConfigurationProvider.Set(System.String,System.String)">
|
||||
<summary>
|
||||
Sets a configuration value for the specified key.
|
||||
</summary>
|
||||
<param name="key">The key.</param>
|
||||
<param name="value">The value.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ChainedConfigurationProvider.GetReloadToken">
|
||||
<summary>
|
||||
Returns a change token if this provider supports change tracking, null otherwise.
|
||||
</summary>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ChainedConfigurationProvider.Load">
|
||||
<summary>
|
||||
Loads configuration values from the source represented by this <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ChainedConfigurationProvider.GetChildKeys(System.Collections.Generic.IEnumerable{System.String},System.String)">
|
||||
<summary>
|
||||
Returns the immediate descendant configuration keys for a given parent path based on this
|
||||
<see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>'s data and the set of keys returned by all the preceding
|
||||
<see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>s.
|
||||
</summary>
|
||||
<param name="earlierKeys">The child keys returned by the preceding providers for the same parent path.</param>
|
||||
<param name="parentPath">The parent path.</param>
|
||||
<returns>The child keys.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.ChainedConfigurationSource">
|
||||
<summary>
|
||||
Represents a chained IConfiguration as an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSource"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.ChainedConfigurationSource.Configuration">
|
||||
<summary>
|
||||
The chained configuration.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ChainedConfigurationSource.Build(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
|
||||
<summary>
|
||||
Builds the <see cref="T:Microsoft.Extensions.Configuration.ChainedConfigurationProvider"/> for this source.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
|
||||
<returns>A <see cref="T:Microsoft.Extensions.Configuration.ChainedConfigurationProvider"/></returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.ConfigurationBuilder">
|
||||
<summary>
|
||||
Used to build key/value based configuration settings for use in an application.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.ConfigurationBuilder.Sources">
|
||||
<summary>
|
||||
Returns the sources used to obtain configuration values.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.ConfigurationBuilder.Properties">
|
||||
<summary>
|
||||
Gets a key/value collection that can be used to share data between the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>
|
||||
and the registered <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>s.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBuilder.Add(Microsoft.Extensions.Configuration.IConfigurationSource)">
|
||||
<summary>
|
||||
Adds a new configuration source.
|
||||
</summary>
|
||||
<param name="source">The configuration source to add.</param>
|
||||
<returns>The same <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBuilder.Build">
|
||||
<summary>
|
||||
Builds an <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> with keys and values from the set of providers registered in
|
||||
<see cref="P:Microsoft.Extensions.Configuration.ConfigurationBuilder.Sources"/>.
|
||||
</summary>
|
||||
<returns>An <see cref="T:Microsoft.Extensions.Configuration.IConfigurationRoot"/> with keys and values from the registered providers.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.ConfigurationKeyComparer">
|
||||
<summary>
|
||||
IComparer implementation used to order configuration keys.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.ConfigurationKeyComparer.Instance">
|
||||
<summary>
|
||||
The default instance.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationKeyComparer.Compare(System.String,System.String)">
|
||||
<summary>
|
||||
Compares two strings.
|
||||
</summary>
|
||||
<param name="x">First string.</param>
|
||||
<param name="y">Second string.</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.ConfigurationProvider">
|
||||
<summary>
|
||||
Base helper class for implementing an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationProvider.#ctor">
|
||||
<summary>
|
||||
Initializes a new <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.ConfigurationProvider.Data">
|
||||
<summary>
|
||||
The configuration key value pairs for this provider.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationProvider.TryGet(System.String,System.String@)">
|
||||
<summary>
|
||||
Attempts to find a value with the given key, returns true if one is found, false otherwise.
|
||||
</summary>
|
||||
<param name="key">The key to lookup.</param>
|
||||
<param name="value">The value found at key if one is found.</param>
|
||||
<returns>True if key has a value, false otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationProvider.Set(System.String,System.String)">
|
||||
<summary>
|
||||
Sets a value for a given key.
|
||||
</summary>
|
||||
<param name="key">The configuration key to set.</param>
|
||||
<param name="value">The value to set.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationProvider.Load">
|
||||
<summary>
|
||||
Loads (or reloads) the data for this provider.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationProvider.GetChildKeys(System.Collections.Generic.IEnumerable{System.String},System.String)">
|
||||
<summary>
|
||||
Returns the list of keys that this provider has.
|
||||
</summary>
|
||||
<param name="earlierKeys">The earlier keys that other providers contain.</param>
|
||||
<param name="parentPath">The path for the parent IConfiguration.</param>
|
||||
<returns>The list of keys for this provider.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationProvider.GetReloadToken">
|
||||
<summary>
|
||||
Returns a <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> that can be used to listen when this provider is reloaded.
|
||||
</summary>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationProvider.OnReload">
|
||||
<summary>
|
||||
Triggers the reload change token and creates a new one.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.ConfigurationReloadToken">
|
||||
<summary>
|
||||
Implements <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.ConfigurationReloadToken.ActiveChangeCallbacks">
|
||||
<summary>
|
||||
Indicates if this token will proactively raise callbacks. Callbacks are still guaranteed to be invoked, eventually.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.ConfigurationReloadToken.HasChanged">
|
||||
<summary>
|
||||
Gets a value that indicates if a change has occurred.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationReloadToken.RegisterChangeCallback(System.Action{System.Object},System.Object)">
|
||||
<summary>
|
||||
Registers for a callback that will be invoked when the entry has changed. <see cref="P:Microsoft.Extensions.Primitives.IChangeToken.HasChanged"/>
|
||||
MUST be set before the callback is invoked.
|
||||
</summary>
|
||||
<param name="callback">The callback to invoke.</param>
|
||||
<param name="state">State to be passed into the callback.</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationReloadToken.OnReload">
|
||||
<summary>
|
||||
Used to trigger the change token when a reload occurs.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.ConfigurationRoot">
|
||||
<summary>
|
||||
The root node for a configuration.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationRoot.#ctor(System.Collections.Generic.IList{Microsoft.Extensions.Configuration.IConfigurationProvider})">
|
||||
<summary>
|
||||
Initializes a Configuration root with a list of providers.
|
||||
</summary>
|
||||
<param name="providers">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>s for this configuration.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.ConfigurationRoot.Providers">
|
||||
<summary>
|
||||
The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>s for this configuration.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.ConfigurationRoot.Item(System.String)">
|
||||
<summary>
|
||||
Gets or sets the value corresponding to a configuration key.
|
||||
</summary>
|
||||
<param name="key">The configuration key.</param>
|
||||
<returns>The configuration value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationRoot.GetChildren">
|
||||
<summary>
|
||||
Gets the immediate children sub-sections.
|
||||
</summary>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationRoot.GetReloadToken">
|
||||
<summary>
|
||||
Returns a <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> that can be used to observe when this configuration is reloaded.
|
||||
</summary>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationRoot.GetSection(System.String)">
|
||||
<summary>
|
||||
Gets a configuration sub-section with the specified key.
|
||||
</summary>
|
||||
<param name="key">The key of the configuration section.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSection"/>.</returns>
|
||||
<remarks>
|
||||
This method will never return <c>null</c>. If no matching sub-section is found with the specified key,
|
||||
an empty <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSection"/> will be returned.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationRoot.Reload">
|
||||
<summary>
|
||||
Force the configuration values to be reloaded from the underlying sources.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.ConfigurationSection">
|
||||
<summary>
|
||||
Represents a section of application configuration values.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationSection.#ctor(Microsoft.Extensions.Configuration.ConfigurationRoot,System.String)">
|
||||
<summary>
|
||||
Initializes a new instance.
|
||||
</summary>
|
||||
<param name="root">The configuration root.</param>
|
||||
<param name="path">The path to this section.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.ConfigurationSection.Path">
|
||||
<summary>
|
||||
Gets the full path to this section from the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationRoot"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.ConfigurationSection.Key">
|
||||
<summary>
|
||||
Gets the key this section occupies in its parent.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.ConfigurationSection.Value">
|
||||
<summary>
|
||||
Gets or sets the section value.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.ConfigurationSection.Item(System.String)">
|
||||
<summary>
|
||||
Gets or sets the value corresponding to a configuration key.
|
||||
</summary>
|
||||
<param name="key">The configuration key.</param>
|
||||
<returns>The configuration value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationSection.GetSection(System.String)">
|
||||
<summary>
|
||||
Gets a configuration sub-section with the specified key.
|
||||
</summary>
|
||||
<param name="key">The key of the configuration section.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSection"/>.</returns>
|
||||
<remarks>
|
||||
This method will never return <c>null</c>. If no matching sub-section is found with the specified key,
|
||||
an empty <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSection"/> will be returned.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationSection.GetChildren">
|
||||
<summary>
|
||||
Gets the immediate descendant configuration sub-sections.
|
||||
</summary>
|
||||
<returns>The configuration sub-sections.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationSection.GetReloadToken">
|
||||
<summary>
|
||||
Returns a <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> that can be used to observe when this configuration is reloaded.
|
||||
</summary>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.MemoryConfigurationBuilderExtensions">
|
||||
<summary>
|
||||
IConfigurationBuilder extension methods for the MemoryConfigurationProvider.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.MemoryConfigurationBuilderExtensions.AddInMemoryCollection(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
|
||||
<summary>
|
||||
Adds the memory configuration provider to <paramref name="configurationBuilder"/>.
|
||||
</summary>
|
||||
<param name="configurationBuilder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.MemoryConfigurationBuilderExtensions.AddInMemoryCollection(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.String}})">
|
||||
<summary>
|
||||
Adds the memory configuration provider to <paramref name="configurationBuilder"/>.
|
||||
</summary>
|
||||
<param name="configurationBuilder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
||||
<param name="initialData">The data to add to memory configuration provider.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.Memory.MemoryConfigurationProvider">
|
||||
<summary>
|
||||
In-memory implementation of <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.Memory.MemoryConfigurationProvider.#ctor(Microsoft.Extensions.Configuration.Memory.MemoryConfigurationSource)">
|
||||
<summary>
|
||||
Initialize a new instance from the source.
|
||||
</summary>
|
||||
<param name="source">The source settings.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.Memory.MemoryConfigurationProvider.Add(System.String,System.String)">
|
||||
<summary>
|
||||
Add a new key and value pair.
|
||||
</summary>
|
||||
<param name="key">The configuration key.</param>
|
||||
<param name="value">The configuration value.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.Memory.MemoryConfigurationProvider.GetEnumerator">
|
||||
<summary>
|
||||
Returns an enumerator that iterates through the collection.
|
||||
</summary>
|
||||
<returns>An enumerator that can be used to iterate through the collection.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.Memory.MemoryConfigurationProvider.System#Collections#IEnumerable#GetEnumerator">
|
||||
<summary>
|
||||
Returns an enumerator that iterates through the collection.
|
||||
</summary>
|
||||
<returns>An enumerator that can be used to iterate through the collection.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.Memory.MemoryConfigurationSource">
|
||||
<summary>
|
||||
Represents in-memory data as an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSource"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.Memory.MemoryConfigurationSource.InitialData">
|
||||
<summary>
|
||||
The initial key value configuration pairs.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.Memory.MemoryConfigurationSource.Build(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
|
||||
<summary>
|
||||
Builds the <see cref="T:Microsoft.Extensions.Configuration.Memory.MemoryConfigurationProvider"/> for this source.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
|
||||
<returns>A <see cref="T:Microsoft.Extensions.Configuration.Memory.MemoryConfigurationProvider"/></returns>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.Resources.Error_NoSources">
|
||||
<summary>
|
||||
A configuration source is not registered. Please register one before setting a value.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.Resources.FormatError_NoSources">
|
||||
<summary>
|
||||
A configuration source is not registered. Please register one before setting a value.
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
File diff suppressed because it is too large
Load Diff
Binary file not shown.
@@ -0,0 +1,244 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.DependencyInjection</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.DependencyInjection.DefaultServiceProviderFactory">
|
||||
<summary>
|
||||
Default implementation of <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceProviderFactory`1"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.DefaultServiceProviderFactory.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Microsoft.Extensions.DependencyInjection.DefaultServiceProviderFactory"/> class
|
||||
with default options.
|
||||
</summary>
|
||||
<seealso cref="F:Microsoft.Extensions.DependencyInjection.ServiceProviderOptions.Default"/>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.DefaultServiceProviderFactory.#ctor(Microsoft.Extensions.DependencyInjection.ServiceProviderOptions)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Microsoft.Extensions.DependencyInjection.DefaultServiceProviderFactory"/> class
|
||||
with the specified <paramref name="options"/>.
|
||||
</summary>
|
||||
<param name="options">The options to use for this instance.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.DefaultServiceProviderFactory.CreateBuilder(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.DefaultServiceProviderFactory.CreateServiceProvider(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.DependencyInjection.Resources.AmbiguousConstructorException">
|
||||
<summary>
|
||||
Unable to activate type '{0}'. The following constructors are ambiguous:
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.Resources.FormatAmbiguousConstructorException(System.Object)">
|
||||
<summary>
|
||||
Unable to activate type '{0}'. The following constructors are ambiguous:
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.DependencyInjection.Resources.CannotResolveService">
|
||||
<summary>
|
||||
Unable to resolve service for type '{0}' while attempting to activate '{1}'.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.Resources.FormatCannotResolveService(System.Object,System.Object)">
|
||||
<summary>
|
||||
Unable to resolve service for type '{0}' while attempting to activate '{1}'.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.DependencyInjection.Resources.CircularDependencyException">
|
||||
<summary>
|
||||
A circular dependency was detected for the service of type '{0}'.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.Resources.FormatCircularDependencyException(System.Object)">
|
||||
<summary>
|
||||
A circular dependency was detected for the service of type '{0}'.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.DependencyInjection.Resources.UnableToActivateTypeException">
|
||||
<summary>
|
||||
No constructor for type '{0}' can be instantiated using services from the service container and default values.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.Resources.FormatUnableToActivateTypeException(System.Object)">
|
||||
<summary>
|
||||
No constructor for type '{0}' can be instantiated using services from the service container and default values.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.DependencyInjection.Resources.OpenGenericServiceRequiresOpenGenericImplementation">
|
||||
<summary>
|
||||
Open generic service type '{0}' requires registering an open generic implementation type.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.Resources.FormatOpenGenericServiceRequiresOpenGenericImplementation(System.Object)">
|
||||
<summary>
|
||||
Open generic service type '{0}' requires registering an open generic implementation type.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.DependencyInjection.Resources.TypeCannotBeActivated">
|
||||
<summary>
|
||||
Cannot instantiate implementation type '{0}' for service type '{1}'.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.Resources.FormatTypeCannotBeActivated(System.Object,System.Object)">
|
||||
<summary>
|
||||
Cannot instantiate implementation type '{0}' for service type '{1}'.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.DependencyInjection.Resources.NoConstructorMatch">
|
||||
<summary>
|
||||
A suitable constructor for type '{0}' could not be located. Ensure the type is concrete and services are registered for all parameters of a public constructor.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.Resources.FormatNoConstructorMatch(System.Object)">
|
||||
<summary>
|
||||
A suitable constructor for type '{0}' could not be located. Ensure the type is concrete and services are registered for all parameters of a public constructor.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.DependencyInjection.Resources.ScopedInSingletonException">
|
||||
<summary>
|
||||
Cannot consume {2} service '{0}' from {3} '{1}'.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.Resources.FormatScopedInSingletonException(System.Object,System.Object,System.Object,System.Object)">
|
||||
<summary>
|
||||
Cannot consume {2} service '{0}' from {3} '{1}'.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.DependencyInjection.Resources.ScopedResolvedFromRootException">
|
||||
<summary>
|
||||
Cannot resolve '{0}' from root provider because it requires {2} service '{1}'.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.Resources.FormatScopedResolvedFromRootException(System.Object,System.Object,System.Object)">
|
||||
<summary>
|
||||
Cannot resolve '{0}' from root provider because it requires {2} service '{1}'.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.DependencyInjection.Resources.DirectScopedResolvedFromRootException">
|
||||
<summary>
|
||||
Cannot resolve {1} service '{0}' from root provider.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.Resources.FormatDirectScopedResolvedFromRootException(System.Object,System.Object)">
|
||||
<summary>
|
||||
Cannot resolve {1} service '{0}' from root provider.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.DependencyInjection.ServiceCollection">
|
||||
<summary>
|
||||
Default implementation of <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.DependencyInjection.ServiceCollection.Count">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.DependencyInjection.ServiceCollection.IsReadOnly">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.DependencyInjection.ServiceCollection.Item(System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.ServiceCollection.Clear">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.ServiceCollection.Contains(Microsoft.Extensions.DependencyInjection.ServiceDescriptor)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.ServiceCollection.CopyTo(Microsoft.Extensions.DependencyInjection.ServiceDescriptor[],System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.ServiceCollection.Remove(Microsoft.Extensions.DependencyInjection.ServiceDescriptor)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.ServiceCollection.GetEnumerator">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.ServiceCollection.IndexOf(Microsoft.Extensions.DependencyInjection.ServiceDescriptor)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.ServiceCollection.Insert(System.Int32,Microsoft.Extensions.DependencyInjection.ServiceDescriptor)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.ServiceCollection.RemoveAt(System.Int32)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.DependencyInjection.ServiceCollectionContainerBuilderExtensions">
|
||||
<summary>
|
||||
Extension methods for building a <see cref="T:Microsoft.Extensions.DependencyInjection.ServiceProvider"/> from an <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.ServiceCollectionContainerBuilderExtensions.BuildServiceProvider(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
|
||||
<summary>
|
||||
Creates a <see cref="T:Microsoft.Extensions.DependencyInjection.ServiceProvider"/> containing services from the provided <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.
|
||||
</summary>
|
||||
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> containing service descriptors.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.ServiceProvider"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.ServiceCollectionContainerBuilderExtensions.BuildServiceProvider(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Boolean)">
|
||||
<summary>
|
||||
Creates a <see cref="T:Microsoft.Extensions.DependencyInjection.ServiceProvider"/> containing services from the provided <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>
|
||||
optionaly enabling scope validation.
|
||||
</summary>
|
||||
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> containing service descriptors.</param>
|
||||
<param name="validateScopes">
|
||||
<c>true</c> to perform check verifying that scoped services never gets resolved from root provider; otherwise <c>false</c>.
|
||||
</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.ServiceProvider"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.ServiceCollectionContainerBuilderExtensions.BuildServiceProvider(Microsoft.Extensions.DependencyInjection.IServiceCollection,Microsoft.Extensions.DependencyInjection.ServiceProviderOptions)">
|
||||
<summary>
|
||||
Creates a <see cref="T:Microsoft.Extensions.DependencyInjection.ServiceProvider"/> containing services from the provided <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>
|
||||
optionaly enabling scope validation.
|
||||
</summary>
|
||||
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> containing service descriptors.</param>
|
||||
<param name="options">
|
||||
Configures various service provider behaviors.
|
||||
</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.ServiceProvider"/>.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.DependencyInjection.ServiceLookup.IServiceCallSite">
|
||||
<summary>
|
||||
Summary description for IServiceCallSite
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.DependencyInjection.ServiceProvider">
|
||||
<summary>
|
||||
The default IServiceProvider.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.ServiceProvider.GetService(System.Type)">
|
||||
<summary>
|
||||
Gets the service object of the specified type.
|
||||
</summary>
|
||||
<param name="serviceType"></param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.ServiceProvider.Dispose">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.DependencyInjection.ServiceProviderOptions">
|
||||
<summary>
|
||||
Options for configuring various behaviors of the default <see cref="T:System.IServiceProvider"/> implementation.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.DependencyInjection.ServiceProviderOptions.ValidateScopes">
|
||||
<summary>
|
||||
<c>true</c> to perform check verifying that scoped services never gets resolved from root provider; otherwise <c>false</c>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Internal.TypeNameHelper.GetTypeDisplayName(System.Type,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
Pretty print a type name.
|
||||
</summary>
|
||||
<param name="type">The <see cref="T:System.Type"/>.</param>
|
||||
<param name="fullName"><c>true</c> to print a fully qualified name.</param>
|
||||
<param name="includeGenericParameterNames"><c>true</c> to include generic parameter names.</param>
|
||||
<returns>The pretty printed type name.</returns>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1,207 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.FileProviders.Abstractions</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.IDirectoryContents">
|
||||
<summary>
|
||||
Represents a directory's content in the file provider.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.IDirectoryContents.Exists">
|
||||
<summary>
|
||||
True if a directory was located at the given path.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.IFileInfo">
|
||||
<summary>
|
||||
Represents a file in the given file provider.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.IFileInfo.Exists">
|
||||
<summary>
|
||||
True if resource exists in the underlying storage system.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.IFileInfo.Length">
|
||||
<summary>
|
||||
The length of the file in bytes, or -1 for a directory or non-existing files.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.IFileInfo.PhysicalPath">
|
||||
<summary>
|
||||
The path to the file, including the file name. Return null if the file is not directly accessible.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.IFileInfo.Name">
|
||||
<summary>
|
||||
The name of the file or directory, not including any path.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.IFileInfo.LastModified">
|
||||
<summary>
|
||||
When the file was last modified
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.IFileInfo.IsDirectory">
|
||||
<summary>
|
||||
True for the case TryGetDirectoryContents has enumerated a sub-directory
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.IFileInfo.CreateReadStream">
|
||||
<summary>
|
||||
Return file contents as readonly stream. Caller should dispose stream when complete.
|
||||
</summary>
|
||||
<returns>The file stream</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.IFileProvider">
|
||||
<summary>
|
||||
A read-only file provider abstraction.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.IFileProvider.GetFileInfo(System.String)">
|
||||
<summary>
|
||||
Locate a file at the given path.
|
||||
</summary>
|
||||
<param name="subpath">Relative path that identifies the file.</param>
|
||||
<returns>The file information. Caller must check Exists property.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.IFileProvider.GetDirectoryContents(System.String)">
|
||||
<summary>
|
||||
Enumerate a directory at the given path, if any.
|
||||
</summary>
|
||||
<param name="subpath">Relative path that identifies the directory.</param>
|
||||
<returns>Returns the contents of the directory.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.IFileProvider.Watch(System.String)">
|
||||
<summary>
|
||||
Creates a <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> for the specified <paramref name="filter"/>.
|
||||
</summary>
|
||||
<param name="filter">Filter string used to determine what files or folders to monitor. Example: **/*.cs, *.*, subFolder/**/*.cshtml.</param>
|
||||
<returns>An <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> that is notified when a file matching <paramref name="filter"/> is added, modified or deleted.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents">
|
||||
<summary>
|
||||
Represents a non-existing directory
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents.Singleton">
|
||||
<summary>
|
||||
A shared instance of <see cref="T:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents"/>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents.Exists">
|
||||
<summary>
|
||||
Always false.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents.GetEnumerator">
|
||||
<summary>Returns an enumerator that iterates through the collection.</summary>
|
||||
<returns>An enumerator to an empty collection.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents.System#Collections#IEnumerable#GetEnumerator">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.NotFoundFileInfo">
|
||||
<summary>
|
||||
Represents a non-existing file.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NotFoundFileInfo.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes an instance of <see cref="T:Microsoft.Extensions.FileProviders.NotFoundFileInfo"/>.
|
||||
</summary>
|
||||
<param name="name">The name of the file that could not be found</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.Exists">
|
||||
<summary>
|
||||
Always false.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.IsDirectory">
|
||||
<summary>
|
||||
Always false.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.LastModified">
|
||||
<summary>
|
||||
Returns <see cref="F:System.DateTimeOffset.MinValue"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.Length">
|
||||
<summary>
|
||||
Always equals -1.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.Name">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NotFoundFileInfo.PhysicalPath">
|
||||
<summary>
|
||||
Always null.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NotFoundFileInfo.CreateReadStream">
|
||||
<summary>
|
||||
Always throws. A stream cannot be created for non-existing file.
|
||||
</summary>
|
||||
<exception cref="T:System.IO.FileNotFoundException">Always thrown.</exception>
|
||||
<returns>Does not return</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.NullChangeToken">
|
||||
<summary>
|
||||
An empty change token that doesn't raise any change callbacks.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NullChangeToken.Singleton">
|
||||
<summary>
|
||||
A singleton instance of <see cref="T:Microsoft.Extensions.FileProviders.NullChangeToken"/>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NullChangeToken.HasChanged">
|
||||
<summary>
|
||||
Always false.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.NullChangeToken.ActiveChangeCallbacks">
|
||||
<summary>
|
||||
Always false.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NullChangeToken.RegisterChangeCallback(System.Action{System.Object},System.Object)">
|
||||
<summary>
|
||||
Always returns an empty disposable object. Callbacks will never be called.
|
||||
</summary>
|
||||
<param name="callback">This parameter is ignored</param>
|
||||
<param name="state">This parameter is ignored</param>
|
||||
<returns>A disposable object that noops on dispose.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.NullFileProvider">
|
||||
<summary>
|
||||
An empty file provider with no contents.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NullFileProvider.GetDirectoryContents(System.String)">
|
||||
<summary>
|
||||
Enumerate a non-existent directory.
|
||||
</summary>
|
||||
<param name="subpath">A path under the root directory. This parameter is ignored.</param>
|
||||
<returns>A <see cref="T:Microsoft.Extensions.FileProviders.IDirectoryContents"/> that does not exist and does not contain any contents.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NullFileProvider.GetFileInfo(System.String)">
|
||||
<summary>
|
||||
Locate a non-existent file.
|
||||
</summary>
|
||||
<param name="subpath">A path under the root directory.</param>
|
||||
<returns>A <see cref="T:Microsoft.Extensions.FileProviders.IFileInfo"/> representing a non-existent file at the given path.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.NullFileProvider.Watch(System.String)">
|
||||
<summary>
|
||||
Returns a <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> that monitors nothing.
|
||||
</summary>
|
||||
<param name="filter">Filter string used to determine what files or folders to monitor. This parameter is ignored.</param>
|
||||
<returns>A <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> that does not register callbacks.</returns>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1,384 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.FileProviders.Physical</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.Physical.ExclusionFilters">
|
||||
<summary>
|
||||
Specifies filtering behavior for files or directories.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.Extensions.FileProviders.Physical.ExclusionFilters.Sensitive">
|
||||
<summary>
|
||||
Equivalent to <c>DotPrefixed | Hidden | System</c>. Exclude files and directories when the name begins with a period, or has either <see cref="F:System.IO.FileAttributes.Hidden"/> or <see cref="F:System.IO.FileAttributes.System"/> is set on <see cref="P:System.IO.FileSystemInfo.Attributes"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.Extensions.FileProviders.Physical.ExclusionFilters.DotPrefixed">
|
||||
<summary>
|
||||
Exclude files and directories when the name begins with period.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.Extensions.FileProviders.Physical.ExclusionFilters.Hidden">
|
||||
<summary>
|
||||
Exclude files and directories when <see cref="F:System.IO.FileAttributes.Hidden"/> is set on <see cref="P:System.IO.FileSystemInfo.Attributes"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.Extensions.FileProviders.Physical.ExclusionFilters.System">
|
||||
<summary>
|
||||
Exclude files and directories when <see cref="F:System.IO.FileAttributes.System"/> is set on <see cref="P:System.IO.FileSystemInfo.Attributes"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.Extensions.FileProviders.Physical.ExclusionFilters.None">
|
||||
<summary>
|
||||
Do not exclude any files.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.Physical.PhysicalDirectoryInfo">
|
||||
<summary>
|
||||
Represents a directory on a physical filesystem
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.Physical.PhysicalDirectoryInfo.#ctor(System.IO.DirectoryInfo)">
|
||||
<summary>
|
||||
Initializes an instance of <see cref="T:Microsoft.Extensions.FileProviders.Physical.PhysicalDirectoryInfo"/> that wraps an instance of <see cref="T:System.IO.DirectoryInfo"/>
|
||||
</summary>
|
||||
<param name="info">The directory</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalDirectoryInfo.Exists">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalDirectoryInfo.Length">
|
||||
<summary>
|
||||
Always equals -1.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalDirectoryInfo.PhysicalPath">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalDirectoryInfo.Name">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalDirectoryInfo.LastModified">
|
||||
<summary>
|
||||
The time when the directory was last written to.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalDirectoryInfo.IsDirectory">
|
||||
<summary>
|
||||
Always true.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.Physical.PhysicalDirectoryInfo.CreateReadStream">
|
||||
<summary>
|
||||
Always throws an exception because read streams are not support on directories.
|
||||
</summary>
|
||||
<exception cref="T:System.InvalidOperationException">Always thrown</exception>
|
||||
<returns>Never returns</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.Physical.PhysicalFileInfo">
|
||||
<summary>
|
||||
Represents a file on a physical filesystem
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFileInfo.#ctor(System.IO.FileInfo)">
|
||||
<summary>
|
||||
Initializes an instance of <see cref="T:Microsoft.Extensions.FileProviders.Physical.PhysicalFileInfo"/> that wraps an instance of <see cref="T:System.IO.FileInfo"/>
|
||||
</summary>
|
||||
<param name="info">The <see cref="T:System.IO.FileInfo"/></param>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalFileInfo.Exists">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalFileInfo.Length">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalFileInfo.PhysicalPath">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalFileInfo.Name">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalFileInfo.LastModified">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalFileInfo.IsDirectory">
|
||||
<summary>
|
||||
Always false.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFileInfo.CreateReadStream">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher">
|
||||
<summary>
|
||||
<para>
|
||||
A file watcher that watches a physical filesystem for changes.
|
||||
</para>
|
||||
<para>
|
||||
Triggers events on <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> when files are created, change, renamed, or deleted.
|
||||
</para>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher.#ctor(System.String,System.IO.FileSystemWatcher,System.Boolean)">
|
||||
<summary>
|
||||
Initializes an instance of <see cref="T:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher" /> that watches files in <paramref name="root" />.
|
||||
Wraps an instance of <see cref="T:System.IO.FileSystemWatcher" />
|
||||
</summary>
|
||||
<param name="root">Root directory for the watcher</param>
|
||||
<param name="fileSystemWatcher">The wrapped watcher that is watching <paramref name="root" /></param>
|
||||
<param name="pollForChanges">
|
||||
True when the watcher should use polling to trigger instances of
|
||||
<see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> created by <see cref="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher.CreateFileChangeToken(System.String)" />
|
||||
</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher.#ctor(System.String,System.IO.FileSystemWatcher,System.Boolean,Microsoft.Extensions.FileProviders.Physical.ExclusionFilters)">
|
||||
<summary>
|
||||
Initializes an instance of <see cref="T:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher" /> that watches files in <paramref name="root" />.
|
||||
Wraps an instance of <see cref="T:System.IO.FileSystemWatcher" />
|
||||
</summary>
|
||||
<param name="root">Root directory for the watcher</param>
|
||||
<param name="fileSystemWatcher">The wrapped watcher that is watching <paramref name="root" /></param>
|
||||
<param name="pollForChanges">
|
||||
True when the watcher should use polling to trigger instances of
|
||||
<see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> created by <see cref="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher.CreateFileChangeToken(System.String)" />
|
||||
</param>
|
||||
<param name="filters">Specifies which files or directories are excluded. Notifications of changes to are not raised to these.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher.CreateFileChangeToken(System.String)">
|
||||
<summary>
|
||||
<para>
|
||||
Creates an instance of <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> for all files and directories that match the
|
||||
<paramref name="filter" />
|
||||
</para>
|
||||
<para>
|
||||
Globbing patterns are relative to the root directory given in the constructor
|
||||
<seealso cref="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher.#ctor(System.String,System.IO.FileSystemWatcher,System.Boolean)" />. Globbing patterns
|
||||
are interpreted by <seealso cref="T:Microsoft.Extensions.FileSystemGlobbing.Matcher" />.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="filter">A globbing pattern for files and directories to watch</param>
|
||||
<returns>A change token for all files that match the filter</returns>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="filter" /> is null</exception>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher.Dispose">
|
||||
<summary>
|
||||
Disposes the provider. Change tokens may not trigger after the provider is disposed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher.Dispose(System.Boolean)">
|
||||
<summary>
|
||||
Disposes the provider.
|
||||
</summary>
|
||||
<param name="disposing"><c>true</c> is invoked from <see cref="M:System.IDisposable.Dispose"/>.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher.Finalize">
|
||||
<summary>
|
||||
Destructor for <see cref="T:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.Physical.PollingFileChangeToken">
|
||||
<summary>
|
||||
<para>
|
||||
A change token that polls for file system changes.
|
||||
</para>
|
||||
<para>
|
||||
This change token does not raise any change callbacks. Callers should watch for <see cref="P:Microsoft.Extensions.FileProviders.Physical.PollingFileChangeToken.HasChanged" /> to turn
|
||||
from false to true
|
||||
and dispose the token after this happens.
|
||||
</para>
|
||||
</summary>
|
||||
<remarks>
|
||||
Polling occurs every 4 seconds.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.Physical.PollingFileChangeToken.#ctor(System.IO.FileInfo)">
|
||||
<summary>
|
||||
Initializes a new instance of <see cref="T:Microsoft.Extensions.FileProviders.Physical.PollingFileChangeToken" /> that polls the specified file for changes as
|
||||
determined by <see cref="P:System.IO.FileSystemInfo.LastWriteTimeUtc" />.
|
||||
</summary>
|
||||
<param name="fileInfo">The <see cref="T:System.IO.FileInfo"/> to poll</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.Physical.PollingFileChangeToken.ActiveChangeCallbacks">
|
||||
<summary>
|
||||
Always false.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.Physical.PollingFileChangeToken.HasChanged">
|
||||
<summary>
|
||||
True when the file has changed since the change token was created. Once the file changes, this value is always true
|
||||
</summary>
|
||||
<remarks>
|
||||
Once true, the value will always be true. Change tokens should not re-used once expired. The caller should discard this
|
||||
instance once it sees <see cref="P:Microsoft.Extensions.FileProviders.Physical.PollingFileChangeToken.HasChanged" /> is true.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.Physical.PollingFileChangeToken.RegisterChangeCallback(System.Action{System.Object},System.Object)">
|
||||
<summary>
|
||||
Does not actually register callbacks.
|
||||
</summary>
|
||||
<param name="callback">This parameter is ignored</param>
|
||||
<param name="state">This parameter is ignored</param>
|
||||
<returns>A disposable object that noops when disposed</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.Physical.PollingWildCardChangeToken">
|
||||
<summary>
|
||||
A polling based <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> for wildcard patterns.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.Physical.PollingWildCardChangeToken.#ctor(System.String,System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of <see cref="T:Microsoft.Extensions.FileProviders.Physical.PollingWildCardChangeToken"/>.
|
||||
</summary>
|
||||
<param name="root">The root of the file system.</param>
|
||||
<param name="pattern">The pattern to watch.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.Physical.PollingWildCardChangeToken.ActiveChangeCallbacks">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.Physical.PollingWildCardChangeToken.HasChanged">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.Physical.PollingWildCardChangeToken.GetLastWriteUtc(System.String)">
|
||||
<summary>
|
||||
Gets the last write time of the file at the specified <paramref name="path"/>.
|
||||
</summary>
|
||||
<param name="path">The root relative path.</param>
|
||||
<returns>The <see cref="T:System.DateTime"/> that the file was last modified.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.Internal.PhysicalDirectoryContents">
|
||||
<summary>
|
||||
Represents the contents of a physical file directory
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.Internal.PhysicalDirectoryContents.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes an instance of <see cref="T:Microsoft.Extensions.FileProviders.Internal.PhysicalDirectoryContents"/>
|
||||
</summary>
|
||||
<param name="directory">The directory</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.Internal.PhysicalDirectoryContents.#ctor(System.String,Microsoft.Extensions.FileProviders.Physical.ExclusionFilters)">
|
||||
<summary>
|
||||
Initializes an instance of <see cref="T:Microsoft.Extensions.FileProviders.Internal.PhysicalDirectoryContents"/>
|
||||
</summary>
|
||||
<param name="directory">The directory</param>
|
||||
<param name="filters">Specifies which files or directories are excluded from enumeration.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.Internal.PhysicalDirectoryContents.Exists">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.Internal.PhysicalDirectoryContents.GetEnumerator">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileProviders.PhysicalFileProvider">
|
||||
<summary>
|
||||
Looks up files using the on-disk file system
|
||||
</summary>
|
||||
<remarks>
|
||||
When the environment variable "DOTNET_USE_POLLING_FILE_WATCHER" is set to "1" or "true", calls to
|
||||
<see cref="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.Watch(System.String)" /> will use <see cref="T:Microsoft.Extensions.FileProviders.Physical.PollingFileChangeToken" />.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of a PhysicalFileProvider at the given root directory.
|
||||
</summary>
|
||||
<param name="root">The root directory. This should be an absolute path.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.#ctor(System.String,Microsoft.Extensions.FileProviders.Physical.ExclusionFilters)">
|
||||
<summary>
|
||||
Initializes a new instance of a PhysicalFileProvider at the given root directory.
|
||||
</summary>
|
||||
<param name="root">The root directory. This should be an absolute path.</param>
|
||||
<param name="filters">Specifies which files or directories are excluded.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.PhysicalFileProvider.UsePollingFileWatcher">
|
||||
<summary>
|
||||
Gets or sets a value that determines if this instance of <see cref="T:Microsoft.Extensions.FileProviders.PhysicalFileProvider"/>
|
||||
uses polling to determine file changes.
|
||||
<para>
|
||||
By default, <see cref="T:Microsoft.Extensions.FileProviders.PhysicalFileProvider"/> uses <see cref="T:System.IO.FileSystemWatcher"/> to listen to file change events
|
||||
for <see cref="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.Watch(System.String)"/>. <see cref="T:System.IO.FileSystemWatcher"/> is ineffective in some scenarios such as mounted drives.
|
||||
Polling is required to effectively watch for file changes.
|
||||
</para>
|
||||
<seealso cref="P:Microsoft.Extensions.FileProviders.PhysicalFileProvider.UseActivePolling"/>.
|
||||
</summary>
|
||||
<value>
|
||||
The default value of this property is determined by the value of environment variable named <c>DOTNET_USE_POLLING_FILE_WATCHER</c>.
|
||||
When <c>true</c> or <c>1</c>, this property defaults to <c>true</c>; otherwise false.
|
||||
</value>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.PhysicalFileProvider.UseActivePolling">
|
||||
<summary>
|
||||
Gets or sets a value that determines if this instance of <see cref="T:Microsoft.Extensions.FileProviders.PhysicalFileProvider"/>
|
||||
actively polls for file changes.
|
||||
<para>
|
||||
When <see langword="true"/>, <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> returned by <see cref="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.Watch(System.String)"/> will actively poll for file changes
|
||||
(<see cref="P:Microsoft.Extensions.Primitives.IChangeToken.ActiveChangeCallbacks"/> will be <see langword="true"/>) instead of being passive.
|
||||
</para>
|
||||
<para>
|
||||
This property is only effective when <see cref="P:Microsoft.Extensions.FileProviders.PhysicalFileProvider.UsePollingFileWatcher"/> is set.
|
||||
</para>
|
||||
</summary>
|
||||
<value>
|
||||
The default value of this property is determined by the value of environment variable named <c>DOTNET_USE_POLLING_FILE_WATCHER</c>.
|
||||
When <c>true</c> or <c>1</c>, this property defaults to <c>true</c>; otherwise false.
|
||||
</value>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.Dispose">
|
||||
<summary>
|
||||
Disposes the provider. Change tokens may not trigger after the provider is disposed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.Dispose(System.Boolean)">
|
||||
<summary>
|
||||
Disposes the provider.
|
||||
</summary>
|
||||
<param name="disposing"><c>true</c> is invoked from <see cref="M:System.IDisposable.Dispose"/>.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.Finalize">
|
||||
<summary>
|
||||
Destructor for <see cref="T:Microsoft.Extensions.FileProviders.PhysicalFileProvider"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileProviders.PhysicalFileProvider.Root">
|
||||
<summary>
|
||||
The root directory for this instance.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.GetFileInfo(System.String)">
|
||||
<summary>
|
||||
Locate a file at the given path by directly mapping path segments to physical directories.
|
||||
</summary>
|
||||
<param name="subpath">A path under the root directory</param>
|
||||
<returns>The file information. Caller must check <see cref="P:Microsoft.Extensions.FileProviders.IFileInfo.Exists"/> property. </returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.GetDirectoryContents(System.String)">
|
||||
<summary>
|
||||
Enumerate a directory at the given path, if any.
|
||||
</summary>
|
||||
<param name="subpath">A path under the root directory. Leading slashes are ignored.</param>
|
||||
<returns>
|
||||
Contents of the directory. Caller must check <see cref="P:Microsoft.Extensions.FileProviders.IDirectoryContents.Exists"/> property. <see cref="T:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents" /> if
|
||||
<paramref name="subpath" /> is absolute, if the directory does not exist, or <paramref name="subpath" /> has invalid
|
||||
characters.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.Watch(System.String)">
|
||||
<summary>
|
||||
<para>Creates a <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> for the specified <paramref name="filter" />.</para>
|
||||
<para>Globbing patterns are interpreted by <seealso cref="T:Microsoft.Extensions.FileSystemGlobbing.Matcher" />.</para>
|
||||
</summary>
|
||||
<param name="filter">
|
||||
Filter string used to determine what files or folders to monitor. Example: **/*.cs, *.*,
|
||||
subFolder/**/*.cshtml.
|
||||
</param>
|
||||
<returns>
|
||||
An <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> that is notified when a file matching <paramref name="filter" /> is added,
|
||||
modified or deleted. Returns a <see cref="T:Microsoft.Extensions.FileProviders.NullChangeToken" /> if <paramref name="filter" /> has invalid filter
|
||||
characters or if <paramref name="filter" /> is an absolute path or outside the root directory specified in the
|
||||
constructor <seealso cref="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.#ctor(System.String)" />.
|
||||
</returns>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1,442 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.FileSystemGlobbing</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoBase">
|
||||
<summary>
|
||||
Represents a directory
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoBase.EnumerateFileSystemInfos">
|
||||
<summary>
|
||||
Enumerates all files and directories in the directory.
|
||||
</summary>
|
||||
<returns>Collection of files and directories</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoBase.GetDirectory(System.String)">
|
||||
<summary>
|
||||
Returns an instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoBase" /> that represents a subdirectory
|
||||
</summary>
|
||||
<param name="path">The directory name</param>
|
||||
<returns>Instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoBase" /> even if directory does not exist</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoBase.GetFile(System.String)">
|
||||
<summary>
|
||||
Returns an instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileInfoBase" /> that represents a file in the directory
|
||||
</summary>
|
||||
<param name="path">The file name</param>
|
||||
<returns>Instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileInfoBase" /> even if file does not exist</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoWrapper">
|
||||
<summary>
|
||||
Wraps an instance of <see cref="T:System.IO.DirectoryInfo" /> and provides implementation of
|
||||
<see cref="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoBase" />.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoWrapper.#ctor(System.IO.DirectoryInfo)">
|
||||
<summary>
|
||||
Initializes an instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoWrapper" />.
|
||||
</summary>
|
||||
<param name="directoryInfo">The <see cref="T:System.IO.DirectoryInfo" />.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoWrapper.EnumerateFileSystemInfos">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoWrapper.GetDirectory(System.String)">
|
||||
<summary>
|
||||
Returns an instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoBase" /> that represents a subdirectory.
|
||||
</summary>
|
||||
<remarks>
|
||||
If <paramref name="name" /> equals '..', this returns the parent directory.
|
||||
</remarks>
|
||||
<param name="name">The directory name</param>
|
||||
<returns>The directory</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoWrapper.GetFile(System.String)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoWrapper.Name">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoWrapper.FullName">
|
||||
<summary>
|
||||
Returns the full path to the directory.
|
||||
</summary>
|
||||
<remarks>
|
||||
Equals the value of <seealso cref="P:System.IO.FileSystemInfo.FullName" />.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoWrapper.ParentDirectory">
|
||||
<summary>
|
||||
Returns the parent directory.
|
||||
</summary>
|
||||
<remarks>
|
||||
Equals the value of <seealso cref="P:System.IO.DirectoryInfo.Parent" />.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileInfoBase">
|
||||
<summary>
|
||||
Represents a file
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileInfoWrapper">
|
||||
<summary>
|
||||
Wraps an instance of <see cref="T:System.IO.FileInfo" /> to provide implementation of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileInfoBase" />.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileInfoWrapper.#ctor(System.IO.FileInfo)">
|
||||
<summary>
|
||||
Initializes instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileInfoWrapper" /> to wrap the specified object <see cref="T:System.IO.FileInfo" />.
|
||||
</summary>
|
||||
<param name="fileInfo">The <see cref="T:System.IO.FileInfo" /></param>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileInfoWrapper.Name">
|
||||
<summary>
|
||||
The file name. (Overrides <see cref="P:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileSystemInfoBase.Name" />).
|
||||
</summary>
|
||||
<remarks>
|
||||
Equals the value of <see cref="P:System.IO.FileInfo.Name" />.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileInfoWrapper.FullName">
|
||||
<summary>
|
||||
The full path of the file. (Overrides <see cref="P:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileSystemInfoBase.FullName" />).
|
||||
</summary>
|
||||
<remarks>
|
||||
Equals the value of <see cref="P:System.IO.FileSystemInfo.Name" />.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileInfoWrapper.ParentDirectory">
|
||||
<summary>
|
||||
The directory containing the file. (Overrides <see cref="P:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileSystemInfoBase.ParentDirectory" />).
|
||||
</summary>
|
||||
<remarks>
|
||||
Equals the value of <see cref="P:System.IO.FileInfo.Directory" />.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileSystemInfoBase">
|
||||
<summary>
|
||||
Shared abstraction for files and directories
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileSystemInfoBase.Name">
|
||||
<summary>
|
||||
A string containing the name of the file or directory
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileSystemInfoBase.FullName">
|
||||
<summary>
|
||||
A string containing the full path of the file or directory
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileSystemInfoBase.ParentDirectory">
|
||||
<summary>
|
||||
The parent directory for the current file or directory
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch">
|
||||
<summary>
|
||||
Represents a file that was matched by searching using a globbing pattern
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch.Path">
|
||||
<summary>
|
||||
The path to the file matched
|
||||
</summary>
|
||||
<remarks>
|
||||
If the matcher searched for "**/*.cs" using "src/Project" as the directory base and the pattern matcher found
|
||||
"src/Project/Interfaces/IFile.cs", then Stem = "Interfaces/IFile.cs" and Path = "src/Project/Interfaces/IFile.cs".
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch.Stem">
|
||||
<summary>
|
||||
The subpath to the matched file under the base directory searched
|
||||
</summary>
|
||||
<remarks>
|
||||
If the matcher searched for "**/*.cs" using "src/Project" as the directory base and the pattern matcher found
|
||||
"src/Project/Interfaces/IFile.cs",
|
||||
then Stem = "Interfaces/IFile.cs" and Path = "src/Project/Interfaces/IFile.cs".
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch.#ctor(System.String,System.String)">
|
||||
<summary>
|
||||
Initializes new instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch" />
|
||||
</summary>
|
||||
<param name="path">The path to the matched file</param>
|
||||
<param name="stem">The stem</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch.Equals(Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch)">
|
||||
<summary>
|
||||
Determines if the specified match is equivalent to the current match using a case-insensitive comparison.
|
||||
</summary>
|
||||
<param name="other">The other match to be compared</param>
|
||||
<returns>True if <see cref="P:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch.Path" /> and <see cref="P:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch.Stem" /> are equal using case-insensitive comparison</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch.Equals(System.Object)">
|
||||
<summary>
|
||||
Determines if the specified object is equivalent to the current match using a case-insensitive comparison.
|
||||
</summary>
|
||||
<param name="obj">The object to be compared</param>
|
||||
<returns>True when <see cref="M:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch.Equals(Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch)" /></returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch.GetHashCode">
|
||||
<summary>
|
||||
Gets a hash for the file pattern match.
|
||||
</summary>
|
||||
<returns>Some number</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileSystemGlobbing.InMemoryDirectoryInfo">
|
||||
<summary>
|
||||
Avoids using disk for uses like Pattern Matching.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileSystemGlobbing.InMemoryDirectoryInfo.#ctor(System.String,System.Collections.Generic.IEnumerable{System.String})">
|
||||
<summary>
|
||||
Creates a new InMemoryDirectoryInfo with the root directory and files given.
|
||||
</summary>
|
||||
<param name="rootDir">The root directory that this FileSystem will use.</param>
|
||||
<param name="files">Collection of file names. If relative paths <paramref name="rootDir"/> will be prepended to the paths.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileSystemGlobbing.InMemoryDirectoryInfo.FullName">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileSystemGlobbing.InMemoryDirectoryInfo.Name">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileSystemGlobbing.InMemoryDirectoryInfo.ParentDirectory">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileSystemGlobbing.InMemoryDirectoryInfo.EnumerateFileSystemInfos">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileSystemGlobbing.InMemoryDirectoryInfo.GetDirectory(System.String)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileSystemGlobbing.InMemoryDirectoryInfo.GetFile(System.String)">
|
||||
<summary>
|
||||
Returns an instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileInfoBase"/> that matches the <paramref name="path"/> given.
|
||||
</summary>
|
||||
<param name="path">The filename.</param>
|
||||
<returns>Instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileInfoBase"/> if the file exists, null otherwise.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileSystemGlobbing.Matcher">
|
||||
<summary>
|
||||
Searches the file system for files with names that match specified patterns.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>
|
||||
Patterns specified in <seealso cref="M:Microsoft.Extensions.FileSystemGlobbing.Matcher.AddInclude(System.String)" /> and <seealso cref="M:Microsoft.Extensions.FileSystemGlobbing.Matcher.AddExclude(System.String)" /> can use
|
||||
the following formats to match multiple files or directories.
|
||||
</para>
|
||||
<list type="bullet">
|
||||
<item>
|
||||
<term>
|
||||
exact directory and file name
|
||||
</term>
|
||||
<description>
|
||||
<list type="bullet">
|
||||
<item>
|
||||
<term>"one.txt"</term>
|
||||
</item>
|
||||
<item>
|
||||
<term>"dir/two.txt"</term>
|
||||
</item>
|
||||
</list>
|
||||
</description>
|
||||
</item>
|
||||
<item>
|
||||
<term>
|
||||
wildcards (*) in file and directory names that represent zero to many characters not including
|
||||
directory separators characters
|
||||
</term>
|
||||
<description>
|
||||
<list type="bullet">
|
||||
<item>
|
||||
<term>"*.txt"</term><description>all files with .txt file extension</description>
|
||||
</item>
|
||||
<item>
|
||||
<term>"*.*"</term><description>all files with an extension</description>
|
||||
</item>
|
||||
<item>
|
||||
<term>"*"</term><description>all files in top level directory</description>
|
||||
</item>
|
||||
<item>
|
||||
<term>".*"</term><description>filenames beginning with '.'</description>
|
||||
</item>
|
||||
- "*word* - all files with 'word' in the filename
|
||||
<item>
|
||||
<term>"readme.*"</term>
|
||||
<description>all files named 'readme' with any file extension</description>
|
||||
</item>
|
||||
<item>
|
||||
<term>"styles/*.css"</term>
|
||||
<description>all files with extension '.css' in the directory 'styles/'</description>
|
||||
</item>
|
||||
<item>
|
||||
<term>"scripts/*/*"</term>
|
||||
<description>all files in 'scripts/' or one level of subdirectory under 'scripts/'</description>
|
||||
</item>
|
||||
<item>
|
||||
<term>"images*/*"</term>
|
||||
<description>all files in a folder with name that is or begins with 'images'</description>
|
||||
</item>
|
||||
</list>
|
||||
</description>
|
||||
</item>
|
||||
<item>
|
||||
<term>arbitrary directory depth ("/**/")</term>
|
||||
<description>
|
||||
<list type="bullet">
|
||||
<item>
|
||||
<term>"**/*"</term><description>all files in any subdirectory</description>
|
||||
</item>
|
||||
<item>
|
||||
<term>"dir/**/*"</term><description>all files in any subdirectory under 'dir/'</description>
|
||||
</item>
|
||||
</list>
|
||||
</description>
|
||||
</item>
|
||||
<item>
|
||||
<term>relative paths</term>
|
||||
<description>
|
||||
'../shared/*' - all files in a diretory named 'shared' at the sibling level to the base directory given
|
||||
to <see cref="M:Microsoft.Extensions.FileSystemGlobbing.Matcher.Execute(Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoBase)" />
|
||||
</description>
|
||||
</item>
|
||||
</list>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileSystemGlobbing.Matcher.#ctor">
|
||||
<summary>
|
||||
Initializes an instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Matcher" /> using case-insensitive matching
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileSystemGlobbing.Matcher.#ctor(System.StringComparison)">
|
||||
<summary>
|
||||
Initializes an instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Matcher" /> using the string comparsion method specified
|
||||
</summary>
|
||||
<param name="comparisonType">The <see cref="T:System.StringComparison" /> to use</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileSystemGlobbing.Matcher.AddInclude(System.String)">
|
||||
<summary>
|
||||
<para>
|
||||
Add a file name pattern that the matcher should use to discover files. Patterns are relative to the root
|
||||
directory given when <see cref="M:Microsoft.Extensions.FileSystemGlobbing.Matcher.Execute(Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoBase)" /> is called.
|
||||
</para>
|
||||
<para>
|
||||
Use the forward slash '/' to represent directory separator. Use '*' to represent wildcards in file and
|
||||
directory names. Use '**' to represent arbitrary directory depth. Use '..' to represent a parent directory.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="pattern">The globbing pattern</param>
|
||||
<returns>The matcher</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileSystemGlobbing.Matcher.AddExclude(System.String)">
|
||||
<summary>
|
||||
<para>
|
||||
Add a file name pattern for files the matcher should exclude from the results. Patterns are relative to the
|
||||
root directory given when <see cref="M:Microsoft.Extensions.FileSystemGlobbing.Matcher.Execute(Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoBase)" /> is called.
|
||||
</para>
|
||||
<para>
|
||||
Use the forward slash '/' to represent directory separator. Use '*' to represent wildcards in file and
|
||||
directory names. Use '**' to represent arbitrary directory depth. Use '..' to represent a parent directory.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="pattern">The globbing pattern</param>
|
||||
<returns>The matcher</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileSystemGlobbing.Matcher.Execute(Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoBase)">
|
||||
<summary>
|
||||
Searches the directory specified for all files matching patterns added to this instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Matcher" />
|
||||
</summary>
|
||||
<param name="directoryInfo">The root directory for the search</param>
|
||||
<returns>Always returns instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.PatternMatchingResult" />, even if not files were matched</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileSystemGlobbing.MatcherExtensions.AddExcludePatterns(Microsoft.Extensions.FileSystemGlobbing.Matcher,System.Collections.Generic.IEnumerable{System.String}[])">
|
||||
<summary>
|
||||
Adds multiple exclude patterns to <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Matcher" />. <seealso cref="M:Microsoft.Extensions.FileSystemGlobbing.Matcher.AddExclude(System.String)" />
|
||||
</summary>
|
||||
<param name="matcher">The matcher to which the exclude patterns are added</param>
|
||||
<param name="excludePatternsGroups">A list of globbing patterns</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileSystemGlobbing.MatcherExtensions.AddIncludePatterns(Microsoft.Extensions.FileSystemGlobbing.Matcher,System.Collections.Generic.IEnumerable{System.String}[])">
|
||||
<summary>
|
||||
Adds multiple patterns to include in <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Matcher" />. See <seealso cref="M:Microsoft.Extensions.FileSystemGlobbing.Matcher.AddInclude(System.String)" />
|
||||
</summary>
|
||||
<param name="matcher">The matcher to which the include patterns are added</param>
|
||||
<param name="includePatternsGroups">A list of globbing patterns</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileSystemGlobbing.MatcherExtensions.GetResultsInFullPath(Microsoft.Extensions.FileSystemGlobbing.Matcher,System.String)">
|
||||
<summary>
|
||||
Searches the directory specified for all files matching patterns added to this instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.Matcher" />
|
||||
</summary>
|
||||
<param name="matcher">The matcher</param>
|
||||
<param name="directoryPath">The root directory for the search</param>
|
||||
<returns>Absolute file paths of all files matched. Empty enumerable if no files matched given patterns.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileSystemGlobbing.MatcherExtensions.Match(Microsoft.Extensions.FileSystemGlobbing.Matcher,System.String)">
|
||||
<summary>
|
||||
Matches the file passed in with the patterns in the matcher without going to disk.
|
||||
</summary>
|
||||
<param name="matcher">The matcher that holds the patterns and pattern matching type.</param>
|
||||
<param name="file">The file to run the matcher against.</param>
|
||||
<returns>The match results.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileSystemGlobbing.MatcherExtensions.Match(Microsoft.Extensions.FileSystemGlobbing.Matcher,System.String,System.String)">
|
||||
<summary>
|
||||
Matches the file passed in with the patterns in the matcher without going to disk.
|
||||
</summary>
|
||||
<param name="matcher">The matcher that holds the patterns and pattern matching type.</param>
|
||||
<param name="rootDir">The root directory for the matcher to match the file from.</param>
|
||||
<param name="file">The file to run the matcher against.</param>
|
||||
<returns>The match results.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileSystemGlobbing.MatcherExtensions.Match(Microsoft.Extensions.FileSystemGlobbing.Matcher,System.Collections.Generic.IEnumerable{System.String})">
|
||||
<summary>
|
||||
Matches the files passed in with the patterns in the matcher without going to disk.
|
||||
</summary>
|
||||
<param name="matcher">The matcher that holds the patterns and pattern matching type.</param>
|
||||
<param name="files">The files to run the matcher against.</param>
|
||||
<returns>The match results.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileSystemGlobbing.MatcherExtensions.Match(Microsoft.Extensions.FileSystemGlobbing.Matcher,System.String,System.Collections.Generic.IEnumerable{System.String})">
|
||||
<summary>
|
||||
Matches the files passed in with the patterns in the matcher without going to disk.
|
||||
</summary>
|
||||
<param name="matcher">The matcher that holds the patterns and pattern matching type.</param>
|
||||
<param name="rootDir">The root directory for the matcher to match the files from.</param>
|
||||
<param name="files">The files to run the matcher against.</param>
|
||||
<returns>The match results.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.FileSystemGlobbing.PatternMatchingResult">
|
||||
<summary>
|
||||
Represents a collection of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch" />
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileSystemGlobbing.PatternMatchingResult.#ctor(System.Collections.Generic.IEnumerable{Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch})">
|
||||
<summary>
|
||||
Initializes the result with a collection of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch" />
|
||||
</summary>
|
||||
<param name="files">A collection of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch" /></param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.FileSystemGlobbing.PatternMatchingResult.#ctor(System.Collections.Generic.IEnumerable{Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch},System.Boolean)">
|
||||
<summary>
|
||||
Initializes the result with a collection of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch" />
|
||||
</summary>
|
||||
<param name="files">A collection of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch" /></param>
|
||||
<param name="hasMatches">A value that determines if <see cref="T:Microsoft.Extensions.FileSystemGlobbing.PatternMatchingResult"/> has any matches.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileSystemGlobbing.PatternMatchingResult.Files">
|
||||
<summary>
|
||||
A collection of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.FilePatternMatch" />
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.FileSystemGlobbing.PatternMatchingResult.HasMatches">
|
||||
<summary>
|
||||
Gets a value that determines if this instance of <see cref="T:Microsoft.Extensions.FileSystemGlobbing.PatternMatchingResult"/> has any matches.
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1,339 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Hosting.Abstractions</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Hosting.BackgroundService">
|
||||
<summary>
|
||||
Base class for implementing a long running <see cref="T:Microsoft.Extensions.Hosting.IHostedService"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Hosting.BackgroundService.ExecuteAsync(System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
This method is called when the <see cref="T:Microsoft.Extensions.Hosting.IHostedService"/> starts. The implementation should return a task that represents
|
||||
the lifetime of the long running operation(s) being performed.
|
||||
</summary>
|
||||
<param name="stoppingToken">Triggered when <see cref="M:Microsoft.Extensions.Hosting.IHostedService.StopAsync(System.Threading.CancellationToken)"/> is called.</param>
|
||||
<returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the long running operations.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Hosting.BackgroundService.StartAsync(System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Triggered when the application host is ready to start the service.
|
||||
</summary>
|
||||
<param name="cancellationToken">Indicates that the start process has been aborted.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Hosting.BackgroundService.StopAsync(System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Triggered when the application host is performing a graceful shutdown.
|
||||
</summary>
|
||||
<param name="cancellationToken">Indicates that the shutdown process should no longer be graceful.</param>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Hosting.EnvironmentName">
|
||||
<summary>
|
||||
Commonly used environment names.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Hosting.HostBuilderContext">
|
||||
<summary>
|
||||
Context containing the common services on the <see cref="T:Microsoft.Extensions.Hosting.IHost" />. Some properties may be null until set by the <see cref="T:Microsoft.Extensions.Hosting.IHost" />.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Hosting.HostBuilderContext.HostingEnvironment">
|
||||
<summary>
|
||||
The <see cref="T:Microsoft.Extensions.Hosting.IHostingEnvironment" /> initialized by the <see cref="T:Microsoft.Extensions.Hosting.IHost" />.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Hosting.HostBuilderContext.Configuration">
|
||||
<summary>
|
||||
The <see cref="T:Microsoft.Extensions.Configuration.IConfiguration" /> containing the merged configuration of the application and the <see cref="T:Microsoft.Extensions.Hosting.IHost" />.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Hosting.HostBuilderContext.Properties">
|
||||
<summary>
|
||||
A central location for sharing state between components during the host building process.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Hosting.HostDefaults">
|
||||
<summary>
|
||||
Constants for HostBuilder configuration keys.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.Extensions.Hosting.HostDefaults.ApplicationKey">
|
||||
<summary>
|
||||
The configuration key used to set <see cref="P:Microsoft.Extensions.Hosting.IHostingEnvironment.ApplicationName"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.Extensions.Hosting.HostDefaults.EnvironmentKey">
|
||||
<summary>
|
||||
The configuration key used to set <see cref="P:Microsoft.Extensions.Hosting.IHostingEnvironment.EnvironmentName"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.Extensions.Hosting.HostDefaults.ContentRootKey">
|
||||
<summary>
|
||||
The configuration key used to set <see cref="P:Microsoft.Extensions.Hosting.IHostingEnvironment.ContentRootPath"/>
|
||||
and <see cref="P:Microsoft.Extensions.Hosting.IHostingEnvironment.ContentRootFileProvider"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Hosting.HostingAbstractionsHostBuilderExtensions.Start(Microsoft.Extensions.Hosting.IHostBuilder)">
|
||||
<summary>
|
||||
Start the host and listen on the specified urls.
|
||||
</summary>
|
||||
<param name="hostBuilder">The <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/> to start.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Hosting.HostingAbstractionsHostExtensions.Start(Microsoft.Extensions.Hosting.IHost)">
|
||||
<summary>
|
||||
Starts the host synchronously.
|
||||
</summary>
|
||||
<param name="host"></param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Hosting.HostingAbstractionsHostExtensions.StopAsync(Microsoft.Extensions.Hosting.IHost,System.TimeSpan)">
|
||||
<summary>
|
||||
Attempts to gracefully stop the host with the given timeout.
|
||||
</summary>
|
||||
<param name="host"></param>
|
||||
<param name="timeout">The timeout for stopping gracefully. Once expired the
|
||||
server may terminate any remaining active connections.</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Hosting.HostingAbstractionsHostExtensions.WaitForShutdown(Microsoft.Extensions.Hosting.IHost)">
|
||||
<summary>
|
||||
Block the calling thread until shutdown is triggered via Ctrl+C or SIGTERM.
|
||||
</summary>
|
||||
<param name="host">The running <see cref="T:Microsoft.Extensions.Hosting.IHost"/>.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Hosting.HostingAbstractionsHostExtensions.Run(Microsoft.Extensions.Hosting.IHost)">
|
||||
<summary>
|
||||
Runs an application and block the calling thread until host shutdown.
|
||||
</summary>
|
||||
<param name="host">The <see cref="T:Microsoft.Extensions.Hosting.IHost"/> to run.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Hosting.HostingAbstractionsHostExtensions.RunAsync(Microsoft.Extensions.Hosting.IHost,System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Runs an application and returns a Task that only completes when the token is triggered or shutdown is triggered.
|
||||
</summary>
|
||||
<param name="host">The <see cref="T:Microsoft.Extensions.Hosting.IHost"/> to run.</param>
|
||||
<param name="token">The token to trigger shutdown.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Hosting.HostingAbstractionsHostExtensions.WaitForShutdownAsync(Microsoft.Extensions.Hosting.IHost,System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Returns a Task that completes when shutdown is triggered via the given token.
|
||||
</summary>
|
||||
<param name="host">The running <see cref="T:Microsoft.Extensions.Hosting.IHost"/>.</param>
|
||||
<param name="token">The token to trigger shutdown.</param>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Hosting.HostingEnvironmentExtensions">
|
||||
<summary>
|
||||
Extension methods for <see cref="T:Microsoft.Extensions.Hosting.IHostingEnvironment"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Hosting.HostingEnvironmentExtensions.IsDevelopment(Microsoft.Extensions.Hosting.IHostingEnvironment)">
|
||||
<summary>
|
||||
Checks if the current hosting environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Development"/>.
|
||||
</summary>
|
||||
<param name="hostingEnvironment">An instance of <see cref="T:Microsoft.Extensions.Hosting.IHostingEnvironment"/>.</param>
|
||||
<returns>True if the environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Development"/>, otherwise false.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Hosting.HostingEnvironmentExtensions.IsStaging(Microsoft.Extensions.Hosting.IHostingEnvironment)">
|
||||
<summary>
|
||||
Checks if the current hosting environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Staging"/>.
|
||||
</summary>
|
||||
<param name="hostingEnvironment">An instance of <see cref="T:Microsoft.Extensions.Hosting.IHostingEnvironment"/>.</param>
|
||||
<returns>True if the environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Staging"/>, otherwise false.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Hosting.HostingEnvironmentExtensions.IsProduction(Microsoft.Extensions.Hosting.IHostingEnvironment)">
|
||||
<summary>
|
||||
Checks if the current hosting environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Production"/>.
|
||||
</summary>
|
||||
<param name="hostingEnvironment">An instance of <see cref="T:Microsoft.Extensions.Hosting.IHostingEnvironment"/>.</param>
|
||||
<returns>True if the environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Production"/>, otherwise false.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Hosting.HostingEnvironmentExtensions.IsEnvironment(Microsoft.Extensions.Hosting.IHostingEnvironment,System.String)">
|
||||
<summary>
|
||||
Compares the current hosting environment name against the specified value.
|
||||
</summary>
|
||||
<param name="hostingEnvironment">An instance of <see cref="T:Microsoft.Extensions.Hosting.IHostingEnvironment"/>.</param>
|
||||
<param name="environmentName">Environment name to validate against.</param>
|
||||
<returns>True if the specified name is the same as the current environment, otherwise false.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Hosting.IApplicationLifetime">
|
||||
<summary>
|
||||
Allows consumers to perform cleanup during a graceful shutdown.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Hosting.IApplicationLifetime.ApplicationStarted">
|
||||
<summary>
|
||||
Triggered when the application host has fully started and is about to wait
|
||||
for a graceful shutdown.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Hosting.IApplicationLifetime.ApplicationStopping">
|
||||
<summary>
|
||||
Triggered when the application host is performing a graceful shutdown.
|
||||
Requests may still be in flight. Shutdown will block until this event completes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Hosting.IApplicationLifetime.ApplicationStopped">
|
||||
<summary>
|
||||
Triggered when the application host is performing a graceful shutdown.
|
||||
All requests should be complete at this point. Shutdown will block
|
||||
until this event completes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Hosting.IApplicationLifetime.StopApplication">
|
||||
<summary>
|
||||
Requests termination of the current application.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Hosting.IHost">
|
||||
<summary>
|
||||
A program abstraction.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Hosting.IHost.Services">
|
||||
<summary>
|
||||
The programs configured services.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Hosting.IHost.StartAsync(System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Start the program.
|
||||
</summary>
|
||||
<param name="cancellationToken">Used to abort program start.</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Hosting.IHost.StopAsync(System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Attempts to gracefully stop the program.
|
||||
</summary>
|
||||
<param name="cancellationToken">Used to indicate when stop should no longer be graceful.</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Hosting.IHostBuilder">
|
||||
<summary>
|
||||
A program initialization abstraction.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Hosting.IHostBuilder.Properties">
|
||||
<summary>
|
||||
A central location for sharing state between components during the host building process.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Hosting.IHostBuilder.ConfigureHostConfiguration(System.Action{Microsoft.Extensions.Configuration.IConfigurationBuilder})">
|
||||
<summary>
|
||||
Set up the configuration for the builder itself. This will be used to initialize the <see cref="T:Microsoft.Extensions.Hosting.IHostingEnvironment"/>
|
||||
for use later in the build process. This can be called multiple times and the results will be additive.
|
||||
</summary>
|
||||
<param name="configureDelegate">The delegate for configuring the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> that will be used
|
||||
to construct the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> for the host.</param>
|
||||
<returns>The same instance of the <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Hosting.IHostBuilder.ConfigureAppConfiguration(System.Action{Microsoft.Extensions.Hosting.HostBuilderContext,Microsoft.Extensions.Configuration.IConfigurationBuilder})">
|
||||
<summary>
|
||||
Sets up the configuration for the remainder of the build process and application. This can be called multiple times and
|
||||
the results will be additive. The results will be available at <see cref="P:Microsoft.Extensions.Hosting.HostBuilderContext.Configuration"/> for
|
||||
subsequent operations, as well as in <see cref="P:Microsoft.Extensions.Hosting.IHost.Services"/>.
|
||||
</summary>
|
||||
<param name="configureDelegate">The delegate for configuring the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> that will be used
|
||||
to construct the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> for the application.</param>
|
||||
<returns>The same instance of the <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Hosting.IHostBuilder.ConfigureServices(System.Action{Microsoft.Extensions.Hosting.HostBuilderContext,Microsoft.Extensions.DependencyInjection.IServiceCollection})">
|
||||
<summary>
|
||||
Adds services to the container. This can be called multiple times and the results will be additive.
|
||||
</summary>
|
||||
<param name="configureDelegate">The delegate for configuring the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> that will be used
|
||||
to construct the <see cref="T:System.IServiceProvider"/>.</param>
|
||||
<returns>The same instance of the <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Hosting.IHostBuilder.UseServiceProviderFactory``1(Microsoft.Extensions.DependencyInjection.IServiceProviderFactory{``0})">
|
||||
<summary>
|
||||
Overrides the factory used to create the service provider.
|
||||
</summary>
|
||||
<typeparam name="TContainerBuilder"></typeparam>
|
||||
<param name="factory"></param>
|
||||
<returns>The same instance of the <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Hosting.IHostBuilder.ConfigureContainer``1(System.Action{Microsoft.Extensions.Hosting.HostBuilderContext,``0})">
|
||||
<summary>
|
||||
Enables configuring the instantiated dependency container. This can be called multiple times and
|
||||
the results will be additive.
|
||||
</summary>
|
||||
<typeparam name="TContainerBuilder"></typeparam>
|
||||
<param name="configureDelegate"></param>
|
||||
<returns>The same instance of the <see cref="T:Microsoft.Extensions.Hosting.IHostBuilder"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Hosting.IHostBuilder.Build">
|
||||
<summary>
|
||||
Run the given actions to initialize the host. This can only be called once.
|
||||
</summary>
|
||||
<returns>An initialized <see cref="T:Microsoft.Extensions.Hosting.IHost"/></returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Hosting.IHostedService">
|
||||
<summary>
|
||||
Defines methods for objects that are managed by the host.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Hosting.IHostedService.StartAsync(System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Triggered when the application host is ready to start the service.
|
||||
</summary>
|
||||
<param name="cancellationToken">Indicates that the start process has been aborted.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Hosting.IHostedService.StopAsync(System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Triggered when the application host is performing a graceful shutdown.
|
||||
</summary>
|
||||
<param name="cancellationToken">Indicates that the shutdown process should no longer be graceful.</param>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Hosting.IHostingEnvironment">
|
||||
<summary>
|
||||
Provides information about the hosting environment an application is running in.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Hosting.IHostingEnvironment.EnvironmentName">
|
||||
<summary>
|
||||
Gets or sets the name of the environment. The host automatically sets this property to the value of the
|
||||
of the "environment" key as specified in configuration.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Hosting.IHostingEnvironment.ApplicationName">
|
||||
<summary>
|
||||
Gets or sets the name of the application. This property is automatically set by the host to the assembly containing
|
||||
the application entry point.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Hosting.IHostingEnvironment.ContentRootPath">
|
||||
<summary>
|
||||
Gets or sets the absolute path to the directory that contains the application content files.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Hosting.IHostingEnvironment.ContentRootFileProvider">
|
||||
<summary>
|
||||
Gets or sets an <see cref="T:Microsoft.Extensions.FileProviders.IFileProvider"/> pointing at <see cref="P:Microsoft.Extensions.Hosting.IHostingEnvironment.ContentRootPath"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Hosting.IHostLifetime.WaitForStartAsync(System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Called at the start of <see cref="M:Microsoft.Extensions.Hosting.IHost.StartAsync(System.Threading.CancellationToken)"/> which will wait until it's complete before
|
||||
continuing. This can be used to delay startup until signaled by an external event.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Hosting.IHostLifetime.StopAsync(System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Called from <see cref="M:Microsoft.Extensions.Hosting.IHost.StopAsync(System.Threading.CancellationToken)"/> to indicate that the host as stopped and clean up resources.
|
||||
</summary>
|
||||
<param name="cancellationToken">Used to indicate when stop should no longer be graceful.</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.ServiceCollectionHostedServiceExtensions.AddHostedService``1(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
|
||||
<summary>
|
||||
Add an <see cref="T:Microsoft.Extensions.Hosting.IHostedService"/> registration for the given type.
|
||||
</summary>
|
||||
<typeparam name="THostedService">An <see cref="T:Microsoft.Extensions.Hosting.IHostedService"/> to register.</typeparam>
|
||||
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> to register with.</param>
|
||||
<returns>The original <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</returns>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1,708 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Logging.Abstractions</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Logging.IExternalScopeProvider">
|
||||
<summary>
|
||||
Represents a storage of common scope data.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.IExternalScopeProvider.ForEachScope``1(System.Action{System.Object,``0},``0)">
|
||||
<summary>
|
||||
Executes callback for each currently active scope objects in order of creation.
|
||||
All callbacks are guaranteed to be called inline from this method.
|
||||
</summary>
|
||||
<param name="callback">The callback to be executed for every scope object</param>
|
||||
<param name="state">The state object to be passed into the callback</param>
|
||||
<typeparam name="TState"></typeparam>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.IExternalScopeProvider.Push(System.Object)">
|
||||
<summary>
|
||||
Adds scope object to the list
|
||||
</summary>
|
||||
<param name="state">The scope object</param>
|
||||
<returns>The <see cref="T:System.IDisposable"/> token that removes scope on dispose.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Logging.ILogger">
|
||||
<summary>
|
||||
Represents a type used to perform logging.
|
||||
</summary>
|
||||
<remarks>Aggregates most logging patterns to a single method.</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.ILogger.Log``1(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,``0,System.Exception,System.Func{``0,System.Exception,System.String})">
|
||||
<summary>
|
||||
Writes a log entry.
|
||||
</summary>
|
||||
<param name="logLevel">Entry will be written on this level.</param>
|
||||
<param name="eventId">Id of the event.</param>
|
||||
<param name="state">The entry to be written. Can be also an object.</param>
|
||||
<param name="exception">The exception related to this entry.</param>
|
||||
<param name="formatter">Function to create a <c>string</c> message of the <paramref name="state"/> and <paramref name="exception"/>.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.ILogger.IsEnabled(Microsoft.Extensions.Logging.LogLevel)">
|
||||
<summary>
|
||||
Checks if the given <paramref name="logLevel"/> is enabled.
|
||||
</summary>
|
||||
<param name="logLevel">level to be checked.</param>
|
||||
<returns><c>true</c> if enabled.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.ILogger.BeginScope``1(``0)">
|
||||
<summary>
|
||||
Begins a logical operation scope.
|
||||
</summary>
|
||||
<param name="state">The identifier for the scope.</param>
|
||||
<returns>An IDisposable that ends the logical operation scope on dispose.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Logging.ILoggerFactory">
|
||||
<summary>
|
||||
Represents a type used to configure the logging system and create instances of <see cref="T:Microsoft.Extensions.Logging.ILogger"/> from
|
||||
the registered <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider"/>s.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.ILoggerFactory.CreateLogger(System.String)">
|
||||
<summary>
|
||||
Creates a new <see cref="T:Microsoft.Extensions.Logging.ILogger"/> instance.
|
||||
</summary>
|
||||
<param name="categoryName">The category name for messages produced by the logger.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Logging.ILogger"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.ILoggerFactory.AddProvider(Microsoft.Extensions.Logging.ILoggerProvider)">
|
||||
<summary>
|
||||
Adds an <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider"/> to the logging system.
|
||||
</summary>
|
||||
<param name="provider">The <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider"/>.</param>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Logging.ILogger`1">
|
||||
<summary>
|
||||
A generic interface for logging where the category name is derived from the specified
|
||||
<typeparamref name="TCategoryName"/> type name.
|
||||
Generally used to enable activation of a named <see cref="T:Microsoft.Extensions.Logging.ILogger"/> from dependency injection.
|
||||
</summary>
|
||||
<typeparam name="TCategoryName">The type who's name is used for the logger category name.</typeparam>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Logging.ILoggerProvider">
|
||||
<summary>
|
||||
Represents a type that can create instances of <see cref="T:Microsoft.Extensions.Logging.ILogger"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.ILoggerProvider.CreateLogger(System.String)">
|
||||
<summary>
|
||||
Creates a new <see cref="T:Microsoft.Extensions.Logging.ILogger"/> instance.
|
||||
</summary>
|
||||
<param name="categoryName">The category name for messages produced by the logger.</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Logging.Internal.FormattedLogValues">
|
||||
<summary>
|
||||
LogValues to enable formatting options supported by <see cref="M:string.Format"/>.
|
||||
This also enables using {NamedformatItem} in the format string.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Logging.Internal.LogValuesFormatter">
|
||||
<summary>
|
||||
Formatter to convert the named format items like {NamedformatItem} to <see cref="M:string.Format"/> format.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Logging.Abstractions.Internal.NullScope">
|
||||
<summary>
|
||||
An empty scope without any logic
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.Abstractions.Internal.NullScope.Dispose">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Logging.Abstractions.NullLogger">
|
||||
<summary>
|
||||
Minimalistic logger that does nothing.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.Abstractions.NullLogger.BeginScope``1(``0)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.Abstractions.NullLogger.IsEnabled(Microsoft.Extensions.Logging.LogLevel)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.Abstractions.NullLogger.Log``1(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,``0,System.Exception,System.Func{``0,System.Exception,System.String})">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Logging.Abstractions.NullLoggerFactory">
|
||||
<summary>
|
||||
An <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/> used to create instance of
|
||||
<see cref="T:Microsoft.Extensions.Logging.Abstractions.NullLogger"/> that logs nothing.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.Abstractions.NullLoggerFactory.CreateLogger(System.String)">
|
||||
<inheritdoc />
|
||||
<remarks>
|
||||
This returns a <see cref="T:Microsoft.Extensions.Logging.Abstractions.NullLogger"/> instance which logs nothing.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.Abstractions.NullLoggerFactory.AddProvider(Microsoft.Extensions.Logging.ILoggerProvider)">
|
||||
<inheritdoc />
|
||||
<remarks>
|
||||
This method ignores the parameter and does nothing.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Logging.Abstractions.NullLogger`1">
|
||||
<summary>
|
||||
Minimalistic logger that does nothing.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.Abstractions.NullLogger`1.BeginScope``1(``0)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.Abstractions.NullLogger`1.Log``1(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,``0,System.Exception,System.Func{``0,System.Exception,System.String})">
|
||||
<inheritdoc />
|
||||
<remarks>
|
||||
This method ignores the parameters and does nothing.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.Abstractions.NullLogger`1.IsEnabled(Microsoft.Extensions.Logging.LogLevel)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Logging.Abstractions.NullLoggerProvider">
|
||||
<summary>
|
||||
Provider for the <see cref="T:Microsoft.Extensions.Logging.Abstractions.NullLogger"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.Abstractions.NullLoggerProvider.CreateLogger(System.String)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.Abstractions.NullLoggerProvider.Dispose">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Logging.Abstractions.Resource.UnexpectedNumberOfNamedParameters">
|
||||
<summary>
|
||||
The format string '{0}' does not have the expected number of named parameters. Expected {1} parameter(s) but found {2} parameter(s).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.Abstractions.Resource.FormatUnexpectedNumberOfNamedParameters(System.Object,System.Object,System.Object)">
|
||||
<summary>
|
||||
The format string '{0}' does not have the expected number of named parameters. Expected {1} parameter(s) but found {2} parameter(s).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Logging.ISupportExternalScope">
|
||||
<summary>
|
||||
Represents a <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider"/> that is able to consume external scope information.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.ISupportExternalScope.SetScopeProvider(Microsoft.Extensions.Logging.IExternalScopeProvider)">
|
||||
<summary>
|
||||
Sets external scope information source for logger provider.
|
||||
</summary>
|
||||
<param name="scopeProvider"></param>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Logging.LoggerExtensions">
|
||||
<summary>
|
||||
ILogger extension methods for common scenarios.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogDebug(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.Exception,System.String,System.Object[])">
|
||||
<summary>
|
||||
Formats and writes a debug log message.
|
||||
</summary>
|
||||
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
|
||||
<param name="eventId">The event id associated with the log.</param>
|
||||
<param name="exception">The exception to log.</param>
|
||||
<param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
|
||||
<param name="args">An object array that contains zero or more objects to format.</param>
|
||||
<example>logger.LogDebug(0, exception, "Error while processing request from {Address}", address)</example>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogDebug(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.String,System.Object[])">
|
||||
<summary>
|
||||
Formats and writes a debug log message.
|
||||
</summary>
|
||||
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
|
||||
<param name="eventId">The event id associated with the log.</param>
|
||||
<param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
|
||||
<param name="args">An object array that contains zero or more objects to format.</param>
|
||||
<example>logger.LogDebug(0, "Processing request from {Address}", address)</example>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogDebug(Microsoft.Extensions.Logging.ILogger,System.Exception,System.String,System.Object[])">
|
||||
<summary>
|
||||
Formats and writes a debug log message.
|
||||
</summary>
|
||||
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
|
||||
<param name="exception">The exception to log.</param>
|
||||
<param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
|
||||
<param name="args">An object array that contains zero or more objects to format.</param>
|
||||
<example>logger.LogDebug(exception, "Error while processing request from {Address}", address)</example>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogDebug(Microsoft.Extensions.Logging.ILogger,System.String,System.Object[])">
|
||||
<summary>
|
||||
Formats and writes a debug log message.
|
||||
</summary>
|
||||
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
|
||||
<param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
|
||||
<param name="args">An object array that contains zero or more objects to format.</param>
|
||||
<example>logger.LogDebug("Processing request from {Address}", address)</example>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogTrace(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.Exception,System.String,System.Object[])">
|
||||
<summary>
|
||||
Formats and writes a trace log message.
|
||||
</summary>
|
||||
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
|
||||
<param name="eventId">The event id associated with the log.</param>
|
||||
<param name="exception">The exception to log.</param>
|
||||
<param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
|
||||
<param name="args">An object array that contains zero or more objects to format.</param>
|
||||
<example>logger.LogTrace(0, exception, "Error while processing request from {Address}", address)</example>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogTrace(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.String,System.Object[])">
|
||||
<summary>
|
||||
Formats and writes a trace log message.
|
||||
</summary>
|
||||
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
|
||||
<param name="eventId">The event id associated with the log.</param>
|
||||
<param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
|
||||
<param name="args">An object array that contains zero or more objects to format.</param>
|
||||
<example>logger.LogTrace(0, "Processing request from {Address}", address)</example>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogTrace(Microsoft.Extensions.Logging.ILogger,System.Exception,System.String,System.Object[])">
|
||||
<summary>
|
||||
Formats and writes a trace log message.
|
||||
</summary>
|
||||
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
|
||||
<param name="exception">The exception to log.</param>
|
||||
<param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
|
||||
<param name="args">An object array that contains zero or more objects to format.</param>
|
||||
<example>logger.LogTrace(exception, "Error while processing request from {Address}", address)</example>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogTrace(Microsoft.Extensions.Logging.ILogger,System.String,System.Object[])">
|
||||
<summary>
|
||||
Formats and writes a trace log message.
|
||||
</summary>
|
||||
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
|
||||
<param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
|
||||
<param name="args">An object array that contains zero or more objects to format.</param>
|
||||
<example>logger.LogTrace("Processing request from {Address}", address)</example>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogInformation(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.Exception,System.String,System.Object[])">
|
||||
<summary>
|
||||
Formats and writes an informational log message.
|
||||
</summary>
|
||||
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
|
||||
<param name="eventId">The event id associated with the log.</param>
|
||||
<param name="exception">The exception to log.</param>
|
||||
<param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
|
||||
<param name="args">An object array that contains zero or more objects to format.</param>
|
||||
<example>logger.LogInformation(0, exception, "Error while processing request from {Address}", address)</example>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogInformation(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.String,System.Object[])">
|
||||
<summary>
|
||||
Formats and writes an informational log message.
|
||||
</summary>
|
||||
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
|
||||
<param name="eventId">The event id associated with the log.</param>
|
||||
<param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
|
||||
<param name="args">An object array that contains zero or more objects to format.</param>
|
||||
<example>logger.LogInformation(0, "Processing request from {Address}", address)</example>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogInformation(Microsoft.Extensions.Logging.ILogger,System.Exception,System.String,System.Object[])">
|
||||
<summary>
|
||||
Formats and writes an informational log message.
|
||||
</summary>
|
||||
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
|
||||
<param name="exception">The exception to log.</param>
|
||||
<param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
|
||||
<param name="args">An object array that contains zero or more objects to format.</param>
|
||||
<example>logger.LogInformation(exception, "Error while processing request from {Address}", address)</example>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogInformation(Microsoft.Extensions.Logging.ILogger,System.String,System.Object[])">
|
||||
<summary>
|
||||
Formats and writes an informational log message.
|
||||
</summary>
|
||||
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
|
||||
<param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
|
||||
<param name="args">An object array that contains zero or more objects to format.</param>
|
||||
<example>logger.LogInformation("Processing request from {Address}", address)</example>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogWarning(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.Exception,System.String,System.Object[])">
|
||||
<summary>
|
||||
Formats and writes a warning log message.
|
||||
</summary>
|
||||
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
|
||||
<param name="eventId">The event id associated with the log.</param>
|
||||
<param name="exception">The exception to log.</param>
|
||||
<param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
|
||||
<param name="args">An object array that contains zero or more objects to format.</param>
|
||||
<example>logger.LogWarning(0, exception, "Error while processing request from {Address}", address)</example>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogWarning(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.String,System.Object[])">
|
||||
<summary>
|
||||
Formats and writes a warning log message.
|
||||
</summary>
|
||||
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
|
||||
<param name="eventId">The event id associated with the log.</param>
|
||||
<param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
|
||||
<param name="args">An object array that contains zero or more objects to format.</param>
|
||||
<example>logger.LogWarning(0, "Processing request from {Address}", address)</example>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogWarning(Microsoft.Extensions.Logging.ILogger,System.Exception,System.String,System.Object[])">
|
||||
<summary>
|
||||
Formats and writes a warning log message.
|
||||
</summary>
|
||||
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
|
||||
<param name="exception">The exception to log.</param>
|
||||
<param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
|
||||
<param name="args">An object array that contains zero or more objects to format.</param>
|
||||
<example>logger.LogWarning(exception, "Error while processing request from {Address}", address)</example>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogWarning(Microsoft.Extensions.Logging.ILogger,System.String,System.Object[])">
|
||||
<summary>
|
||||
Formats and writes a warning log message.
|
||||
</summary>
|
||||
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
|
||||
<param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
|
||||
<param name="args">An object array that contains zero or more objects to format.</param>
|
||||
<example>logger.LogWarning("Processing request from {Address}", address)</example>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogError(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.Exception,System.String,System.Object[])">
|
||||
<summary>
|
||||
Formats and writes an error log message.
|
||||
</summary>
|
||||
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
|
||||
<param name="eventId">The event id associated with the log.</param>
|
||||
<param name="exception">The exception to log.</param>
|
||||
<param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
|
||||
<param name="args">An object array that contains zero or more objects to format.</param>
|
||||
<example>logger.LogError(0, exception, "Error while processing request from {Address}", address)</example>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogError(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.String,System.Object[])">
|
||||
<summary>
|
||||
Formats and writes an error log message.
|
||||
</summary>
|
||||
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
|
||||
<param name="eventId">The event id associated with the log.</param>
|
||||
<param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
|
||||
<param name="args">An object array that contains zero or more objects to format.</param>
|
||||
<example>logger.LogError(0, "Processing request from {Address}", address)</example>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogError(Microsoft.Extensions.Logging.ILogger,System.Exception,System.String,System.Object[])">
|
||||
<summary>
|
||||
Formats and writes an error log message.
|
||||
</summary>
|
||||
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
|
||||
<param name="exception">The exception to log.</param>
|
||||
<param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
|
||||
<param name="args">An object array that contains zero or more objects to format.</param>
|
||||
<example>logger.LogError(exception, "Error while processing request from {Address}", address)</example>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogError(Microsoft.Extensions.Logging.ILogger,System.String,System.Object[])">
|
||||
<summary>
|
||||
Formats and writes an error log message.
|
||||
</summary>
|
||||
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
|
||||
<param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
|
||||
<param name="args">An object array that contains zero or more objects to format.</param>
|
||||
<example>logger.LogError("Processing request from {Address}", address)</example>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogCritical(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.Exception,System.String,System.Object[])">
|
||||
<summary>
|
||||
Formats and writes a critical log message.
|
||||
</summary>
|
||||
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
|
||||
<param name="eventId">The event id associated with the log.</param>
|
||||
<param name="exception">The exception to log.</param>
|
||||
<param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
|
||||
<param name="args">An object array that contains zero or more objects to format.</param>
|
||||
<example>logger.LogCritical(0, exception, "Error while processing request from {Address}", address)</example>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogCritical(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.EventId,System.String,System.Object[])">
|
||||
<summary>
|
||||
Formats and writes a critical log message.
|
||||
</summary>
|
||||
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
|
||||
<param name="eventId">The event id associated with the log.</param>
|
||||
<param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
|
||||
<param name="args">An object array that contains zero or more objects to format.</param>
|
||||
<example>logger.LogCritical(0, "Processing request from {Address}", address)</example>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogCritical(Microsoft.Extensions.Logging.ILogger,System.Exception,System.String,System.Object[])">
|
||||
<summary>
|
||||
Formats and writes a critical log message.
|
||||
</summary>
|
||||
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
|
||||
<param name="exception">The exception to log.</param>
|
||||
<param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
|
||||
<param name="args">An object array that contains zero or more objects to format.</param>
|
||||
<example>logger.LogCritical(exception, "Error while processing request from {Address}", address)</example>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.LogCritical(Microsoft.Extensions.Logging.ILogger,System.String,System.Object[])">
|
||||
<summary>
|
||||
Formats and writes a critical log message.
|
||||
</summary>
|
||||
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
|
||||
<param name="message">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
|
||||
<param name="args">An object array that contains zero or more objects to format.</param>
|
||||
<example>logger.LogCritical("Processing request from {Address}", address)</example>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.Log(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.LogLevel,System.String,System.Object[])">
|
||||
<summary>
|
||||
Formats and writes a log message at the specified log level.
|
||||
</summary>
|
||||
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
|
||||
<param name="logLevel">Entry will be written on this level.</param>
|
||||
<param name="message">Format string of the log message.</param>
|
||||
<param name="args">An object array that contains zero or more objects to format.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.Log(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String,System.Object[])">
|
||||
<summary>
|
||||
Formats and writes a log message at the specified log level.
|
||||
</summary>
|
||||
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
|
||||
<param name="logLevel">Entry will be written on this level.</param>
|
||||
<param name="eventId">The event id associated with the log.</param>
|
||||
<param name="message">Format string of the log message.</param>
|
||||
<param name="args">An object array that contains zero or more objects to format.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.Log(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.LogLevel,System.Exception,System.String,System.Object[])">
|
||||
<summary>
|
||||
Formats and writes a log message at the specified log level.
|
||||
</summary>
|
||||
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
|
||||
<param name="logLevel">Entry will be written on this level.</param>
|
||||
<param name="exception">The exception to log.</param>
|
||||
<param name="message">Format string of the log message.</param>
|
||||
<param name="args">An object array that contains zero or more objects to format.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.Log(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.Exception,System.String,System.Object[])">
|
||||
<summary>
|
||||
Formats and writes a log message at the specified log level.
|
||||
</summary>
|
||||
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to write to.</param>
|
||||
<param name="logLevel">Entry will be written on this level.</param>
|
||||
<param name="eventId">The event id associated with the log.</param>
|
||||
<param name="exception">The exception to log.</param>
|
||||
<param name="message">Format string of the log message.</param>
|
||||
<param name="args">An object array that contains zero or more objects to format.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.LoggerExtensions.BeginScope(Microsoft.Extensions.Logging.ILogger,System.String,System.Object[])">
|
||||
<summary>
|
||||
Formats the message and creates a scope.
|
||||
</summary>
|
||||
<param name="logger">The <see cref="T:Microsoft.Extensions.Logging.ILogger"/> to create the scope in.</param>
|
||||
<param name="messageFormat">Format string of the log message in message template format. Example: <code>"User {User} logged in from {Address}"</code></param>
|
||||
<param name="args">An object array that contains zero or more objects to format.</param>
|
||||
<returns>A disposable scope object. Can be null.</returns>
|
||||
<example>
|
||||
using(logger.BeginScope("Processing request from {Address}", address))
|
||||
{
|
||||
}
|
||||
</example>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Logging.LoggerExternalScopeProvider">
|
||||
<summary>
|
||||
Default implemenation of <see cref="T:Microsoft.Extensions.Logging.IExternalScopeProvider"/>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.LoggerExternalScopeProvider.ForEachScope``1(System.Action{System.Object,``0},``0)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.LoggerExternalScopeProvider.Push(System.Object)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Logging.LoggerFactoryExtensions">
|
||||
<summary>
|
||||
ILoggerFactory extension methods for common scenarios.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.LoggerFactoryExtensions.CreateLogger``1(Microsoft.Extensions.Logging.ILoggerFactory)">
|
||||
<summary>
|
||||
Creates a new ILogger instance using the full name of the given type.
|
||||
</summary>
|
||||
<typeparam name="T">The type.</typeparam>
|
||||
<param name="factory">The factory.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.LoggerFactoryExtensions.CreateLogger(Microsoft.Extensions.Logging.ILoggerFactory,System.Type)">
|
||||
<summary>
|
||||
Creates a new ILogger instance using the full name of the given type.
|
||||
</summary>
|
||||
<param name="factory">The factory.</param>
|
||||
<param name="type">The type.</param>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Logging.LoggerMessage">
|
||||
<summary>
|
||||
Creates delegates which can be later cached to log messages in a performant way.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.LoggerMessage.DefineScope(System.String)">
|
||||
<summary>
|
||||
Creates a delegate which can be invoked to create a log scope.
|
||||
</summary>
|
||||
<param name="formatString">The named format string</param>
|
||||
<returns>A delegate which when invoked creates a log scope.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.LoggerMessage.DefineScope``1(System.String)">
|
||||
<summary>
|
||||
Creates a delegate which can be invoked to create a log scope.
|
||||
</summary>
|
||||
<typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
|
||||
<param name="formatString">The named format string</param>
|
||||
<returns>A delegate which when invoked creates a log scope.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.LoggerMessage.DefineScope``2(System.String)">
|
||||
<summary>
|
||||
Creates a delegate which can be invoked to create a log scope.
|
||||
</summary>
|
||||
<typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
|
||||
<typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
|
||||
<param name="formatString">The named format string</param>
|
||||
<returns>A delegate which when invoked creates a log scope.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.LoggerMessage.DefineScope``3(System.String)">
|
||||
<summary>
|
||||
Creates a delegate which can be invoked to create a log scope.
|
||||
</summary>
|
||||
<typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
|
||||
<typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
|
||||
<typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
|
||||
<param name="formatString">The named format string</param>
|
||||
<returns>A delegate which when invoked creates a log scope.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String)">
|
||||
<summary>
|
||||
Creates a delegate which can be invoked for logging a message.
|
||||
</summary>
|
||||
<param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel"/></param>
|
||||
<param name="eventId">The event id</param>
|
||||
<param name="formatString">The named format string</param>
|
||||
<returns>A delegate which when invoked creates a log message.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``1(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String)">
|
||||
<summary>
|
||||
Creates a delegate which can be invoked for logging a message.
|
||||
</summary>
|
||||
<typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
|
||||
<param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel"/></param>
|
||||
<param name="eventId">The event id</param>
|
||||
<param name="formatString">The named format string</param>
|
||||
<returns>A delegate which when invoked creates a log message.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``2(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String)">
|
||||
<summary>
|
||||
Creates a delegate which can be invoked for logging a message.
|
||||
</summary>
|
||||
<typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
|
||||
<typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
|
||||
<param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel"/></param>
|
||||
<param name="eventId">The event id</param>
|
||||
<param name="formatString">The named format string</param>
|
||||
<returns>A delegate which when invoked creates a log message.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``3(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String)">
|
||||
<summary>
|
||||
Creates a delegate which can be invoked for logging a message.
|
||||
</summary>
|
||||
<typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
|
||||
<typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
|
||||
<typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
|
||||
<param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel"/></param>
|
||||
<param name="eventId">The event id</param>
|
||||
<param name="formatString">The named format string</param>
|
||||
<returns>A delegate which when invoked creates a log message.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``4(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String)">
|
||||
<summary>
|
||||
Creates a delegate which can be invoked for logging a message.
|
||||
</summary>
|
||||
<typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
|
||||
<typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
|
||||
<typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
|
||||
<typeparam name="T4">The type of the fourth parameter passed to the named format string.</typeparam>
|
||||
<param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel"/></param>
|
||||
<param name="eventId">The event id</param>
|
||||
<param name="formatString">The named format string</param>
|
||||
<returns>A delegate which when invoked creates a log message.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``5(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String)">
|
||||
<summary>
|
||||
Creates a delegate which can be invoked for logging a message.
|
||||
</summary>
|
||||
<typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
|
||||
<typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
|
||||
<typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
|
||||
<typeparam name="T4">The type of the fourth parameter passed to the named format string.</typeparam>
|
||||
<typeparam name="T5">The type of the fifth parameter passed to the named format string.</typeparam>
|
||||
<param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel"/></param>
|
||||
<param name="eventId">The event id</param>
|
||||
<param name="formatString">The named format string</param>
|
||||
<returns>A delegate which when invoked creates a log message.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.LoggerMessage.Define``6(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.String)">
|
||||
<summary>
|
||||
Creates a delegate which can be invoked for logging a message.
|
||||
</summary>
|
||||
<typeparam name="T1">The type of the first parameter passed to the named format string.</typeparam>
|
||||
<typeparam name="T2">The type of the second parameter passed to the named format string.</typeparam>
|
||||
<typeparam name="T3">The type of the third parameter passed to the named format string.</typeparam>
|
||||
<typeparam name="T4">The type of the fourth parameter passed to the named format string.</typeparam>
|
||||
<typeparam name="T5">The type of the fifth parameter passed to the named format string.</typeparam>
|
||||
<typeparam name="T6">The type of the sixth parameter passed to the named format string.</typeparam>
|
||||
<param name="logLevel">The <see cref="T:Microsoft.Extensions.Logging.LogLevel"/></param>
|
||||
<param name="eventId">The event id</param>
|
||||
<param name="formatString">The named format string</param>
|
||||
<returns>A delegate which when invoked creates a log message.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Logging.Logger`1">
|
||||
<summary>
|
||||
Delegates to a new <see cref="T:Microsoft.Extensions.Logging.ILogger"/> instance using the full name of the given type, created by the
|
||||
provided <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/>.
|
||||
</summary>
|
||||
<typeparam name="T">The type.</typeparam>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.Logger`1.#ctor(Microsoft.Extensions.Logging.ILoggerFactory)">
|
||||
<summary>
|
||||
Creates a new <see cref="T:Microsoft.Extensions.Logging.Logger`1"/>.
|
||||
</summary>
|
||||
<param name="factory">The factory.</param>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Logging.LogLevel">
|
||||
<summary>
|
||||
Defines logging severity levels.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.Extensions.Logging.LogLevel.Trace">
|
||||
<summary>
|
||||
Logs that contain the most detailed messages. These messages may contain sensitive application data.
|
||||
These messages are disabled by default and should never be enabled in a production environment.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.Extensions.Logging.LogLevel.Debug">
|
||||
<summary>
|
||||
Logs that are used for interactive investigation during development. These logs should primarily contain
|
||||
information useful for debugging and have no long-term value.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.Extensions.Logging.LogLevel.Information">
|
||||
<summary>
|
||||
Logs that track the general flow of the application. These logs should have long-term value.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.Extensions.Logging.LogLevel.Warning">
|
||||
<summary>
|
||||
Logs that highlight an abnormal or unexpected event in the application flow, but do not otherwise cause the
|
||||
application execution to stop.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.Extensions.Logging.LogLevel.Error">
|
||||
<summary>
|
||||
Logs that highlight when the current flow of execution is stopped due to a failure. These should indicate a
|
||||
failure in the current activity, not an application-wide failure.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.Extensions.Logging.LogLevel.Critical">
|
||||
<summary>
|
||||
Logs that describe an unrecoverable application or system crash, or a catastrophic failure that requires
|
||||
immediate attention.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.Extensions.Logging.LogLevel.None">
|
||||
<summary>
|
||||
Not used for writing log messages. Specifies that a logging category should not write any messages.
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1,59 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Logging.Configuration</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Logging.Configuration.ILoggerProviderConfiguration`1">
|
||||
<summary>
|
||||
Allows access to configuration section associated with logger provider
|
||||
</summary>
|
||||
<typeparam name="T">Type of logger provider to get configuration for</typeparam>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Logging.Configuration.ILoggerProviderConfiguration`1.Configuration">
|
||||
<summary>
|
||||
Configuration section for requested logger provider
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Logging.Configuration.ILoggerProviderConfigurationFactory">
|
||||
<summary>
|
||||
Allows access to configuration section associated with logger provider
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.Configuration.ILoggerProviderConfigurationFactory.GetConfiguration(System.Type)">
|
||||
<summary>
|
||||
Return configuration section associated with logger provider
|
||||
</summary>
|
||||
<param name="providerType">The logger provider type</param>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Logging.Configuration.LoggerProviderOptionsChangeTokenSource`2">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.Configuration.LoggerProviderOptionsChangeTokenSource`2.#ctor(Microsoft.Extensions.Logging.Configuration.ILoggerProviderConfiguration{`1})">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Logging.Configuration.LoggingBuilderConfigurationExtensions">
|
||||
<summary>
|
||||
Extension methods for setting up logging services in an <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder" />.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.Configuration.LoggingBuilderConfigurationExtensions.AddConfiguration(Microsoft.Extensions.Logging.ILoggingBuilder)">
|
||||
<summary>
|
||||
Adds services required to consume <see cref="T:Microsoft.Extensions.Logging.Configuration.ILoggerProviderConfigurationFactory"/> or <see cref="T:Microsoft.Extensions.Logging.Configuration.ILoggerProviderConfiguration`1"/>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Logging.LoggingBuilderExtensions">
|
||||
<summary>
|
||||
Extension methods for setting up logging services in an <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder" />.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.LoggingBuilderExtensions.AddConfiguration(Microsoft.Extensions.Logging.ILoggingBuilder,Microsoft.Extensions.Configuration.IConfiguration)">
|
||||
<summary>
|
||||
Configures <see cref="T:Microsoft.Extensions.Logging.LoggerFilterOptions" /> from an instance of <see cref="T:Microsoft.Extensions.Configuration.IConfiguration" />.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to use.</param>
|
||||
<param name="configuration">The <see cref="T:Microsoft.Extensions.Configuration.IConfiguration" /> to add.</param>
|
||||
<returns>The builder.</returns>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1,86 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Logging.Console</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Logging.Console.Internal.AnsiLogConsole">
|
||||
<summary>
|
||||
For non-Windows platform consoles which understand the ANSI escape code sequences to represent color
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.ConsoleLoggerExtensions.AddConsole(Microsoft.Extensions.Logging.ILoggingBuilder)">
|
||||
<summary>
|
||||
Adds a console logger named 'Console' to the factory.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to use.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.ConsoleLoggerExtensions.AddConsole(Microsoft.Extensions.Logging.ILoggingBuilder,System.Action{Microsoft.Extensions.Logging.Console.ConsoleLoggerOptions})">
|
||||
<summary>
|
||||
Adds a console logger named 'Console' to the factory.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to use.</param>
|
||||
<param name="configure"></param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.ConsoleLoggerExtensions.AddConsole(Microsoft.Extensions.Logging.ILoggerFactory)">
|
||||
<summary>
|
||||
Adds a console logger that is enabled for <see cref="T:Microsoft.Extensions.Logging.LogLevel"/>.Information or higher.
|
||||
</summary>
|
||||
<param name="factory">The <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/> to use.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.ConsoleLoggerExtensions.AddConsole(Microsoft.Extensions.Logging.ILoggerFactory,System.Boolean)">
|
||||
<summary>
|
||||
Adds a console logger that is enabled for <see cref="T:Microsoft.Extensions.Logging.LogLevel"/>.Information or higher.
|
||||
</summary>
|
||||
<param name="factory">The <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/> to use.</param>
|
||||
<param name="includeScopes">A value which indicates whether log scope information should be displayed
|
||||
in the output.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.ConsoleLoggerExtensions.AddConsole(Microsoft.Extensions.Logging.ILoggerFactory,Microsoft.Extensions.Logging.LogLevel)">
|
||||
<summary>
|
||||
Adds a console logger that is enabled for <see cref="T:Microsoft.Extensions.Logging.LogLevel"/>s of minLevel or higher.
|
||||
</summary>
|
||||
<param name="factory">The <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/> to use.</param>
|
||||
<param name="minLevel">The minimum <see cref="T:Microsoft.Extensions.Logging.LogLevel"/> to be logged</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.ConsoleLoggerExtensions.AddConsole(Microsoft.Extensions.Logging.ILoggerFactory,Microsoft.Extensions.Logging.LogLevel,System.Boolean)">
|
||||
<summary>
|
||||
Adds a console logger that is enabled for <see cref="T:Microsoft.Extensions.Logging.LogLevel"/>s of minLevel or higher.
|
||||
</summary>
|
||||
<param name="factory">The <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/> to use.</param>
|
||||
<param name="minLevel">The minimum <see cref="T:Microsoft.Extensions.Logging.LogLevel"/> to be logged</param>
|
||||
<param name="includeScopes">A value which indicates whether log scope information should be displayed
|
||||
in the output.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.ConsoleLoggerExtensions.AddConsole(Microsoft.Extensions.Logging.ILoggerFactory,System.Func{System.String,Microsoft.Extensions.Logging.LogLevel,System.Boolean})">
|
||||
<summary>
|
||||
Adds a console logger that is enabled as defined by the filter function.
|
||||
</summary>
|
||||
<param name="factory">The <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/> to use.</param>
|
||||
<param name="filter">The category filter to apply to logs.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.ConsoleLoggerExtensions.AddConsole(Microsoft.Extensions.Logging.ILoggerFactory,System.Func{System.String,Microsoft.Extensions.Logging.LogLevel,System.Boolean},System.Boolean)">
|
||||
<summary>
|
||||
Adds a console logger that is enabled as defined by the filter function.
|
||||
</summary>
|
||||
<param name="factory">The <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/> to use.</param>
|
||||
<param name="filter">The category filter to apply to logs.</param>
|
||||
<param name="includeScopes">A value which indicates whether log scope information should be displayed
|
||||
in the output.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.ConsoleLoggerExtensions.AddConsole(Microsoft.Extensions.Logging.ILoggerFactory,Microsoft.Extensions.Logging.Console.IConsoleLoggerSettings)">
|
||||
<summary>
|
||||
</summary>
|
||||
<param name="factory">The <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/> to use.</param>
|
||||
<param name="settings">The settings to apply to created <see cref="T:Microsoft.Extensions.Logging.Console.ConsoleLogger"/>'s.</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.ConsoleLoggerExtensions.AddConsole(Microsoft.Extensions.Logging.ILoggerFactory,Microsoft.Extensions.Configuration.IConfiguration)">
|
||||
<summary>
|
||||
</summary>
|
||||
<param name="factory">The <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/> to use.</param>
|
||||
<param name="configuration">The <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> to use for <see cref="T:Microsoft.Extensions.Logging.Console.IConsoleLoggerSettings"/>.</param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1,80 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Logging.Debug</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Logging.Debug.DebugLogger">
|
||||
<summary>
|
||||
A logger that writes messages in the debug output window only when a debugger is attached.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.Debug.DebugLogger.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Microsoft.Extensions.Logging.Debug.DebugLogger"/> class.
|
||||
</summary>
|
||||
<param name="name">The name of the logger.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.Debug.DebugLogger.#ctor(System.String,System.Func{System.String,Microsoft.Extensions.Logging.LogLevel,System.Boolean})">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Microsoft.Extensions.Logging.Debug.DebugLogger"/> class.
|
||||
</summary>
|
||||
<param name="name">The name of the logger.</param>
|
||||
<param name="filter">The function used to filter events based on the log level.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.Debug.DebugLogger.BeginScope``1(``0)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.Debug.DebugLogger.IsEnabled(Microsoft.Extensions.Logging.LogLevel)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.Debug.DebugLogger.Log``1(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,``0,System.Exception,System.Func{``0,System.Exception,System.String})">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Logging.Debug.DebugLoggerProvider">
|
||||
<summary>
|
||||
The provider for the <see cref="T:Microsoft.Extensions.Logging.Debug.DebugLogger"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.Debug.DebugLoggerProvider.#ctor(System.Func{System.String,Microsoft.Extensions.Logging.LogLevel,System.Boolean})">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:Microsoft.Extensions.Logging.Debug.DebugLoggerProvider"/> class.
|
||||
</summary>
|
||||
<param name="filter">The function used to filter events based on the log level.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.Debug.DebugLoggerProvider.CreateLogger(System.String)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Logging.DebugLoggerFactoryExtensions">
|
||||
<summary>
|
||||
Extension methods for the <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.DebugLoggerFactoryExtensions.AddDebug(Microsoft.Extensions.Logging.ILoggingBuilder)">
|
||||
<summary>
|
||||
Adds a debug logger named 'Debug' to the factory.
|
||||
</summary>
|
||||
<param name="builder">The extension method argument.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.DebugLoggerFactoryExtensions.AddDebug(Microsoft.Extensions.Logging.ILoggerFactory)">
|
||||
<summary>
|
||||
Adds a debug logger that is enabled for <see cref="T:Microsoft.Extensions.Logging.LogLevel"/>.Information or higher.
|
||||
</summary>
|
||||
<param name="factory">The extension method argument.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.DebugLoggerFactoryExtensions.AddDebug(Microsoft.Extensions.Logging.ILoggerFactory,System.Func{System.String,Microsoft.Extensions.Logging.LogLevel,System.Boolean})">
|
||||
<summary>
|
||||
Adds a debug logger that is enabled as defined by the filter function.
|
||||
</summary>
|
||||
<param name="factory">The extension method argument.</param>
|
||||
<param name="filter">The function used to filter events based on the log level.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.DebugLoggerFactoryExtensions.AddDebug(Microsoft.Extensions.Logging.ILoggerFactory,Microsoft.Extensions.Logging.LogLevel)">
|
||||
<summary>
|
||||
Adds a debug logger that is enabled for <see cref="T:Microsoft.Extensions.Logging.LogLevel"/>s of minLevel or higher.
|
||||
</summary>
|
||||
<param name="factory">The extension method argument.</param>
|
||||
<param name="minLevel">The minimum <see cref="T:Microsoft.Extensions.Logging.LogLevel"/> to be logged</param>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1,209 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Logging.EventSource</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Logging.EventSource.EventSourceLogger">
|
||||
<summary>
|
||||
A logger that writes messages to EventSource instance.
|
||||
</summary>
|
||||
<remarks>
|
||||
On Windows platforms EventSource will deliver messages using Event Tracing for Windows (ETW) events.
|
||||
On Linux EventSource will use LTTng (http://lttng.org) to deliver messages.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Logging.EventSource.EventSourceLogger.ActivityScope">
|
||||
<summary>
|
||||
ActivityScope is just a IDisposable that knows how to send the ActivityStop event when it is
|
||||
desposed. It is part of the BeginScope() support.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.EventSource.EventSourceLogger.GetExceptionInfo(System.Exception)">
|
||||
<summary>
|
||||
'serializes' a given exception into an ExceptionInfo (that EventSource knows how to serialize)
|
||||
</summary>
|
||||
<param name="exception"></param>
|
||||
<returns>ExceptionInfo object represending a .NET Exception</returns>
|
||||
<remarks>ETW does not support a concept of a null value. So we use an un-initialized object if there is no exception in the event data.</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.EventSource.EventSourceLogger.GetProperties(System.Object)">
|
||||
<summary>
|
||||
Converts an ILogger state object into a set of key-value pairs (That can be send to a EventSource)
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Logging.EventSource.EventSourceLoggerProvider">
|
||||
<summary>
|
||||
The provider for the <see cref="T:Microsoft.Extensions.Logging.EventSource.EventSourceLogger"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.EventSource.EventSourceLoggerProvider.CreateLogger(System.String)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Logging.EventSource.ExceptionInfo">
|
||||
<summary>
|
||||
Represents information about exceptions that is captured by EventSourceLogger
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Logging.EventSource.LoggingEventSource">
|
||||
<summary>
|
||||
The LoggingEventSource is the bridge form all ILogger based logging to EventSource/EventListener logging.
|
||||
|
||||
You turn this logging on by enabling the EvenSource called
|
||||
|
||||
Microsoft-Extensions-Logging
|
||||
|
||||
When you enabled the EventSource, the EventLevel you set is translated in the obvious way to the level
|
||||
associated with the ILogger (thus Debug = verbose, Informational = Informational ... Critical == Critical)
|
||||
|
||||
This allows you to filter by event level in a straighforward way.
|
||||
|
||||
For finer control you can specify a EventSource Argument called
|
||||
|
||||
FilterSpecs
|
||||
|
||||
The FilterSpecs argument is a semicolon separated list of specifications. Where each specification is
|
||||
|
||||
SPEC = // empty spec, same as *
|
||||
| NAME // Just a name the level is the default level
|
||||
| NAME : LEVEL // specifies level for a particular logger (can have a * suffix).
|
||||
|
||||
Where Name is the name of a ILoggger (case matters), Name can have a * which acts as a wildcard
|
||||
AS A SUFFIX. Thus Net* will match any loggers that start with the 'Net'.
|
||||
|
||||
The LEVEL is a number or a LogLevel string. 0=Trace, 1=Debug, 2=Information, 3=Warning, 4=Error, Critical=5
|
||||
This speicifies the level for the associated pattern. If the number is not specified, (first form
|
||||
of the specification) it is the default level for the EventSource.
|
||||
|
||||
First match is used if a partciular name matches more than one pattern.
|
||||
|
||||
In addition the level and FilterSpec argument, you can also set EventSource Keywords. See the Keywords
|
||||
definition below, but basically you get to decide if you wish to have
|
||||
|
||||
* Keywords.Message - You get the event with the data in parsed form.
|
||||
* Keywords.JsonMessage - you get an event with the data in parse form but as a JSON blob (not broken up by argument ...)
|
||||
* Keywords.FormattedMessage - you get an event with the data formatted as a string
|
||||
|
||||
It is expected that you will turn only one of these keywords on at a time, but you can turn them all on (and get
|
||||
the same data logged three different ways.
|
||||
|
||||
Example Usage
|
||||
|
||||
This example shows how to use an EventListener to get ILogging information
|
||||
|
||||
class MyEventListener : EventListener {
|
||||
protected override void OnEventSourceCreated(EventSource eventSource) {
|
||||
if (eventSource.Name == "Microsoft-Extensions-Logging") {
|
||||
// initialize a string, string dictionary of arguments to pass to the EventSource.
|
||||
// Turn on loggers matching App* to Information, everything else (*) is the default level (which is EventLevel.Error)
|
||||
var args = new Dictionary<string, string>() { { "FilterSpecs", "App*:Information;*" } };
|
||||
// Set the default level (verbosity) to Error, and only ask for the formatted messages in this case.
|
||||
EnableEvents(eventSource, EventLevel.Error, LoggingEventSource.Keywords.FormattedMessage, args);
|
||||
}
|
||||
}
|
||||
protected override void OnEventWritten(EventWrittenEventArgs eventData) {
|
||||
// Look for the formatted message event, which has the following argument layout (as defined in the LoggingEventSource.
|
||||
// FormattedMessage(LogLevel Level, int FactoryID, string LoggerName, string EventId, string FormattedMessage);
|
||||
if (eventData.EventName == "FormattedMessage")
|
||||
Console.WriteLine("Logger {0}: {1}", eventData.Payload[2], eventData.Payload[4]);
|
||||
}
|
||||
}
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.Keywords">
|
||||
<summary>
|
||||
This is public from an EventSource consumer point of view, but since these defintions
|
||||
are not needed outside this class
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.Keywords.Meta">
|
||||
<summary>
|
||||
Meta events are evnets about the LoggingEventSource itself (that is they did not come from ILogger
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.Keywords.Message">
|
||||
<summary>
|
||||
Turns on the 'Message' event when ILogger.Log() is called. It gives the information in a programatic (not formatted) way
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.Keywords.FormattedMessage">
|
||||
<summary>
|
||||
Turns on the 'FormatMessage' event when ILogger.Log() is called. It gives the formatted string version of the information.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.Keywords.JsonMessage">
|
||||
<summary>
|
||||
Turns on the 'MessageJson' event when ILogger.Log() is called. It gives JSON representation of the Arguments.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.Instance">
|
||||
<summary>
|
||||
The one and only instance of the LoggingEventSource.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.FormattedMessage(Microsoft.Extensions.Logging.LogLevel,System.Int32,System.String,System.String,System.String)">
|
||||
<summary>
|
||||
FormattedMessage() is called when ILogger.Log() is called. and the FormattedMessage keyword is active
|
||||
This only gives you the human reasable formatted message.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.Message(Microsoft.Extensions.Logging.LogLevel,System.Int32,System.String,System.String,Microsoft.Extensions.Logging.EventSource.ExceptionInfo,System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.String}})">
|
||||
<summary>
|
||||
Message() is called when ILogger.Log() is called. and the Message keyword is active
|
||||
This gives you the logged information in a programatic format (arguments are key-value pairs)
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.ActivityStart(System.Int32,System.Int32,System.String,System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.String}})">
|
||||
<summary>
|
||||
ActivityStart is called when ILogger.BeginScope() is called
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.OnEventCommand(System.Diagnostics.Tracing.EventCommandEventArgs)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.SetFilterSpec(System.String)">
|
||||
<summary>
|
||||
Set the filtering specifcation. null means turn off all loggers. Empty string is turn on all providers.
|
||||
</summary>
|
||||
<param name="filterSpec"></param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.ParseFilterSpec(System.String,Microsoft.Extensions.Logging.LogLevel)">
|
||||
<summary>
|
||||
Given a set of specifications Pat1:Level1;Pat1;Level2 ... Where
|
||||
Pat is a string pattern (a logger Name with a optional trailing wildcard * char)
|
||||
and Level is a number 0 (Trace) through 5 (Critical).
|
||||
|
||||
The :Level can be omitted (thus Pat1;Pat2 ...) in which case the level is 1 (Debug).
|
||||
|
||||
A completely emtry sting act like * (all loggers set to Debug level).
|
||||
|
||||
The first specification that 'loggers' Name matches is used.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.EventSource.LoggingEventSource.TryParseLevel(Microsoft.Extensions.Logging.LogLevel,System.String,Microsoft.Extensions.Logging.LogLevel@)">
|
||||
<summary>
|
||||
Parses the level specification (which should look like :N where n is a number 0 (Trace)
|
||||
through 5 (Critical). It can also be an empty string (which means 1 (Debug) and ';' marks
|
||||
the end of the specifcation This specification should start at spec[curPos]
|
||||
It returns the value in 'ret' and returns true if successful. If false is returned ret is left unchanged.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Logging.EventSourceLoggerFactoryExtensions">
|
||||
<summary>
|
||||
Extension methods for the <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.EventSourceLoggerFactoryExtensions.AddEventSourceLogger(Microsoft.Extensions.Logging.ILoggingBuilder)">
|
||||
<summary>
|
||||
Adds an event logger named 'EventSource' to the factory.
|
||||
</summary>
|
||||
<param name="builder">The extension method argument.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.EventSourceLoggerFactoryExtensions.AddEventSourceLogger(Microsoft.Extensions.Logging.ILoggerFactory)">
|
||||
<summary>
|
||||
Adds an event logger that is enabled for <see cref="T:Microsoft.Extensions.Logging.LogLevel"/>.Information or higher.
|
||||
</summary>
|
||||
<param name="factory">The extension method argument.</param>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1,94 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Logging</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Logging.FilterLoggingBuilderExtensions">
|
||||
<summary>
|
||||
Extension methods for setting up logging services in an <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Logging.ILoggingBuilder">
|
||||
<summary>
|
||||
An interface for configuring logging providers.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Logging.ILoggingBuilder.Services">
|
||||
<summary>
|
||||
Gets the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> where Logging services are configured.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Logging.LoggerFactory.CheckDisposed">
|
||||
<summary>
|
||||
Check if the factory has been disposed.
|
||||
</summary>
|
||||
<returns>True when <see cref="M:Microsoft.Extensions.Logging.LoggerFactory.Dispose"/> as been called</returns>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Logging.LoggerFilterOptions.MinLevel">
|
||||
<summary>
|
||||
Gets or sets the minimum level of log messages if none of the rules match.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Logging.LoggerFilterOptions.Rules">
|
||||
<summary>
|
||||
Gets the collection of <see cref="T:Microsoft.Extensions.Logging.LoggerFilterRule"/> used for filtering log messages.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Logging.LoggerFilterRule">
|
||||
<summary>
|
||||
Defines a rule used to filter log messages
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Logging.LoggerFilterRule.ProviderName">
|
||||
<summary>
|
||||
Gets the logger provider type or alias this rule applies to.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Logging.LoggerFilterRule.CategoryName">
|
||||
<summary>
|
||||
Gets the logger category this rule applies to.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Logging.LoggerFilterRule.LogLevel">
|
||||
<summary>
|
||||
Gets the minimum <see cref="P:Microsoft.Extensions.Logging.LoggerFilterRule.LogLevel"/> of messages.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Logging.LoggerFilterRule.Filter">
|
||||
<summary>
|
||||
Gets the filter delegate that would be applied to messages that passed the <see cref="P:Microsoft.Extensions.Logging.LoggerFilterRule.LogLevel"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Logging.LoggingBuilderExtensions">
|
||||
<summary>
|
||||
Extension methods for setting up logging services in an <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder" />.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Logging.ProviderAliasAttribute">
|
||||
<summary>
|
||||
Defines alias for <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider"/> implementation to be used in filtering rules.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.DependencyInjection.LoggingServiceCollectionExtensions">
|
||||
<summary>
|
||||
Extension methods for setting up logging services in an <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.LoggingServiceCollectionExtensions.AddLogging(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
|
||||
<summary>
|
||||
Adds logging services to the specified <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.
|
||||
</summary>
|
||||
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add services to.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.LoggingServiceCollectionExtensions.AddLogging(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{Microsoft.Extensions.Logging.ILoggingBuilder})">
|
||||
<summary>
|
||||
Adds logging services to the specified <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.
|
||||
</summary>
|
||||
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add services to.</param>
|
||||
<param name="configure">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> configuration delegate.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1,8 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.ObjectPool</name>
|
||||
</assembly>
|
||||
<members>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1,140 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Options.ConfigurationExtensions</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Options.ConfigurationChangeTokenSource`1">
|
||||
<summary>
|
||||
Creates IChangeTokens so that IOptionsMonitor gets notified when IConfiguration changes.
|
||||
</summary>
|
||||
<typeparam name="TOptions"></typeparam>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Options.ConfigurationChangeTokenSource`1.#ctor(Microsoft.Extensions.Configuration.IConfiguration)">
|
||||
<summary>
|
||||
Constructor taking the IConfiguration instance to watch.
|
||||
</summary>
|
||||
<param name="config">The configuration instance.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Options.ConfigurationChangeTokenSource`1.#ctor(System.String,Microsoft.Extensions.Configuration.IConfiguration)">
|
||||
<summary>
|
||||
Constructor taking the IConfiguration instance to watch.
|
||||
</summary>
|
||||
<param name="name">The name of the options instance being watche.</param>
|
||||
<param name="config">The configuration instance.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Options.ConfigurationChangeTokenSource`1.Name">
|
||||
<summary>
|
||||
The name of the option instance being changed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Options.ConfigurationChangeTokenSource`1.GetChangeToken">
|
||||
<summary>
|
||||
Returns the reloadToken from IConfiguration.
|
||||
</summary>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Options.ConfigureFromConfigurationOptions`1">
|
||||
<summary>
|
||||
Configures an option instance by using ConfigurationBinder.Bind against an IConfiguration.
|
||||
</summary>
|
||||
<typeparam name="TOptions">The type of options to bind.</typeparam>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Options.ConfigureFromConfigurationOptions`1.#ctor(Microsoft.Extensions.Configuration.IConfiguration)">
|
||||
<summary>
|
||||
Constructor that takes the IConfiguration instance to bind against.
|
||||
</summary>
|
||||
<param name="config">The IConfiguration instance.</param>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Options.NamedConfigureFromConfigurationOptions`1">
|
||||
<summary>
|
||||
Configures an option instance by using ConfigurationBinder.Bind against an IConfiguration.
|
||||
</summary>
|
||||
<typeparam name="TOptions">The type of options to bind.</typeparam>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Options.NamedConfigureFromConfigurationOptions`1.#ctor(System.String,Microsoft.Extensions.Configuration.IConfiguration)">
|
||||
<summary>
|
||||
Constructor that takes the IConfiguration instance to bind against.
|
||||
</summary>
|
||||
<param name="name">The name of the options instance.</param>
|
||||
<param name="config">The IConfiguration instance.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Options.NamedConfigureFromConfigurationOptions`1.#ctor(System.String,Microsoft.Extensions.Configuration.IConfiguration,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
|
||||
<summary>
|
||||
Constructor that takes the IConfiguration instance to bind against.
|
||||
</summary>
|
||||
<param name="name">The name of the options instance.</param>
|
||||
<param name="config">The IConfiguration instance.</param>
|
||||
<param name="configureBinder">Used to configure the <see cref="T:Microsoft.Extensions.Configuration.BinderOptions"/>.</param>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.DependencyInjection.OptionsBuilderConfigurationExtensions">
|
||||
<summary>
|
||||
Extension methods for adding configuration related options services to the DI container via <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.OptionsBuilderConfigurationExtensions.Bind``1(Microsoft.Extensions.Options.OptionsBuilder{``0},Microsoft.Extensions.Configuration.IConfiguration)">
|
||||
<summary>
|
||||
Registers a configuration instance which TOptions will bind against.
|
||||
</summary>
|
||||
<typeparam name="TOptions">The options type to be configured.</typeparam>
|
||||
<param name="optionsBuilder">The options builder to add the services to.</param>
|
||||
<param name="config">The configuration being bound.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1"/> so that additional calls can be chained.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.OptionsBuilderConfigurationExtensions.Bind``1(Microsoft.Extensions.Options.OptionsBuilder{``0},Microsoft.Extensions.Configuration.IConfiguration,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
|
||||
<summary>
|
||||
Registers a configuration instance which TOptions will bind against.
|
||||
</summary>
|
||||
<typeparam name="TOptions">The options type to be configured.</typeparam>
|
||||
<param name="optionsBuilder">The options builder to add the services to.</param>
|
||||
<param name="config">The configuration being bound.</param>
|
||||
<param name="configureBinder">Used to configure the <see cref="T:Microsoft.Extensions.Configuration.BinderOptions"/>.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1"/> so that additional calls can be chained.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.DependencyInjection.OptionsConfigurationServiceCollectionExtensions">
|
||||
<summary>
|
||||
Extension methods for adding configuration related options services to the DI container.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.OptionsConfigurationServiceCollectionExtensions.Configure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,Microsoft.Extensions.Configuration.IConfiguration)">
|
||||
<summary>
|
||||
Registers a configuration instance which TOptions will bind against.
|
||||
</summary>
|
||||
<typeparam name="TOptions">The type of options being configured.</typeparam>
|
||||
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> to add the services to.</param>
|
||||
<param name="config">The configuration being bound.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.OptionsConfigurationServiceCollectionExtensions.Configure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String,Microsoft.Extensions.Configuration.IConfiguration)">
|
||||
<summary>
|
||||
Registers a configuration instance which TOptions will bind against.
|
||||
</summary>
|
||||
<typeparam name="TOptions">The type of options being configured.</typeparam>
|
||||
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> to add the services to.</param>
|
||||
<param name="name">The name of the options instance.</param>
|
||||
<param name="config">The configuration being bound.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.OptionsConfigurationServiceCollectionExtensions.Configure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,Microsoft.Extensions.Configuration.IConfiguration,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
|
||||
<summary>
|
||||
Registers a configuration instance which TOptions will bind against.
|
||||
</summary>
|
||||
<typeparam name="TOptions">The type of options being configured.</typeparam>
|
||||
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> to add the services to.</param>
|
||||
<param name="config">The configuration being bound.</param>
|
||||
<param name="configureBinder">Used to configure the <see cref="T:Microsoft.Extensions.Configuration.BinderOptions"/>.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.OptionsConfigurationServiceCollectionExtensions.Configure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String,Microsoft.Extensions.Configuration.IConfiguration,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
|
||||
<summary>
|
||||
Registers a configuration instance which TOptions will bind against.
|
||||
</summary>
|
||||
<typeparam name="TOptions">The type of options being configured.</typeparam>
|
||||
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> to add the services to.</param>
|
||||
<param name="name">The name of the options instance.</param>
|
||||
<param name="config">The configuration being bound.</param>
|
||||
<param name="configureBinder">Used to configure the <see cref="T:Microsoft.Extensions.Configuration.BinderOptions"/>.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
File diff suppressed because it is too large
Load Diff
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user