danog/MadelineProtoDocs
1
0
Fork 0
mirror of https://github.com/danog/MadelineProtoDocs.git synced 2024-11-29 20:29:45 +01:00
Code Issues Projects Releases Wiki Activity

Bump

Browse Source
This commit is contained in:
Daniil Gentili 2024-06-26 18:27:13 +02:00
parent 0385b677fe
commit 2da03b4f6e
5 changed files with 100 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -85,7 +85,7 @@ Main API wrapper for MadelineProto.
* [`MTProtoToBotAPI(array $data): array`](#MTProtoToBotAPI) * [`MTProtoToBotAPI(array $data): array`](#MTProtoToBotAPI)
* [`MTProtoToTd(mixed $params): array`](#MTProtoToTd) * [`MTProtoToTd(mixed $params): array`](#MTProtoToTd)
* [`MTProtoToTdcli(mixed $params): array`](#MTProtoToTdcli) * [`MTProtoToTdcli(mixed $params): array`](#MTProtoToTdcli)
* [`acceptCall(int $id): void`](#acceptCall) * [`acceptCall(int $id, ?\Amp\Cancellation $cancellation = NULL): void`](#acceptCall)
* [`acceptSecretChat(array $params): void`](#acceptSecretChat) * [`acceptSecretChat(array $params): void`](#acceptSecretChat)
* [`arr(mixed ...$params): array`](#arr) * [`arr(mixed ...$params): array`](#arr)
* [`base64urlDecode(string $data): string`](#base64urlDecode) * [`base64urlDecode(string $data): string`](#base64urlDecode)
@ -143,7 +143,7 @@ Main API wrapper for MadelineProto.
* [`getCdnConfig(): void`](#getCdnConfig) * [`getCdnConfig(): void`](#getCdnConfig)
* [`getConfig(array $config = []): array`](#getConfig) * [`getConfig(array $config = []): array`](#getConfig)
* [`getDNSClient(): \Amp\Dns\DnsResolver`](#getDNSClient) * [`getDNSClient(): \Amp\Dns\DnsResolver`](#getDNSClient)
* [`getDhConfig(): array`](#getDhConfig) * [`getDhConfig(?\Amp\Cancellation $cancellation = NULL): array`](#getDhConfig)
* [`getDialogIds(): list<int>`](#getDialogIds) * [`getDialogIds(): list<int>`](#getDialogIds)
* [`getDownloadInfo(mixed $messageMedia): array{ext: string, name: string, mime: string, size: int, InputFileLocation: array, key_fingerprint?: string, key?: string, iv?: string, thumb_size?: string}`](#getDownloadInfo) * [`getDownloadInfo(mixed $messageMedia): array{ext: string, name: string, mime: string, size: int, InputFileLocation: array, key_fingerprint?: string, key?: string, iv?: string, thumb_size?: string}`](#getDownloadInfo)
* [`getDownloadLink(\danog\MadelineProto\EventHandler\Message|\danog\MadelineProto\EventHandler\Media|array|string $media, ?string $scriptUrl = NULL, ?int $size = NULL, ?string $name = NULL, ?string $mime = NULL): string`](#getDownloadLink) * [`getDownloadLink(\danog\MadelineProto\EventHandler\Message|\danog\MadelineProto\EventHandler\Media|array|string $media, ?string $scriptUrl = NULL, ?int $size = NULL, ?string $name = NULL, ?string $mime = NULL): string`](#getDownloadLink)
@ -379,7 +379,7 @@ Parameters:
### <a name="acceptCall"></a> `acceptCall(int $id): void` ### <a name="acceptCall"></a> `acceptCall(int $id, ?\Amp\Cancellation $cancellation = NULL): void`
Accept call. Accept call.
@ -387,6 +387,12 @@ Accept call.
Parameters: Parameters:
* `$id`: `int` * `$id`: `int`
* `$cancellation`: `?\Amp\Cancellation`
#### See also:
* `\Amp\Cancellation`
@ -1234,11 +1240,21 @@ Get async DNS client.
### <a name="getDhConfig"></a> `getDhConfig(): array` ### <a name="getDhConfig"></a> `getDhConfig(?\Amp\Cancellation $cancellation = NULL): array`
Get diffie-hellman configuration. Get diffie-hellman configuration.
Parameters:
* `$cancellation`: `?\Amp\Cancellation`
#### See also:
* `\Amp\Cancellation`
### <a name="getDialogIds"></a> `getDialogIds(): list<int>` ### <a name="getDialogIds"></a> `getDialogIds(): list<int>`

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

@ -50,7 +50,7 @@ Event handler.
* [`MTProtoToBotAPI(array $data): array`](#MTProtoToBotAPI) * [`MTProtoToBotAPI(array $data): array`](#MTProtoToBotAPI)
* [`MTProtoToTd(mixed $params): array`](#MTProtoToTd) * [`MTProtoToTd(mixed $params): array`](#MTProtoToTd)
* [`MTProtoToTdcli(mixed $params): array`](#MTProtoToTdcli) * [`MTProtoToTdcli(mixed $params): array`](#MTProtoToTdcli)
* [`acceptCall(int $id): void`](#acceptCall) * [`acceptCall(int $id, ?\Amp\Cancellation $cancellation = NULL): void`](#acceptCall)
* [`acceptSecretChat(array $params): void`](#acceptSecretChat) * [`acceptSecretChat(array $params): void`](#acceptSecretChat)
* [`arr(mixed ...$params): array`](#arr) * [`arr(mixed ...$params): array`](#arr)
* [`base64urlDecode(string $data): string`](#base64urlDecode) * [`base64urlDecode(string $data): string`](#base64urlDecode)
@ -108,7 +108,7 @@ Event handler.
* [`getCdnConfig(): void`](#getCdnConfig) * [`getCdnConfig(): void`](#getCdnConfig)
* [`getConfig(array $config = []): array`](#getConfig) * [`getConfig(array $config = []): array`](#getConfig)
* [`getDNSClient(): \Amp\Dns\DnsResolver`](#getDNSClient) * [`getDNSClient(): \Amp\Dns\DnsResolver`](#getDNSClient)
* [`getDhConfig(): array`](#getDhConfig) * [`getDhConfig(?\Amp\Cancellation $cancellation = NULL): array`](#getDhConfig)
* [`getDialogIds(): list<int>`](#getDialogIds) * [`getDialogIds(): list<int>`](#getDialogIds)
* [`getDownloadInfo(mixed $messageMedia): array{ext: string, name: string, mime: string, size: int, InputFileLocation: array, key_fingerprint?: string, key?: string, iv?: string, thumb_size?: string}`](#getDownloadInfo) * [`getDownloadInfo(mixed $messageMedia): array{ext: string, name: string, mime: string, size: int, InputFileLocation: array, key_fingerprint?: string, key?: string, iv?: string, thumb_size?: string}`](#getDownloadInfo)
* [`getDownloadLink(\danog\MadelineProto\EventHandler\Message|\danog\MadelineProto\EventHandler\Media|array|string $media, ?string $scriptUrl = NULL, ?int $size = NULL, ?string $name = NULL, ?string $mime = NULL): string`](#getDownloadLink) * [`getDownloadLink(\danog\MadelineProto\EventHandler\Message|\danog\MadelineProto\EventHandler\Media|array|string $media, ?string $scriptUrl = NULL, ?int $size = NULL, ?string $name = NULL, ?string $mime = NULL): string`](#getDownloadLink)
@ -387,7 +387,7 @@ Parameters:
### <a name="acceptCall"></a> `acceptCall(int $id): void` ### <a name="acceptCall"></a> `acceptCall(int $id, ?\Amp\Cancellation $cancellation = NULL): void`
Accept call. Accept call.
@ -395,6 +395,12 @@ Accept call.
Parameters: Parameters:
* `$id`: `int` * `$id`: `int`
* `$cancellation`: `?\Amp\Cancellation`
#### See also:
* `\Amp\Cancellation`
@ -1242,11 +1248,21 @@ Get async DNS client.
### <a name="getDhConfig"></a> `getDhConfig(): array` ### <a name="getDhConfig"></a> `getDhConfig(?\Amp\Cancellation $cancellation = NULL): array`
Get diffie-hellman configuration. Get diffie-hellman configuration.
Parameters:
* `$cancellation`: `?\Amp\Cancellation`
#### See also:
* `\Amp\Cancellation`
### <a name="getDialogIds"></a> `getDialogIds(): list<int>` ### <a name="getDialogIds"></a> `getDialogIds(): list<int>`

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

@ -52,7 +52,7 @@ Plugin that offers a /restart command to admins that can be used to restart the
* [`MTProtoToBotAPI(array $data): array`](#MTProtoToBotAPI) * [`MTProtoToBotAPI(array $data): array`](#MTProtoToBotAPI)
* [`MTProtoToTd(mixed $params): array`](#MTProtoToTd) * [`MTProtoToTd(mixed $params): array`](#MTProtoToTd)
* [`MTProtoToTdcli(mixed $params): array`](#MTProtoToTdcli) * [`MTProtoToTdcli(mixed $params): array`](#MTProtoToTdcli)
* [`acceptCall(int $id): void`](#acceptCall) * [`acceptCall(int $id, ?\Amp\Cancellation $cancellation = NULL): void`](#acceptCall)
* [`acceptSecretChat(array $params): void`](#acceptSecretChat) * [`acceptSecretChat(array $params): void`](#acceptSecretChat)
* [`arr(mixed ...$params): array`](#arr) * [`arr(mixed ...$params): array`](#arr)
* [`base64urlDecode(string $data): string`](#base64urlDecode) * [`base64urlDecode(string $data): string`](#base64urlDecode)
@ -110,7 +110,7 @@ Plugin that offers a /restart command to admins that can be used to restart the
* [`getCdnConfig(): void`](#getCdnConfig) * [`getCdnConfig(): void`](#getCdnConfig)
* [`getConfig(array $config = []): array`](#getConfig) * [`getConfig(array $config = []): array`](#getConfig)
* [`getDNSClient(): \Amp\Dns\DnsResolver`](#getDNSClient) * [`getDNSClient(): \Amp\Dns\DnsResolver`](#getDNSClient)
* [`getDhConfig(): array`](#getDhConfig) * [`getDhConfig(?\Amp\Cancellation $cancellation = NULL): array`](#getDhConfig)
* [`getDialogIds(): list<int>`](#getDialogIds) * [`getDialogIds(): list<int>`](#getDialogIds)
* [`getDownloadInfo(mixed $messageMedia): array{ext: string, name: string, mime: string, size: int, InputFileLocation: array, key_fingerprint?: string, key?: string, iv?: string, thumb_size?: string}`](#getDownloadInfo) * [`getDownloadInfo(mixed $messageMedia): array{ext: string, name: string, mime: string, size: int, InputFileLocation: array, key_fingerprint?: string, key?: string, iv?: string, thumb_size?: string}`](#getDownloadInfo)
* [`getDownloadLink(\danog\MadelineProto\EventHandler\Message|\danog\MadelineProto\EventHandler\Media|array|string $media, ?string $scriptUrl = NULL, ?int $size = NULL, ?string $name = NULL, ?string $mime = NULL): string`](#getDownloadLink) * [`getDownloadLink(\danog\MadelineProto\EventHandler\Message|\danog\MadelineProto\EventHandler\Media|array|string $media, ?string $scriptUrl = NULL, ?int $size = NULL, ?string $name = NULL, ?string $mime = NULL): string`](#getDownloadLink)
@ -403,7 +403,7 @@ Parameters:
### <a name="acceptCall"></a> `acceptCall(int $id): void` ### <a name="acceptCall"></a> `acceptCall(int $id, ?\Amp\Cancellation $cancellation = NULL): void`
Accept call. Accept call.
@ -411,6 +411,12 @@ Accept call.
Parameters: Parameters:
* `$id`: `int` * `$id`: `int`
* `$cancellation`: `?\Amp\Cancellation`
#### See also:
* `\Amp\Cancellation`
@ -1258,11 +1264,21 @@ Get async DNS client.
### <a name="getDhConfig"></a> `getDhConfig(): array` ### <a name="getDhConfig"></a> `getDhConfig(?\Amp\Cancellation $cancellation = NULL): array`
Get diffie-hellman configuration. Get diffie-hellman configuration.
Parameters:
* `$cancellation`: `?\Amp\Cancellation`
#### See also:
* `\Amp\Cancellation`
### <a name="getDialogIds"></a> `getDialogIds(): list<int>` ### <a name="getDialogIds"></a> `getDialogIds(): list<int>`

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

@ -51,7 +51,7 @@ Plugin event handler class.
* [`MTProtoToBotAPI(array $data): array`](#MTProtoToBotAPI) * [`MTProtoToBotAPI(array $data): array`](#MTProtoToBotAPI)
* [`MTProtoToTd(mixed $params): array`](#MTProtoToTd) * [`MTProtoToTd(mixed $params): array`](#MTProtoToTd)
* [`MTProtoToTdcli(mixed $params): array`](#MTProtoToTdcli) * [`MTProtoToTdcli(mixed $params): array`](#MTProtoToTdcli)
* [`acceptCall(int $id): void`](#acceptCall) * [`acceptCall(int $id, ?\Amp\Cancellation $cancellation = NULL): void`](#acceptCall)
* [`acceptSecretChat(array $params): void`](#acceptSecretChat) * [`acceptSecretChat(array $params): void`](#acceptSecretChat)
* [`arr(mixed ...$params): array`](#arr) * [`arr(mixed ...$params): array`](#arr)
* [`base64urlDecode(string $data): string`](#base64urlDecode) * [`base64urlDecode(string $data): string`](#base64urlDecode)
@ -109,7 +109,7 @@ Plugin event handler class.
* [`getCdnConfig(): void`](#getCdnConfig) * [`getCdnConfig(): void`](#getCdnConfig)
* [`getConfig(array $config = []): array`](#getConfig) * [`getConfig(array $config = []): array`](#getConfig)
* [`getDNSClient(): \Amp\Dns\DnsResolver`](#getDNSClient) * [`getDNSClient(): \Amp\Dns\DnsResolver`](#getDNSClient)
* [`getDhConfig(): array`](#getDhConfig) * [`getDhConfig(?\Amp\Cancellation $cancellation = NULL): array`](#getDhConfig)
* [`getDialogIds(): list<int>`](#getDialogIds) * [`getDialogIds(): list<int>`](#getDialogIds)
* [`getDownloadInfo(mixed $messageMedia): array{ext: string, name: string, mime: string, size: int, InputFileLocation: array, key_fingerprint?: string, key?: string, iv?: string, thumb_size?: string}`](#getDownloadInfo) * [`getDownloadInfo(mixed $messageMedia): array{ext: string, name: string, mime: string, size: int, InputFileLocation: array, key_fingerprint?: string, key?: string, iv?: string, thumb_size?: string}`](#getDownloadInfo)
* [`getDownloadLink(\danog\MadelineProto\EventHandler\Message|\danog\MadelineProto\EventHandler\Media|array|string $media, ?string $scriptUrl = NULL, ?int $size = NULL, ?string $name = NULL, ?string $mime = NULL): string`](#getDownloadLink) * [`getDownloadLink(\danog\MadelineProto\EventHandler\Message|\danog\MadelineProto\EventHandler\Media|array|string $media, ?string $scriptUrl = NULL, ?int $size = NULL, ?string $name = NULL, ?string $mime = NULL): string`](#getDownloadLink)
@ -386,7 +386,7 @@ Parameters:
### <a name="acceptCall"></a> `acceptCall(int $id): void` ### <a name="acceptCall"></a> `acceptCall(int $id, ?\Amp\Cancellation $cancellation = NULL): void`
Accept call. Accept call.
@ -394,6 +394,12 @@ Accept call.
Parameters: Parameters:
* `$id`: `int` * `$id`: `int`
* `$cancellation`: `?\Amp\Cancellation`
#### See also:
* `\Amp\Cancellation`
@ -1241,11 +1247,21 @@ Get async DNS client.
### <a name="getDhConfig"></a> `getDhConfig(): array` ### <a name="getDhConfig"></a> `getDhConfig(?\Amp\Cancellation $cancellation = NULL): array`
Get diffie-hellman configuration. Get diffie-hellman configuration.
Parameters:
* `$cancellation`: `?\Amp\Cancellation`
#### See also:
* `\Amp\Cancellation`
### <a name="getDialogIds"></a> `getDialogIds(): list<int>` ### <a name="getDialogIds"></a> `getDialogIds(): list<int>`

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

@ -50,7 +50,7 @@ Simple event handler class: by extending this class, you can use filters, crons
* [`MTProtoToBotAPI(array $data): array`](#MTProtoToBotAPI) * [`MTProtoToBotAPI(array $data): array`](#MTProtoToBotAPI)
* [`MTProtoToTd(mixed $params): array`](#MTProtoToTd) * [`MTProtoToTd(mixed $params): array`](#MTProtoToTd)
* [`MTProtoToTdcli(mixed $params): array`](#MTProtoToTdcli) * [`MTProtoToTdcli(mixed $params): array`](#MTProtoToTdcli)
* [`acceptCall(int $id): void`](#acceptCall) * [`acceptCall(int $id, ?\Amp\Cancellation $cancellation = NULL): void`](#acceptCall)
* [`acceptSecretChat(array $params): void`](#acceptSecretChat) * [`acceptSecretChat(array $params): void`](#acceptSecretChat)
* [`arr(mixed ...$params): array`](#arr) * [`arr(mixed ...$params): array`](#arr)
* [`base64urlDecode(string $data): string`](#base64urlDecode) * [`base64urlDecode(string $data): string`](#base64urlDecode)
@ -108,7 +108,7 @@ Simple event handler class: by extending this class, you can use filters, crons
* [`getCdnConfig(): void`](#getCdnConfig) * [`getCdnConfig(): void`](#getCdnConfig)
* [`getConfig(array $config = []): array`](#getConfig) * [`getConfig(array $config = []): array`](#getConfig)
* [`getDNSClient(): \Amp\Dns\DnsResolver`](#getDNSClient) * [`getDNSClient(): \Amp\Dns\DnsResolver`](#getDNSClient)
* [`getDhConfig(): array`](#getDhConfig) * [`getDhConfig(?\Amp\Cancellation $cancellation = NULL): array`](#getDhConfig)
* [`getDialogIds(): list<int>`](#getDialogIds) * [`getDialogIds(): list<int>`](#getDialogIds)
* [`getDownloadInfo(mixed $messageMedia): array{ext: string, name: string, mime: string, size: int, InputFileLocation: array, key_fingerprint?: string, key?: string, iv?: string, thumb_size?: string}`](#getDownloadInfo) * [`getDownloadInfo(mixed $messageMedia): array{ext: string, name: string, mime: string, size: int, InputFileLocation: array, key_fingerprint?: string, key?: string, iv?: string, thumb_size?: string}`](#getDownloadInfo)
* [`getDownloadLink(\danog\MadelineProto\EventHandler\Message|\danog\MadelineProto\EventHandler\Media|array|string $media, ?string $scriptUrl = NULL, ?int $size = NULL, ?string $name = NULL, ?string $mime = NULL): string`](#getDownloadLink) * [`getDownloadLink(\danog\MadelineProto\EventHandler\Message|\danog\MadelineProto\EventHandler\Media|array|string $media, ?string $scriptUrl = NULL, ?int $size = NULL, ?string $name = NULL, ?string $mime = NULL): string`](#getDownloadLink)
@ -387,7 +387,7 @@ Parameters:
### <a name="acceptCall"></a> `acceptCall(int $id): void` ### <a name="acceptCall"></a> `acceptCall(int $id, ?\Amp\Cancellation $cancellation = NULL): void`
Accept call. Accept call.
@ -395,6 +395,12 @@ Accept call.
Parameters: Parameters:
* `$id`: `int` * `$id`: `int`
* `$cancellation`: `?\Amp\Cancellation`
#### See also:
* `\Amp\Cancellation`
@ -1242,11 +1248,21 @@ Get async DNS client.
### <a name="getDhConfig"></a> `getDhConfig(): array` ### <a name="getDhConfig"></a> `getDhConfig(?\Amp\Cancellation $cancellation = NULL): array`
Get diffie-hellman configuration. Get diffie-hellman configuration.
Parameters:
* `$cancellation`: `?\Amp\Cancellation`
#### See also:
* `\Amp\Cancellation`
### <a name="getDialogIds"></a> `getDialogIds(): list<int>` ### <a name="getDialogIds"></a> `getDialogIds(): list<int>`