Final documentation fixes

This commit is contained in:
Daniil Gentili 2018-03-24 00:33:08 +00:00
parent 27d627279c
commit 5028a840ce
7 changed files with 12 additions and 12 deletions

View File

@ -67,7 +67,7 @@ src/danog/MadelineProto/
Tools - Various tools (positive modulus, string2bin, python-like range) Tools - Various tools (positive modulus, string2bin, python-like range)
``` ```
Check out the [Contribution guide](https://github.com/danog/MadelineProto/blob/master/CONTRIBUTING.md) before contributing. Check out the [Contribution guide](https://github.com/danog/MadelineProto/blob/master/CONTRIBUTING.html) before contributing.
Kiao by grizzly Kiao by grizzly

View File

@ -27,6 +27,6 @@ foreach ($MadelineProto->API->chats as $bot_api_id => $chat) {
``` ```
Since bots cannot run `get_dialogs`, you must make use of the internal MadelineProto database to get a list of all users, chats and channels MadelineProto has seen. Since bots cannot run `get_dialogs`, you must make use of the internal MadelineProto database to get a list of all users, chats and channels MadelineProto has seen.
`$MadelineProto->API->chats` contains a list of [Chat](../API_docs/types/Chat.md) and [User](../API_docs/types/User.md) objects, indexed by bot API id. `$MadelineProto->API->chats` contains a list of [Chat](../API_docs/types/Chat.html) and [User](../API_docs/types/User.html) objects, indexed by bot API id.
<form action="https://docs.madelineproto.xyz/docs/CHAT_INFO.html"><input type="submit" value="Previous section" /></form><form action="https://docs.madelineproto.xyz/docs/INLINE_BUTTONS.html"><input type="submit" value="Next section" /></form> <form action="https://docs.madelineproto.xyz/docs/CHAT_INFO.html"><input type="submit" value="Previous section" /></form><form action="https://docs.madelineproto.xyz/docs/INLINE_BUTTONS.html"><input type="submit" value="Next section" /></form>

View File

@ -1,6 +1,6 @@
# Logging # Logging
MadelineProto provides a unified class for logging messages to the logging destination defined in [settings](SETTINGS.md#settingslogger). MadelineProto provides a unified class for logging messages to the logging destination defined in [settings](SETTINGS.html#settingslogger).
```php ```php
\danog\MadelineProto\Logger::log($message, $level); \danog\MadelineProto\Logger::log($message, $level);

View File

@ -18,7 +18,7 @@ $secret_chat = $MadelineProto->request_secret_chat($InputUser);
## Accepting secret chats ## Accepting secret chats
Secret chats are accepted or refused automatically, based on a value in the [settings](SETTINGS.md#settingssecret_chatsaccept_chats) (by default MadelineProto is set to accept all secret chats). Secret chats are accepted or refused automatically, based on a value in the [settings](SETTINGS.html#settingssecret_chatsaccept_chats) (by default MadelineProto is set to accept all secret chats).
Before sending any message, you must check if the secret chat was accepted by the other client with the following method: Before sending any message, you must check if the secret chat was accepted by the other client with the following method:

View File

@ -6,6 +6,6 @@ $me = $MadelineProto->get_self();
\danog\MadelineProto\Logger::log("Hi ".$me['first_name']."!"); \danog\MadelineProto\Logger::log("Hi ".$me['first_name']."!");
``` ```
[`get_self`](https://docs.madelineproto.xyz/get_self.html) returns a [User object](API_docs/types/User.md) that contains info about the currently logged in user/bot, or false if the current instance is not logged in. [`get_self`](https://docs.madelineproto.xyz/get_self.html) returns a [User object](../API_docs/types/User.html) that contains info about the currently logged in user/bot, or false if the current instance is not logged in.
<form action="https://docs.madelineproto.xyz/docs/SETTINGS.html"><input type="submit" value="Previous section" /></form><form action="https://docs.madelineproto.xyz/docs/EXCEPTIONS.html"><input type="submit" value="Next section" /></form> <form action="https://docs.madelineproto.xyz/docs/SETTINGS.html"><input type="submit" value="Previous section" /></form><form action="https://docs.madelineproto.xyz/docs/EXCEPTIONS.html"><input type="submit" value="Next section" /></form>

View File

@ -184,7 +184,7 @@ Description: Connection, read and write timeout for sockets
### `$settings['connection_settings']['all']['proxy']` ### `$settings['connection_settings']['all']['proxy']`
Default: `\Socket` Default: `\Socket`
Description: The [proxy class](PROXY.md) to use. Description: The [proxy class](PROXY.html) to use.
### `$settings['connection_settings']['all']['proxy_extra']` ### `$settings['connection_settings']['all']['proxy_extra']`
Default: `[]` Default: `[]`
@ -316,7 +316,7 @@ Upload settings
### `$settings['upload']['allow_automatic_uploads']` ### `$settings['upload']['allow_automatic_uploads']`
Default: `true` Default: `true`
Description: If false, [disables automatic upload from file path in constructors](FILES.md) Description: If false, [disables automatic upload from file path in constructors](FILES.html)
<hr> <hr>
## `$settings['msg_array_limit']` ## `$settings['msg_array_limit']`
@ -333,7 +333,7 @@ Description: maximum number of allowed MTProto messages in the outgoing message
### `$settings['msg_array_limit']['call_queue']` ### `$settings['msg_array_limit']['call_queue']`
Default: 200 Default: 200
Description: maximum number of allowed MTProto messages in any [call queue](USING_METHOD.md#call-queues) Description: maximum number of allowed MTProto messages in any [call queue](USING_METHOD.html#call-queues)
<hr> <hr>
@ -343,7 +343,7 @@ Peer caching settings
### `$settings['peer']['full_info_cache_time']` ### `$settings['peer']['full_info_cache_time']`
Default: 3600 Default: 3600
Description: Cache validity of full peer info (obtained with [get_full_info](CHAT_INFO.md#get_full_info)) Description: Cache validity of full peer info (obtained with [get_full_info](CHAT_INFO.html#get_full_info))
### `$settings['peer']['full_fetch']` ### `$settings['peer']['full_fetch']`
Default: false Default: false

View File

@ -5,7 +5,7 @@ A list of all of the methods that can be called with MadelineProto can be found
There are simplifications for many, if not all of, these methods. There are simplifications for many, if not all of, these methods.
* [Peers](#peers) * [Peers](#peers)
* [Files](FILES.md) * [Files](FILES.html)
* [Secret chats](#secret-chats) * [Secret chats](#secret-chats)
* [Entities (Markdown & HTML)](#entities) * [Entities (Markdown & HTML)](#entities)
* [reply_markup (keyboards & inline keyboards)](#reply_markup) * [reply_markup (keyboards & inline keyboards)](#reply_markup)
@ -78,7 +78,7 @@ To convert the results of methods to bot API objects you must provide a second p
$bot_API_object = $MadelineProto->messages->sendMessage(['peer' => '@danogentili', 'message' => 'lel'], ['botAPI' => true]); $bot_API_object = $MadelineProto->messages->sendMessage(['peer' => '@danogentili', 'message' => 'lel'], ['botAPI' => true]);
``` ```
MadelineProto also [supports bot API file IDs when working with files](FILES.md) MadelineProto also [supports bot API file IDs when working with files](FILES.html)
## No result ## No result