Telegrator/docs/Telegrator.Hosting.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>Telegrator.Hosting</name>
    </assembly>
    <members>
        <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.IConfiguration)">
            <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.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)">
            <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>
        </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(Microsoft.Extensions.Hosting.HostApplicationBuilderSettings)">
            <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(Microsoft.Extensions.Hosting.HostApplicationBuilderSettings)">
            <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="P:Telegrator.Hosting.TelegramBotHostBuilder.Properties">
            <inheritdoc/>
        </member>
        <member name="P:Telegrator.Hosting.TelegramBotHostBuilder.Metrics">
            <inheritdoc/>
        </member>
        <member name="M:Telegrator.Hosting.TelegramBotHostBuilder.#ctor(Microsoft.Extensions.Hosting.HostApplicationBuilder,Microsoft.Extensions.Hosting.HostApplicationBuilderSettings)">
            <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.TelegratorOptions,Microsoft.Extensions.Hosting.HostApplicationBuilderSettings)">
            <summary>
            Initializes a new instance of the <see cref="T:Telegrator.Hosting.TelegramBotHostBuilder"/> class.
            </summary>
            <param name="hostApplicationBuilder"></param>
            <param name="options"></param>
            <param name="settings"></param>
        </member>
        <member name="M:Telegrator.Hosting.TelegramBotHostBuilder.#ctor(Microsoft.Extensions.Hosting.HostApplicationBuilder,Telegrator.Core.IHandlersCollection,Microsoft.Extensions.Hosting.HostApplicationBuilderSettings)">
            <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.#ctor(Microsoft.Extensions.Hosting.HostApplicationBuilder,Telegrator.Core.IHandlersCollection,Telegrator.TelegratorOptions,Microsoft.Extensions.Hosting.HostApplicationBuilderSettings)">
            <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="options"></param>
            <param name="settings"></param>
        </member>
        <member name="M:Telegrator.Hosting.TelegramBotHostBuilder.Build">
            <summary>
            Builds the host.
            </summary>
            <returns></returns>
        </member>
        <member name="M:Telegrator.Hosting.TelegramBotHostBuilder.ConfigureContainer``1(Microsoft.Extensions.DependencyInjection.IServiceProviderFactory{``0},System.Action{``0})">
            <inheritdoc/>
        </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="botClient"></param>
            <param name="updateRouter"></param>
            <param name="options"></param>
            <param name="logger"></param>
        </member>
        <member name="M:Telegrator.Polling.HostedUpdateReceiver.#ctor(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="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.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,Telegrator.Core.States.IStateStorage,Microsoft.Extensions.Options.IOptions{Telegrator.TelegratorOptions},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})">
            <inheritdoc/>
        </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="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)">
            <inheritdoc/>
        </member>
        <member name="M:Telegrator.Providers.HostHandlersProvider.GetHandlerInstance(Telegrator.Core.Descriptors.HandlerDescriptor,System.Threading.CancellationToken)">
            <inheritdoc/>
        </member>
        <member name="T:Telegrator.HostBuilderExtensions">
            <summary>
            Provides extension methods for <see cref="T:Microsoft.Extensions.Hosting.IHostApplicationBuilder"/> to configure Telegrator.
            </summary>
        </member>
        <member name="F:Telegrator.HostBuilderExtensions.HandlersCollectionPropertyKey">
            <summary>
            The key used to store the <see cref="T:Telegrator.Core.IHandlersCollection"/> in the builder properties.
            </summary>
        </member>
        <member name="M:Telegrator.HostBuilderExtensions.get_Handlers(Microsoft.Extensions.Hosting.IHostApplicationBuilder)">
            <inheritdoc cref="P:Telegrator.HostBuilderExtensions.&lt;G&gt;$605D8CCF64349EA050C790D67C500BD9.Handlers"/>
        </member>
        <member name="M:Telegrator.HostBuilderExtensions.AddTelegrator(Microsoft.Extensions.Hosting.IHostApplicationBuilder,Telegrator.TelegratorOptions,Telegrator.Core.IHandlersCollection)">
            <summary>
            Replaces TelegramBotWebHostBuilder. Configures DI, options, and handlers.
            </summary>
        </member>
        <member name="P:Telegrator.HostBuilderExtensions.&lt;G&gt;$605D8CCF64349EA050C790D67C500BD9.Handlers">
            <summary>
            Gets the <see cref="T:Telegrator.Core.IHandlersCollection"/> from the builder properties.
            </summary>
        </member>
        <member name="T:Telegrator.ServicesCollectionExtensions">
            <summary>
            Contains extensions for <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>
            Provides method to configure Telegram Bot Host
            </summary>
        </member>
        <member name="M:Telegrator.ServicesCollectionExtensions.AddStateStorage``1(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
            <summary>
            Registers <see cref="T:Telegrator.Core.States.IStateStorage"/> service
            </summary>
            <typeparam name="TStorage"></typeparam>
            <param name="services"></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 Telegram bot Host
            </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.LoggerExtensions">
            <summary>
            Provides extension methods for logging Telegrator-related information.
            </summary>
        </member>
        <member name="M:Telegrator.LoggerExtensions.LogHandlers(Microsoft.Extensions.Logging.ILogger,Telegrator.Core.IHandlersCollection)">
            <summary>
            Logs the registered handlers to the specified logger.
            </summary>
            <param name="logger">The logger to write to.</param>
            <param name="handlers">The collection of handlers to log.</param>
        </member>
    </members>
</doc>