From 7dc578f91d2ef18ab5bc3604c8adb82fbacd0e86 Mon Sep 17 00:00:00 2001
From: Wizou <11647984+wiz0u@users.noreply.github.com>
Date: Tue, 16 Jan 2024 18:09:45 +0100
Subject: [PATCH] api doc
---
src/TL.Schema.cs | 27 +++++++++++++++++++--------
src/TL.SchemaFuncs.cs | 32 ++++++++++++++++++++++----------
2 files changed, 41 insertions(+), 18 deletions(-)
diff --git a/src/TL.Schema.cs b/src/TL.Schema.cs
index b0255e7..be2abc6 100644
--- a/src/TL.Schema.cs
+++ b/src/TL.Schema.cs
@@ -1807,7 +1807,7 @@ namespace TL
public override int TtlPeriod => ttl_period;
}
- /// Media See Derived classes: , , , , , , , , , , , , ,
+ /// Media See Derived classes: , , , , , , , , , , , , , ,
/// a value means messageMediaEmpty
public abstract partial class MessageMedia : IObject { }
/// Attached photo. See
@@ -2063,6 +2063,7 @@ namespace TL
[TLDef(0xC6991068)]
public class MessageMediaGiveawayResults : MessageMedia
{
+ /// Extra bits of information, use flags.HasFlag(...) to test for those
public Flags flags;
public long channel_id;
[IfFlag(3)] public int additional_peers_count;
@@ -2077,8 +2078,10 @@ namespace TL
[Flags] public enum Flags : uint
{
only_new_subscribers = 0x1,
+ /// Field has a value
has_prize_description = 0x2,
refunded = 0x4,
+ /// Field has a value
has_additional_peers_count = 0x8,
}
}
@@ -3543,7 +3546,7 @@ namespace TL
[TLDef(0x1BB00451)]
public class InputMessagesFilterPinned : MessagesFilter { }
- /// Object contains info on events occurred. See Derived classes: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
+ /// Object contains info on events occurred. See Derived classes: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
public abstract class Update : IObject
{
public virtual (long mbox_id, int pts, int pts_count) GetMBox() => default;
@@ -5034,6 +5037,7 @@ namespace TL
[TLDef(0xAEAF9E74)]
public class UpdateSavedDialogPinned : Update
{
+ /// Extra bits of information, use flags.HasFlag(...) to test for those
public Flags flags;
public DialogPeerBase peer;
@@ -5046,11 +5050,13 @@ namespace TL
[TLDef(0x686C85A6)]
public class UpdatePinnedSavedDialogs : Update
{
+ /// Extra bits of information, use flags.HasFlag(...) to test for those
public Flags flags;
[IfFlag(0)] public DialogPeerBase[] order;
[Flags] public enum Flags : uint
{
+ /// Field has a value
has_order = 0x1,
}
}
@@ -6927,7 +6933,7 @@ namespace TL
public DateTime expires;
}
- /// Represents a stickerset See Derived classes: , , , , , , , ,
+ /// Represents a stickerset See Derived classes: , , , , , , , , ,
/// a value means inputStickerSetEmpty
public abstract partial class InputStickerSet : IObject { }
/// Stickerset by ID See
@@ -10603,7 +10609,7 @@ namespace TL
}
}
- /// Channel admin log event See Derived classes: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
+ /// Channel admin log event See Derived classes: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
public abstract class ChannelAdminLogEventAction : IObject { }
/// Channel/supergroup title was changed See
[TLDef(0xE6DFB825)]
@@ -15924,7 +15930,7 @@ namespace TL
public IPeerInfo UserOrChat(Peer peer) => peer?.UserOrChat(users, chats);
}
- /// Story view date and reaction information See Derived classes:
+ /// Story view date and reaction information See Derived classes: , ,
public abstract class StoryViewBase : IObject { }
/// Story view date and reaction information See
[TLDef(0xB0BDEAC5)]
@@ -15953,6 +15959,7 @@ namespace TL
[TLDef(0x9083670B)]
public class StoryViewPublicForward : StoryViewBase
{
+ /// Extra bits of information, use flags.HasFlag(...) to test for those
public Flags flags;
public MessageBase message;
@@ -15966,6 +15973,7 @@ namespace TL
[TLDef(0xBD74CF49)]
public class StoryViewPublicRepost : StoryViewBase
{
+ /// Extra bits of information, use flags.HasFlag(...) to test for those
public Flags flags;
public Peer peer_id;
public StoryItemBase story;
@@ -16105,7 +16113,7 @@ namespace TL
public double rotation;
}
- /// Represents a story media area » See Derived classes: , , ,
+ /// Represents a story media area » See Derived classes: , , , , ,
public abstract class MediaArea : IObject { }
/// Represents a location tag attached to a story, with additional venue information. See
[TLDef(0xBE82DB9C)]
@@ -16704,7 +16712,7 @@ namespace TL
public Help_PeerColorOption[] colors;
}
- /// See
+ /// See Derived classes: , ,
public abstract class StoryReactionBase : IObject { }
/// See
[TLDef(0x6090D6D5)]
@@ -16732,6 +16740,7 @@ namespace TL
[TLDef(0xAA5F789C)]
public class Stories_StoryReactionsList : IObject, IPeerResolver
{
+ /// Extra bits of information, use flags.HasFlag(...) to test for those
public Flags flags;
public int count;
public StoryReactionBase[] reactions;
@@ -16741,6 +16750,7 @@ namespace TL
[Flags] public enum Flags : uint
{
+ /// Field has a value
has_next_offset = 0x1,
}
/// returns a or for the given Peer
@@ -16751,6 +16761,7 @@ namespace TL
[TLDef(0xBD87CB6C)]
public class SavedDialog : IObject
{
+ /// Extra bits of information, use flags.HasFlag(...) to test for those
public Flags flags;
public Peer peer;
public int top_message;
@@ -16761,7 +16772,7 @@ namespace TL
}
}
- /// See
+ /// See Derived classes: , ,
public abstract class Messages_SavedDialogsBase : IObject
{
public virtual SavedDialog[] Dialogs { get; }
diff --git a/src/TL.SchemaFuncs.cs b/src/TL.SchemaFuncs.cs
index 86d591e..ef09a2b 100644
--- a/src/TL.SchemaFuncs.cs
+++ b/src/TL.SchemaFuncs.cs
@@ -1175,7 +1175,8 @@ namespace TL
hash = hash,
});
- /// See
+ /// See [bots: ✓]
+ /// Hash for pagination, for more info click here
/// a null value means account.emojiStatusesNotModified
public static Task Account_GetChannelDefaultEmojiStatuses(this Client client, long hash = default)
=> client.Invoke(new Account_GetChannelDefaultEmojiStatuses
@@ -1183,7 +1184,8 @@ namespace TL
hash = hash,
});
- /// See
+ /// See [bots: ✓]
+ /// Hash for pagination, for more info click here
/// a null value means emojiListNotModified
public static Task Account_GetChannelRestrictedStatusEmojis(this Client client, long hash = default)
=> client.Invoke(new Account_GetChannelRestrictedStatusEmojis
@@ -3743,7 +3745,11 @@ namespace TL
hash = hash,
});
- /// See
+ /// See [bots: ✓]
+ /// Offsets for pagination, for more info click here
+ /// Offsets for pagination, for more info click here
+ /// Maximum number of results to return, see pagination
+ /// Hash for pagination, for more info click here
public static Task Messages_GetSavedDialogs(this Client client, DateTime offset_date = default, int offset_id = default, InputPeer offset_peer = null, int limit = int.MaxValue, long hash = default, bool exclude_pinned = false)
=> client.Invoke(new Messages_GetSavedDialogs
{
@@ -3755,7 +3761,12 @@ namespace TL
hash = hash,
});
- /// See
+ /// See [bots: ✓]
+ /// Offsets for pagination, for more info click here
+ /// Offsets for pagination, for more info click here
+ /// Offsets for pagination, for more info click here
+ /// Maximum number of results to return, see pagination
+ /// Hash for pagination, for more info click here
public static Task Messages_GetSavedHistory(this Client client, InputPeer peer, int offset_id = default, DateTime offset_date = default, int add_offset = default, int limit = int.MaxValue, int max_id = default, int min_id = default, long hash = default)
=> client.Invoke(new Messages_GetSavedHistory
{
@@ -3769,7 +3780,7 @@ namespace TL
hash = hash,
});
- /// See
+ /// See [bots: ✓]
public static Task Messages_DeleteSavedHistory(this Client client, InputPeer peer, int max_id = default, DateTime? min_date = null, DateTime? max_date = null)
=> client.Invoke(new Messages_DeleteSavedHistory
{
@@ -3780,13 +3791,13 @@ namespace TL
max_date = max_date.GetValueOrDefault(),
});
- /// See
+ /// See [bots: ✓]
public static Task Messages_GetPinnedSavedDialogs(this Client client)
=> client.Invoke(new Messages_GetPinnedSavedDialogs
{
});
- /// See
+ /// See [bots: ✓]
public static Task Messages_ToggleSavedDialogPin(this Client client, InputDialogPeerBase peer, bool pinned = false)
=> client.Invoke(new Messages_ToggleSavedDialogPin
{
@@ -3794,7 +3805,7 @@ namespace TL
peer = peer,
});
- /// See
+ /// See [bots: ✓]
public static Task Messages_ReorderPinnedSavedDialogs(this Client client, InputDialogPeerBase[] order, bool force = false)
=> client.Invoke(new Messages_ReorderPinnedSavedDialogs
{
@@ -4844,7 +4855,7 @@ namespace TL
channel = channel,
});
- /// See
+ /// See [bots: ✓]
public static Task Channels_UpdateEmojiStatus(this Client client, InputChannelBase channel, EmojiStatus emoji_status)
=> client.Invoke(new Channels_UpdateEmojiStatus
{
@@ -6168,7 +6179,8 @@ namespace TL
hidden = hidden,
});
- /// See
+ /// See [bots: ✓]
+ /// Maximum number of results to return, see pagination
public static Task Stories_GetStoryReactionsList(this Client client, InputPeer peer, int id, int limit = int.MaxValue, Reaction reaction = null, string offset = null, bool forwards_first = false)
=> client.Invoke(new Stories_GetStoryReactionsList
{