Telegrator/docs/Telegrator.Hosting.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>Telegrator.Hosting</name>
    </assembly>
    <members>
        <member name="T:Telegrator.ConfigureOptionsProxy`1">
            <summary>
            Abstract base class for configuring options from configuration sources.
            Provides a proxy pattern for binding configuration to strongly-typed options classes.
            </summary>
            <typeparam name="TOptions">The type of options to configure.</typeparam>
        </member>
        <member name="M:Telegrator.ConfigureOptionsProxy`1.Configure(Microsoft.Extensions.DependencyInjection.IServiceCollection,Microsoft.Extensions.Configuration.IConfiguration)">
            <summary>
            Configures the options using the default configuration section.
            </summary>
            <param name="services">The service collection to configure.</param>
            <param name="configuration">The configuration source.</param>
        </member>
        <member name="M:Telegrator.ConfigureOptionsProxy`1.Configure(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String,Microsoft.Extensions.Configuration.IConfiguration)">
            <summary>
            Configures the options using a named configuration section.
            </summary>
            <param name="services">The service collection to configure.</param>
            <param name="name">The name of the configuration section.</param>
            <param name="configuration">The configuration source.</param>
        </member>
        <member name="M:Telegrator.ConfigureOptionsProxy`1.Configure(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String,Microsoft.Extensions.Configuration.IConfiguration,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
            <summary>
            Configures the options using a named configuration section with custom binder options.
            </summary>
            <param name="services">The service collection to configure.</param>
            <param name="name">The name of the configuration section.</param>
            <param name="configuration">The configuration source.</param>
            <param name="configureBinder">Optional action to configure the binder options.</param>
        </member>
        <member name="M:Telegrator.ConfigureOptionsProxy`1.Realize">
            <summary>
            Creates the actual options instance from the configuration.
            </summary>
            <returns>The configured options instance.</returns>
        </member>
        <member name="T:Telegrator.Core.IHostHandlersCollection">
            <summary>
            Collection class for managing handler descriptors organized by update type for host apps.
            Provides functionality for collecting, adding, scanning, and organizing handlers.
            </summary>
        </member>
        <member name="P:Telegrator.Core.IHostHandlersCollection.PreBuilderRoutines">
            <summary>
            List of tasks that should be completed right before building the bot
            </summary>
        </member>
        <member name="T:Telegrator.Handlers.IPreBuildingRoutine">
            <summary>
            Interface for pre-building routines that can be executed during host construction.
            Allows for custom initialization and configuration steps before the bot host is built.
            </summary>
        </member>
        <member name="M:Telegrator.Handlers.IPreBuildingRoutine.PreBuildingRoutine(Telegrator.Hosting.ITelegramBotHostBuilder)">
            <summary>
            Executes the pre-building routine on the specified host builder.
            </summary>
            <param name="hostBuilder">The host builder to configure.</param>
        </member>
        <member name="T:Telegrator.Hosting.HostedTelegramBotInfo">
            <summary>
            Implementation of <see cref="T:Telegrator.Core.ITelegramBotInfo"/> that provides bot information.
            Contains metadata about the Telegram bot including user details and service provider for wider filterring abilities
            </summary>
            <param name="client"></param>
            <param name="services"></param>
            <param name="configuration"></param>
        </member>
        <member name="M:Telegrator.Hosting.HostedTelegramBotInfo.#ctor(Telegram.Bot.ITelegramBotClient,System.IServiceProvider,Microsoft.Extensions.Configuration.IConfigurationManager)">
            <summary>
            Implementation of <see cref="T:Telegrator.Core.ITelegramBotInfo"/> that provides bot information.
            Contains metadata about the Telegram bot including user details and service provider for wider filterring abilities
            </summary>
            <param name="client"></param>
            <param name="services"></param>
            <param name="configuration"></param>
        </member>
        <member name="P:Telegrator.Hosting.HostedTelegramBotInfo.User">
            <inheritdoc/>
        </member>
        <member name="P:Telegrator.Hosting.HostedTelegramBotInfo.Services">
            <summary>
            Provides access to services of this Hosted telegram bot
            </summary>
        </member>
        <member name="P:Telegrator.Hosting.HostedTelegramBotInfo.Configuration">
            <summary>
            Provides access to configuration of this Hosted telegram bot
            </summary>
        </member>
        <member name="T:Telegrator.Hosting.ITelegramBotHost">
            <summary>
            Interface for Telegram bot hosts.
            Combines host application capabilities with reactive Telegram bot functionality.
            </summary>
        </member>
        <member name="T:Telegrator.Hosting.ITelegramBotHostBuilder">
            <summary>
            Interface for building Telegram bot hosts with dependency injection support.
            Combines host application building capabilities with handler collection functionality.
            </summary>
        </member>
        <member name="P:Telegrator.Hosting.ITelegramBotHostBuilder.Configuration">
            <summary>
            Gets the set of key/value configuration properties.
            </summary>
        </member>
        <member name="P:Telegrator.Hosting.ITelegramBotHostBuilder.Logging">
            <summary>
            Gets a collection of logging providers for the application to compose. This is useful for adding new logging providers.
            </summary>
        </member>
        <member name="P:Telegrator.Hosting.ITelegramBotHostBuilder.Services">
            <summary>
            Gets a collection of services for the application to compose. This is useful for adding user provided or framework provided services.
            </summary>
        </member>
        <member name="T:Telegrator.Hosting.TelegramBotHost">
            <summary>
            Represents a hosted telegram bot
            </summary>
        </member>
        <member name="P:Telegrator.Hosting.TelegramBotHost.Services">
            <inheritdoc/>
        </member>
        <member name="P:Telegrator.Hosting.TelegramBotHost.UpdateRouter">
            <inheritdoc/>
        </member>
        <member name="P:Telegrator.Hosting.TelegramBotHost.Logger">
            <summary>
            This application's logger
            </summary>
        </member>
        <member name="M:Telegrator.Hosting.TelegramBotHost.#ctor(Microsoft.Extensions.Hosting.HostApplicationBuilder,Telegrator.Core.IHandlersCollection)">
            <summary>
            Initializes a new instance of the <see cref="T:Telegrator.Hosting.TelegramBotHost"/> class.
            </summary>
            <param name="hostApplicationBuilder">The proxied instance of host builder.</param>
            <param name="handlers"></param>
        </member>
        <member name="M:Telegrator.Hosting.TelegramBotHost.CreateBuilder">
            <summary>
            Creates new <see cref="T:Telegrator.Hosting.TelegramBotHostBuilder"/> with default configuration, services and long-polling update receiving scheme
            </summary>
            <returns></returns>
        </member>
        <member name="M:Telegrator.Hosting.TelegramBotHost.CreateBuilder(Telegrator.Hosting.TelegramBotHostBuilderSettings)">
            <summary>
            Creates new <see cref="T:Telegrator.Hosting.TelegramBotHostBuilder"/> with default services and long-polling update receiving scheme
            </summary>
            <returns></returns>
        </member>
        <member name="M:Telegrator.Hosting.TelegramBotHost.CreateEmptyBuilder">
            <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.TelegramBotHost.CreateEmptyBuilder(Telegrator.Hosting.TelegramBotHostBuilderSettings)">
            <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.TelegramBotHost.StartAsync(System.Threading.CancellationToken)">
            <inheritdoc/>
        </member>
        <member name="M:Telegrator.Hosting.TelegramBotHost.StopAsync(System.Threading.CancellationToken)">
            <inheritdoc/>
        </member>
        <member name="M:Telegrator.Hosting.TelegramBotHost.Dispose">
            <summary>
            Disposes the host.
            </summary>
        </member>
        <member name="T:Telegrator.Hosting.TelegramBotHostBuilder">
            <summary>
            Represents a hosted telegram bots and services builder that helps manage configuration, logging, lifetime, and more.
            </summary>
        </member>
        <member name="P:Telegrator.Hosting.TelegramBotHostBuilder.Handlers">
            <inheritdoc/>
        </member>
        <member name="P:Telegrator.Hosting.TelegramBotHostBuilder.Services">
            <inheritdoc/>
        </member>
        <member name="P:Telegrator.Hosting.TelegramBotHostBuilder.Configuration">
            <inheritdoc/>
        </member>
        <member name="P:Telegrator.Hosting.TelegramBotHostBuilder.Logging">
            <inheritdoc/>
        </member>
        <member name="P:Telegrator.Hosting.TelegramBotHostBuilder.Environment">
            <inheritdoc/>
        </member>
        <member name="M:Telegrator.Hosting.TelegramBotHostBuilder.#ctor(Microsoft.Extensions.Hosting.HostApplicationBuilder,Telegrator.Hosting.TelegramBotHostBuilderSettings)">
            <summary>
            Initializes a new instance of the <see cref="T:Telegrator.Hosting.TelegramBotHostBuilder"/> class.
            </summary>
            <param name="hostApplicationBuilder"></param>
            <param name="settings"></param>
        </member>
        <member name="M:Telegrator.Hosting.TelegramBotHostBuilder.#ctor(Microsoft.Extensions.Hosting.HostApplicationBuilder,Telegrator.Core.IHandlersCollection,Telegrator.Hosting.TelegramBotHostBuilderSettings)">
            <summary>
            Initializes a new instance of the <see cref="T:Telegrator.Hosting.TelegramBotHostBuilder"/> class.
            </summary>
            <param name="hostApplicationBuilder"></param>
            <param name="handlers"></param>
            <param name="settings"></param>
        </member>
        <member name="M:Telegrator.Hosting.TelegramBotHostBuilder.Build">
            <summary>
            Builds the host.
            </summary>
            <returns></returns>
        </member>
        <member name="T:Telegrator.Hosting.TelegramBotHostBuilderSettings">
            <summary>
            Settings os hosted Telegram bot
            </summary>
        </member>
        <member name="M:Telegrator.Hosting.TelegramBotHostBuilderSettings.#ctor">
            <summary>
            Settings os hosted Telegram bot
            </summary>
        </member>
        <member name="P:Telegrator.Hosting.TelegramBotHostBuilderSettings.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.TelegramBotHostBuilderSettings.DisableDefaults">
            <inheritdoc cref="P:Microsoft.Extensions.Hosting.HostApplicationBuilderSettings.DisableDefaults"/>
        </member>
        <member name="P:Telegrator.Hosting.TelegramBotHostBuilderSettings.Args">
            <inheritdoc cref="P:Microsoft.Extensions.Hosting.HostApplicationBuilderSettings.Args"/>
        </member>
        <member name="P:Telegrator.Hosting.TelegramBotHostBuilderSettings.Configuration">
            <inheritdoc cref="P:Microsoft.Extensions.Hosting.HostApplicationBuilderSettings.Configuration"/>
        </member>
        <member name="P:Telegrator.Hosting.TelegramBotHostBuilderSettings.EnvironmentName">
            <inheritdoc cref="P:Microsoft.Extensions.Hosting.HostApplicationBuilderSettings.EnvironmentName"/>
        </member>
        <member name="P:Telegrator.Hosting.TelegramBotHostBuilderSettings.ApplicationName">
            <inheritdoc cref="P:Microsoft.Extensions.Hosting.HostApplicationBuilderSettings.ApplicationName"/>
        </member>
        <member name="P:Telegrator.Hosting.TelegramBotHostBuilderSettings.ContentRootPath">
            <inheritdoc cref="P:Microsoft.Extensions.Hosting.HostApplicationBuilderSettings.ContentRootPath"/>
        </member>
        <member name="T:Telegrator.Logging.MicrosoftLoggingAdapter">
            <summary>
            Adapter for Microsoft.Extensions.Logging to work with Telegrator logging system.
            This allows seamless integration with ASP.NET Core logging infrastructure.
            </summary>
        </member>
        <member name="M:Telegrator.Logging.MicrosoftLoggingAdapter.#ctor(Microsoft.Extensions.Logging.ILogger)">
            <summary>
            Initializes a new instance of MicrosoftLoggingAdapter.
            </summary>
            <param name="logger">The Microsoft.Extensions.Logging logger instance.</param>
        </member>
        <member name="M:Telegrator.Logging.MicrosoftLoggingAdapter.Log(Telegrator.Logging.LogLevel,System.String,System.Exception)">
            <inheritdoc/>
        </member>
        <member name="T:Telegrator.Polling.HostedUpdateReceiver">
            <summary>
            Service for receiving updates for Hosted telegram bots
            </summary>
            <param name="botHost"></param>
            <param name="botClient"></param>
            <param name="updateRouter"></param>
            <param name="options"></param>
            <param name="logger"></param>
        </member>
        <member name="M:Telegrator.Polling.HostedUpdateReceiver.#ctor(Telegrator.Hosting.ITelegramBotHost,Telegram.Bot.ITelegramBotClient,Telegrator.Core.IUpdateRouter,Microsoft.Extensions.Options.IOptions{Telegram.Bot.Polling.ReceiverOptions},Microsoft.Extensions.Logging.ILogger{Telegrator.Polling.HostedUpdateReceiver})">
            <summary>
            Service for receiving updates for Hosted telegram bots
            </summary>
            <param name="botHost"></param>
            <param name="botClient"></param>
            <param name="updateRouter"></param>
            <param name="options"></param>
            <param name="logger"></param>
        </member>
        <member name="M:Telegrator.Polling.HostedUpdateReceiver.ExecuteAsync(System.Threading.CancellationToken)">
            <inheritdoc/>
        </member>
        <member name="T:Telegrator.Polling.HostUpdateHandlersPool">
            <inheritdoc/>
        </member>
        <member name="M:Telegrator.Polling.HostUpdateHandlersPool.#ctor(Telegrator.Core.IUpdateRouter,Microsoft.Extensions.Options.IOptions{Telegrator.TelegratorOptions})">
            <inheritdoc/>
        </member>
        <member name="T:Telegrator.Polling.HostUpdateRouter">
            <inheritdoc/>
        </member>
        <member name="F:Telegrator.Polling.HostUpdateRouter.Logger">
            <summary>
            <see cref="T:Microsoft.Extensions.Logging.ILogger"/> of this router
            </summary>
        </member>
        <member name="M:Telegrator.Polling.HostUpdateRouter.#ctor(Telegrator.Core.IHandlersProvider,Telegrator.Core.IAwaitingProvider,Microsoft.Extensions.Options.IOptions{Telegrator.TelegratorOptions},Telegrator.Core.IUpdateHandlersPool,Telegrator.Core.ITelegramBotInfo,Microsoft.Extensions.Logging.ILogger{Telegrator.Polling.HostUpdateRouter})">
            <inheritdoc/>
        </member>
        <member name="M:Telegrator.Polling.HostUpdateRouter.HandleUpdateAsync(Telegram.Bot.ITelegramBotClient,Telegram.Bot.Types.Update,System.Threading.CancellationToken)">
            <inheritdoc/>
        </member>
        <member name="M:Telegrator.Polling.HostUpdateRouter.HandleException(Telegram.Bot.ITelegramBotClient,System.Exception,Telegram.Bot.Polling.HandleErrorSource,System.Threading.CancellationToken)">
            <summary>
            Default exception handler of this router
            </summary>
            <param name="botClient"></param>
            <param name="exception"></param>
            <param name="source"></param>
            <param name="cancellationToken"></param>
        </member>
        <member name="T:Telegrator.Providers.HostAwaitingProvider">
            <inheritdoc/>
        </member>
        <member name="M:Telegrator.Providers.HostAwaitingProvider.#ctor(Microsoft.Extensions.Options.IOptions{Telegrator.TelegratorOptions},Microsoft.Extensions.Logging.ILogger{Telegrator.Providers.HostAwaitingProvider})">
            <inheritdoc/>
        </member>
        <member name="T:Telegrator.Providers.PreBuildingRoutine">
            <summary>
            Pre host building task
            </summary>
            <param name="builder"></param>
        </member>
        <member name="T:Telegrator.Providers.HostHandlersCollection">
            <inheritdoc/>
        </member>
        <member name="M:Telegrator.Providers.HostHandlersCollection.#ctor(Microsoft.Extensions.DependencyInjection.IServiceCollection,Telegrator.TelegratorOptions)">
            <inheritdoc/>
        </member>
        <member name="P:Telegrator.Providers.HostHandlersCollection.MustHaveParameterlessCtor">
            <inheritdoc/>
        </member>
        <member name="P:Telegrator.Providers.HostHandlersCollection.PreBuilderRoutines">
            <summary>
            List of tasks that should be completed right before building the bot
            </summary>
        </member>
        <member name="M:Telegrator.Providers.HostHandlersCollection.AddDescriptor(Telegrator.Core.Descriptors.HandlerDescriptor)">
            <inheritdoc/>
        </member>
        <member name="T:Telegrator.Providers.HostHandlersProvider">
            <inheritdoc/>
        </member>
        <member name="M:Telegrator.Providers.HostHandlersProvider.#ctor(Telegrator.Core.IHandlersCollection,Microsoft.Extensions.Options.IOptions{Telegrator.TelegratorOptions},System.IServiceProvider,Microsoft.Extensions.Logging.ILogger{Telegrator.Providers.HostHandlersProvider})">
            <inheritdoc/>
        </member>
        <member name="M:Telegrator.Providers.HostHandlersProvider.GetHandlerInstance(Telegrator.Core.Descriptors.HandlerDescriptor,System.Threading.CancellationToken)">
            <inheritdoc/>
        </member>
        <member name="T:Telegrator.TelegramBotClientOptionsProxy">
            <summary>
            Internal proxy class for configuring Telegram bot client options from configuration.
            Extends ConfigureOptionsProxy to provide specific configuration for Telegram bot client options.
            </summary>
        </member>
        <member name="P:Telegrator.TelegramBotClientOptionsProxy.Token">
            <summary>
            Gets or sets the bot token.
            </summary>
        </member>
        <member name="P:Telegrator.TelegramBotClientOptionsProxy.BaseUrl">
            <summary>
            Gets or sets the base URL for the bot API.
            </summary>
        </member>
        <member name="P:Telegrator.TelegramBotClientOptionsProxy.UseTestEnvironment">
            <summary>
            Gets or sets whether to use the test environment.
            </summary>
        </member>
        <member name="P:Telegrator.TelegramBotClientOptionsProxy.RetryThreshold">
            <summary>
            Gets or sets the retry threshold in seconds.
            </summary>
        </member>
        <member name="P:Telegrator.TelegramBotClientOptionsProxy.RetryCount">
            <summary>
            Gets or sets the number of retry attempts.
            </summary>
        </member>
        <member name="M:Telegrator.TelegramBotClientOptionsProxy.Realize">
            <summary>
            Creates a TelegramBotClientOptions instance from the proxy configuration.
            </summary>
            <returns>The configured TelegramBotClientOptions instance.</returns>
        </member>
        <member name="M:Telegrator.HostBuilderExtensions.AddTelegrator(Microsoft.Extensions.Hosting.IHostApplicationBuilder,Telegrator.Hosting.TelegramBotHostBuilderSettings,Telegrator.Core.IHandlersCollection)">
            <summary>
            Replaces TelegramBotWebHostBuilder. Configures DI, options, and handlers.
            </summary>
        </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.ITelegramBotHost"/>
            </summary>
        </member>
        <member name="M:Telegrator.ServicesCollectionExtensions.Configure``1(Microsoft.Extensions.DependencyInjection.IServiceCollection,Microsoft.Extensions.Configuration.IConfiguration,Telegrator.ConfigureOptionsProxy{``0})">
            <summary>
            Registers a configuration instance that strongly-typed <typeparamref name="TOptions"/> will bind against using <see cref="T:Telegrator.ConfigureOptionsProxy`1"/>.
            </summary>
            <typeparam name="TOptions"></typeparam>
            <param name="services"></param>
            <param name="configuration"></param>
            <param name="optionsProxy"></param>
            <returns></returns>
        </member>
        <member name="M:Telegrator.ServicesCollectionExtensions.AddTelegramBotHostDefaults(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
            <summary>
            Registers <see cref="T:Telegrator.Hosting.TelegramBotHost"/> default services
            </summary>
            <param name="services"></param>
            <returns></returns>
        </member>
        <member name="M:Telegrator.ServicesCollectionExtensions.AddTelegramReceiver(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
            <summary>
            Registers <see cref="T:Telegram.Bot.ITelegramBotClient"/> service with <see cref="T:Telegrator.Polling.HostedUpdateReceiver"/> to receive updates using long polling
            </summary>
            <param name="services"></param>
            <returns></returns>
        </member>
        <member name="M:Telegrator.ServicesCollectionExtensions.TypedTelegramBotClientFactory(System.Net.Http.HttpClient,System.IServiceProvider)">
            <summary>
            <see cref="T:Telegram.Bot.ITelegramBotClient"/> factory method
            </summary>
            <param name="httpClient"></param>
            <param name="provider"></param>
            <returns></returns>
        </member>
        <member name="T:Telegrator.TelegramBotHostExtensions">
            <summary>
            Provides useful methods to adjust <see cref="T:Telegrator.Hosting.ITelegramBotHost"/>
            </summary>
        </member>
        <member name="M:Telegrator.TelegramBotHostExtensions.UseTelegrator(Microsoft.Extensions.Hosting.IHost)">
            <summary>
            Replaces the initialization logic from TelegramBotWebHost constructor. 
            Initializes the bot and logs handlers on application startup.
            </summary>
        </member>
        <member name="M:Telegrator.TelegramBotHostExtensions.SetBotCommands(Microsoft.Extensions.Hosting.IHost)">
            <summary>
            Configures bots available commands depending on what handlers was registered
            </summary>
            <param name="botHost"></param>
            <returns></returns>
        </member>
        <member name="M:Telegrator.TelegramBotHostExtensions.AddLoggingAdapter(Microsoft.Extensions.Hosting.IHost)">
            <summary>
            Adds a Microsoft.Extensions.Logging adapter to Alligator using a logger factory.
            </summary>
            <param name="host"></param>
        </member>
        <member name="T:Telegrator.ReflectionExtensions">
            <summary>
            Provides extension methods for reflection and type inspection.
            </summary>
        </member>
        <member name="M:Telegrator.ReflectionExtensions.IsPreBuildingRoutine(System.Type,System.Reflection.MethodInfo@)">
            <summary>
            Checks if a type implements the <see cref="T:Telegrator.Handlers.IPreBuildingRoutine"/> interface.
            </summary>
            <param name="handlerType">The type to check.</param>
            <param name="routineMethod"></param>
            <returns>True if the type implements IPreBuildingRoutine; otherwise, false.</returns>
        </member>
    </members>
</doc>