Telegrator/docs/Telegrator.Hosting.WideBot.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>Telegrator.Hosting.WideBot</name>
    </assembly>
    <members>
        <member name="T:Telegrator.Mediation.HostedWideBotUpdateReceiver">
            <summary>
            Service for receiving updates for Hosted wide telegram bots and queuing them to router
            </summary>
            <param name="logger"></param>
            <param name="botClient"></param>
            <param name="updateRouter"></param>
            <param name="options"></param>
        </member>
        <member name="M:Telegrator.Mediation.HostedWideBotUpdateReceiver.#ctor(Microsoft.Extensions.Logging.ILogger{Telegrator.Mediation.HostedWideBotUpdateReceiver},Telegram.Bot.ITelegramBotClient,Telegrator.Core.IUpdateRouter,Microsoft.Extensions.Options.IOptions{Telegrator.WideBotOptions})">
            <summary>
            Service for receiving updates for Hosted wide telegram bots and queuing them to router
            </summary>
            <param name="logger"></param>
            <param name="botClient"></param>
            <param name="updateRouter"></param>
            <param name="options"></param>
        </member>
        <member name="M:Telegrator.Mediation.HostedWideBotUpdateReceiver.ExecuteAsync(System.Threading.CancellationToken)">
            <inheritdoc/>
        </member>
        <member name="T:Telegrator.Mediation.WideUpdateReceiver">
            <summary>
            Reactive implementation of <see cref="T:Telegrator.Core.IUpdateReceiver"/> for polling updates from Telegram.
            Provides custom update receiving logic with error handling and configuration options.
            </summary>
            <param name="client">The Telegram bot client for making API requests.</param>
        </member>
        <member name="M:Telegrator.Mediation.WideUpdateReceiver.#ctor(Telegram.Bot.WTelegramBotClient)">
            <summary>
            Reactive implementation of <see cref="T:Telegrator.Core.IUpdateReceiver"/> for polling updates from Telegram.
            Provides custom update receiving logic with error handling and configuration options.
            </summary>
            <param name="client">The Telegram bot client for making API requests.</param>
        </member>
        <member name="M:Telegrator.Mediation.WideUpdateReceiver.ReceiveAsync(Telegram.Bot.Polling.IUpdateHandler,System.Threading.CancellationToken)">
            <inheritdoc/>
        </member>
        <member name="T:Telegrator.TelegratorWClient">
            <summary>
            Client class for the Telegrator library with Wider functionality, provided by WTelegramBotClient.
            Extends TelegramBotClient with reactive capabilities for handling updates.
            </summary>
        </member>
        <member name="P:Telegrator.TelegratorWClient.Options">
            <inheritdoc/>
        </member>
        <member name="P:Telegrator.TelegratorWClient.Handlers">
            <inheritdoc/>
        </member>
        <member name="P:Telegrator.TelegratorWClient.BotInfo">
            <inheritdoc/>
        </member>
        <member name="P:Telegrator.TelegratorWClient.UpdateRouter">
            <inheritdoc/>
        </member>
        <member name="M:Telegrator.TelegratorWClient.#ctor(Telegram.Bot.WTelegramBotClientOptions,Telegrator.TelegratorOptions,System.Net.Http.HttpClient,System.Threading.CancellationToken)">
            <summary>
            Initializes new instance of <see cref="T:Telegrator.TelegratorWClient"/>
            </summary>
            <param name="wOptions"></param>
            <param name="telegratorOptions"></param>
            <param name="httpClient"></param>
            <param name="cancellationToken"></param>
        </member>
        <member name="M:Telegrator.TelegratorWClient.StartReceiving(Telegram.Bot.Polling.ReceiverOptions,System.Threading.CancellationToken)">
            <inheritdoc/>
        </member>
        <member name="M:Telegrator.TelegratorWClient.StartReceivingAsync(Telegram.Bot.Polling.ReceiverOptions,System.Threading.CancellationToken)">
            <inheritdoc/>
        </member>
        <member name="T:Telegrator.HandlersExtensions">
            <summary>
            Provides extensions memebrs for <see cref="T:Telegrator.Core.Handlers.UpdateHandlerBase"/> for easy access to Wider bot functions and update
            </summary>
        </member>
        <member name="M:Telegrator.HandlersExtensions.get_WClient``1(Telegrator.Core.Handlers.AbstractUpdateHandler{``0})">
            <inheritdoc cref="P:Telegrator.HandlersExtensions.&lt;G&gt;$F89AF16C011F73161937A1614DCDDD7A`1.WClient"/>
        </member>
        <member name="M:Telegrator.HandlersExtensions.get_WideUpdate``1(Telegrator.Core.Handlers.AbstractUpdateHandler{``0})">
            <inheritdoc cref="P:Telegrator.HandlersExtensions.&lt;G&gt;$F89AF16C011F73161937A1614DCDDD7A`1.WideUpdate"/>
        </member>
        <member name="M:Telegrator.HandlersExtensions.get_TLUpdate``1(Telegrator.Core.Handlers.AbstractUpdateHandler{``0})">
            <inheritdoc cref="P:Telegrator.HandlersExtensions.&lt;G&gt;$F89AF16C011F73161937A1614DCDDD7A`1.TLUpdate"/>
        </member>
        <member name="M:Telegrator.HandlersExtensions.AsWClient(Telegram.Bot.ITelegramBotClient)">
            <summary>
            Casts Update to <see cref="T:Telegram.Bot.WTelegramBotClient"/>
            </summary>
        </member>
        <member name="M:Telegrator.HandlersExtensions.AsWUpdate(Telegram.Bot.Types.Update)">
            <summary>
            Casts Update to <see cref="T:WTelegram.Types.Update"/>
            </summary>
        </member>
        <member name="P:Telegrator.HandlersExtensions.&lt;G&gt;$F89AF16C011F73161937A1614DCDDD7A`1.WClient">
            <summary>
            Casts Update to <see cref="T:Telegram.Bot.WTelegramBotClient"/>
            </summary>
        </member>
        <member name="P:Telegrator.HandlersExtensions.&lt;G&gt;$F89AF16C011F73161937A1614DCDDD7A`1.WideUpdate">
            <summary>
            Casts Update to <see cref="T:WTelegram.Types.Update"/>
            </summary>
        </member>
        <member name="P:Telegrator.HandlersExtensions.&lt;G&gt;$F89AF16C011F73161937A1614DCDDD7A`1.TLUpdate">
            <summary>
            Casts Update to <see cref="T:TL.Update"/>
            </summary>
        </member>
        <member name="T:Telegrator.WideHostBuilderExtensions">
            <summary>
            Provides extension methods for <see cref="T:Microsoft.Extensions.Hosting.IHostApplicationBuilder"/> to configure Telegrator.
            </summary>
        </member>
        <member name="M:Telegrator.WideHostBuilderExtensions.AddWideTelegrator(Microsoft.Extensions.Hosting.IHostApplicationBuilder,System.Func{System.IServiceProvider,System.Data.Common.DbConnection},System.Action{Telegrator.Hosting.ITelegramBotHostBuilder},Telegrator.TelegratorOptions,Telegrator.Core.IHandlersCollection)">
            <summary>
            Replaces TelegramBotHostBuilder. Configures DI, options, and handlers.
            </summary>
        </member>
        <member name="M:Telegrator.WideHostBuilderExtensions.AddWideTelegrator(Microsoft.Extensions.Hosting.IHostApplicationBuilder,System.Func{System.IServiceProvider,System.Data.Common.DbConnection},Telegrator.TelegratorOptions,Telegrator.Core.IHandlersCollection)">
            <summary>
            Replaces TelegramBotHostBuilder. Configures DI, options, and handlers.
            </summary>
        </member>
        <member name="M:Telegrator.WideHostBuilderExtensions.AddWideTelegratorInternal(Microsoft.Extensions.DependencyInjection.IServiceCollection,Microsoft.Extensions.Configuration.IConfiguration,System.Collections.Generic.IDictionary{System.Object,System.Object},System.Func{System.IServiceProvider,System.Data.Common.DbConnection},Telegrator.Core.IHandlersCollection@,Telegrator.TelegratorOptions)">
            <summary>
            Replaces TelegramBotHostBuilder. Configures DI, options, and handlers.
            </summary>
        </member>
        <member name="T:Telegrator.WideBotServiceCollectionExtensions">
            <summary>
            Contains extensions for <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>
            Provides method to configure Telegram Bot WebHost
            </summary>
        </member>
        <member name="M:Telegrator.WideBotServiceCollectionExtensions.ConfigureWideTelegram(Microsoft.Extensions.DependencyInjection.IServiceCollection,Telegram.Bot.WTelegramBotClientOptions)">
            <summary>
            Adds WTelegramBotClientOptions to services
            </summary>
            <param name="services"></param>
            <param name="options"></param>
            <returns></returns>
        </member>
        <member name="M:Telegrator.WideBotServiceCollectionExtensions.ConfigureWideBot(Microsoft.Extensions.DependencyInjection.IServiceCollection,Telegrator.WideBotOptions)">
            <summary>
            Adds WTelegramBotClientOptions to services
            </summary>
            <param name="services"></param>
            <param name="options"></param>
            <returns></returns>
        </member>
        <member name="M:Telegrator.WideBotServiceCollectionExtensions.AddMTProtoUpdateReceiver(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Boolean)">
            <summary>
            Adds WTelegramBotClient 
            </summary>
            <param name="services"></param>
            <param name="useHttp"></param>
            <returns></returns>
        </member>
        <member name="T:Telegrator.WideTelegramBotHostExtensions">
            <summary>
            Provides useful methods to adjust Telegram bot Host
            </summary>
        </member>
        <member name="M:Telegrator.WideTelegramBotHostExtensions.UseWideTelegrator(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="T:Telegrator.WideBotOptions">
            <summary>
            Represents configuration options for initializing and customizing the behavior of a WideBot instance.
            </summary>
            <remarks>Use this class to specify required API credentials, optional proxy settings, update handling
            preferences, and SQL command detection for WideBot. All required properties must be set before using the options
            with a WideBot instance.
            </remarks>
        </member>
        <member name="P:Telegrator.WideBotOptions.ApiId">
            <inheritdoc cref="P:Telegram.Bot.WTelegramBotClientOptions.ApiId"/>
        </member>
        <member name="P:Telegrator.WideBotOptions.ApiHash">
            <inheritdoc cref="P:Telegram.Bot.WTelegramBotClientOptions.ApiHash"/>
        </member>
        <member name="P:Telegrator.WideBotOptions.MTProxy">
            <inheritdoc cref="P:Telegram.Bot.WTelegramBotClientOptions.MTProxy"/>
        </member>
        <member name="P:Telegrator.WideBotOptions.SqlCommands">
            <inheritdoc cref="P:Telegram.Bot.WTelegramBotClientOptions.SqlCommands"/>
        </member>
        <member name="P:Telegrator.WideBotOptions.DropPendingUpdates">
            <summary>
            Gets or sets a value indicating whether pending updates should be discarded.
            </summary>
        </member>
    </members>
</doc>