kosyakmakc/TelegramBotFramework
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Optimization of API calls within DeviceSession

Browse Source 
- replacing all API calls with new method "API" to cover APIRequestExceptions
- adding IDeviceSession interface for future use
- adding "API" method without result
This commit is contained in:
FlorianDahn 2020-12-22 21:55:47 +01:00
parent 46160b54ae
commit 73ba36ea2b
2 changed files with 84 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
TelegramBotBase/Interfaces/IDeviceSession.cs Normal file
View File

@ -0,0 +1,42 @@
using System;
using System.Collections.Generic;
using System.Text;
using TelegramBotBase.Form;
namespace TelegramBotBase.Interfaces
{
interface IDeviceSession
{
/// <summary>
/// Device or chat id
/// </summary>
long DeviceId { get; set; }
/// <summary>
/// Username of user or group
/// </summary>
String ChatTitle { get; set; }
/// <summary>
/// When did any last action happend (message received or button clicked)
/// </summary>
DateTime LastAction { get; set; }
/// <summary>
/// Returns the form where the user/group is at the moment.
/// </summary>
FormBase ActiveForm { get; set; }
/// <summary>
/// Returns the previous shown form
/// </summary>
FormBase PreviousForm { get; set; }
/// <summary>
/// contains if the form has been switched (navigated)
/// </summary>
bool FormSwitched { get; set; }
}
}

92
TelegramBotBase/Sessions/DeviceSession.cs
View File

@ -16,6 +16,7 @@ using TelegramBotBase.Args;
using TelegramBotBase.Base; using TelegramBotBase.Base;
using TelegramBotBase.Exceptions; using TelegramBotBase.Exceptions;
using TelegramBotBase.Form; using TelegramBotBase.Form;
using TelegramBotBase.Interfaces;
using TelegramBotBase.Markdown; using TelegramBotBase.Markdown;
namespace TelegramBotBase.Sessions namespace TelegramBotBase.Sessions
@ -23,7 +24,7 @@ namespace TelegramBotBase.Sessions
/// <summary> /// <summary>
/// Base class for a device/chat session /// Base class for a device/chat session
/// </summary> /// </summary>
public class DeviceSession public class DeviceSession : IDeviceSession
{ {
/// <summary> /// <summary>
/// Device or chat id /// Device or chat id
@ -154,7 +155,7 @@ namespace TelegramBotBase.Sessions
try try
{ {
return await this.Client.TelegramClient.EditMessageTextAsync(this.DeviceId, messageId, text, parseMode, replyMarkup: markup); return await API(a => a.EditMessageTextAsync(this.DeviceId, messageId, text, parseMode, replyMarkup: markup));
} }
catch catch
{ {
@ -181,7 +182,7 @@ namespace TelegramBotBase.Sessions
try try
{ {
return await this.Client.TelegramClient.EditMessageTextAsync(this.DeviceId, messageId, text, parseMode, replyMarkup: markup); return await API(a => a.EditMessageTextAsync(this.DeviceId, messageId, text, parseMode, replyMarkup: markup));
} }
catch catch
{ {
@ -210,7 +211,7 @@ namespace TelegramBotBase.Sessions
try try
{ {
return await this.Client.TelegramClient.EditMessageTextAsync(this.DeviceId, message.MessageId, message.Text, parseMode, replyMarkup: markup); return await API(a => a.EditMessageTextAsync(this.DeviceId, message.MessageId, message.Text, parseMode, replyMarkup: markup));
} }
catch catch
{ {
@ -232,7 +233,7 @@ namespace TelegramBotBase.Sessions
try try
{ {
return await this.Client.TelegramClient.EditMessageReplyMarkupAsync(this.DeviceId, messageId, bf); return await API(a => a.EditMessageReplyMarkupAsync(this.DeviceId, messageId, bf));
} }
catch catch
{ {
@ -271,15 +272,7 @@ namespace TelegramBotBase.Sessions
try try
{ {
m = await (this.Client.TelegramClient.SendTextMessageAsync(deviceId, text, parseMode, replyToMessageId: replyTo, replyMarkup: markup, disableNotification: disableNotification)); m = await API(a => a.SendTextMessageAsync(deviceId, text, parseMode, replyToMessageId: replyTo, replyMarkup: markup, disableNotification: disableNotification));
OnMessageSent(new MessageSentEventArgs(m));
}
catch (ApiRequestException ex)
{
await Task.Delay(ex.Parameters.RetryAfter);
m = await (this.Client.TelegramClient.SendTextMessageAsync(deviceId, text, parseMode, replyToMessageId: replyTo, replyMarkup: markup, disableNotification: disableNotification));
OnMessageSent(new MessageSentEventArgs(m)); OnMessageSent(new MessageSentEventArgs(m));
} }
@ -331,14 +324,10 @@ namespace TelegramBotBase.Sessions
try try
{ {
m = await (this.Client.TelegramClient.SendTextMessageAsync(this.DeviceId, text, parseMode, replyToMessageId: replyTo, replyMarkup: markup, disableNotification: disableNotification)); m = await API(a => a.SendTextMessageAsync(this.DeviceId, text, parseMode, replyToMessageId: replyTo, replyMarkup: markup, disableNotification: disableNotification));
OnMessageSent(new MessageSentEventArgs(m)); OnMessageSent(new MessageSentEventArgs(m));
} }
catch (ApiRequestException)
{
return null;
}
catch catch
{ {
return null; return null;
@ -374,14 +363,10 @@ namespace TelegramBotBase.Sessions
try try
{ {
m = await (this.Client.TelegramClient.SendTextMessageAsync(this.DeviceId, text, parseMode, replyToMessageId: replyTo, replyMarkup: markup, disableNotification: disableNotification)); m = await API(a => a.SendTextMessageAsync(this.DeviceId, text, parseMode, replyToMessageId: replyTo, replyMarkup: markup, disableNotification: disableNotification));
OnMessageSent(new MessageSentEventArgs(m)); OnMessageSent(new MessageSentEventArgs(m));
} }
catch (ApiRequestException)
{
return null;
}
catch catch
{ {
return null; return null;
@ -409,14 +394,10 @@ namespace TelegramBotBase.Sessions
try try
{ {
m = await this.Client.TelegramClient.SendPhotoAsync(this.DeviceId, file, caption: caption, parseMode: parseMode, replyToMessageId: replyTo, replyMarkup: markup, disableNotification: disableNotification); m = await API(a => a.SendPhotoAsync(this.DeviceId, file, caption: caption, parseMode: parseMode, replyToMessageId: replyTo, replyMarkup: markup, disableNotification: disableNotification));
OnMessageSent(new MessageSentEventArgs(m)); OnMessageSent(new MessageSentEventArgs(m));
} }
catch (ApiRequestException)
{
return null;
}
catch catch
{ {
return null; return null;
@ -482,14 +463,10 @@ namespace TelegramBotBase.Sessions
try try
{ {
m = await this.Client.TelegramClient.SendVideoAsync(this.DeviceId, file, caption: caption, parseMode: parseMode, replyToMessageId: replyTo, replyMarkup: markup, disableNotification: disableNotification); m = await API(a => a.SendVideoAsync(this.DeviceId, file, caption: caption, parseMode: parseMode, replyToMessageId: replyTo, replyMarkup: markup, disableNotification: disableNotification));
OnMessageSent(new MessageSentEventArgs(m)); OnMessageSent(new MessageSentEventArgs(m));
} }
catch (ApiRequestException)
{
return null;
}
catch catch
{ {
return null; return null;
@ -517,14 +494,10 @@ namespace TelegramBotBase.Sessions
try try
{ {
m = await this.Client.TelegramClient.SendVideoAsync(this.DeviceId, new InputOnlineFile(url), parseMode: parseMode, replyToMessageId: replyTo, replyMarkup: markup, disableNotification: disableNotification); m = await API(a => a.SendVideoAsync(this.DeviceId, new InputOnlineFile(url), parseMode: parseMode, replyToMessageId: replyTo, replyMarkup: markup, disableNotification: disableNotification));
OnMessageSent(new MessageSentEventArgs(m)); OnMessageSent(new MessageSentEventArgs(m));
} }
catch (ApiRequestException)
{
return null;
}
catch catch
{ {
return null; return null;
@ -595,7 +568,7 @@ namespace TelegramBotBase.Sessions
markup = buttons; markup = buttons;
} }
var m = await this.Client.TelegramClient.SendDocumentAsync(this.DeviceId, document, caption, replyMarkup: markup, disableNotification: disableNotification, replyToMessageId: replyTo); var m = await API(a => a.SendDocumentAsync(this.DeviceId, document, caption, replyMarkup: markup, disableNotification: disableNotification, replyToMessageId: replyTo));
OnMessageSent(new MessageSentEventArgs(m)); OnMessageSent(new MessageSentEventArgs(m));
@ -609,7 +582,7 @@ namespace TelegramBotBase.Sessions
/// <returns></returns> /// <returns></returns>
public async Task SetAction(ChatAction action) public async Task SetAction(ChatAction action)
{ {
await this.Client.TelegramClient.SendChatActionAsync(this.DeviceId, action); await API(a => a.SendChatActionAsync(this.DeviceId, action));
} }
/// <summary> /// <summary>
@ -623,7 +596,7 @@ namespace TelegramBotBase.Sessions
{ {
var rck = new ReplyKeyboardMarkup(KeyboardButton.WithRequestContact(buttonText)); var rck = new ReplyKeyboardMarkup(KeyboardButton.WithRequestContact(buttonText));
rck.OneTimeKeyboard = OneTimeOnly; rck.OneTimeKeyboard = OneTimeOnly;
return await this.Client.TelegramClient.SendTextMessageAsync(this.DeviceId, requestMessage, replyMarkup: rck); return await API(a => a.SendTextMessageAsync(this.DeviceId, requestMessage, replyMarkup: rck));
} }
/// <summary> /// <summary>
@ -637,7 +610,7 @@ namespace TelegramBotBase.Sessions
{ {
var rcl = new ReplyKeyboardMarkup(KeyboardButton.WithRequestLocation(buttonText)); var rcl = new ReplyKeyboardMarkup(KeyboardButton.WithRequestLocation(buttonText));
rcl.OneTimeKeyboard = OneTimeOnly; rcl.OneTimeKeyboard = OneTimeOnly;
return await this.Client.TelegramClient.SendTextMessageAsync(this.DeviceId, requestMessage, replyMarkup: rcl); return await API(a => a.SendTextMessageAsync(this.DeviceId, requestMessage, replyMarkup: rcl));
} }
public async Task<Message> HideReplyKeyboard(String closedMsg = "Closed", bool autoDeleteResponse = true) public async Task<Message> HideReplyKeyboard(String closedMsg = "Closed", bool autoDeleteResponse = true)
@ -669,7 +642,7 @@ namespace TelegramBotBase.Sessions
{ {
try try
{ {
await this.Client.TelegramClient.DeleteMessageAsync(this.DeviceId, messageId); await API(a => a.DeleteMessageAsync(this.DeviceId, messageId));
return true; return true;
} }
@ -696,7 +669,7 @@ namespace TelegramBotBase.Sessions
{ {
try try
{ {
await this.Client.TelegramClient.SetChatPermissionsAsync(this.DeviceId, permissions); await API(a => a.SetChatPermissionsAsync(this.DeviceId, permissions));
} }
catch catch
{ {
@ -710,7 +683,7 @@ namespace TelegramBotBase.Sessions
{ {
try try
{ {
await this.Client.TelegramClient.RestrictChatMemberAsync(this.DeviceId, userId, permissions, until); await API(a => a.RestrictChatMemberAsync(this.DeviceId, userId, permissions, until));
} }
catch catch
{ {
@ -722,7 +695,7 @@ namespace TelegramBotBase.Sessions
{ {
try try
{ {
return await this.Client.TelegramClient.GetChatMemberAsync(this.DeviceId, userId); return await API(a => a.GetChatMemberAsync(this.DeviceId, userId));
} }
catch catch
{ {
@ -735,7 +708,7 @@ namespace TelegramBotBase.Sessions
{ {
try try
{ {
await this.Client.TelegramClient.KickChatMemberAsync(this.DeviceId, userId, until); await API(a => a.KickChatMemberAsync(this.DeviceId, userId, until));
} }
catch catch
{ {
@ -747,7 +720,7 @@ namespace TelegramBotBase.Sessions
{ {
try try
{ {
await this.Client.TelegramClient.UnbanChatMemberAsync(this.DeviceId, userId); await API(a => a.UnbanChatMemberAsync(this.DeviceId, userId));
} }
catch catch
{ {
@ -780,7 +753,7 @@ namespace TelegramBotBase.Sessions
{ {
return await call(this.Client.TelegramClient); return await call(this.Client.TelegramClient);
} }
catch(ApiRequestException ex) catch (ApiRequestException ex)
{ {
await Task.Delay(ex.Parameters.RetryAfter); await Task.Delay(ex.Parameters.RetryAfter);
@ -788,6 +761,25 @@ namespace TelegramBotBase.Sessions
} }
} }
/// <summary>
/// This will call a function on the TelegramClient and automatically Retry if an limit has been exceeded.
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="call"></param>
/// <returns></returns>
public async Task API(Func<Telegram.Bot.TelegramBotClient, Task> call)
{
try
{
await call(this.Client.TelegramClient);
}
catch (ApiRequestException ex)
{
await Task.Delay(ex.Parameters.RetryAfter);
await call(this.Client.TelegramClient);
}
}
#region "Events" #region "Events"