diff options
Diffstat (limited to '.packages/microsoft.aspnetcore.app.ref/3.0.1/ref/netcoreapp3.0/Microsoft.AspNetCore.Hosting.Abstractions.xml')
-rwxr-xr-x | .packages/microsoft.aspnetcore.app.ref/3.0.1/ref/netcoreapp3.0/Microsoft.AspNetCore.Hosting.Abstractions.xml | 378 |
1 files changed, 378 insertions, 0 deletions
diff --git a/.packages/microsoft.aspnetcore.app.ref/3.0.1/ref/netcoreapp3.0/Microsoft.AspNetCore.Hosting.Abstractions.xml b/.packages/microsoft.aspnetcore.app.ref/3.0.1/ref/netcoreapp3.0/Microsoft.AspNetCore.Hosting.Abstractions.xml new file mode 100755 index 0000000000..73f40fdb9e --- /dev/null +++ b/.packages/microsoft.aspnetcore.app.ref/3.0.1/ref/netcoreapp3.0/Microsoft.AspNetCore.Hosting.Abstractions.xml @@ -0,0 +1,378 @@ +<?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. + <para> + This type is obsolete and will be removed in a future version. + The recommended alternative is Microsoft.Extensions.Hosting.IHostApplicationLifetime. + </para> + </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. + <para> + This type is obsolete and will be removed in a future version. + The recommended alternative is Microsoft.AspNetCore.Hosting.IWebHostEnvironment. + </para> + </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.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.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> + <param name="cancellationToken">Used to abort program start.</param> + <returns>A <see cref="T:System.Threading.Tasks.Task"/> that completes when the <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost"/> starts.</returns> + </member> + <member name="M:Microsoft.AspNetCore.Hosting.IWebHost.StopAsync(System.Threading.CancellationToken)"> + <summary> + Attempt to gracefully stop the host. + </summary> + <param name="cancellationToken">Used to indicate when stop should no longer be graceful.</param> + <returns>A <see cref="T:System.Threading.Tasks.Task"/> that completes when the <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost"/> stops.</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.IWebHostEnvironment"> + <summary> + Provides information about the web hosting environment an application is running in. + </summary> + </member> + <member name="P:Microsoft.AspNetCore.Hosting.IWebHostEnvironment.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.IWebHostEnvironment.WebRootFileProvider"> + <summary> + Gets or sets an <see cref="T:Microsoft.Extensions.FileProviders.IFileProvider"/> pointing at <see cref="P:Microsoft.AspNetCore.Hosting.IWebHostEnvironment.WebRootPath"/>. + </summary> + </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.IWebHostEnvironment" /> 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> |