use enum in inline query results

DinoLeung · Mar 31, 2024 · e46f659 · e46f659
1 parent 80c9651
commit e46f659
Show file tree

Hide file tree

Showing 22 changed files with 78 additions and 41 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,7 @@
 
 - support Telegram API 6.9
 - **Breaking** Updated class `Dice`, function `telegram:Telegram.sendDice` and function `teledart:Message.replyDice` to accept enum of `DiceEmoji` instead of emoji string
+- **Breaking** Updated class `InlineQueryResult` to use enum for `type`
 
 ## 0.6.1
 

diff --git a/lib/src/telegram/models/inline_query_result.dart b/lib/src/telegram/models/inline_query_result.dart
@@ -43,6 +43,41 @@ part of '../model.dart';
 /// * [InlineQueryResultVoice](https://core.telegram.org/bots/api#inlinequeryresultvoice)
 ///
 /// https://core.telegram.org/bots/api#inlinequeryresult
+
+@JsonEnum()
+enum InlineQueryResultType {
+  @JsonValue('article')
+  article,
+  @JsonValue('audio')
+  audio,
+  @JsonValue('document')
+  document,
+  @JsonValue('gif')
+  gif,
+  @JsonValue('mpeg4_gif')
+  mpeg4Gif,
+  @JsonValue('photo')
+  photo,
+  @JsonValue('sticker')
+  sticker,
+  @JsonValue('video')
+  video,
+  @JsonValue('voice')
+  voice,
+  @JsonValue('contact')
+  contact,
+  @JsonValue('game')
+  game,
+  @JsonValue('location')
+  location,
+  @JsonValue('venue')
+  venue,
+}
+
+extension InlineQueryResultTypeExtenson on InlineQueryResultType {
+  String value() => _$InlineQueryResultTypeEnumMap[this]!;
+}
+
 @JsonSerializable(fieldRename: FieldRename.snake)
 class InlineQueryResult {
   static const typeArticle = 'article';
@@ -59,7 +94,8 @@ class InlineQueryResult {
   static const typeLocation = 'location';
   static const typeVenue = 'venue';
 
-  String type;
+  // String type;
+  InlineQueryResultType type;
   String id;
   InlineKeyboardMarkup? replyMarkup;
   InlineQueryResult({

diff --git a/lib/src/telegram/models/inline_query_result_article.dart b/lib/src/telegram/models/inline_query_result_article.dart
@@ -26,7 +26,7 @@ class InlineQueryResultArticle implements InlineQueryResult {
   @override
   String id;
   @override
-  String type;
+  InlineQueryResultType type;
   String title;
   InputMessageContent inputMessageContent;
   @override
@@ -39,7 +39,7 @@ class InlineQueryResultArticle implements InlineQueryResult {
   String? thumbnailHeight;
   InlineQueryResultArticle({
     required this.id,
-    this.type = InlineQueryResult.typeArticle,
+    this.type = InlineQueryResultType.article,
     required this.title,
     required this.inputMessageContent,
     this.replyMarkup,

diff --git a/lib/src/telegram/models/inline_query_result_audio.dart b/lib/src/telegram/models/inline_query_result_audio.dart
@@ -33,7 +33,7 @@ class InlineQueryResultAudio implements InlineQueryResult {
   @override
   String id;
   @override
-  String type;
+  InlineQueryResultType type;
   String audioUrl;
   String title;
   String? caption;
@@ -47,7 +47,7 @@ class InlineQueryResultAudio implements InlineQueryResult {
 
   InlineQueryResultAudio({
     required this.id,
-    this.type = InlineQueryResult.typeAudio,
+    this.type = InlineQueryResultType.audio,
     required this.audioUrl,
     required this.title,
     this.caption,

diff --git a/lib/src/telegram/models/inline_query_result_cached_audio.dart b/lib/src/telegram/models/inline_query_result_cached_audio.dart
@@ -33,7 +33,7 @@ class InlineQueryResultCachedAudio implements InlineQueryResult {
   @override
   String id;
   @override
-  String type;
+  InlineQueryResultType type;
   String audioFileId;
   String? caption;
   String? parseMode;
@@ -43,7 +43,7 @@ class InlineQueryResultCachedAudio implements InlineQueryResult {
   InputMessageContent? inputMessageContent;
   InlineQueryResultCachedAudio({
     required this.id,
-    this.type = InlineQueryResult.typeAudio,
+    this.type = InlineQueryResultType.article,
     required this.audioFileId,
     this.caption,
     this.parseMode,

diff --git a/lib/src/telegram/models/inline_query_result_cached_document.dart b/lib/src/telegram/models/inline_query_result_cached_document.dart
@@ -33,7 +33,7 @@ class InlineQueryResultCachedDocument implements InlineQueryResult {
   @override
   String id;
   @override
-  String type;
+  InlineQueryResultType type;
   String title;
   String documentFileId;
   String? description;
@@ -45,7 +45,7 @@ class InlineQueryResultCachedDocument implements InlineQueryResult {
   InputMessageContent? inputMessageContent;
   InlineQueryResultCachedDocument({
     required this.id,
-    this.type = InlineQueryResult.typeDocument,
+    this.type = InlineQueryResultType.document,
     required this.title,
     required this.documentFileId,
     this.description,

diff --git a/lib/src/telegram/models/inline_query_result_cached_gif.dart b/lib/src/telegram/models/inline_query_result_cached_gif.dart
@@ -30,7 +30,7 @@ class InlineQueryResultCachedGif implements InlineQueryResult {
   @override
   String id;
   @override
-  String type;
+  InlineQueryResultType type;
   String gifFileId;
   String? title;
   String? caption;
@@ -41,7 +41,7 @@ class InlineQueryResultCachedGif implements InlineQueryResult {
   InputMessageContent? inputMessageContent;
   InlineQueryResultCachedGif({
     required this.id,
-    this.type = InlineQueryResult.typeGif,
+    this.type = InlineQueryResultType.gif,
     required this.gifFileId,
     this.title,
     this.caption,

diff --git a/lib/src/telegram/models/inline_query_result_cached_mpeg4_gif.dart b/lib/src/telegram/models/inline_query_result_cached_mpeg4_gif.dart
@@ -30,7 +30,7 @@ class InlineQueryResultCachedMpeg4Gif implements InlineQueryResult {
   @override
   String id;
   @override
-  String type;
+  InlineQueryResultType type;
   String mpeg4FileId;
   String? title;
   String? caption;
@@ -41,7 +41,7 @@ class InlineQueryResultCachedMpeg4Gif implements InlineQueryResult {
   InputMessageContent? inputMessageContent;
   InlineQueryResultCachedMpeg4Gif({
     required this.id,
-    this.type = InlineQueryResult.typeMpeg4Gif,
+    this.type = InlineQueryResultType.mpeg4Gif,
     required this.mpeg4FileId,
     this.title,
     this.caption,

diff --git a/lib/src/telegram/models/inline_query_result_cached_photo.dart b/lib/src/telegram/models/inline_query_result_cached_photo.dart
@@ -30,7 +30,7 @@ class InlineQueryResultCachedPhoto implements InlineQueryResult {
   @override
   String id;
   @override
-  String type;
+  InlineQueryResultType type;
   String photoFileId;
   String? title;
   String? description;
@@ -42,7 +42,7 @@ class InlineQueryResultCachedPhoto implements InlineQueryResult {
   InputMessageContent? inputMessageContent;
   InlineQueryResultCachedPhoto({
     required this.id,
-    this.type = InlineQueryResult.typePhoto,
+    this.type = InlineQueryResultType.photo,
     required this.photoFileId,
     this.title,
     this.description,

diff --git a/lib/src/telegram/models/inline_query_result_cached_sticker.dart b/lib/src/telegram/models/inline_query_result_cached_sticker.dart
@@ -33,14 +33,14 @@ class InlineQueryResultCachedSticker implements InlineQueryResult {
   @override
   String id;
   @override
-  String type;
+  InlineQueryResultType type;
   String? stickerFileId;
   @override
   InlineKeyboardMarkup? replyMarkup;
   InputMessageContent? inputMessageContent;
   InlineQueryResultCachedSticker({
     required this.id,
-    this.type = InlineQueryResult.typeSticker,
+    this.type = InlineQueryResultType.sticker,
     required this.stickerFileId,
     this.replyMarkup,
     this.inputMessageContent,

diff --git a/lib/src/telegram/models/inline_query_result_cached_video.dart b/lib/src/telegram/models/inline_query_result_cached_video.dart
@@ -30,7 +30,7 @@ class InlineQueryResultCachedVideo implements InlineQueryResult {
   @override
   String id;
   @override
-  String type;
+  InlineQueryResultType type;
   String videoFileId;
   String title;
   String? description;
@@ -42,7 +42,7 @@ class InlineQueryResultCachedVideo implements InlineQueryResult {
   InputMessageContent? inputMessageContent;
   InlineQueryResultCachedVideo({
     required this.id,
-    this.type = InlineQueryResult.typeVideo,
+    this.type = InlineQueryResultType.video,
     required this.videoFileId,
     required this.title,
     this.description,

diff --git a/lib/src/telegram/models/inline_query_result_cached_voice.dart b/lib/src/telegram/models/inline_query_result_cached_voice.dart
@@ -33,7 +33,7 @@ class InlineQueryResultCachedVoice implements InlineQueryResult {
   @override
   String id;
   @override
-  String type;
+  InlineQueryResultType type;
   String voiceFileId;
   String title;
   String? caption;
@@ -44,7 +44,7 @@ class InlineQueryResultCachedVoice implements InlineQueryResult {
   InputMessageContent? inputMessageContent;
   InlineQueryResultCachedVoice({
     required this.id,
-    this.type = InlineQueryResult.typeVoice,
+    this.type = InlineQueryResultType.voice,
     required this.voiceFileId,
     required this.title,
     this.caption,

diff --git a/lib/src/telegram/models/inline_query_result_contact.dart b/lib/src/telegram/models/inline_query_result_contact.dart
@@ -33,7 +33,7 @@ class InlineQueryResultContact implements InlineQueryResult {
   @override
   String id;
   @override
-  String type;
+  InlineQueryResultType type;
   String phoneNumber;
   String firstName;
   String? lastName;
@@ -46,7 +46,7 @@ class InlineQueryResultContact implements InlineQueryResult {
   int? thumbnailHeight;
   InlineQueryResultContact({
     required this.id,
-    this.type = InlineQueryResult.typeContact,
+    this.type = InlineQueryResultType.contact,
     required this.phoneNumber,
     required this.firstName,
     this.lastName,

diff --git a/lib/src/telegram/models/inline_query_result_document.dart b/lib/src/telegram/models/inline_query_result_document.dart
@@ -33,7 +33,7 @@ class InlineQueryResultDocument implements InlineQueryResult {
   @override
   String id;
   @override
-  String type;
+  InlineQueryResultType type;
   String title;
   String? caption;
   String? parseMode;
@@ -49,7 +49,7 @@ class InlineQueryResultDocument implements InlineQueryResult {
   int? thumbnailHeight;
   InlineQueryResultDocument({
     required this.id,
-    this.type = InlineQueryResult.typeDocument,
+    this.type = InlineQueryResultType.document,
     required this.title,
     this.caption,
     this.parseMode,

diff --git a/lib/src/telegram/models/inline_query_result_game.dart b/lib/src/telegram/models/inline_query_result_game.dart
@@ -31,13 +31,13 @@ class InlineQueryResultGame implements InlineQueryResult {
   @override
   String id;
   @override
-  String type;
+  InlineQueryResultType type;
   String gameShortName;
   @override
   InlineKeyboardMarkup? replyMarkup;
   InlineQueryResultGame({
     required this.id,
-    this.type = InlineQueryResult.typeGame,
+    this.type = InlineQueryResultType.game,
     required this.gameShortName,
     this.replyMarkup,
   });

diff --git a/lib/src/telegram/models/inline_query_result_gif.dart b/lib/src/telegram/models/inline_query_result_gif.dart
@@ -29,7 +29,7 @@ class InlineQueryResultGif implements InlineQueryResult {
   @override
   String id;
   @override
-  String type;
+  InlineQueryResultType type;
   String gifUrl;
   int? gifWidth;
   int? gifHeight;
@@ -46,7 +46,7 @@ class InlineQueryResultGif implements InlineQueryResult {
 
   InlineQueryResultGif({
     required this.id,
-    this.type = InlineQueryResult.typeGif,
+    this.type = InlineQueryResultType.gif,
     required this.gifUrl,
     this.gifWidth,
     this.gifHeight,

diff --git a/lib/src/telegram/models/inline_query_result_location.dart b/lib/src/telegram/models/inline_query_result_location.dart
@@ -32,7 +32,7 @@ class InlineQueryResultLocation implements InlineQueryResult {
   @override
   String id;
   @override
-  String type;
+  InlineQueryResultType type;
   double latitude;
   double longitude;
   String title;
@@ -49,7 +49,7 @@ class InlineQueryResultLocation implements InlineQueryResult {
 
   InlineQueryResultLocation({
     required this.id,
-    this.type = InlineQueryResult.typeLocation,
+    this.type = InlineQueryResultType.location,
     required this.latitude,
     required this.longitude,
     required this.title,

diff --git a/lib/src/telegram/models/inline_query_result_mpeg4_gif.dart b/lib/src/telegram/models/inline_query_result_mpeg4_gif.dart
@@ -30,7 +30,7 @@ class InlineQueryResultMpeg4Gif implements InlineQueryResult {
   @override
   String id;
   @override
-  String type;
+  InlineQueryResultType type;
   String mpeg4Url;
   int? mpeg4Width;
   int? mpeg4Height;
@@ -47,7 +47,7 @@ class InlineQueryResultMpeg4Gif implements InlineQueryResult {
 
   InlineQueryResultMpeg4Gif({
     required this.id,
-    this.type = InlineQueryResult.typeMpeg4Gif,
+    this.type = InlineQueryResultType.mpeg4Gif,
     required this.mpeg4Url,
     this.mpeg4Width,
     this.mpeg4Height,

diff --git a/lib/src/telegram/models/inline_query_result_photo.dart b/lib/src/telegram/models/inline_query_result_photo.dart
@@ -30,7 +30,7 @@ class InlineQueryResultPhoto implements InlineQueryResult {
   @override
   String id;
   @override
-  String type;
+  InlineQueryResultType type;
   String photoUrl;
   String thumbnailUrl;
   int? photoWidth;
@@ -45,7 +45,7 @@ class InlineQueryResultPhoto implements InlineQueryResult {
   InputMessageContent? inputMessageContent;
   InlineQueryResultPhoto({
     required this.id,
-    this.type = InlineQueryResult.typePhoto,
+    this.type = InlineQueryResultType.photo,
     required this.photoUrl,
     required this.thumbnailUrl,
     this.photoWidth,

diff --git a/lib/src/telegram/models/inline_query_result_venue.dart b/lib/src/telegram/models/inline_query_result_venue.dart
@@ -33,7 +33,7 @@ class InlineQueryResultVenue implements InlineQueryResult {
   @override
   String id;
   @override
-  String type;
+  InlineQueryResultType type;
   double latitude;
   double longitude;
   String title;
@@ -50,7 +50,7 @@ class InlineQueryResultVenue implements InlineQueryResult {
   int? thumbnailHeight;
   InlineQueryResultVenue({
     required this.id,
-    this.type = InlineQueryResult.typeVenue,
+    this.type = InlineQueryResultType.venue,
     required this.latitude,
     required this.longitude,
     required this.title,

diff --git a/lib/src/telegram/models/inline_query_result_video.dart b/lib/src/telegram/models/inline_query_result_video.dart
@@ -33,7 +33,7 @@ class InlineQueryResultVideo implements InlineQueryResult {
   @override
   String id;
   @override
-  String type;
+  InlineQueryResultType type;
   String videoUrl;
   String mimeType;
   String thumbnailUrl;
@@ -51,7 +51,7 @@ class InlineQueryResultVideo implements InlineQueryResult {
 
   InlineQueryResultVideo({
     required this.id,
-    this.type = InlineQueryResult.typeVideo,
+    this.type = InlineQueryResultType.video,
     required this.videoUrl,
     required this.mimeType,
     required this.thumbnailUrl,