add style

Add style field support for keyboard buttons

Author: Al-Muhandis

fptelegram.lpk

@@ -23,7 +23,7 @@
     </CompilerOptions>
     <Description Value="Telegram bots API library"/>
     <License Value="MIT License"/>
-    <Version Release="10"/>
+    <Version Release="11"/>
     <Files Count="6">
       <Item1>
         <Filename Value="tgsendertypes.pas"/>

test/testtelegram.pas

@@ -85,6 +85,13 @@   TTestReactionUpdates=class(TTestCase)
     procedure ParseMessageReactionCountUpdate;
   end;
 
+  { TTestSenderTypes }
+
+  TTestSenderTypes=class(TTestCase)
+  published
+    procedure KeyboardButtonsStyle;
+  end;
+
   { TTestReceiveLongPollingBase }
   { Test receiving updates via longpolling from the test bot. Please send test messages to the bot
     immediately before running the test! }
@@ -467,6 +474,38 @@ procedure TTestMessageQuote.ParseMessageExternalReply;
   end;
 end;
 
+{ TTestSenderTypes }
+
+procedure TTestSenderTypes.KeyboardButtonsStyle;
+var
+  aReplyMarkup: TReplyMarkup;
+  aReplyButtons: TKeyboardButtons;
+  aInlineButtons: TInlineKeyboardButtons;
+  aReplyButton: TKeyboardButton;
+  aInlineButton: TInlineKeyboardButton;
+begin
+  aReplyMarkup:=TReplyMarkup.Create;
+  try
+    aReplyButtons:=aReplyMarkup.CreateReplyKeyboard.Add;
+    aReplyButton:=TKeyboardButton.Create('Reply button');
+    aReplyButton.Style:='primary';
+    aReplyButtons.Add(aReplyButton);
+
+    aInlineButtons:=aReplyMarkup.CreateInlineKeyBoard.Add;
+    aInlineButton:=TInlineKeyboardButton.Create('Inline button');
+    aInlineButton.Callback_Data:='cb';
+    aInlineButton.Style:='secondary';
+    aInlineButtons.Add(aInlineButton);
+
+    AssertEquals('primary', aReplyButton.Style);
+    AssertEquals('secondary', aInlineButton.Style);
+    AssertTrue('Reply keyboard JSON should contain style', Pos('"style" : "primary"', aReplyMarkup.AsJSON)>0);
+    AssertTrue('Inline keyboard JSON should contain style', Pos('"style" : "secondary"', aReplyMarkup.AsJSON)>0);
+  finally
+    aReplyMarkup.Free;
+  end;
+end;
+
 { TTestSender }
 
 procedure TTestSender.SetUp;
@@ -794,6 +833,6 @@ procedure TTestSender.getChatAdministators;
 
 initialization
   RegisterTests([TTestSender, TTestSenderProcedure, TTestProxySender, TTestReceiveLongPolling,
-    TTestPayments, TTestReactionUpdates, TTestMessageQuote]);
+    TTestPayments, TTestReactionUpdates, TTestMessageQuote, TTestSenderTypes]);
 
 end.

tgsendertypes.pas

@@ -32,14 +32,14 @@   TInlineKeyboard = class;
   TInlineQueryEvent = procedure (ASender: TObject; AnInlineQuery: TTelegramInlineQueryObj) of object;
   TChosenInlineResultEvent = procedure (ASender: TObject;
     AChosenInlineResult: TTelegramChosenInlineResultObj) of object;
-  TPreCheckoutQueryEvent = procedure (ASender: TObject;
-    APreCheckoutQuery: TTelegramPreCheckOutQuery) of object;
-  TSuccessfulPaymentEvent = procedure (ASender: TObject;
-    ASuccessfulPayment: TTelegramSuccessfulPayment) of object;
-  TMessageReactionEvent = procedure (ASender: TObject;
-    AMessageReaction: TTelegramMessageReactionUpdated) of object;
-  TMessageReactionCountEvent = procedure (ASender: TObject;
-    AMessageReactionCount: TTelegramMessageReactionCountUpdated) of object;
+  TPreCheckoutQueryEvent = procedure (ASender: TObject;
+    APreCheckoutQuery: TTelegramPreCheckOutQuery) of object;
+  TSuccessfulPaymentEvent = procedure (ASender: TObject;
+    ASuccessfulPayment: TTelegramSuccessfulPayment) of object;
+  TMessageReactionEvent = procedure (ASender: TObject;
+    AMessageReaction: TTelegramMessageReactionUpdated) of object;
+  TMessageReactionCountEvent = procedure (ASender: TObject;
+    AMessageReactionCount: TTelegramMessageReactionCountUpdated) of object;
 
   { TStringHash }
 
@@ -108,13 +108,16 @@   TKeyboardButton = class(TJSONObject)
   private
     function GetRequestContact: Boolean;
     function GetRequestLocation: Boolean;
+    function GetStyle: String;
     function Gettext: String;
     procedure SetRequestContact(AValue: Boolean);
     procedure SetRequestLocation(AValue: Boolean);
+    procedure SetStyle(const AValue: String);
     procedure Settext(AValue: String);
   public
     constructor Create(const AText: String);
     property text: String read Gettext write Settext;
+    property Style: String read GetStyle write SetStyle; // Optional
     property RequestContact: Boolean read GetRequestContact write SetRequestContact; // Optional
     property RequestLocation: Boolean read GetRequestLocation write SetRequestLocation; // Optional
   end;
@@ -142,16 +145,19 @@   TInlineKeyboardButton = class(TJSONObject)
     function Getcallback_data: String;
     function Getswitch_inline_query: String;
     function Getswitch_inline_query_current_chat: String;
+    function GetStyle: String;
     function Gettext: String;
     function Geturl: String;
     procedure Setcallback_data(AValue: String);
+    procedure SetStyle(AValue: String);
     procedure Setswitch_inline_query(AValue: String);
     procedure Setswitch_inline_query_current_chat(AValue: String);
     procedure Settext(AValue: String);
     procedure Seturl(AValue: String);
   public
     constructor Create(const AText: String);
     property text: String read Gettext write Settext;
+    property Style: String read GetStyle write SetStyle;
     property url: String read Geturl write Seturl;
     property callback_data: String read Getcallback_data write Setcallback_data;
     property switch_inline_query: String read Getswitch_inline_query write Setswitch_inline_query;
@@ -454,10 +460,10 @@   TTelegramSender = class
     FOnReceiveEditedChannelPost: TMessageEvent;
     FOnReceiveEditedMessage: TMessageEvent;
     FOnReceiveInlineQuery: TInlineQueryEvent;
-    FOnReceiveMessage: TMessageEvent;
-    FOnReceiveMessageReaction: TMessageReactionEvent;
-    FOnReceiveMessageReactionCount: TMessageReactionCountEvent;
-    FOnReceiveMyChatMemberUpdated: TChatMemberEvent;
+    FOnReceiveMessage: TMessageEvent;
+    FOnReceiveMessageReaction: TMessageReactionEvent;
+    FOnReceiveMessageReactionCount: TMessageReactionCountEvent;
+    FOnReceiveMyChatMemberUpdated: TChatMemberEvent;
     FOnReceivePreCheckoutQuery: TPreCheckoutQueryEvent;
     FOnReceiveSuccessfulPayment: TMessageEvent;
     FUpdate: TTelegramUpdateObj;
@@ -528,14 +534,14 @@   TTelegramSender = class
     procedure DoReceiveCallbackQuery(ACallback: TCallbackQueryObj); virtual;
     procedure DoReceiveChannelPost(AChannelPost: TTelegramMessageObj); virtual;
     procedure DoReceiveEditedChannelPost(AChannelPost: TTelegramMessageObj); virtual;
-    procedure DoReceiveInlineQuery(AnInlineQuery: TTelegramInlineQueryObj);  virtual;
-    procedure DoReceiveChosenInlineResult(AChosenInlineResult: TTelegramChosenInlineResultObj); virtual;
-    procedure DoReceivePreCheckoutQuery(APreCheckoutQuery: TTelegramPreCheckOutQuery); virtual;  
-    procedure DoReceiveMyChatMemberQuery(AMyChatMember: TTelegramChatMemberUpdated); virtual;
-    procedure DoReceiveChatMemberQuery(AChatMember: TTelegramChatMemberUpdated); virtual;
-    procedure DoReceiveMessageReaction(AMessageReaction: TTelegramMessageReactionUpdated); virtual;
-    procedure DoReceiveMessageReactionCount(AMessageReactionCount: TTelegramMessageReactionCountUpdated); virtual;
-    procedure DoReceiveSuccessfulPayment(AMessage: TTelegramMessageObj); virtual;  
+    procedure DoReceiveInlineQuery(AnInlineQuery: TTelegramInlineQueryObj);  virtual;
+    procedure DoReceiveChosenInlineResult(AChosenInlineResult: TTelegramChosenInlineResultObj); virtual;
+    procedure DoReceivePreCheckoutQuery(APreCheckoutQuery: TTelegramPreCheckOutQuery); virtual;  
+    procedure DoReceiveMyChatMemberQuery(AMyChatMember: TTelegramChatMemberUpdated); virtual;
+    procedure DoReceiveChatMemberQuery(AChatMember: TTelegramChatMemberUpdated); virtual;
+    procedure DoReceiveMessageReaction(AMessageReaction: TTelegramMessageReactionUpdated); virtual;
+    procedure DoReceiveMessageReactionCount(AMessageReactionCount: TTelegramMessageReactionCountUpdated); virtual;
+    procedure DoReceiveSuccessfulPayment(AMessage: TTelegramMessageObj); virtual;  
     procedure DoReceiveBusinessConnection(ABusinessConnection: TTelegramBusinessConnectionObj); virtual; 
     procedure DoReceiveBusinessMessage(ABusinessMessage: TTelegramMessageObj); virtual;
     procedure DebugMessage(const Msg: String); virtual; // it will send all requests and responses to the log. Useful during development
@@ -744,20 +750,20 @@   TTelegramSender = class
       write FOnReceiveInlineQuery;
     property OnReceiveChosenInlineResult: TChosenInlineResultEvent read FOnReceiveChosenInlineResult
       write FOnReceiveChosenInlineResult;
-    property OnReceivePreCheckoutQuery: TPreCheckoutQueryEvent read FOnReceivePreCheckoutQuery
-      write FOnReceivePreCheckoutQuery;
-    property OnReceiveSuccessfulPayment: TMessageEvent read FOnReceiveSuccessfulPayment
-      write FOnReceiveSuccessfulPayment;  
-    property OnReceiveBusinessConnection: TBusinessConnectionEvent read FOnReceiveBusinessConnection
-      write FOnReceiveBusinessConnection;
-    property OnReceiveBusinessMessage: TMessageEvent read FOnReceiveBusinessMessage
-      write FOnReceiveBusinessMessage;
-    property OnReceiveMessageReaction: TMessageReactionEvent read FOnReceiveMessageReaction
-      write FOnReceiveMessageReaction;
-    property OnReceiveMessageReactionCount: TMessageReactionCountEvent read FOnReceiveMessageReactionCount
-      write FOnReceiveMessageReactionCount;
-    property OnReceiveMyChatMemberUpdated: TChatMemberEvent read FOnReceiveMyChatMemberUpdated
-      write FOnReceiveMyChatMemberUpdated;
+    property OnReceivePreCheckoutQuery: TPreCheckoutQueryEvent read FOnReceivePreCheckoutQuery
+      write FOnReceivePreCheckoutQuery;
+    property OnReceiveSuccessfulPayment: TMessageEvent read FOnReceiveSuccessfulPayment
+      write FOnReceiveSuccessfulPayment;  
+    property OnReceiveBusinessConnection: TBusinessConnectionEvent read FOnReceiveBusinessConnection
+      write FOnReceiveBusinessConnection;
+    property OnReceiveBusinessMessage: TMessageEvent read FOnReceiveBusinessMessage
+      write FOnReceiveBusinessMessage;
+    property OnReceiveMessageReaction: TMessageReactionEvent read FOnReceiveMessageReaction
+      write FOnReceiveMessageReaction;
+    property OnReceiveMessageReactionCount: TMessageReactionCountEvent read FOnReceiveMessageReactionCount
+      write FOnReceiveMessageReactionCount;
+    property OnReceiveMyChatMemberUpdated: TChatMemberEvent read FOnReceiveMyChatMemberUpdated
+      write FOnReceiveMyChatMemberUpdated;
     property OnReceiveChatMemberUpdated: TChatMemberEvent read FOnReceiveChatMemberUpdated
       write FOnReceiveChatMemberUpdated;
   end;
@@ -856,6 +862,7 @@ implementation
   s_OneTimeKeyboard = 'one_time_keyboard';
   s_RequestContact = 'request_contact';
   s_RequestLocation = 'request_location';
+  s_Style = 'style';
   s_SwitchInlineQuery = 'switch_inline_query';
   s_CallbackData = 'callback_data';
   s_SwitchInlineQueryCurrentChat = 's_switch_inline_query_current_chat';
@@ -1697,6 +1704,11 @@ function TKeyboardButton.Gettext: String;
   Result:=Strings[s_text];
 end;
 
+function TKeyboardButton.GetStyle: String;
+begin
+  Result:=Strings[s_Style];
+end;
+
 procedure TKeyboardButton.SetRequestContact(AValue: Boolean);
 begin
   Booleans[s_RequestContact]:=AValue;
@@ -1712,6 +1724,11 @@ procedure TKeyboardButton.Settext(AValue: String);
   Strings[s_text]:=AValue;
 end;
 
+procedure TKeyboardButton.SetStyle(const AValue: String);
+begin
+  Strings[s_Style]:=AValue;
+end;
+
 constructor TKeyboardButton.Create(const AText: String);
 begin
   inherited Create;
@@ -1910,6 +1927,11 @@ procedure TInlineKeyboardButton.Settext(AValue: String);
   Strings[s_text]:=AValue;
 end;
 
+procedure TInlineKeyboardButton.SetStyle(AValue: String);
+begin
+  Strings[s_Style]:=AValue;
+end;
+
 procedure TInlineKeyboardButton.Setcallback_data(AValue: String);
 begin
   CheckOptnlAndSet(s_callbackdata, AValue);
@@ -1920,6 +1942,11 @@ function TInlineKeyboardButton.Geturl: String;
   Result:=Strings[s_url];
 end;
 
+function TInlineKeyboardButton.GetStyle: String;
+begin
+  Result:=Strings[s_Style];
+end;
+
 function TInlineKeyboardButton.CheckOptnlNull: Boolean;
 begin
   Result:=not (Assigned(Find(s_CallbackData)) or Assigned(Find(s_SwitchInlineQuery)) or
@@ -2277,11 +2304,11 @@ procedure TTelegramSender.DoReceiveMyChatMemberQuery(AMyChatMember: TTelegramCha
     FOnReceiveMyChatMemberUpdated(Self, AMyChatMember);
 end;
 
-procedure TTelegramSender.DoReceiveChatMemberQuery(AChatMember: TTelegramChatMemberUpdated);
-begin
-  FCurrentMessage:=nil;
-  FCurrentChat:=AChatMember.Chat;
-  FCurrentUser:=AChatMember.From;
+procedure TTelegramSender.DoReceiveChatMemberQuery(AChatMember: TTelegramChatMemberUpdated);
+begin
+  FCurrentMessage:=nil;
+  FCurrentChat:=AChatMember.Chat;
+  FCurrentUser:=AChatMember.From;
   FCurrentThreadId:=_nullThrd;
   FCurrentIsTopicMessage:=False;
   FCurrentChatId:=FCurrentUser.ID;
@@ -2290,41 +2317,41 @@ procedure TTelegramSender.DoReceiveChatMemberQuery(AChatMember: TTelegramChatMem
   DoAfterParseUpdate;
   if FLanguage=EmptyStr then
     SetLanguage(CurrentLanguage(FCurrentUser));
-  if Assigned(FOnReceiveChatMemberUpdated) then
-    FOnReceiveChatMemberUpdated(Self, AChatMember);
-end;
-
-procedure TTelegramSender.DoReceiveMessageReaction(
-  AMessageReaction: TTelegramMessageReactionUpdated);
-begin
-  FCurrentMessage:=nil;
-  FCurrentChat:=AMessageReaction.Chat;
-  FCurrentChatID:=AMessageReaction.Chat.ID;
-  FCurrentThreadId:=_nullThrd;
-  FCurrentIsTopicMessage:=False;
-  FCurrentUser:=AMessageReaction.User;
-  if CurrentIsBanned then
-    Exit;
-  DoAfterParseUpdate;
-  if Assigned(FOnReceiveMessageReaction) then
-    FOnReceiveMessageReaction(Self, AMessageReaction);
-end;
-
-procedure TTelegramSender.DoReceiveMessageReactionCount(
-  AMessageReactionCount: TTelegramMessageReactionCountUpdated);
-begin
-  FCurrentMessage:=nil;
-  FCurrentChat:=AMessageReactionCount.Chat;
-  FCurrentChatID:=AMessageReactionCount.Chat.ID;
-  FCurrentThreadId:=_nullThrd;
-  FCurrentIsTopicMessage:=False;
-  FCurrentUser:=nil;
-  if CurrentIsBanned then
-    Exit;
-  DoAfterParseUpdate;
-  if Assigned(FOnReceiveMessageReactionCount) then
-    FOnReceiveMessageReactionCount(Self, AMessageReactionCount);
-end;
+  if Assigned(FOnReceiveChatMemberUpdated) then
+    FOnReceiveChatMemberUpdated(Self, AChatMember);
+end;
+
+procedure TTelegramSender.DoReceiveMessageReaction(
+  AMessageReaction: TTelegramMessageReactionUpdated);
+begin
+  FCurrentMessage:=nil;
+  FCurrentChat:=AMessageReaction.Chat;
+  FCurrentChatID:=AMessageReaction.Chat.ID;
+  FCurrentThreadId:=_nullThrd;
+  FCurrentIsTopicMessage:=False;
+  FCurrentUser:=AMessageReaction.User;
+  if CurrentIsBanned then
+    Exit;
+  DoAfterParseUpdate;
+  if Assigned(FOnReceiveMessageReaction) then
+    FOnReceiveMessageReaction(Self, AMessageReaction);
+end;
+
+procedure TTelegramSender.DoReceiveMessageReactionCount(
+  AMessageReactionCount: TTelegramMessageReactionCountUpdated);
+begin
+  FCurrentMessage:=nil;
+  FCurrentChat:=AMessageReactionCount.Chat;
+  FCurrentChatID:=AMessageReactionCount.Chat.ID;
+  FCurrentThreadId:=_nullThrd;
+  FCurrentIsTopicMessage:=False;
+  FCurrentUser:=nil;
+  if CurrentIsBanned then
+    Exit;
+  DoAfterParseUpdate;
+  if Assigned(FOnReceiveMessageReactionCount) then
+    FOnReceiveMessageReactionCount(Self, AMessageReactionCount);
+end;
 
 procedure TTelegramSender.DoReceiveSuccessfulPayment(
   AMessage: TTelegramMessageObj);
@@ -2394,13 +2421,13 @@ procedure TTelegramSender.DoReceiveUpdate(AnUpdate: TTelegramUpdateObj);
         utChosenInlineResult: DoReceiveChosenInlineResult(AnUpdate.ChosenInlineResult);
         utCallbackQuery:      DoReceiveCallbackQuery(AnUpdate.CallbackQuery);
         utPreCheckoutQuery:   DoReceivePreCheckoutQuery(AnUpdate.PreCheckoutQuery);
-        utMyChatMember:       DoReceiveMyChatMemberQuery(AnUpdate.MyChatMember);
-        utChatMember:         DoReceiveChatMemberQuery(AnUpdate.ChatMember);
-        utBusinessConnection: DoReceiveBusinessConnection(AnUpdate.BusinessConnection);
-        utBusinessMessage:    DoReceiveBusinessMessage(AnUpdate.BusinessMessage);
-        utMessageReaction:    DoReceiveMessageReaction(AnUpdate.MessageReaction);
-        utMessageReactionCount: DoReceiveMessageReactionCount(AnUpdate.MessageReactionCount);
-      end;
+        utMyChatMember:       DoReceiveMyChatMemberQuery(AnUpdate.MyChatMember);
+        utChatMember:         DoReceiveChatMemberQuery(AnUpdate.ChatMember);
+        utBusinessConnection: DoReceiveBusinessConnection(AnUpdate.BusinessConnection);
+        utBusinessMessage:    DoReceiveBusinessMessage(AnUpdate.BusinessMessage);
+        utMessageReaction:    DoReceiveMessageReaction(AnUpdate.MessageReaction);
+        utMessageReactionCount: DoReceiveMessageReactionCount(AnUpdate.MessageReactionCount);
+      end;
       if Assigned(FUpdateLogger) then
         if CurrentIsSimpleUser then  // This is to ensure that admins and moderators do not affect the statistics
           FUpdateLogger.Log(AnUpdate.AsString);