Update docs

This commit is contained in:
Daniil Gentili 2020-10-01 20:48:22 +02:00
parent f6772e49de
commit 05a859ea50
Signed by: danog
GPG Key ID: 8C1BE3B34B230CA7
6 changed files with 12 additions and 8 deletions

View File

@ -86,8 +86,7 @@ You can find examples for nearly every MadelineProto function in
* [Handling updates (new messages)](https://docs.madelineproto.xyz/docs/UPDATES.html)
* [Self-restart on webhosts](https://docs.madelineproto.xyz/docs/UPDATES.html#self-restart-on-webhosts)
* [Async Event driven](https://docs.madelineproto.xyz/docs/UPDATES.html#async-event-driven)
* [Multi-account: Async Event driven](https://docs.madelineproto.xyz/docs/UPDATES.html#async-event-driven)
* [Async Callback](https://docs.madelineproto.xyz/docs/UPDATES.html#async-callback)
* [Async Event driven multi-account](https://docs.madelineproto.xyz/docs/UPDATES.html#async-event-driven-multiaccount)
* [Noop (default)](https://docs.madelineproto.xyz/docs/UPDATES.html#noop)
* [Fetch all updates from the beginning](https://docs.madelineproto.xyz/docs/UPDATES.html#fetch-all-updates-from-the-beginning)
* [Settings](https://docs.madelineproto.xyz/docs/SETTINGS.html)
@ -352,7 +351,7 @@ You can find examples for nearly every MadelineProto function in
* <a href="https://docs.madelineproto.xyz/API_docs/methods/account.getTmpPassword.html" name="account.getTmpPassword">Get temporary payment password: account.getTmpPassword</a>
* <a href="https://docs.madelineproto.xyz/API_docs/methods/channels.getAdminLog.html" name="channels.getAdminLog">Get the admin log of a channel/supergroup: channels.getAdminLog</a>
* <a href="https://docs.madelineproto.xyz/API_docs/methods/messages.getSearchCounters.html" name="messages.getSearchCounters">Get the number of results that would be found by a messages.search call with the same parameters: messages.getSearchCounters</a>
* <a href="https://docs.madelineproto.xyz/API_docs/methods/channels.getParticipants.html" name="channels.getParticipants">Get the participants of a channel: channels.getParticipants</a>
* <a href="https://docs.madelineproto.xyz/API_docs/methods/channels.getParticipants.html" name="channels.getParticipants">Get the participants of a supergroup/channel: channels.getParticipants</a>
* <a href="https://docs.madelineproto.xyz/API_docs/methods/account.getTheme.html" name="account.getTheme">Get theme information: account.getTheme</a>
* <a href="https://docs.madelineproto.xyz/API_docs/methods/messages.getUnreadMentions.html" name="messages.getUnreadMentions">Get unread messages where we were mentioned: messages.getUnreadMentions</a>
* <a href="https://docs.madelineproto.xyz/API_docs/methods/account.getWebAuthorizations.html" name="account.getWebAuthorizations">Get web login widget authorizations: account.getWebAuthorizations</a>

2
docs

@ -1 +1 @@
Subproject commit 2b94d12fbdf270e2d329e192dfca040260274e40
Subproject commit e15b11644a7e763127ed6439ac0aec84944e288e

View File

@ -33,6 +33,9 @@ use danog\MadelineProto\Stream\MTProtoTransport\HttpStream;
use danog\MadelineProto\Stream\Transport\WssStream;
use JsonSerializable;
/**
* Datacenter connection
*/
class DataCenterConnection implements JsonSerializable
{
const READ_WEIGHT = 1;
@ -65,13 +68,13 @@ class DataCenterConnection implements JsonSerializable
/**
* Connections open to a certain DC.
*
* @var array<string, Connection>
* @var array<int, Connection>
*/
private $connections = [];
/**
* Connection weights.
*
* @var array<string, int>
* @var array<int, int>
*/
private $availableConnections = [];
/**
@ -394,7 +397,7 @@ class DataCenterConnection implements JsonSerializable
*
* @param integer $count Number of sockets to open
*
* @return void
* @return \Generator
*/
private function connectMore(int $count): \Generator
{

View File

@ -175,6 +175,7 @@ trait Constructors
$description = isset($this->TL->getDescriptions()['constructors'][$constructor]) ? $this->TL->getDescriptions()['constructors'][$constructor]['description'] : $constructor.' attributes, type and example';
$symFile = \str_replace('.', '_', $constructor.$layer);
$redir = $symFile !== $constructor.$layer ? "\nredirect_from: /API_docs/constructors/{$symFile}.html" : '';
$description = \rtrim(\explode("\n", $description)[0], ':');
$header = '---
title: '.$constructor.'
description: '.$description.'

View File

@ -203,6 +203,7 @@ trait Methods
$description = isset($this->td_descriptions['methods'][$method]) ? $this->td_descriptions['methods'][$method]['description'] : $method.' parameters, return type and example';
$symFile = \str_replace('.', '_', $method);
$redir = $symFile !== $method ? "\nredirect_from: /API_docs/methods/{$symFile}.html" : '';
$description = \rtrim(\explode("\n", $description)[0], ':');
$header = $this->template('Method', $method, $description, $redir, StrTools::markdownEscape($method));
if ($this->td) {
$header .= "YOU CANNOT USE THIS METHOD IN MADELINEPROTO\n\n\n\n\n";

View File

@ -3559,7 +3559,7 @@ interface channels
public function getMessages($params);
/**
* Get the participants of a channel.
* Get the participants of a [supergroup/channel](https://core.telegram.org/api/channel).
*
* Parameters:
* * `InputChannel` **channel** - Channel