From 1f9cb6873101c39811bbe165aeefee90ec39f7aa Mon Sep 17 00:00:00 2001 From: Daniil Gentili Date: Tue, 24 Sep 2024 18:02:34 +0200 Subject: [PATCH] bump --- .../constructors/documentAttributeVideo.md | 3 +- docs/API_docs/constructors/index.md | 5 +++- .../constructors/keyboardButtonCopy.md | 28 +++++++++++++++++++ .../constructors/messageMediaDocument.md | 4 +-- docs/API_docs/index.md | 2 +- docs/API_docs/methods/api_index.md | 2 +- .../methods/channels.clickSponsoredMessage.md | 4 ++- docs/API_docs/types/KeyboardButton.md | 2 ++ .../EventHandler/AbstractPoll.md | 2 +- .../EventHandler/Poll/MultiplePoll.md | 2 +- .../EventHandler/Poll/QuizPoll.md | 2 +- .../EventHandler/Poll/SinglePoll.md | 2 +- docs/docs/USING_METHODS.md | 2 +- 13 files changed, 48 insertions(+), 12 deletions(-) create mode 100644 docs/API_docs/constructors/keyboardButtonCopy.md diff --git a/docs/API_docs/constructors/documentAttributeVideo.md b/docs/API_docs/constructors/documentAttributeVideo.md index 1f496ec1ea..7b7d2b3691 100644 --- a/docs/API_docs/constructors/documentAttributeVideo.md +++ b/docs/API_docs/constructors/documentAttributeVideo.md @@ -23,6 +23,7 @@ Defines a video |h|[int](/API_docs/types/int.html) | Optional|Video height| |preload\_prefix\_size|[int](/API_docs/types/int.html) | Optional|Number of bytes to preload when preloading videos (particularly [video stories](https://core.telegram.org/api/stories)).| |video\_start\_ts|[double](/API_docs/types/double.html) | Optional| +|video\_codec|[string](/API_docs/types/string.html) | Optional| @@ -32,5 +33,5 @@ Defines a video ### Example: ``` -$documentAttributeVideo = ['_' => 'documentAttributeVideo', 'round_message' => Bool, 'supports_streaming' => Bool, 'nosound' => Bool, 'duration' => double, 'w' => int, 'h' => int, 'preload_prefix_size' => int, 'video_start_ts' => double]; +$documentAttributeVideo = ['_' => 'documentAttributeVideo', 'round_message' => Bool, 'supports_streaming' => Bool, 'nosound' => Bool, 'duration' => double, 'w' => int, 'h' => int, 'preload_prefix_size' => int, 'video_start_ts' => double, 'video_codec' => 'string']; ``` diff --git a/docs/API_docs/constructors/index.md b/docs/API_docs/constructors/index.md index d4c87b0206..44a8b1e898 100644 --- a/docs/API_docs/constructors/index.md +++ b/docs/API_docs/constructors/index.md @@ -1873,6 +1873,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ***

[$keyboardButtonCallback](/API_docs/constructors/keyboardButtonCallback.html) = \['requires_password' => [Bool](/API_docs/types/Bool.html), 'text' => [string](/API_docs/types/string.html), 'data' => [bytes](/API_docs/types/bytes.html), \]; +*** +

[$keyboardButtonCopy](/API_docs/constructors/keyboardButtonCopy.html) = \['text' => [string](/API_docs/types/string.html), 'copy_text' => [string](/API_docs/types/string.html), \]; + ***

[$keyboardButtonGame](/API_docs/constructors/keyboardButtonGame.html) = \['text' => [string](/API_docs/types/string.html), \]; @@ -2171,7 +2174,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png

[$messageMediaDice](/API_docs/constructors/messageMediaDice.html) = \['value' => [int](/API_docs/types/int.html), 'emoticon' => [string](/API_docs/types/string.html), \]; *** -

[$messageMediaDocument](/API_docs/constructors/messageMediaDocument.html) = \['nopremium' => [Bool](/API_docs/types/Bool.html), 'spoiler' => [Bool](/API_docs/types/Bool.html), 'video' => [Bool](/API_docs/types/Bool.html), 'round' => [Bool](/API_docs/types/Bool.html), 'voice' => [Bool](/API_docs/types/Bool.html), 'document' => [Document](/API_docs/types/Document.html), 'alt_document' => [Document](/API_docs/types/Document.html), 'ttl_seconds' => [int](/API_docs/types/int.html), \]; +

[$messageMediaDocument](/API_docs/constructors/messageMediaDocument.html) = \['nopremium' => [Bool](/API_docs/types/Bool.html), 'spoiler' => [Bool](/API_docs/types/Bool.html), 'video' => [Bool](/API_docs/types/Bool.html), 'round' => [Bool](/API_docs/types/Bool.html), 'voice' => [Bool](/API_docs/types/Bool.html), 'document' => [Document](/API_docs/types/Document.html), 'alt_documents' => \[[Document](/API_docs/types/Document.html)\], 'ttl_seconds' => [int](/API_docs/types/int.html), \]; ***

[$messageMediaEmpty](/API_docs/constructors/messageMediaEmpty.html) = \[\]; diff --git a/docs/API_docs/constructors/keyboardButtonCopy.md b/docs/API_docs/constructors/keyboardButtonCopy.md new file mode 100644 index 0000000000..8e3ba353dc --- /dev/null +++ b/docs/API_docs/constructors/keyboardButtonCopy.md @@ -0,0 +1,28 @@ +--- +title: "keyboardButtonCopy" +description: "keyboardButtonCopy attributes, type and example" +nav_exclude: true +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: keyboardButtonCopy +[Back to constructors index](/API_docs/constructors/index.html) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|text|[string](/API_docs/types/string.html) | Yes| +|copy\_text|[string](/API_docs/types/string.html) | Yes| + + + +### Type: [KeyboardButton](/API_docs/types/KeyboardButton.html) + + +### Example: + +``` +$keyboardButtonCopy = ['_' => 'keyboardButtonCopy', 'text' => 'string', 'copy_text' => 'string']; +``` diff --git a/docs/API_docs/constructors/messageMediaDocument.md b/docs/API_docs/constructors/messageMediaDocument.md index e697ab5b3c..c972f46c42 100644 --- a/docs/API_docs/constructors/messageMediaDocument.md +++ b/docs/API_docs/constructors/messageMediaDocument.md @@ -21,7 +21,7 @@ Document (video, audio, voice, sticker, any media type except photo) |round|[Bool](/API_docs/types/Bool.html) | Optional|Whether this is a round video.| |voice|[Bool](/API_docs/types/Bool.html) | Optional|Whether this is a voice message.| |document|[Document](/API_docs/types/Document.html) | Optional|Attached document| -|alt\_document|[Document](/API_docs/types/Document.html) | Optional|Currently only used for story videos, may contain an alternative version of the story video, explicitly encoded using H.264 (in MPEG4 transport) at a lower resolution than `document`.| +|alt\_documents|Array of [Document](/API_docs/types/Document.html) | Optional| |ttl\_seconds|[int](/API_docs/types/int.html) | Optional|Time to live of self-destructing document| @@ -32,5 +32,5 @@ Document (video, audio, voice, sticker, any media type except photo) ### Example: ``` -$messageMediaDocument = ['_' => 'messageMediaDocument', 'nopremium' => Bool, 'spoiler' => Bool, 'video' => Bool, 'round' => Bool, 'voice' => Bool, 'document' => Document, 'alt_document' => Document, 'ttl_seconds' => int]; +$messageMediaDocument = ['_' => 'messageMediaDocument', 'nopremium' => Bool, 'spoiler' => Bool, 'video' => Bool, 'round' => Bool, 'voice' => Bool, 'document' => Document, 'alt_documents' => [Document, Document], 'ttl_seconds' => int]; ``` diff --git a/docs/API_docs/index.md b/docs/API_docs/index.md index c302024a41..80168cc729 100644 --- a/docs/API_docs/index.md +++ b/docs/API_docs/index.md @@ -1,6 +1,6 @@ --- title: "Telegram RPC API" -description: "MadelineProto API documentation (layer 187)" +description: "MadelineProto API documentation (layer 188)" has_children: true has_toc: false image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png diff --git a/docs/API_docs/methods/api_index.md b/docs/API_docs/methods/api_index.md index 1378f1edbe..c71ee0681a 100644 --- a/docs/API_docs/methods/api_index.md +++ b/docs/API_docs/methods/api_index.md @@ -673,7 +673,7 @@ $MadelineProto->[channels->checkUsername](/API_docs/methods/channels.checkUserna ***

-$MadelineProto->[channels->clickSponsoredMessage](/API_docs/methods/channels.clickSponsoredMessage.html)(\[channel: $[InputChannel](/API_docs/types/InputChannel.html), \]) === [$Bool](/API_docs/types/Bool.html) +$MadelineProto->[channels->clickSponsoredMessage](/API_docs/methods/channels.clickSponsoredMessage.html)(\[media: $[Bool](/API_docs/types/Bool.html), fullscreen: $[Bool](/API_docs/types/Bool.html), channel: $[InputChannel](/API_docs/types/InputChannel.html), \]) === [$Bool](/API_docs/types/Bool.html) ***

diff --git a/docs/API_docs/methods/channels.clickSponsoredMessage.md b/docs/API_docs/methods/channels.clickSponsoredMessage.md index 96943491d5..65025da8f0 100644 --- a/docs/API_docs/methods/channels.clickSponsoredMessage.md +++ b/docs/API_docs/methods/channels.clickSponsoredMessage.md @@ -21,6 +21,8 @@ Informs the server that the user has either: | Name | Type | Description | Required | |----------|---------------|-------------|----------| +|media|[Bool](/API_docs/types/Bool.html) | | Optional| +|fullscreen|[Bool](/API_docs/types/Bool.html) | | Optional| |channel|[Username, chat ID, Update, Message or InputChannel](/API_docs/types/InputChannel.html) | Channel where the sponsored message was posted | Optional| @@ -41,6 +43,6 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$Bool = $MadelineProto->channels->clickSponsoredMessage(channel: $InputChannel, ); +$Bool = $MadelineProto->channels->clickSponsoredMessage(media: $Bool, fullscreen: $Bool, channel: $InputChannel, ); ``` diff --git a/docs/API_docs/types/KeyboardButton.md b/docs/API_docs/types/KeyboardButton.md index 23439a518f..12a457e0e8 100644 --- a/docs/API_docs/types/KeyboardButton.md +++ b/docs/API_docs/types/KeyboardButton.md @@ -66,6 +66,8 @@ You can also access the properties of the constructor as a normal array, for exa [inputKeyboardButtonRequestPeer](/API_docs/constructors/inputKeyboardButtonRequestPeer.html) +[keyboardButtonCopy](/API_docs/constructors/keyboardButtonCopy.html) + ### Methods that return an object of this type (methods): diff --git a/docs/PHP/danog/MadelineProto/EventHandler/AbstractPoll.md b/docs/PHP/danog/MadelineProto/EventHandler/AbstractPoll.md index 421926f0f6..9eb6b44555 100644 --- a/docs/PHP/danog/MadelineProto/EventHandler/AbstractPoll.md +++ b/docs/PHP/danog/MadelineProto/EventHandler/AbstractPoll.md @@ -24,7 +24,7 @@ Poll * `$closePeriod`: `?int` Amount of time in seconds the poll will be active after creation, 5-600 * `$closeDate`: `?int` Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 600 seconds in the future * `$recentVoters`: `list` IDs of the last users that recently voted in the poll -* `$totalVoters`: `int` Total number of people that voted in the poll +* `$totalVoters`: `?int` Total number of people that voted in the poll ## Method list: * [`fromRawPoll(array $rawPoll): \danog\MadelineProto\EventHandler\AbstractPoll`](#fromRawPoll) diff --git a/docs/PHP/danog/MadelineProto/EventHandler/Poll/MultiplePoll.md b/docs/PHP/danog/MadelineProto/EventHandler/Poll/MultiplePoll.md index 344cf62b2b..08c87425b5 100644 --- a/docs/PHP/danog/MadelineProto/EventHandler/Poll/MultiplePoll.md +++ b/docs/PHP/danog/MadelineProto/EventHandler/Poll/MultiplePoll.md @@ -24,7 +24,7 @@ Represents a poll with multiple options can be chosen as answer * `$closePeriod`: `?int` Amount of time in seconds the poll will be active after creation, 5-600 * `$closeDate`: `?int` Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 600 seconds in the future * `$recentVoters`: `list` IDs of the last users that recently voted in the poll -* `$totalVoters`: `int` Total number of people that voted in the poll +* `$totalVoters`: `?int` Total number of people that voted in the poll ## Method list: * [`fromRawPoll(array $rawPoll): \danog\MadelineProto\EventHandler\AbstractPoll`](#fromRawPoll) diff --git a/docs/PHP/danog/MadelineProto/EventHandler/Poll/QuizPoll.md b/docs/PHP/danog/MadelineProto/EventHandler/Poll/QuizPoll.md index afca8291eb..5bcbba5171 100644 --- a/docs/PHP/danog/MadelineProto/EventHandler/Poll/QuizPoll.md +++ b/docs/PHP/danog/MadelineProto/EventHandler/Poll/QuizPoll.md @@ -26,7 +26,7 @@ Represents a quiz (with wrong and correct answers, results shown in the return t * `$closePeriod`: `?int` Amount of time in seconds the poll will be active after creation, 5-600 * `$closeDate`: `?int` Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 600 seconds in the future * `$recentVoters`: `list` IDs of the last users that recently voted in the poll -* `$totalVoters`: `int` Total number of people that voted in the poll +* `$totalVoters`: `?int` Total number of people that voted in the poll ## Method list: * [`getSolutionHTML(bool $allowTelegramTags = false): ?string`](#getSolutionHTML) diff --git a/docs/PHP/danog/MadelineProto/EventHandler/Poll/SinglePoll.md b/docs/PHP/danog/MadelineProto/EventHandler/Poll/SinglePoll.md index f44f8e4bdd..40c1ef23a0 100644 --- a/docs/PHP/danog/MadelineProto/EventHandler/Poll/SinglePoll.md +++ b/docs/PHP/danog/MadelineProto/EventHandler/Poll/SinglePoll.md @@ -24,7 +24,7 @@ Represents a poll with a option can be chosen as answer * `$closePeriod`: `?int` Amount of time in seconds the poll will be active after creation, 5-600 * `$closeDate`: `?int` Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 600 seconds in the future * `$recentVoters`: `list` IDs of the last users that recently voted in the poll -* `$totalVoters`: `int` Total number of people that voted in the poll +* `$totalVoters`: `?int` Total number of people that voted in the poll ## Method list: * [`fromRawPoll(array $rawPoll): \danog\MadelineProto\EventHandler\AbstractPoll`](#fromRawPoll) diff --git a/docs/docs/USING_METHODS.md b/docs/docs/USING_METHODS.md index 8a44a6b34b..d8c5e56cf3 100644 --- a/docs/docs/USING_METHODS.md +++ b/docs/docs/USING_METHODS.md @@ -8,7 +8,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png There are simplifications for many, if not all of, these methods. -A list of all of the methods that can be called with MadelineProto can be found here: [here (layer 187)](https://docs.madelineproto.xyz/API_docs/). +A list of all of the methods that can be called with MadelineProto can be found here: [here (layer 188)](https://docs.madelineproto.xyz/API_docs/). [Now fully async!](https://docs.madelineproto.xyz/docs/ASYNC.html)