244 lines
13 KiB
XML
244 lines
13 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>Telegrator.Hosting.Web</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:Telegrator.Hosting.Web.ITelegramBotWebHost">
|
|
<summary>
|
|
Interface for Telegram bot hosts with Webhook update receiving.
|
|
Combines wbe application capabilities with reactive Telegram bot functionality.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Telegrator.Hosting.Web.TelegramBotWebHost">
|
|
<summary>
|
|
Represents a web hosted telegram bot
|
|
</summary>
|
|
</member>
|
|
<member name="P:Telegrator.Hosting.Web.TelegramBotWebHost.Services">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Telegrator.Hosting.Web.TelegramBotWebHost.UpdateRouter">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Telegrator.Hosting.Web.TelegramBotWebHost.DataSources">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Telegrator.Hosting.Web.TelegramBotWebHost.Lifetime">
|
|
<summary>
|
|
Allows consumers to be notified of application lifetime events.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Telegrator.Hosting.Web.TelegramBotWebHost.Logger">
|
|
<summary>
|
|
This application's logger
|
|
</summary>
|
|
</member>
|
|
<member name="M:Telegrator.Hosting.Web.TelegramBotWebHost.#ctor(Microsoft.AspNetCore.Builder.WebApplicationBuilder)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.AspNetCore.Builder.WebApplicationBuilder"/> class.
|
|
</summary>
|
|
<param name="webApplicationBuilder">The proxied instance of host builder.</param>
|
|
</member>
|
|
<member name="M:Telegrator.Hosting.Web.TelegramBotWebHost.CreateBuilder(Telegrator.Hosting.Web.TelegramBotWebOptions)">
|
|
<summary>
|
|
Creates new <see cref="T:Telegrator.Hosting.TelegramBotHostBuilder"/> with default services and webhook update receiving scheme
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Telegrator.Hosting.Web.TelegramBotWebHost.CreateSlimBuilder(Telegrator.Hosting.Web.TelegramBotWebOptions)">
|
|
<summary>
|
|
Creates new SLIM <see cref="T:Telegrator.Hosting.TelegramBotHostBuilder"/> with default services and webhook update receiving scheme
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Telegrator.Hosting.Web.TelegramBotWebHost.CreateEmptyBuilder(Telegrator.Hosting.Web.TelegramBotWebOptions)">
|
|
<summary>
|
|
Creates new EMPTY <see cref="T:Telegrator.Hosting.TelegramBotHostBuilder"/> WITHOUT any services or update receiving schemes
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Telegrator.Hosting.Web.TelegramBotWebHost.StartAsync(System.Threading.CancellationToken)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Telegrator.Hosting.Web.TelegramBotWebHost.StopAsync(System.Threading.CancellationToken)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Telegrator.Hosting.Web.TelegramBotWebHost.CreateApplicationBuilder">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Telegrator.Hosting.Web.TelegramBotWebHost.Use(System.Func{Microsoft.AspNetCore.Http.RequestDelegate,Microsoft.AspNetCore.Http.RequestDelegate})">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Telegrator.Hosting.Web.TelegramBotWebHost.New">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Telegrator.Hosting.Web.TelegramBotWebHost.Build">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Telegrator.Hosting.Web.TelegramBotWebHost.DisposeAsync">
|
|
<summary>
|
|
Disposes the host.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Telegrator.Hosting.Web.TelegramBotWebHost.Dispose">
|
|
<summary>
|
|
Disposes the host.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Telegrator.Hosting.Web.TelegramBotWebHostBuilder">
|
|
<summary>
|
|
Represents a web hosted telegram bots and services builder that helps manage configuration, logging, lifetime, and more.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Telegrator.Hosting.Web.TelegramBotWebHostBuilder.Handlers">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Telegrator.Hosting.Web.TelegramBotWebHostBuilder.Configuration">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Telegrator.Hosting.Web.TelegramBotWebHostBuilder.Logging">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Telegrator.Hosting.Web.TelegramBotWebHostBuilder.Services">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Telegrator.Hosting.Web.TelegramBotWebHostBuilder.Environment">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Telegrator.Hosting.Web.TelegramBotWebHostBuilder.#ctor(Microsoft.AspNetCore.Builder.WebApplicationBuilder,Telegrator.Hosting.Web.TelegramBotWebOptions)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Telegrator.Hosting.Web.TelegramBotWebHostBuilder"/> class.
|
|
</summary>
|
|
<param name="webApplicationBuilder"></param>
|
|
<param name="settings"></param>
|
|
</member>
|
|
<member name="M:Telegrator.Hosting.Web.TelegramBotWebHostBuilder.#ctor(Microsoft.AspNetCore.Builder.WebApplicationBuilder,Telegrator.Hosting.Web.TelegramBotWebOptions,Telegrator.Core.IHandlersCollection)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Telegrator.Hosting.Web.TelegramBotWebHostBuilder"/> class.
|
|
</summary>
|
|
<param name="webApplicationBuilder"></param>
|
|
<param name="handlers"></param>
|
|
<param name="settings"></param>
|
|
</member>
|
|
<member name="M:Telegrator.Hosting.Web.TelegramBotWebHostBuilder.Build">
|
|
<summary>
|
|
Builds the host.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:Telegrator.Hosting.Web.TelegramBotWebOptions">
|
|
<summary>
|
|
Options for configuring the behavior for TelegramBotWebHost.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Telegrator.Hosting.Web.TelegramBotWebOptions.DisableAutoConfigure">
|
|
<summary>
|
|
Disables automatic configuration for all of required <see cref="T:Microsoft.Extensions.Options.IOptions`1"/> instances
|
|
</summary>
|
|
</member>
|
|
<member name="P:Telegrator.Hosting.Web.TelegramBotWebOptions.Args">
|
|
<inheritdoc cref="P:Microsoft.AspNetCore.Builder.WebApplicationOptions.Args"/>
|
|
</member>
|
|
<member name="P:Telegrator.Hosting.Web.TelegramBotWebOptions.EnvironmentName">
|
|
<inheritdoc cref="P:Microsoft.AspNetCore.Builder.WebApplicationOptions.EnvironmentName"/>
|
|
</member>
|
|
<member name="P:Telegrator.Hosting.Web.TelegramBotWebOptions.ApplicationName">
|
|
<inheritdoc cref="P:Microsoft.AspNetCore.Builder.WebApplicationOptions.ApplicationName"/>
|
|
</member>
|
|
<member name="P:Telegrator.Hosting.Web.TelegramBotWebOptions.ContentRootPath">
|
|
<inheritdoc cref="P:Microsoft.AspNetCore.Builder.WebApplicationOptions.ContentRootPath"/>
|
|
</member>
|
|
<member name="P:Telegrator.Hosting.Web.TelegramBotWebOptions.WebRootPath">
|
|
<inheritdoc cref="P:Microsoft.AspNetCore.Builder.WebApplicationOptions.WebRootPath"/>
|
|
</member>
|
|
<member name="T:Telegrator.Hosting.Web.TelegratorWebOptions">
|
|
<summary>
|
|
Configuration options for Telegram bot behavior and execution settings.
|
|
Controls various aspects of bot operation including concurrency, routing, webhook receiving, and execution policies.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Telegrator.Hosting.Web.TelegratorWebOptions.WebhookUri">
|
|
<summary>
|
|
Gets or sets HTTPS URL to send updates to. Use an empty string to remove webhook integration
|
|
</summary>
|
|
</member>
|
|
<member name="P:Telegrator.Hosting.Web.TelegratorWebOptions.SecretToken">
|
|
<summary>
|
|
A secret token to be sent in a header “X-Telegram-Bot-Api-Secret-Token” in every webhook request, 1-256 characters.
|
|
Only characters A-Z, a-z, 0-9, _ and - are allowed.
|
|
The header is useful to ensure that the request comes from a webhook set by you.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Telegrator.Hosting.Web.TelegratorWebOptions.MaxConnections">
|
|
<summary>
|
|
The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to 40.
|
|
Use lower values to limit the load on your bot's server, and higher values to increase your bot's throughput.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Telegrator.Hosting.Web.TelegratorWebOptions.DropPendingUpdates">
|
|
<summary>
|
|
Pass true to drop all pending updates
|
|
</summary>
|
|
</member>
|
|
<member name="T:Telegrator.Mediation.HostedUpdateWebhooker">
|
|
<summary>
|
|
Service for receiving updates for Hosted telegram bots via Webhooks
|
|
</summary>
|
|
</member>
|
|
<member name="M:Telegrator.Mediation.HostedUpdateWebhooker.#ctor(Microsoft.AspNetCore.Routing.IEndpointRouteBuilder,Telegram.Bot.ITelegramBotClient,Telegrator.Core.IUpdateRouter,Microsoft.Extensions.Options.IOptions{Telegrator.Hosting.Web.TelegratorWebOptions})">
|
|
<summary>
|
|
Initiallizes new instance of <see cref="T:Telegrator.Mediation.HostedUpdateWebhooker"/>
|
|
</summary>
|
|
<param name="botHost"></param>
|
|
<param name="botClient"></param>
|
|
<param name="updateRouter"></param>
|
|
<param name="options"></param>
|
|
<exception cref="T:System.ArgumentNullException"></exception>
|
|
</member>
|
|
<member name="M:Telegrator.Mediation.HostedUpdateWebhooker.StartAsync(System.Threading.CancellationToken)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Telegrator.Mediation.HostedUpdateWebhooker.StopAsync(System.Threading.CancellationToken)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Telegrator.ServicesCollectionExtensions">
|
|
<summary>
|
|
Contains extensions for <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>
|
|
Provides method to configure <see cref="T:Telegrator.Hosting.Web.ITelegramBotWebHost"/>
|
|
</summary>
|
|
</member>
|
|
<member name="F:Telegrator.ServicesCollectionExtensions.HandlersCollectionPropertyKey">
|
|
<summary>
|
|
The key used to store the <see cref="T:Telegrator.Core.IHandlersCollection"/> in the builder properties.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Telegrator.ServicesCollectionExtensions.get_Handlers(Microsoft.Extensions.Hosting.IHostApplicationBuilder)">
|
|
<inheritdoc cref="P:Telegrator.ServicesCollectionExtensions.<G>$605D8CCF64349EA050C790D67C500BD9.Handlers"/>
|
|
</member>
|
|
<member name="M:Telegrator.ServicesCollectionExtensions.AddTelegratorWeb(Microsoft.AspNetCore.Builder.WebApplicationBuilder,Telegrator.Hosting.Web.TelegramBotWebOptions,Telegrator.Core.IHandlersCollection)">
|
|
<summary>
|
|
Replaces TelegramBotWebHostBuilder. Configures DI, options, and handlers.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Telegrator.ServicesCollectionExtensions.UseTelegratorWeb(Microsoft.AspNetCore.Builder.WebApplication)">
|
|
<summary>
|
|
Replaces the initialization logic from TelegramBotWebHost constructor.
|
|
Initializes the bot and logs handlers on application startup.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Telegrator.ServicesCollectionExtensions.AddTelegramWebhook(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
|
|
<summary>
|
|
Registers <see cref="T:Telegram.Bot.ITelegramBotClient"/> service with <see cref="T:Telegrator.Mediation.HostedUpdateWebhooker"/> to receive updates using webhook
|
|
</summary>
|
|
<param name="services"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="P:Telegrator.ServicesCollectionExtensions.<G>$605D8CCF64349EA050C790D67C500BD9.Handlers">
|
|
<summary>
|
|
Gets the <see cref="T:Telegrator.Core.IHandlersCollection"/> from the builder properties.
|
|
</summary>
|
|
</member>
|
|
</members>
|
|
</doc>
|