From b31aa55c34d5c9008bd27a73d0f1ea509613d1a9 Mon Sep 17 00:00:00 2001 From: Wizou <11647984+wiz0u@users.noreply.github.com> Date: Fri, 18 Mar 2022 03:53:19 +0100 Subject: [PATCH] updated API docs --- src/TL.Schema.cs | 72 +++++++++++++++++++++++++++++------------------- 1 file changed, 43 insertions(+), 29 deletions(-) diff --git a/src/TL.Schema.cs b/src/TL.Schema.cs index 569eb2f..a512d78 100644 --- a/src/TL.Schema.cs +++ b/src/TL.Schema.cs @@ -1034,7 +1034,7 @@ namespace TL public override string Title => title; } - /// Object containing detailed group info Derived classes: , See + /// Full info about a channel, supergroup, gigagroup or legacy group. Derived classes: , See public abstract partial class ChatFullBase : IObject { /// ID of the chat @@ -1068,7 +1068,7 @@ namespace TL /// Allowed message reactions » public abstract string[] AvailableReactions { get; } } - /// Detailed chat info See + /// Full info about a legacy group. See [TLDef(0xD18EE226)] public partial class ChatFull : ChatFullBase { @@ -1168,7 +1168,7 @@ namespace TL /// Allowed message reactions » public override string[] AvailableReactions => available_reactions; } - /// Full info about a channel/supergroup See + /// Full info about a channel, supergroup or gigagroup. See [TLDef(0xE13C3D20)] public partial class ChannelFull : ChatFullBase { @@ -2593,9 +2593,9 @@ namespace TL GeoIrrelevant = 0xDBD4FEED, ///Report for impersonation Fake = 0xF5DDD6E7, - ///See + ///Report for illegal drugs IllegalDrugs = 0x0A8EB2BE, - ///See + ///Report for divulgation of personal details PersonalDetails = 0x9EC7863D, } @@ -2897,15 +2897,15 @@ namespace TL public int count; } - /// Extended info on chat and auxiliary data. See + /// Full info about a channel, supergroup, gigagroup or legacy group. See [TLDef(0xE5D7D19C)] public class Messages_ChatFull : IObject, IPeerResolver { - /// Extended info on a chat + /// Full info public ChatFullBase full_chat; - /// List containing basic info on chat + /// Mentioned chats public Dictionary chats; - /// List of users mentioned above + /// Mentioned users public Dictionary users; /// returns a or for the given Peer public IPeerInfo UserOrChat(Peer peer) => peer?.UserOrChat(users, chats); @@ -2987,7 +2987,7 @@ namespace TL /// Object contains info on events occurred. Derived classes: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , See public abstract class Update : IObject { } - /// New message in a private chat or in a legacy group. See + /// New message in a private chat or in a legacy group. See [TLDef(0x1F2B0AFD)] public class UpdateNewMessage : Update { @@ -3321,7 +3321,7 @@ namespace TL /// New view counter public int views; } - /// Admin permissions of a user in a legacy group were changed See + /// Admin permissions of a user in a legacy group were changed See [TLDef(0xD7CA61A2, inheritBefore = true)] public class UpdateChatParticipantAdmin : UpdateChat { @@ -11970,6 +11970,7 @@ namespace TL record_video_active = 0x800, /// Whether RTMP streams are allowed rtmp_stream = 0x1000, + /// Whether the listeners list is hidden and cannot be fetched using phone.getGroupParticipants. The phone.groupParticipants.count and groupCall.participants_count counters will still include listeners. listeners_hidden = 0x2000, } @@ -12705,27 +12706,33 @@ namespace TL } } - /// See + /// Info about an RTMP stream in a group call or livestream See [TLDef(0x80EB48AF)] public class GroupCallStreamChannel : IObject { + /// Channel ID public int channel; + /// Specifies the duration of the video segment to fetch in milliseconds, by bitshifting 1000 to the right scale times: duration_ms := 1000 >> scale. public int scale; + /// Last seen timestamp to easily start fetching livestream chunks using public long last_timestamp_ms; } - /// See + /// Info about RTMP streams in a group call or livestream See [TLDef(0xD0E482B2)] public class Phone_GroupCallStreamChannels : IObject { + /// RTMP streams public GroupCallStreamChannel[] channels; } - /// See + /// RTMP URL and stream key to be used in streaming software See [TLDef(0x2DBF3432)] public class Phone_GroupCallStreamRtmpUrl : IObject { + /// RTMP URL public string url; + /// Stream key public string key; } @@ -13377,9 +13384,9 @@ namespace TL /// Initialize account takeout session See Possible codes: 420 (details) /// Whether to export contacts /// Whether to export messages in private chats - /// Whether to export messages in legacy groups - /// Whether to export messages in supergroups - /// Whether to export messages in channels + /// Whether to export messages in legacy groups + /// Whether to export messages in supergroups + /// Whether to export messages in channels /// Whether to export files /// Maximum size of files to export public static Task Account_InitTakeoutSession(this Client client, bool contacts = false, bool message_users = false, bool message_chats = false, bool message_megagroups = false, bool message_channels = false, bool files = false, int? file_max_size = null) @@ -13911,7 +13918,8 @@ namespace TL msg_id = msg_id, }); - /// See + /// Resolve a phone number to get user info, if their privacy settings allow it. See + /// Phone number in international format, possibly obtained from a t.me/+number or tg://resolve?phone=number URI. public static Task Contacts_ResolvePhone(this Client client, string phone) => client.Invoke(new Contacts_ResolvePhone { @@ -14179,8 +14187,8 @@ namespace TL id = id, }); - /// ⚠ This method is only for small private Chat. See Terminology to understand what this means
Search for a similar method name starting with Channels_ if you're dealing with a Returns full chat info according to its ID. See [bots: ✓] Possible codes: 400 (details) - /// Chat ID + /// ⚠ This method is only for small private Chat. See Terminology to understand what this means
Search for a similar method name starting with Channels_ if you're dealing with a Get full info about a legacy group. See [bots: ✓] Possible codes: 400 (details) + /// Legacy group ID. public static Task Messages_GetFullChat(this Client client, long chat_id) => client.Invoke(new Messages_GetFullChat { @@ -14491,7 +14499,7 @@ namespace TL increment = increment, }); - /// ⚠ This method is only for small private Chat. See Terminology to understand what this means
Search for a similar method name starting with Channels_ if you're dealing with a Make a user admin in a legacy group. See Possible codes: 400 (details) + /// ⚠ This method is only for small private Chat. See Terminology to understand what this means
Search for a similar method name starting with Channels_ if you're dealing with a Make a user admin in a legacy group. See Possible codes: 400 (details) /// The ID of the group /// The user to make admin /// Whether to make them admin @@ -14503,8 +14511,8 @@ namespace TL is_admin = is_admin, }); - /// ⚠ This method is only for small private Chat. See Terminology to understand what this means
Search for a similar method name starting with Channels_ if you're dealing with a Turn a legacy group into a supergroup See Possible codes: 400,403 (details) - /// Legacy group to migrate + /// ⚠ This method is only for small private Chat. See Terminology to understand what this means
Search for a similar method name starting with Channels_ if you're dealing with a Turn a legacy group into a supergroup See Possible codes: 400,403 (details) + /// Legacy group to migrate public static Task Messages_MigrateChat(this Client client, long chat_id) => client.Invoke(new Messages_MigrateChat { @@ -15809,7 +15817,10 @@ namespace TL peer = peer, }); - /// See + /// View and search recently sent media.
This method does not support pagination. See + /// Optional search query + /// Message filter + /// Maximum number of results to return (max 100). public static Task Messages_SearchSentMedia(this Client client, string q, MessagesFilter filter, int limit = int.MaxValue) => client.Invoke(new Messages_SearchSentMedia { @@ -16244,8 +16255,8 @@ namespace TL id = id, }); - /// Get full info about a channel See [bots: ✓] Possible codes: 400,403,406 (details) - /// The channel to get info about + /// Get full info about a supergroup, gigagroup or channel See [bots: ✓] Possible codes: 400,403,406 (details) + /// The channel, supergroup or gigagroup to get info about public static Task Channels_GetFullChannel(this Client client, InputChannelBase channel) => client.Invoke(new Channels_GetFullChannel { @@ -16892,7 +16903,7 @@ namespace TL }); /// Create a group call or livestream See Possible codes: 400 (details) - /// Whether RTMP stream support should be enabled + /// Whether RTMP stream support should be enabled: only the group/supergroup/channel owner can use this flag. /// Associate the group call or livestream to the provided group/supergroup/channel /// Unique client message ID required to prevent creation of duplicate group calls /// Call title @@ -17112,14 +17123,17 @@ namespace TL call = call, }); - /// See + /// Get info about RTMP streams in a group call or livestream.
This method should be invoked to the same group/channel-related DC used for downloading livestream chunks.
As usual, the media DC is preferred, if available. See Possible codes: 400 (details) + /// Group call or livestream public static Task Phone_GetGroupCallStreamChannels(this Client client, InputGroupCall call) => client.Invoke(new Phone_GetGroupCallStreamChannels { call = call, }); - /// See + /// Get RTMP URL and stream key for RTMP livestreams. Can be used even before creating the actual RTMP livestream with phone.createGroupCall (the rtmp_stream flag must be set). See + /// Peer to livestream into + /// Whether to revoke the previous stream key or simply return the existing one public static Task Phone_GetGroupCallStreamRtmpUrl(this Client client, InputPeer peer, bool revoke) => client.Invoke(new Phone_GetGroupCallStreamRtmpUrl {