danog/MadelineProtoDocs
1
0
Fork 0
mirror of https://github.com/danog/MadelineProtoDocs.git synced 2024-11-30 04:39:42 +01:00
Code Issues Projects Releases Wiki Activity

Bump

Browse Source
This commit is contained in:
Daniil Gentili 2024-05-23 18:20:53 +02:00
parent da954d5948
commit f4194b5037
7 changed files with 28 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/PHP/danog/MadelineProto/API.md
View File

@ -108,7 +108,7 @@ Main API wrapper for MadelineProto.
* [`completePhoneLogin(string $code): array`](#completePhoneLogin)
* [`completeSignup(string $first_name, string $last_name = ''): array`](#completeSignup)
* [`discardCall(int $id, \danog\MadelineProto\VoIP\DiscardReason $reason = \danog\MadelineProto\VoIP\DiscardReason::HANGUP, int<1, 5> $rating = NULL, string $comment = NULL): void`](#discardCall)
* [`discardSecretChat(int $chat): void`](#discardSecretChat)
* [`discardSecretChat(int $chat, bool $deleteHistory = false): void`](#discardSecretChat)
* [`downloadServer(string $session): void`](#downloadServer)
* [`downloadToBrowser((array|string|\danog\MadelineProto\FileCallbackInterface|\danog\MadelineProto\EventHandler\Message) $messageMedia, (null|callable) $cb = NULL, (null|int) $size = NULL, (null|string) $name = NULL, (null|string) $mime = NULL, ?\Amp\Cancellation $cancellation = NULL): void`](#downloadToBrowser)
* [`downloadToCallable(mixed $messageMedia, (callable|\danog\MadelineProto\FileCallbackInterface) $callable, callable $cb = NULL, bool $seekable = true, int $offset = 0, int $end = -1, int $part_size = NULL, ?\Amp\Cancellation $cancellation = NULL): void`](#downloadToCallable)
@ -736,7 +736,7 @@ Parameters:
### <a name="discardSecretChat"></a> `discardSecretChat(int $chat): void`
### <a name="discardSecretChat"></a> `discardSecretChat(int $chat, bool $deleteHistory = false): void`
Discard secret chat.
@ -744,6 +744,7 @@ Discard secret chat.
Parameters:
* `$chat`: `int` Secret chat ID
* `$deleteHistory`: `bool` If true, deletes the entire chat history for the other user as well.

5
docs/PHP/danog/MadelineProto/EventHandler.md
View File

@ -73,7 +73,7 @@ Event handler.
* [`completePhoneLogin(string $code): array`](#completePhoneLogin)
* [`completeSignup(string $first_name, string $last_name = ''): array`](#completeSignup)
* [`discardCall(int $id, \danog\MadelineProto\VoIP\DiscardReason $reason = \danog\MadelineProto\VoIP\DiscardReason::HANGUP, int<1, 5> $rating = NULL, string $comment = NULL): void`](#discardCall)
* [`discardSecretChat(int $chat): void`](#discardSecretChat)
* [`discardSecretChat(int $chat, bool $deleteHistory = false): void`](#discardSecretChat)
* [`downloadServer(string $session): void`](#downloadServer)
* [`downloadToBrowser((array|string|\danog\MadelineProto\FileCallbackInterface|\danog\MadelineProto\EventHandler\Message) $messageMedia, (null|callable) $cb = NULL, (null|int) $size = NULL, (null|string) $name = NULL, (null|string) $mime = NULL, ?\Amp\Cancellation $cancellation = NULL): void`](#downloadToBrowser)
* [`downloadToCallable(mixed $messageMedia, (callable|\danog\MadelineProto\FileCallbackInterface) $callable, callable $cb = NULL, bool $seekable = true, int $offset = 0, int $end = -1, int $part_size = NULL, ?\Amp\Cancellation $cancellation = NULL): void`](#downloadToCallable)
@ -744,7 +744,7 @@ Parameters:
### <a name="discardSecretChat"></a> `discardSecretChat(int $chat): void`
### <a name="discardSecretChat"></a> `discardSecretChat(int $chat, bool $deleteHistory = false): void`
Discard secret chat.
@ -752,6 +752,7 @@ Discard secret chat.
Parameters:
* `$chat`: `int` Secret chat ID
* `$deleteHistory`: `bool` If true, deletes the entire chat history for the other user as well.

24
docs/PHP/danog/MadelineProto/EventHandler/Message/SecretMessage.md
View File

@ -58,6 +58,7 @@ All messages associated to the same album will have an identical grouped ID.
## Method list:
* [`getReply(string $class = 'danog\\MadelineProto\\EventHandler\\Message\\SecretMessage'): ?\danog\MadelineProto\EventHandler\Message\SecretMessage`](#getReply)
* [`delete(boolean $revoke = true): void`](#delete)
* [`screenShot(): \danog\MadelineProto\EventHandler\Message\Service\DialogScreenshotTaken`](#screenShot)
* [`pin(bool $pmOneside = false, bool $silent = false): void`](#pin)
* [`unpin(bool $pmOneside = false, bool $silent = false): ?\danog\MadelineProto\EventHandler\Update`](#unpin)
@ -75,7 +76,6 @@ All messages associated to the same album will have an identical grouped ID.
* [`forward((integer|string) $peer, list<int> $id = [], bool $dropAuthor = false, bool $dropCaption = false, int $topicId = 1, boolean $silent = false, boolean $noForwards = false, boolean $background = false, boolean $score = false, (integer|null) $scheduleDate = NULL, (integer|string|null) $sendAs = NULL): non-empty-list<\danog\MadelineProto\EventHandler\Message>`](#forward)
* [`getHTML(bool $allowTelegramTags = false): string`](#getHTML)
* [`isReply(): bool`](#isReply)
* [`delete(boolean $revoke = true): void`](#delete)
* [`reply(string $message, \danog\MadelineProto\ParseMode $parseMode = \danog\MadelineProto\ParseMode::TEXT, (array|null) $replyMarkup = NULL, (integer|string|null) $sendAs = NULL, (integer|null) $scheduleDate = NULL, boolean $noWebpage = false, boolean $silent = false, boolean $noForwards = false, boolean $background = false, boolean $clearDraft = false, boolean $updateStickersetsOrder = false, ?\Amp\Cancellation $cancellation = NULL): \danog\MadelineProto\EventHandler\Message`](#reply)
* [`replyDocument((\danog\MadelineProto\EventHandler\Message|\danog\MadelineProto\EventHandler\Media|\danog\MadelineProto\LocalFile|\danog\MadelineProto\RemoteUrl|\danog\MadelineProto\BotApiFileId|\Amp\ByteStream\ReadableStream) $file, (\danog\MadelineProto\EventHandler\Message|\danog\MadelineProto\EventHandler\Media|\danog\MadelineProto\LocalFile|\danog\MadelineProto\RemoteUrl|\danog\MadelineProto\BotApiFileId|\Amp\ByteStream\ReadableStream|null) $thumb = NULL, string $caption = '', \danog\MadelineProto\ParseMode $parseMode = \danog\MadelineProto\ParseMode::TEXT, ?callable $callback = NULL, ?string $fileName = NULL, ?string $mimeType = NULL, ?int $ttl = NULL, bool $spoiler = false, (array|null) $replyMarkup = NULL, (integer|null) $sendAs = NULL, (integer|null) $scheduleDate = NULL, boolean $silent = false, bool $noForwards = false, boolean $background = false, boolean $clearDraft = false, boolean $updateStickersetsOrder = false, boolean $forceResend = false, \Amp\Cancellation $cancellation = NULL): \danog\MadelineProto\EventHandler\Message`](#replyDocument)
* [`replyVideo((\danog\MadelineProto\EventHandler\Message|\danog\MadelineProto\EventHandler\Media|\danog\MadelineProto\LocalFile|\danog\MadelineProto\RemoteUrl|\danog\MadelineProto\BotApiFileId|\Amp\ByteStream\ReadableStream) $file, (\danog\MadelineProto\EventHandler\Message|\danog\MadelineProto\EventHandler\Media|\danog\MadelineProto\LocalFile|\danog\MadelineProto\RemoteUrl|\danog\MadelineProto\BotApiFileId|\Amp\ByteStream\ReadableStream|null) $thumb = NULL, string $caption = '', \danog\MadelineProto\ParseMode $parseMode = \danog\MadelineProto\ParseMode::TEXT, ?callable $callback = NULL, ?string $fileName = NULL, string $mimeType = 'video/mp4', (integer|null) $ttl = NULL, boolean $spoiler = false, boolean $roundMessage = false, boolean $supportsStreaming = true, boolean $noSound = false, (integer|null) $duration = NULL, (integer|null) $width = NULL, (integer|null) $height = NULL, (array|null) $replyMarkup = NULL, (integer|string|null) $sendAs = NULL, (integer|null) $scheduleDate = NULL, boolean $silent = false, boolean $noForwards = false, boolean $background = false, boolean $clearDraft = false, boolean $forceResend = false, bool $updateStickersetsOrder = false, \Amp\Cancellation $cancellation = NULL): \danog\MadelineProto\EventHandler\Message`](#replyVideo)
@ -107,6 +107,17 @@ Parameters:
### <a name="delete"></a> `delete(boolean $revoke = true): void`
Delete the message.
Parameters:
* `$revoke`: `boolean` Whether to delete the message for all participants of the chat.
### <a name="screenShot"></a> `screenShot(): \danog\MadelineProto\EventHandler\Message\Service\DialogScreenshotTaken`
@ -330,17 +341,6 @@ Check if the current message replies to another message.
### <a name="delete"></a> `delete(boolean $revoke = true): void`
Delete the message.
Parameters:
* `$revoke`: `boolean` Whether to delete the message for all participants of the chat.
### <a name="reply"></a> `reply(string $message, \danog\MadelineProto\ParseMode $parseMode = \danog\MadelineProto\ParseMode::TEXT, (array|null) $replyMarkup = NULL, (integer|string|null) $sendAs = NULL, (integer|null) $scheduleDate = NULL, boolean $noWebpage = false, boolean $silent = false, boolean $noForwards = false, boolean $background = false, boolean $clearDraft = false, boolean $updateStickersetsOrder = false, ?\Amp\Cancellation $cancellation = NULL): \danog\MadelineProto\EventHandler\Message`
Reply to the message.

5
docs/PHP/danog/MadelineProto/EventHandler/Plugin/RestartPlugin.md
View File

@ -75,7 +75,7 @@ Plugin that offers a /restart command to admins that can be used to restart the
* [`completePhoneLogin(string $code): array`](#completePhoneLogin)
* [`completeSignup(string $first_name, string $last_name = ''): array`](#completeSignup)
* [`discardCall(int $id, \danog\MadelineProto\VoIP\DiscardReason $reason = \danog\MadelineProto\VoIP\DiscardReason::HANGUP, int<1, 5> $rating = NULL, string $comment = NULL): void`](#discardCall)
* [`discardSecretChat(int $chat): void`](#discardSecretChat)
* [`discardSecretChat(int $chat, bool $deleteHistory = false): void`](#discardSecretChat)
* [`downloadServer(string $session): void`](#downloadServer)
* [`downloadToBrowser((array|string|\danog\MadelineProto\FileCallbackInterface|\danog\MadelineProto\EventHandler\Message) $messageMedia, (null|callable) $cb = NULL, (null|int) $size = NULL, (null|string) $name = NULL, (null|string) $mime = NULL, ?\Amp\Cancellation $cancellation = NULL): void`](#downloadToBrowser)
* [`downloadToCallable(mixed $messageMedia, (callable|\danog\MadelineProto\FileCallbackInterface) $callable, callable $cb = NULL, bool $seekable = true, int $offset = 0, int $end = -1, int $part_size = NULL, ?\Amp\Cancellation $cancellation = NULL): void`](#downloadToCallable)
@ -760,7 +760,7 @@ Parameters:
### <a name="discardSecretChat"></a> `discardSecretChat(int $chat): void`
### <a name="discardSecretChat"></a> `discardSecretChat(int $chat, bool $deleteHistory = false): void`
Discard secret chat.
@ -768,6 +768,7 @@ Discard secret chat.
Parameters:
* `$chat`: `int` Secret chat ID
* `$deleteHistory`: `bool` If true, deletes the entire chat history for the other user as well.

5
docs/PHP/danog/MadelineProto/PluginEventHandler.md
View File

@ -74,7 +74,7 @@ Plugin event handler class.
* [`completePhoneLogin(string $code): array`](#completePhoneLogin)
* [`completeSignup(string $first_name, string $last_name = ''): array`](#completeSignup)
* [`discardCall(int $id, \danog\MadelineProto\VoIP\DiscardReason $reason = \danog\MadelineProto\VoIP\DiscardReason::HANGUP, int<1, 5> $rating = NULL, string $comment = NULL): void`](#discardCall)
* [`discardSecretChat(int $chat): void`](#discardSecretChat)
* [`discardSecretChat(int $chat, bool $deleteHistory = false): void`](#discardSecretChat)
* [`downloadServer(string $session): void`](#downloadServer)
* [`downloadToBrowser((array|string|\danog\MadelineProto\FileCallbackInterface|\danog\MadelineProto\EventHandler\Message) $messageMedia, (null|callable) $cb = NULL, (null|int) $size = NULL, (null|string) $name = NULL, (null|string) $mime = NULL, ?\Amp\Cancellation $cancellation = NULL): void`](#downloadToBrowser)
* [`downloadToCallable(mixed $messageMedia, (callable|\danog\MadelineProto\FileCallbackInterface) $callable, callable $cb = NULL, bool $seekable = true, int $offset = 0, int $end = -1, int $part_size = NULL, ?\Amp\Cancellation $cancellation = NULL): void`](#downloadToCallable)
@ -743,7 +743,7 @@ Parameters:
### <a name="discardSecretChat"></a> `discardSecretChat(int $chat): void`
### <a name="discardSecretChat"></a> `discardSecretChat(int $chat, bool $deleteHistory = false): void`
Discard secret chat.
@ -751,6 +751,7 @@ Discard secret chat.
Parameters:
* `$chat`: `int` Secret chat ID
* `$deleteHistory`: `bool` If true, deletes the entire chat history for the other user as well.

5
docs/PHP/danog/MadelineProto/SimpleEventHandler.md
View File

@ -73,7 +73,7 @@ Simple event handler class: by extending this class, you can use filters, crons
* [`completePhoneLogin(string $code): array`](#completePhoneLogin)
* [`completeSignup(string $first_name, string $last_name = ''): array`](#completeSignup)
* [`discardCall(int $id, \danog\MadelineProto\VoIP\DiscardReason $reason = \danog\MadelineProto\VoIP\DiscardReason::HANGUP, int<1, 5> $rating = NULL, string $comment = NULL): void`](#discardCall)
* [`discardSecretChat(int $chat): void`](#discardSecretChat)
* [`discardSecretChat(int $chat, bool $deleteHistory = false): void`](#discardSecretChat)
* [`downloadServer(string $session): void`](#downloadServer)
* [`downloadToBrowser((array|string|\danog\MadelineProto\FileCallbackInterface|\danog\MadelineProto\EventHandler\Message) $messageMedia, (null|callable) $cb = NULL, (null|int) $size = NULL, (null|string) $name = NULL, (null|string) $mime = NULL, ?\Amp\Cancellation $cancellation = NULL): void`](#downloadToBrowser)
* [`downloadToCallable(mixed $messageMedia, (callable|\danog\MadelineProto\FileCallbackInterface) $callable, callable $cb = NULL, bool $seekable = true, int $offset = 0, int $end = -1, int $part_size = NULL, ?\Amp\Cancellation $cancellation = NULL): void`](#downloadToCallable)
@ -744,7 +744,7 @@ Parameters:
### <a name="discardSecretChat"></a> `discardSecretChat(int $chat): void`
### <a name="discardSecretChat"></a> `discardSecretChat(int $chat, bool $deleteHistory = false): void`
Discard secret chat.
@ -752,6 +752,7 @@ Discard secret chat.
Parameters:
* `$chat`: `int` Secret chat ID
* `$deleteHistory`: `bool` If true, deletes the entire chat history for the other user as well.

2
docs/docs/FILTERS.md
View File

@ -939,4 +939,4 @@ Here's a full list of all MTProto filters (click on each filter name to view the
<!-- cut_here_end mtprotofilters -->
<a href="https://docs.madelineproto.xyz/docs/PLUGINS.html">Next section</a>
<a href="https://docs.madelineproto.xyz/docs/PLUGINS.html">Next section</a>