From 253b80f29c4727ea0fa3b49f455bf020e0217f75 Mon Sep 17 00:00:00 2001 From: Daniil Gentili Date: Fri, 8 Mar 2019 14:35:09 +0100 Subject: [PATCH] Improve docs --- .../constructors/account_wallPapers.md | 12 +- .../account_wallPapersNotModified.md | 4 +- docs/API_docs/constructors/channel.md | 6 +- ...lAdminLogEventActionDefaultBannedRights.md | 12 +- .../channelAdminLogEventActionStopPoll.md | 10 +- .../constructors/channelParticipantAdmin.md | 4 +- .../constructors/channelParticipantBanned.md | 2 +- .../channelParticipantsContacts.md | 10 +- docs/API_docs/constructors/chat.md | 4 +- docs/API_docs/constructors/chatAdminRights.md | 24 +- .../API_docs/constructors/chatBannedRights.md | 34 +- docs/API_docs/constructors/chatFull.md | 4 +- docs/API_docs/constructors/codeSettings.md | 16 +- docs/API_docs/constructors/document.md | 2 +- docs/API_docs/constructors/inputWallPaper.md | 12 +- .../constructors/inputWallPaperSlug.md | 10 +- .../constructors/messages_messagesSlice.md | 2 +- .../constructors/photoStrippedSize.md | 12 +- .../updateChatDefaultBannedRights.md | 14 +- docs/API_docs/constructors/wallPaper.md | 18 +- .../constructors/wallPaperSettings.md | 16 +- docs/API_docs/methods/account_getWallPaper.md | 10 +- .../API_docs/methods/account_getWallPapers.md | 2 +- .../methods/account_installWallPaper.md | 12 +- .../methods/account_resetWallPapers.md | 4 +- .../API_docs/methods/account_saveWallPaper.md | 14 +- .../methods/account_sendChangePhoneCode.md | 2 +- .../methods/account_sendConfirmPhoneCode.md | 2 +- .../methods/account_sendVerifyPhoneCode.md | 2 +- .../methods/account_uploadWallPaper.md | 14 +- docs/API_docs/methods/channels_editAdmin.md | 2 +- docs/API_docs/methods/channels_editBanned.md | 2 +- docs/API_docs/methods/index.md | 14 + .../methods/messages_editChatAbout.md | 12 +- .../messages_editChatDefaultBannedRights.md | 12 +- .../methods/messages_exportChatInvite.md | 2 +- docs/docs/CALLS.md | 2 +- docs/docs/INLINE_BUTTONS.md | 2 +- docs/docs/INSTALLATION.md | 2 +- docs/docs/LOGGING.md | 2 +- docs/docs/PROXY.md | 2 +- docs/docs/UPDATES.md | 2 +- docs/docs/USING_METHODS.md | 2 +- docs/index.md | 299 +++++++++++++++++- 44 files changed, 483 insertions(+), 164 deletions(-) diff --git a/docs/API_docs/constructors/account_wallPapers.md b/docs/API_docs/constructors/account_wallPapers.md index 7251d4b6..444a641f 100644 --- a/docs/API_docs/constructors/account_wallPapers.md +++ b/docs/API_docs/constructors/account_wallPapers.md @@ -1,6 +1,6 @@ --- title: account.wallPapers -description: account_wallPapers attributes, type and example +description: Wallpapers image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- # Constructor: account.wallPapers @@ -8,12 +8,14 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +Wallpapers + ### Attributes: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[int](../types/int.md) | Yes| -|wallpapers|Array of [WallPaper](../types/WallPaper.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[int](../types/int.md) | Yes|Hash| +|wallpapers|Array of [WallPaper](../types/WallPaper.md) | Yes|Wallpapers| diff --git a/docs/API_docs/constructors/account_wallPapersNotModified.md b/docs/API_docs/constructors/account_wallPapersNotModified.md index c296e74b..ca98b42f 100644 --- a/docs/API_docs/constructors/account_wallPapersNotModified.md +++ b/docs/API_docs/constructors/account_wallPapersNotModified.md @@ -1,6 +1,6 @@ --- title: account.wallPapersNotModified -description: account_wallPapersNotModified attributes, type and example +description: No wallpapers were modified image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- # Constructor: account.wallPapersNotModified @@ -8,6 +8,8 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +No wallpapers were modified + diff --git a/docs/API_docs/constructors/channel.md b/docs/API_docs/constructors/channel.md index a1713e1d..ffd4cccc 100644 --- a/docs/API_docs/constructors/channel.md +++ b/docs/API_docs/constructors/channel.md @@ -30,9 +30,9 @@ Channel |date|[int](../types/int.md) | Yes|Date| |version|[int](../types/int.md) | Yes|Version| |restriction\_reason|[string](../types/string.md) | Optional|Restriction reason| -|admin\_rights|[ChatAdminRights](../types/ChatAdminRights.md) | Optional|| -|banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | Optional|| -|default\_banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | Optional|| +|admin\_rights|[ChatAdminRights](../types/ChatAdminRights.md) | Optional|Admin rights of current user| +|banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | Optional|Banned rights of current user| +|default\_banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | Optional|Global chat banned rights| |participants\_count|[int](../types/int.md) | Optional|Participants count| diff --git a/docs/API_docs/constructors/channelAdminLogEventActionDefaultBannedRights.md b/docs/API_docs/constructors/channelAdminLogEventActionDefaultBannedRights.md index e921c68f..bbb66c09 100644 --- a/docs/API_docs/constructors/channelAdminLogEventActionDefaultBannedRights.md +++ b/docs/API_docs/constructors/channelAdminLogEventActionDefaultBannedRights.md @@ -1,6 +1,6 @@ --- title: channelAdminLogEventActionDefaultBannedRights -description: channelAdminLogEventActionDefaultBannedRights attributes, type and example +description: Changed global chat rights image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- # Constructor: channelAdminLogEventActionDefaultBannedRights @@ -8,12 +8,14 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +Changed global chat rights + ### Attributes: -| Name | Type | Required | -|----------|---------------|----------| -|prev\_banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | Yes| -|new\_banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|prev\_banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | Yes|Previous Banned rights of current user| +|new\_banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | Yes|New Banned rights of current user| diff --git a/docs/API_docs/constructors/channelAdminLogEventActionStopPoll.md b/docs/API_docs/constructors/channelAdminLogEventActionStopPoll.md index 480835c9..cdaaa051 100644 --- a/docs/API_docs/constructors/channelAdminLogEventActionStopPoll.md +++ b/docs/API_docs/constructors/channelAdminLogEventActionStopPoll.md @@ -1,6 +1,6 @@ --- title: channelAdminLogEventActionStopPoll -description: channelAdminLogEventActionStopPoll attributes, type and example +description: Stopped poll image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- # Constructor: channelAdminLogEventActionStopPoll @@ -8,11 +8,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +Stopped poll + ### Attributes: -| Name | Type | Required | -|----------|---------------|----------| -|message|[Message](../types/Message.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[Message](../types/Message.md) | Optional|Message| diff --git a/docs/API_docs/constructors/channelParticipantAdmin.md b/docs/API_docs/constructors/channelParticipantAdmin.md index bb7a6007..c2f4af2e 100644 --- a/docs/API_docs/constructors/channelParticipantAdmin.md +++ b/docs/API_docs/constructors/channelParticipantAdmin.md @@ -15,12 +15,12 @@ Channel participant admin | Name | Type | Required | Description | |----------|---------------|----------|-------------| |can\_edit|[Bool](../types/Bool.md) | Optional|Can edit?| -|self|[Bool](../types/Bool.md) | Optional|| +|self|[Bool](../types/Bool.md) | Optional|Is this the current user?| |user\_id|[int](../types/int.md) | Yes|User ID| |inviter\_id|[int](../types/int.md) | Optional|Inviter ID| |promoted\_by|[int](../types/int.md) | Yes|Promoted by| |date|[int](../types/int.md) | Yes|Date| -|admin\_rights|[ChatAdminRights](../types/ChatAdminRights.md) | Yes|| +|admin\_rights|[ChatAdminRights](../types/ChatAdminRights.md) | Yes|Admin rights| diff --git a/docs/API_docs/constructors/channelParticipantBanned.md b/docs/API_docs/constructors/channelParticipantBanned.md index 31ba0363..03a9245b 100644 --- a/docs/API_docs/constructors/channelParticipantBanned.md +++ b/docs/API_docs/constructors/channelParticipantBanned.md @@ -18,7 +18,7 @@ Channel participant banned |user\_id|[int](../types/int.md) | Yes|User ID| |kicked\_by|[int](../types/int.md) | Yes|Kicked by| |date|[int](../types/int.md) | Yes|Date| -|banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | Yes|| +|banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | Yes|Banned rights| diff --git a/docs/API_docs/constructors/channelParticipantsContacts.md b/docs/API_docs/constructors/channelParticipantsContacts.md index b68b0ce8..57b8a277 100644 --- a/docs/API_docs/constructors/channelParticipantsContacts.md +++ b/docs/API_docs/constructors/channelParticipantsContacts.md @@ -1,6 +1,6 @@ --- title: channelParticipantsContacts -description: channelParticipantsContacts attributes, type and example +description: Contacts image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- # Constructor: channelParticipantsContacts @@ -8,11 +8,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +Contacts + ### Attributes: -| Name | Type | Required | -|----------|---------------|----------| -|q|[string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|q|[string](../types/string.md) | Yes|Query| diff --git a/docs/API_docs/constructors/chat.md b/docs/API_docs/constructors/chat.md index dba8b661..3732b831 100644 --- a/docs/API_docs/constructors/chat.md +++ b/docs/API_docs/constructors/chat.md @@ -25,8 +25,8 @@ Chat |date|[int](../types/int.md) | Yes|Date| |version|[int](../types/int.md) | Yes|Version| |migrated\_to|[InputChannel](../types/InputChannel.md) | Optional|Migrated to| -|admin\_rights|[ChatAdminRights](../types/ChatAdminRights.md) | Optional|| -|default\_banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | Optional|| +|admin\_rights|[ChatAdminRights](../types/ChatAdminRights.md) | Optional|Admin rights of current user| +|default\_banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | Optional|Global chat banned rights| diff --git a/docs/API_docs/constructors/chatAdminRights.md b/docs/API_docs/constructors/chatAdminRights.md index f16fd37a..99340a1a 100644 --- a/docs/API_docs/constructors/chatAdminRights.md +++ b/docs/API_docs/constructors/chatAdminRights.md @@ -1,6 +1,6 @@ --- title: chatAdminRights -description: chatAdminRights attributes, type and example +description: Admin rights image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- # Constructor: chatAdminRights @@ -8,18 +8,20 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +Admin rights + ### Attributes: -| Name | Type | Required | -|----------|---------------|----------| -|change\_info|[Bool](../types/Bool.md) | Optional| -|post\_messages|[Bool](../types/Bool.md) | Optional| -|edit\_messages|[Bool](../types/Bool.md) | Optional| -|delete\_messages|[Bool](../types/Bool.md) | Optional| -|ban\_users|[Bool](../types/Bool.md) | Optional| -|invite\_users|[Bool](../types/Bool.md) | Optional| -|pin\_messages|[Bool](../types/Bool.md) | Optional| -|add\_admins|[Bool](../types/Bool.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|change\_info|[Bool](../types/Bool.md) | Optional|Can change info?| +|post\_messages|[Bool](../types/Bool.md) | Optional|Can post messages?| +|edit\_messages|[Bool](../types/Bool.md) | Optional|Can edit messages?| +|delete\_messages|[Bool](../types/Bool.md) | Optional|Can delete messages?| +|ban\_users|[Bool](../types/Bool.md) | Optional|Can ban users?| +|invite\_users|[Bool](../types/Bool.md) | Optional|Can invite users?| +|pin\_messages|[Bool](../types/Bool.md) | Optional|Can pin messages?| +|add\_admins|[Bool](../types/Bool.md) | Optional|Can add other admins?| diff --git a/docs/API_docs/constructors/chatBannedRights.md b/docs/API_docs/constructors/chatBannedRights.md index 55e86a94..3aa72b84 100644 --- a/docs/API_docs/constructors/chatBannedRights.md +++ b/docs/API_docs/constructors/chatBannedRights.md @@ -1,6 +1,6 @@ --- title: chatBannedRights -description: chatBannedRights attributes, type and example +description: Banned rights (when true, the user will NOT be able to do that thing) image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- # Constructor: chatBannedRights @@ -8,23 +8,25 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +Banned rights (when true, the user will NOT be able to do that thing) + ### Attributes: -| Name | Type | Required | -|----------|---------------|----------| -|view\_messages|[Bool](../types/Bool.md) | Optional| -|send\_messages|[Bool](../types/Bool.md) | Optional| -|send\_media|[Bool](../types/Bool.md) | Optional| -|send\_stickers|[Bool](../types/Bool.md) | Optional| -|send\_gifs|[Bool](../types/Bool.md) | Optional| -|send\_games|[Bool](../types/Bool.md) | Optional| -|send\_inline|[Bool](../types/Bool.md) | Optional| -|embed\_links|[Bool](../types/Bool.md) | Optional| -|send\_polls|[Bool](../types/Bool.md) | Optional| -|change\_info|[Bool](../types/Bool.md) | Optional| -|invite\_users|[Bool](../types/Bool.md) | Optional| -|pin\_messages|[Bool](../types/Bool.md) | Optional| -|until\_date|[int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|view\_messages|[Bool](../types/Bool.md) | Optional|Can view messages?| +|send\_messages|[Bool](../types/Bool.md) | Optional|Can send messages?| +|send\_media|[Bool](../types/Bool.md) | Optional|Can send media?| +|send\_stickers|[Bool](../types/Bool.md) | Optional|Can send stickers?| +|send\_gifs|[Bool](../types/Bool.md) | Optional|Can send gifs?| +|send\_games|[Bool](../types/Bool.md) | Optional|Can send games?| +|send\_inline|[Bool](../types/Bool.md) | Optional|Can use inline bots?| +|embed\_links|[Bool](../types/Bool.md) | Optional|Can embed links?| +|send\_polls|[Bool](../types/Bool.md) | Optional|Can send polls?| +|change\_info|[Bool](../types/Bool.md) | Optional|Can change info?| +|invite\_users|[Bool](../types/Bool.md) | Optional|Can invite users?| +|pin\_messages|[Bool](../types/Bool.md) | Optional|Can pin messages?| +|until\_date|[int](../types/int.md) | Yes|Until date (0 = forever)| diff --git a/docs/API_docs/constructors/chatFull.md b/docs/API_docs/constructors/chatFull.md index 5ff1a5dc..dbe56848 100644 --- a/docs/API_docs/constructors/chatFull.md +++ b/docs/API_docs/constructors/chatFull.md @@ -14,9 +14,9 @@ Chat full | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|can\_set\_username|[Bool](../types/Bool.md) | Optional|| +|can\_set\_username|[Bool](../types/Bool.md) | Optional|Can set username?| |id|[int](../types/int.md) | Yes|ID| -|about|[string](../types/string.md) | Yes|| +|about|[string](../types/string.md) | Yes|Chat about| |participants|[ChatParticipants](../types/ChatParticipants.md) | Yes|Participants| |chat\_photo|[Photo](../types/Photo.md) | Optional|Chat photo| |notify\_settings|[PeerNotifySettings](../types/PeerNotifySettings.md) | Yes|Notify settings| diff --git a/docs/API_docs/constructors/codeSettings.md b/docs/API_docs/constructors/codeSettings.md index 0a319b8c..1f55bc19 100644 --- a/docs/API_docs/constructors/codeSettings.md +++ b/docs/API_docs/constructors/codeSettings.md @@ -1,6 +1,6 @@ --- title: codeSettings -description: codeSettings attributes, type and example +description: Code settings image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- # Constructor: codeSettings @@ -8,14 +8,16 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +Code settings + ### Attributes: -| Name | Type | Required | -|----------|---------------|----------| -|allow\_flashcall|[Bool](../types/Bool.md) | Optional| -|current\_number|[Bool](../types/Bool.md) | Optional| -|app\_hash\_persistent|[Bool](../types/Bool.md) | Optional| -|app\_hash|[string](../types/string.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|allow\_flashcall|[Bool](../types/Bool.md) | Optional|Allow flashcal?| +|current\_number|[Bool](../types/Bool.md) | Optional|Current number?| +|app\_hash\_persistent|[Bool](../types/Bool.md) | Optional|Persistent hash?| +|app\_hash|[string](../types/string.md) | Optional|Hash type| diff --git a/docs/API_docs/constructors/document.md b/docs/API_docs/constructors/document.md index 78bed9f4..89915f88 100644 --- a/docs/API_docs/constructors/document.md +++ b/docs/API_docs/constructors/document.md @@ -20,7 +20,7 @@ Document |date|[int](../types/int.md) | Yes|Date| |mime\_type|[string](../types/string.md) | Yes|Mime type| |size|[int](../types/int.md) | Yes|Size| -|thumbs|Array of [PhotoSize](../types/PhotoSize.md) | Optional|| +|thumbs|Array of [PhotoSize](../types/PhotoSize.md) | Optional|Thumbnails| |dc\_id|[int](../types/int.md) | Yes|DC ID| |attributes|Array of [DocumentAttribute](../types/DocumentAttribute.md) | Yes|Attributes| diff --git a/docs/API_docs/constructors/inputWallPaper.md b/docs/API_docs/constructors/inputWallPaper.md index 188c4e60..8c82cf49 100644 --- a/docs/API_docs/constructors/inputWallPaper.md +++ b/docs/API_docs/constructors/inputWallPaper.md @@ -1,6 +1,6 @@ --- title: inputWallPaper -description: inputWallPaper attributes, type and example +description: Wallpaper image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- # Constructor: inputWallPaper @@ -8,12 +8,14 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +Wallpaper + ### Attributes: -| Name | Type | Required | -|----------|---------------|----------| -|id|[long](../types/long.md) | Yes| -|access\_hash|[long](../types/long.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|ID| +|access\_hash|[long](../types/long.md) | Yes|Access hash| diff --git a/docs/API_docs/constructors/inputWallPaperSlug.md b/docs/API_docs/constructors/inputWallPaperSlug.md index bbd00fc9..cfae6618 100644 --- a/docs/API_docs/constructors/inputWallPaperSlug.md +++ b/docs/API_docs/constructors/inputWallPaperSlug.md @@ -1,6 +1,6 @@ --- title: inputWallPaperSlug -description: inputWallPaperSlug attributes, type and example +description: Wallpaper slug image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- # Constructor: inputWallPaperSlug @@ -8,11 +8,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +Wallpaper slug + ### Attributes: -| Name | Type | Required | -|----------|---------------|----------| -|slug|[string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|slug|[string](../types/string.md) | Yes|Type| diff --git a/docs/API_docs/constructors/messages_messagesSlice.md b/docs/API_docs/constructors/messages_messagesSlice.md index 504a0e47..de9be9e0 100644 --- a/docs/API_docs/constructors/messages_messagesSlice.md +++ b/docs/API_docs/constructors/messages_messagesSlice.md @@ -14,7 +14,7 @@ Messages slice | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|inexact|[Bool](../types/Bool.md) | Optional|| +|inexact|[Bool](../types/Bool.md) | Optional|Inexact?| |count|[int](../types/int.md) | Yes|Count| |messages|Array of [Message](../types/Message.md) | Yes|Messages| |chats|Array of [Chat](../types/Chat.md) | Yes|Chats| diff --git a/docs/API_docs/constructors/photoStrippedSize.md b/docs/API_docs/constructors/photoStrippedSize.md index 958d6071..03f47dad 100644 --- a/docs/API_docs/constructors/photoStrippedSize.md +++ b/docs/API_docs/constructors/photoStrippedSize.md @@ -1,6 +1,6 @@ --- title: photoStrippedSize -description: photoStrippedSize attributes, type and example +description: Stripped size image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- # Constructor: photoStrippedSize @@ -8,12 +8,14 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +Stripped size + ### Attributes: -| Name | Type | Required | -|----------|---------------|----------| -|type|[string](../types/string.md) | Yes| -|bytes|[bytes](../types/bytes.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|type|[string](../types/string.md) | Yes|Stripped size| +|bytes|[bytes](../types/bytes.md) | Yes|Bytes| diff --git a/docs/API_docs/constructors/updateChatDefaultBannedRights.md b/docs/API_docs/constructors/updateChatDefaultBannedRights.md index 436230d6..47e8417b 100644 --- a/docs/API_docs/constructors/updateChatDefaultBannedRights.md +++ b/docs/API_docs/constructors/updateChatDefaultBannedRights.md @@ -1,6 +1,6 @@ --- title: updateChatDefaultBannedRights -description: updateChatDefaultBannedRights attributes, type and example +description: Global chat rights updated image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- # Constructor: updateChatDefaultBannedRights @@ -8,13 +8,15 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +Global chat rights updated + ### Attributes: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Peer](../types/Peer.md) | Yes| -|default\_banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | Yes| -|version|[int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Peer](../types/Peer.md) | Yes|Peer| +|default\_banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | Yes|Global chat rights| +|version|[int](../types/int.md) | Yes|Version| diff --git a/docs/API_docs/constructors/wallPaper.md b/docs/API_docs/constructors/wallPaper.md index 6acc963b..67a9cfbc 100644 --- a/docs/API_docs/constructors/wallPaper.md +++ b/docs/API_docs/constructors/wallPaper.md @@ -14,15 +14,15 @@ Wall paper | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|[long](../types/long.md) | Yes|| -|creator|[Bool](../types/Bool.md) | Optional|| -|default|[Bool](../types/Bool.md) | Optional|| -|pattern|[Bool](../types/Bool.md) | Optional|| -|dark|[Bool](../types/Bool.md) | Optional|| -|access\_hash|[long](../types/long.md) | Yes|| -|slug|[string](../types/string.md) | Yes|| -|document|[Document](../types/Document.md) | Optional|| -|settings|[WallPaperSettings](../types/WallPaperSettings.md) | Optional|| +|id|[long](../types/long.md) | Yes|ID| +|creator|[Bool](../types/Bool.md) | Optional|Am I the creator?| +|default|[Bool](../types/Bool.md) | Optional|Default?| +|pattern|[Bool](../types/Bool.md) | Optional|Pattern| +|dark|[Bool](../types/Bool.md) | Optional|Dark?| +|access\_hash|[long](../types/long.md) | Yes|Hash| +|slug|[string](../types/string.md) | Yes|Slug?| +|document|[Document](../types/Document.md) | Optional|Wallpaper| +|settings|[WallPaperSettings](../types/WallPaperSettings.md) | Optional|Wallpaper settings| diff --git a/docs/API_docs/constructors/wallPaperSettings.md b/docs/API_docs/constructors/wallPaperSettings.md index 24da9d8f..110d94c6 100644 --- a/docs/API_docs/constructors/wallPaperSettings.md +++ b/docs/API_docs/constructors/wallPaperSettings.md @@ -1,6 +1,6 @@ --- title: wallPaperSettings -description: wallPaperSettings attributes, type and example +description: Wallpaper settings image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- # Constructor: wallPaperSettings @@ -8,14 +8,16 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +Wallpaper settings + ### Attributes: -| Name | Type | Required | -|----------|---------------|----------| -|blur|[Bool](../types/Bool.md) | Optional| -|motion|[Bool](../types/Bool.md) | Optional| -|background\_color|[int](../types/int.md) | Optional| -|intensity|[int](../types/int.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|blur|[Bool](../types/Bool.md) | Optional|Blur?| +|motion|[Bool](../types/Bool.md) | Optional|Motion?| +|background\_color|[int](../types/int.md) | Optional|Background color| +|intensity|[int](../types/int.md) | Optional|Intensity| diff --git a/docs/API_docs/methods/account_getWallPaper.md b/docs/API_docs/methods/account_getWallPaper.md index 8c69b51b..d83e445b 100644 --- a/docs/API_docs/methods/account_getWallPaper.md +++ b/docs/API_docs/methods/account_getWallPaper.md @@ -1,17 +1,19 @@ --- title: account.getWallPaper -description: account.getWallPaper parameters, return type and example +description: Get wallpaper info image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- # Method: account.getWallPaper [Back to methods index](index.md) +Get wallpaper info + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|wallpaper|[InputWallPaper](../types/InputWallPaper.md) | Yes| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|wallpaper|[InputWallPaper](../types/InputWallPaper.md) | Wallpaper | Yes| ### Return type: [WallPaper](../types/WallPaper.md) diff --git a/docs/API_docs/methods/account_getWallPapers.md b/docs/API_docs/methods/account_getWallPapers.md index 3a95f1f8..5161fd57 100644 --- a/docs/API_docs/methods/account_getWallPapers.md +++ b/docs/API_docs/methods/account_getWallPapers.md @@ -13,7 +13,7 @@ Returns a list of available wallpapers. | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|hash|Array of [int](../types/int.md) | | Optional| +|hash|Array of [int](../types/int.md) | IDs of previously fetched wallpapers | Optional| ### Return type: [account\_WallPapers](../types/account_WallPapers.md) diff --git a/docs/API_docs/methods/account_installWallPaper.md b/docs/API_docs/methods/account_installWallPaper.md index 4ef01b73..7680de0c 100644 --- a/docs/API_docs/methods/account_installWallPaper.md +++ b/docs/API_docs/methods/account_installWallPaper.md @@ -1,18 +1,20 @@ --- title: account.installWallPaper -description: account.installWallPaper parameters, return type and example +description: Install wallpaper image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- # Method: account.installWallPaper [Back to methods index](index.md) +Install wallpaper + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|wallpaper|[InputWallPaper](../types/InputWallPaper.md) | Yes| -|settings|[WallPaperSettings](../types/WallPaperSettings.md) | Yes| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|wallpaper|[InputWallPaper](../types/InputWallPaper.md) | Wallpaper to install | Yes| +|settings|[WallPaperSettings](../types/WallPaperSettings.md) | Wallpaper settings | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/account_resetWallPapers.md b/docs/API_docs/methods/account_resetWallPapers.md index 3c458982..81d1f202 100644 --- a/docs/API_docs/methods/account_resetWallPapers.md +++ b/docs/API_docs/methods/account_resetWallPapers.md @@ -1,12 +1,14 @@ --- title: account.resetWallPapers -description: account.resetWallPapers parameters, return type and example +description: Reset wallpapers image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- # Method: account.resetWallPapers [Back to methods index](index.md) +Reset wallpapers + ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/account_saveWallPaper.md b/docs/API_docs/methods/account_saveWallPaper.md index 8da37a29..6d894f16 100644 --- a/docs/API_docs/methods/account_saveWallPaper.md +++ b/docs/API_docs/methods/account_saveWallPaper.md @@ -1,19 +1,21 @@ --- title: account.saveWallPaper -description: account.saveWallPaper parameters, return type and example +description: Save wallpaper image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- # Method: account.saveWallPaper [Back to methods index](index.md) +Save wallpaper + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|wallpaper|[InputWallPaper](../types/InputWallPaper.md) | Yes| -|unsave|[Bool](../types/Bool.md) | Yes| -|settings|[WallPaperSettings](../types/WallPaperSettings.md) | Yes| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|wallpaper|[InputWallPaper](../types/InputWallPaper.md) | The wallpaper to save | Yes| +|unsave|[Bool](../types/Bool.md) | Delete saved wallpaper | Yes| +|settings|[WallPaperSettings](../types/WallPaperSettings.md) | The wallpaper to save | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/account_sendChangePhoneCode.md b/docs/API_docs/methods/account_sendChangePhoneCode.md index caccf3cb..8d433762 100644 --- a/docs/API_docs/methods/account_sendChangePhoneCode.md +++ b/docs/API_docs/methods/account_sendChangePhoneCode.md @@ -14,7 +14,7 @@ Change the phone number | Name | Type | Description | Required | |----------|---------------|-------------|----------| |phone\_number|[string](../types/string.md) | New phone number | Yes| -|settings|[CodeSettings](../types/CodeSettings.md) | | Yes| +|settings|[CodeSettings](../types/CodeSettings.md) | Code settings | Yes| ### Return type: [auth\_SentCode](../types/auth_SentCode.md) diff --git a/docs/API_docs/methods/account_sendConfirmPhoneCode.md b/docs/API_docs/methods/account_sendConfirmPhoneCode.md index 6dc9eaf4..85746f4d 100644 --- a/docs/API_docs/methods/account_sendConfirmPhoneCode.md +++ b/docs/API_docs/methods/account_sendConfirmPhoneCode.md @@ -14,7 +14,7 @@ Send confirmation phone code | Name | Type | Description | Required | |----------|---------------|-------------|----------| |hash|[string](../types/string.md) | The hash | Yes| -|settings|[CodeSettings](../types/CodeSettings.md) | | Yes| +|settings|[CodeSettings](../types/CodeSettings.md) | Code settings | Yes| ### Return type: [auth\_SentCode](../types/auth_SentCode.md) diff --git a/docs/API_docs/methods/account_sendVerifyPhoneCode.md b/docs/API_docs/methods/account_sendVerifyPhoneCode.md index 9c5e08ac..187b79d3 100644 --- a/docs/API_docs/methods/account_sendVerifyPhoneCode.md +++ b/docs/API_docs/methods/account_sendVerifyPhoneCode.md @@ -14,7 +14,7 @@ Send phone verification code | Name | Type | Description | Required | |----------|---------------|-------------|----------| |phone\_number|[string](../types/string.md) | The phone number | Yes| -|settings|[CodeSettings](../types/CodeSettings.md) | | Yes| +|settings|[CodeSettings](../types/CodeSettings.md) | Code settings | Yes| ### Return type: [auth\_SentCode](../types/auth_SentCode.md) diff --git a/docs/API_docs/methods/account_uploadWallPaper.md b/docs/API_docs/methods/account_uploadWallPaper.md index c6d3e2a7..4c47946e 100644 --- a/docs/API_docs/methods/account_uploadWallPaper.md +++ b/docs/API_docs/methods/account_uploadWallPaper.md @@ -1,19 +1,21 @@ --- title: account.uploadWallPaper -description: account.uploadWallPaper parameters, return type and example +description: Upload wallpaper image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- # Method: account.uploadWallPaper [Back to methods index](index.md) +Upload wallpaper + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|file|[File path or InputFile](../types/InputFile.md) | Yes| -|mime\_type|[string](../types/string.md) | Yes| -|settings|[WallPaperSettings](../types/WallPaperSettings.md) | Yes| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file|[File path or InputFile](../types/InputFile.md) | Image | Yes| +|mime\_type|[string](../types/string.md) | Mime type | Yes| +|settings|[WallPaperSettings](../types/WallPaperSettings.md) | Wallpaper settings | Yes| ### Return type: [WallPaper](../types/WallPaper.md) diff --git a/docs/API_docs/methods/channels_editAdmin.md b/docs/API_docs/methods/channels_editAdmin.md index 16910bd4..5e77eade 100644 --- a/docs/API_docs/methods/channels_editAdmin.md +++ b/docs/API_docs/methods/channels_editAdmin.md @@ -15,7 +15,7 @@ Edit admin permissions of a user in a channel/supergroup |----------|---------------|-------------|----------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel | Optional| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user | Optional| -|admin\_rights|[ChatAdminRights](../types/ChatAdminRights.md) | | Yes| +|admin\_rights|[ChatAdminRights](../types/ChatAdminRights.md) | Admin rights | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/docs/API_docs/methods/channels_editBanned.md b/docs/API_docs/methods/channels_editBanned.md index daa1f569..74a99ee7 100644 --- a/docs/API_docs/methods/channels_editBanned.md +++ b/docs/API_docs/methods/channels_editBanned.md @@ -15,7 +15,7 @@ Kick or ban a user from a channel/supergroup |----------|---------------|-------------|----------| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel/supergroup | Optional| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user to kick/ban | Optional| -|banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | | Yes| +|banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | Banned rights | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/docs/API_docs/methods/index.md b/docs/API_docs/methods/index.md index 4f0eb4e6..852bdc21 100644 --- a/docs/API_docs/methods/index.md +++ b/docs/API_docs/methods/index.md @@ -150,6 +150,10 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Edit admin permissions: messages.editChatAdmin +* Edit chat info: messages.editChatAbout + +* Edit default rights of chat: messages.editChatDefaultBannedRights + * Edit the photo of a normal chat (not supergroup): messages.editChatPhoto * Edit the photo of a supergroup/channel: channels.editPhoto @@ -332,6 +336,8 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Get user info: help.getUserInfo +* Get wallpaper info: account.getWallPaper + * Get webpage preview: messages.getWebPage * Get webpage preview: messages.getWebPagePreview @@ -346,6 +352,8 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Initializes connection and save information on the user's device and application.: initConnection +* Install wallpaper: account.installWallPaper + * Invalidate sent phone code: auth.cancelCode * Invoke method from takeout session: invokeWithTakeout @@ -420,6 +428,8 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Reset top peer rating for a certain category/peer: contacts.resetTopPeerRating +* Reset wallpapers: account.resetWallPapers + * Result type returned by a current query.: invokeAfterMsgs * Returns a list of available wallpapers.: account.getWallPapers @@ -432,6 +442,8 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Save telegram passport secure value: account.saveSecureValue +* Save wallpaper: account.saveWallPaper + * Search contacts: contacts.search * Search gifs: messages.searchGifs @@ -516,6 +528,8 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png * Upload profile photo: photos.uploadProfilePhoto +* Upload wallpaper: account.uploadWallPaper + * Use the code that was emailed to you after running $MadelineProto->auth->requestPasswordRecovery to login to your account: auth.recoverPassword * Validate requested payment info: payments.validateRequestedInfo diff --git a/docs/API_docs/methods/messages_editChatAbout.md b/docs/API_docs/methods/messages_editChatAbout.md index cdaa7b55..2e5f1970 100644 --- a/docs/API_docs/methods/messages_editChatAbout.md +++ b/docs/API_docs/methods/messages_editChatAbout.md @@ -1,18 +1,20 @@ --- title: messages.editChatAbout -description: messages.editChatAbout parameters, return type and example +description: Edit chat info image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- # Method: messages.editChatAbout [Back to methods index](index.md) +Edit chat info + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|about|[string](../types/string.md) | Yes| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Chat | Optional| +|about|[string](../types/string.md) | Info | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_editChatDefaultBannedRights.md b/docs/API_docs/methods/messages_editChatDefaultBannedRights.md index 67d37679..822cb684 100644 --- a/docs/API_docs/methods/messages_editChatDefaultBannedRights.md +++ b/docs/API_docs/methods/messages_editChatDefaultBannedRights.md @@ -1,18 +1,20 @@ --- title: messages.editChatDefaultBannedRights -description: messages.editChatDefaultBannedRights parameters, return type and example +description: Edit default rights of chat image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- # Method: messages.editChatDefaultBannedRights [Back to methods index](index.md) +Edit default rights of chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | Yes| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Chat | Optional| +|banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | Global chat rights | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/docs/API_docs/methods/messages_exportChatInvite.md b/docs/API_docs/methods/messages_exportChatInvite.md index cfc0418a..952b6a43 100644 --- a/docs/API_docs/methods/messages_exportChatInvite.md +++ b/docs/API_docs/methods/messages_exportChatInvite.md @@ -13,7 +13,7 @@ Export chat invite | Name | Type | Description | Required | |----------|---------------|-------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Export invite only for this user | Optional| ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/docs/docs/CALLS.md b/docs/docs/CALLS.md index 03aad4fc..b3293da3 100644 --- a/docs/docs/CALLS.md +++ b/docs/docs/CALLS.md @@ -124,4 +124,4 @@ while (true) { } ``` -Next section +Next section \ No newline at end of file diff --git a/docs/docs/INLINE_BUTTONS.md b/docs/docs/INLINE_BUTTONS.md index 806e4ba0..fc20cd31 100644 --- a/docs/docs/INLINE_BUTTONS.md +++ b/docs/docs/INLINE_BUTTONS.md @@ -53,4 +53,4 @@ And click them: $button->click(); ``` -Next section \ No newline at end of file +Next section \ No newline at end of file diff --git a/docs/docs/INSTALLATION.md b/docs/docs/INSTALLATION.md index 79f6a4f7..ea2eb888 100644 --- a/docs/docs/INSTALLATION.md +++ b/docs/docs/INSTALLATION.md @@ -110,4 +110,4 @@ Then you can require the package by addding the following lines to the require s ``` -Next section +Next section \ No newline at end of file diff --git a/docs/docs/LOGGING.md b/docs/docs/LOGGING.md index e97aefc2..2db8c7e9 100644 --- a/docs/docs/LOGGING.md +++ b/docs/docs/LOGGING.md @@ -22,4 +22,4 @@ MadelineProto provides a unified class for logging messages to the logging desti By default, `$level` is `\danog\MadelineProto\Logger:NOTICE`. -Next section \ No newline at end of file +Next section \ No newline at end of file diff --git a/docs/docs/PROXY.md b/docs/docs/PROXY.md index 613a1b4c..71397658 100644 --- a/docs/docs/PROXY.md +++ b/docs/docs/PROXY.md @@ -166,4 +166,4 @@ Can return additional HTTP headers to use when the HTTP protocol is being used. Returns the resource used for socket communication: should call `$socket->getResource()`. -Next section \ No newline at end of file +Next section \ No newline at end of file diff --git a/docs/docs/UPDATES.md b/docs/docs/UPDATES.md index 204f9c5f..667fb412 100644 --- a/docs/docs/UPDATES.md +++ b/docs/docs/UPDATES.md @@ -297,4 +297,4 @@ $MadelineProto->setNoop(); ``` When an [Update](https://docs.madelineproto.xyz/API_docs/types/Update.html) is received, nothing is done. This is useful if you need to populate the internal peer database with peers to avoid `This peer is not present in the internal peer database errors`, but don't need to handle updates. -Next section +Next section \ No newline at end of file diff --git a/docs/docs/USING_METHODS.md b/docs/docs/USING_METHODS.md index 9ff53d92..33b8fdd0 100644 --- a/docs/docs/USING_METHODS.md +++ b/docs/docs/USING_METHODS.md @@ -107,4 +107,4 @@ $MadelineProto->messages->sendMessage(['peer' => '@danogentili', 'message' => 'l If the queue if the specified queue name does not exist, it will be created. -Next section +Next section \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 4a6afa0f..e22e9ecf 100644 --- a/docs/index.md +++ b/docs/index.md @@ -83,16 +83,13 @@ Tip: if you receive an error (or nothing), [send us](https://t.me/pwrtelegramgro * [Getting the TL trace](https://docs.madelineproto.xyz/docs/EXCEPTIONS.html#getting-the-tl-trace) * [Avoiding FLOOD_WAITs](https://docs.madelineproto.xyz/docs/FLOOD_WAIT.html) * [Logging](https://docs.madelineproto.xyz/docs/LOGGING.html) -* [Using methods](https://docs.madelineproto.xyz/docs/USING_METHODS.html) - * [FULL API Documentation with descriptions](https://docs.madelineproto.xyz/API_docs/methods/) - * [Peers](https://docs.madelineproto.xyz/docs/USING_METHODS.html#peers) - * [Files](https://docs.madelineproto.xyz/docs/FILES.html) - * [Secret chats](https://docs.madelineproto.xyz/docs/USING_METHODS.html#secret-chats) - * [Entities (Markdown & HTML)](https://docs.madelineproto.xyz/docs/USING_METHODS.html#entities) - * [reply_markup (keyboards & inline keyboards)](https://docs.madelineproto.xyz/docs/USING_METHODS.html#reply_markup) - * [bot API objects](https://docs.madelineproto.xyz/docs/USING_METHODS.html#bot-api-objects) - * [No result](https://docs.madelineproto.xyz/docs/USING_METHODS.html#no-result) - * [Queues](https://docs.madelineproto.xyz/docs/USING_METHODS.html#queues) +* [Telegram VoIP phone calls](https://docs.madelineproto.xyz/docs/CALLS.html) + * [Requesting a call](https://docs.madelineproto.xyz/docs/CALLS.html#requesting-a-call) + * [Playing mp3 files](https://docs.madelineproto.xyz/docs/CALLS.html#playing-mp3-files) + * [Playing streams](https://docs.madelineproto.xyz/docs/CALLS.html#playing-streams) + * [Changing audio quality](https://docs.madelineproto.xyz/docs/CALLS.html#changing-audio-quality) + * [Putting it all together](https://docs.madelineproto.xyz/docs/CALLS.html#putting-it-all-together) + * [Accepting calls](https://docs.madelineproto.xyz/docs/CALLS.html#accepting-calls) * [Uploading and downloading files](https://docs.madelineproto.xyz/docs/FILES.html) * [Uploading & sending files](https://docs.madelineproto.xyz/docs/FILES.html#sending-files) * [Security notice](https://docs.madelineproto.xyz/docs/FILES.html#security-notice) @@ -120,13 +117,6 @@ Tip: if you receive an error (or nothing), [send us](https://t.me/pwrtelegramgro * [As user](https://docs.madelineproto.xyz/docs/DIALOGS.html#user-get_dialogs) * [As bot](https://docs.madelineproto.xyz/docs/DIALOGS.html#bot-internal-peer-database) * [Inline buttons](https://docs.madelineproto.xyz/docs/INLINE_BUTTONS.html) -* [Calls](https://docs.madelineproto.xyz/docs/CALLS.html) - * [Requesting a call](https://docs.madelineproto.xyz/docs/CALLS.html#requesting-a-call) - * [Playing mp3 files](https://docs.madelineproto.xyz/docs/CALLS.html#playing-mp3-files) - * [Playing streams](https://docs.madelineproto.xyz/docs/CALLS.html#playing-streams) - * [Changing audio quality](https://docs.madelineproto.xyz/docs/CALLS.html#changing-audio-quality) - * [Putting it all together](https://docs.madelineproto.xyz/docs/CALLS.html#putting-it-all-together) - * [Accepting calls](https://docs.madelineproto.xyz/docs/CALLS.html#accepting-calls) * [Secret chats](https://docs.madelineproto.xyz/docs/SECRET_CHATS.html) * [Requesting secret chats](https://docs.madelineproto.xyz/docs/SECRET_CHATS.html#requesting-secret-chats) * [Accepting secret chats](https://docs.madelineproto.xyz/docs/SECRET_CHATS.html#accepting-secret-chats) @@ -137,6 +127,281 @@ Tip: if you receive an error (or nothing), [send us](https://t.me/pwrtelegramgro * [Use pre-built Socks5 proxy](https://docs.madelineproto.xyz/docs/PROXY.html#socks5-proxy) * [Use pre-built HTTP proxy](https://docs.madelineproto.xyz/docs/PROXY.html#http-proxy) * [Build your own proxy](https://docs.madelineproto.xyz/docs/PROXY.html#build-your-proxy) +* [Using methods](https://docs.madelineproto.xyz/docs/USING_METHODS.html) + * [FULL API Documentation with descriptions](https://docs.madelineproto.xyz/API_docs/methods/) + * [Logout](https://docs.madelineproto.xyz/logout.html) + * [Login](https://docs.madelineproto.xyz/docs/LOGIN.html) + * [Get all chats, broadcast a message to all chats](https://docs.madelineproto.xyz/docs/DIALOGS.html) + * [Get the full participant list of a channel/group/supergroup](https://docs.madelineproto.xyz/get_pwr_chat.html) + * [Get full info about a user/chat/supergroup/channel](https://docs.madelineproto.xyz/get_full_info.html) + * [Get info about a user/chat/supergroup/channel](https://docs.madelineproto.xyz/get_info.html) + * [Get info about the currently logged-in user](https://docs.madelineproto.xyz/get_self.html) + * [Upload or download files up to 1.5 GB](https://docs.madelineproto.xyz/docs/FILES.html) + * [Make a phone call and play a song](https://docs.madelineproto.xyz/docs/CALLS.html) + * [Create a secret chat bot](https://docs.madelineproto.xyz/docs/SECRET_CHATS.html) + * Accept telegram passport authorization: account.acceptAuthorization + * Accept telegram's TOS: help.acceptTermsOfService + * Add a sticker set: messages.installStickerSet + * Add a sticker to favorites: messages.faveSticker + * Add a sticker to recent stickers: messages.saveRecentSticker + * Add a user to a normal chat (use channels->inviteToChannel for supergroups): messages.addChatUser + * Add phone number as contact: contacts.importContacts + * Add sticker to stickerset: stickers.addStickerToSet + * Add users to channel/supergroup: channels.inviteToChannel + * Block a user: contacts.block + * Bots only: get telegram passport authorization form: account.getAuthorizationForm + * Bots only: send payment form: payments.sendPaymentForm + * Bots only: set precheckout results: messages.setBotPrecheckoutResults + * Bots only: set shipping results: messages.setBotShippingResults + * Bots only: set the callback answer (after a button was clicked): messages.setBotCallbackAnswer + * Bots only: set the results of an inline query: messages.setInlineBotResults + * Call inline bot: messages.getInlineBotResults + * Cancel password recovery email: account.cancelPasswordEmail + * Change notification settings: account.updateNotifySettings + * Change sticker position in photo: stickers.changeStickerPosition + * Change the phone number associated to this account: account.changePhone + * Change the phone number: account.sendChangePhoneCode + * Change the profile photo: photos.updateProfilePhoto + * Change typing status: messages.setTyping + * Check if about to edit a message or a media caption: messages.getMessageEditData + * Check if an invitation link is valid: messages.checkChatInvite + * Check if this username is available: account.checkUsername + * Check if this username is free and can be assigned to a channel/supergroup: channels.checkUsername + * Clear all drafts: messages.clearAllDrafts + * Clear all recent stickers: messages.clearRecentStickers + * Clear saved payments info: payments.clearSavedInfo + * Confirm password recovery using email: account.confirmPasswordEmail + * Confirm this phone number is associated to this account, obtain phone_code_hash from sendConfirmPhoneCode: account.confirmPhone + * Contact signup notification setting value: account.getContactSignUpNotification + * Convert chat to supergroup: messages.migrateChat + * Create a chat (not supergroup): messages.createChat + * Create channel/supergroup: channels.createChannel + * Create stickerset: stickers.createStickerSet + * Delete a certain session: account.resetAuthorization + * Delete a certain telegram web login authorization: account.resetWebAuthorization + * Delete a channel/supergroup: channels.deleteChannel + * Delete a contact: contacts.deleteContact + * Delete a user from a chat (not supergroup): messages.deleteChatUser + * Delete all logged-in sessions.: auth.resetAuthorizations + * Delete all messages of a user in a channel/supergroup: channels.deleteUserHistory + * Delete all temporary authorization keys except the ones provided: auth.dropTempAuthKeys + * Delete channel/supergroup messages: channels.deleteMessages + * Delete chat history: messages.deleteHistory + * Delete contacts by phones: contacts.deleteByPhones + * Delete messages: messages.deleteMessages + * Delete multiple contacts: contacts.deleteContacts + * Delete profile photos: photos.deletePhotos + * Delete secure telegram passport value: account.deleteSecureValue + * Delete the history of a supergroup/channel: channels.deleteHistory + * Delete this account: account.deleteAccount + * Disable all notifications for a certain period: account.updateDeviceLocked + * Download a file through telegram: upload.getWebFile + * Edit a message: messages.editMessage + * Edit a sent inline message: messages.editInlineBotMessage + * Edit admin permissions of a user in a channel/supergroup: channels.editAdmin + * Edit admin permissions: messages.editChatAdmin + * Edit chat info: messages.editChatAbout + * Edit default rights of chat: messages.editChatDefaultBannedRights + * Edit the photo of a normal chat (not supergroup): messages.editChatPhoto + * Edit the photo of a supergroup/channel: channels.editPhoto + * Edit the title of a normal chat (not supergroup): messages.editChatTitle + * Edit the title of a supergroup/channel: channels.editTitle + * Edit user info: help.editUserInfo + * Enable or disable hidden history for new channel/supergroup users: channels.togglePreHistoryHidden + * Export chat invite : messages.exportChatInvite + * Find a sticker set: messages.searchStickerSets + * Finish account exporting session: account.finishTakeoutSession + * Forward messages: messages.forwardMessages + * Get CDN configuration: help.getCdnConfig + * Get a stickerset: messages.getStickerSet + * Get account TTL: account.getAccountTTL + * Get admin log of a channel/supergroup: channels.getAdminLog + * Get all archived stickers: messages.getArchivedStickers + * Get all channels you left: channels.getLeftChannels + * Get all chats (not supergroups or channels): messages.getAllChats + * Get all contacts: contacts.getContacts + * Get all logged-in authorizations: account.getAuthorizations + * Get all message drafts: messages.getAllDrafts + * Get all secure telegram passport values: account.getAllSecureValues + * Get all stickerpacks: messages.getAllStickers + * Get all supergroups/channels where you're admin: channels.getAdminedPublicChannels + * Get and increase message views: messages.getMessagesViews + * Get app config: help.getAppConfig + * Get available languages: langpack.getLanguages + * Get blocked users: contacts.getBlocked + * Get call configuration: phone.getCallConfig + * Get channel/supergroup messages: channels.getMessages + * Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead): channels.getParticipants + * Get chats in common with a user: messages.getCommonChats + * Get contacts by IDs: contacts.getContactIDs + * Get deep link info: help.getDeepLinkInfo + * Get dialog info of peers: messages.getPeerDialogs + * Get dialogs marked as unread manually: messages.getDialogUnreadMarks + * Get document by SHA256 hash: messages.getDocumentByHash + * Get favorite stickers: messages.getFavedStickers + * Get featured stickers: messages.getFeaturedStickers + * Get high scores of a game sent in an inline message: messages.getInlineGameHighScores + * Get high scores of a game: messages.getGameHighScores + * Get info about a certain channel/supergroup participant: channels.getParticipant + * Get info about app updates: help.getAppUpdate + * Get info about chats: messages.getChats + * Get info about multiple channels/supergroups: channels.getChannels + * Get info about users: users.getUsers + * Get info of support user: help.getSupport + * Get information about the current proxy: help.getProxyData + * Get invitation text: help.getInviteText + * Get language pack strings: langpack.getStrings + * Get language pack updates: langpack.getDifference + * Get language pack: langpack.getLangPack + * Get language: langpack.getLanguage + * Get masks: messages.getMaskStickers + * Get message ranges to fetch: messages.getSplitRanges + * Get messages: messages.getMessages + * Get most used chats: contacts.getTopPeers + * Get nearest datacenter: help.getNearestDc + * Get notification exceptions: account.getNotifyExceptions + * Get notification settings: account.getNotifySettings + * Get online status of all users: contacts.getStatuses + * Get online users: messages.getOnlines + * Get passport config: help.getPassportConfig + * Get payment form: payments.getPaymentForm + * Get payment receipt: payments.getPaymentReceipt + * Get pinned dialogs: messages.getPinnedDialogs + * Get poll results: messages.getPollResults + * Get previous messages of a group: messages.getHistory + * Get privacy settings: account.getPrivacy + * Get recent locations: messages.getRecentLocations + * Get recent stickers: messages.getRecentStickers + * Get recent t.me URLs: help.getRecentMeUrls + * Get saved contacts: contacts.getSaved + * Get saved gifs: messages.getSavedGifs + * Get saved payments info: payments.getSavedInfo + * Get secure value for telegram passport: account.getSecureValue + * Get server configuration: help.getConfig + * Get stats URL: messages.getStatsURL + * Get stickers attachable to images: messages.getAttachedStickers + * Get stickers: messages.getStickers + * Get support name: help.getSupportName + * Get telegram web login authorizations: account.getWebAuthorizations + * Get temporary password for buying products through bots: account.getTmpPassword + * Get the callback answer of a bot (after clicking a button): messages.getBotCallbackAnswer + * Get the changelog of this app: help.getAppChangelog + * Get the current password: account.getPassword + * Get the link of a message in a channel: channels.exportMessageLink + * Get the profile photos of a user: photos.getUserPhotos + * Get the settings of apeer: messages.getPeerSettings + * Get unread mentions: messages.getUnreadMentions + * Get updated TOS: help.getTermsOfServiceUpdate + * Get user info: help.getUserInfo + * Get wallpaper info: account.getWallPaper + * Get webpage preview: messages.getWebPage + * Get webpage preview: messages.getWebPagePreview + * Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https://docs.madelineproto.xyz/docs/DIALOGS.html: messages.getDialogs + * Global message search: messages.searchGlobal + * Hide report spam popup: messages.hideReportSpam + * Import chat invite: messages.importChatInvite + * Initializes connection and save information on the user's device and application.: initConnection + * Install wallpaper: account.installWallPaper + * Invalidate sent phone code: auth.cancelCode + * Invoke method from takeout session: invokeWithTakeout + * Invoke this method with layer X: invokeWithLayer + * Invoke with messages range: invokeWithMessagesRange + * Invoke with method without returning updates in the socket: invokeWithoutUpdates + * Invokes a query after successfull completion of one of the previous queries.: invokeAfterMsg + * Join a channel/supergroup: channels.joinChannel + * Kick or ban a user from a channel/supergroup: channels.editBanned + * Leave a channel/supergroup: channels.leaveChannel + * Log data for developer of this app: help.saveAppLog + * Mark channel/supergroup history as read: channels.readHistory + * Mark channel/supergroup messages as read: channels.readMessageContents + * Mark dialog as unread : messages.markDialogUnread + * Mark mentions as read: messages.readMentions + * Mark message as read: messages.readMessageContents + * Mark messages as read in secret chats: messages.readEncryptedHistory + * Mark messages as read: messages.readHistory + * Mark messages as read: messages.receivedMessages + * Mark new featured stickers as read: messages.readFeaturedStickers + * Notify server that you received a call (server will refuse all incoming calls until the current call is over): phone.receivedCall + * Pin or unpin dialog: messages.toggleDialogPin + * Register device for push notifications: account.registerDevice + * Remove a sticker set: messages.uninstallStickerSet + * Remove sticker from stickerset: stickers.removeStickerFromSet + * Reorder pinned dialogs: messages.reorderPinnedDialogs + * Reorder sticker sets: messages.reorderStickerSets + * Report a message in a supergroup/channel for spam: channels.reportSpam + * Report a message: messages.report + * Report a peer for spam: messages.reportSpam + * Report for spam a secret chat: messages.reportEncryptedSpam + * Report for spam: account.reportPeer + * Resend password recovery email: account.resendPasswordEmail + * Resend the SMS verification code: auth.resendCode + * Reset all notification settings: account.resetNotifySettings + * Reset all telegram web login authorizations: account.resetWebAuthorizations + * Reset saved contacts: contacts.resetSaved + * Reset top peer rating for a certain category/peer: contacts.resetTopPeerRating + * Reset wallpapers: account.resetWallPapers + * Result type returned by a current query.: invokeAfterMsgs + * Returns a list of available wallpapers.: account.getWallPapers + * Save a GIF: messages.saveGif + * Save a message draft: messages.saveDraft + * Save call debugging info: phone.saveCallDebug + * Save telegram passport secure value: account.saveSecureValue + * Save wallpaper: account.saveWallPaper + * Search contacts: contacts.search + * Search gifs: messages.searchGifs + * Search peers or messages: messages.search + * Send a custom request to the bot API: bots.sendCustomRequest + * Send a file to a secret chat: messages.sendEncryptedFile + * Send a media: messages.sendMedia + * Send a message: messages.sendMessage + * Send a service message to a secret chat: messages.sendEncryptedService + * Send an album: messages.sendMultiMedia + * Send an email to recover the 2FA password: auth.requestPasswordRecovery + * Send confirmation phone code: account.sendConfirmPhoneCode + * Send email verification code: account.sendVerifyEmailCode + * Send inline bot result obtained with messages.getInlineBotResults to the chat: messages.sendInlineBotResult + * Send message to secret chat: messages.sendEncrypted + * Send phone verification code: account.sendVerifyPhoneCode + * Send screenshot notification: messages.sendScreenshotNotification + * Send typing notification to secret chat: messages.setEncryptedTyping + * Send vote: messages.sendVote + * Send webhook request via bot API: bots.answerWebhookJSONQuery + * Set account TTL: account.setAccountTTL + * Set contact sign up notification: account.setContactSignUpNotification + * Set phone call rating: phone.setCallRating + * Set privacy settings: account.setPrivacy + * Set secure value error for telegram passport: users.setSecureValueErrors + * Set the game score of an inline message: messages.setInlineGameScore + * Set the game score: messages.setGameScore + * Set the supergroup/channel stickerpack: channels.setStickers + * Set the update status of webhook: help.setBotUpdatesStatus + * Start a bot: messages.startBot + * Start account exporting session: account.initTakeoutSession + * Stop sending PUSH notifications to app: account.unregisterDevice + * Toggle channel signatures: channels.toggleSignatures + * Toggle top peers: contacts.toggleTopPeers + * Unblock a user: contacts.unblock + * Update online status: account.updateStatus + * Update pinned message (private chat only): messages.updatePinnedMessage + * Update profile info: account.updateProfile + * Update the username of a supergroup/channel: channels.updateUsername + * Update this user's username: account.updateUsername + * Upload a file without sending it to anyone: messages.uploadMedia + * Upload a secret chat file without sending it to anyone: messages.uploadEncryptedFile + * Upload profile photo: photos.uploadProfilePhoto + * Upload wallpaper: account.uploadWallPaper + * Use the code that was emailed to you after running $MadelineProto->auth->requestPasswordRecovery to login to your account: auth.recoverPassword + * Validate requested payment info: payments.validateRequestedInfo + * Verify email address: account.verifyEmail + * Verify phone number: account.verifyPhone + * [Peers](https://docs.madelineproto.xyz/docs/USING_METHODS.html#peers) + * [Files](https://docs.madelineproto.xyz/docs/FILES.html) + * [Secret chats](https://docs.madelineproto.xyz/docs/USING_METHODS.html#secret-chats) + * [Entities (Markdown & HTML)](https://docs.madelineproto.xyz/docs/USING_METHODS.html#entities) + * [reply_markup (keyboards & inline keyboards)](https://docs.madelineproto.xyz/docs/USING_METHODS.html#reply_markup) + * [bot API objects](https://docs.madelineproto.xyz/docs/USING_METHODS.html#bot-api-objects) + * [No result](https://docs.madelineproto.xyz/docs/USING_METHODS.html#no-result) + * [Queues](https://docs.madelineproto.xyz/docs/USING_METHODS.html#queues) * [Contributing](https://docs.madelineproto.xyz/docs/CONTRIB.html) * [Translation](https://docs.madelineproto.xyz/docs/CONTRIB.html#translation) * [Contribution guide](https://docs.madelineproto.xyz/docs/CONTRIB.html#contribution-guide)