Skip to content

Commit

Permalink
Docs refactoring, part 1
Browse files Browse the repository at this point in the history
  • Loading branch information
danog committed Oct 29, 2019
1 parent acdcb1a commit 9f21080
Show file tree
Hide file tree
Showing 438 changed files with 1,542 additions and 1,542 deletions.
20 changes: 10 additions & 10 deletions docs/API_docs/methods/api_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,29 +10,29 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png

$MadelineProto->[logout](https://docs.madelineproto.xyz/logout.html)();

$MadelineProto->[phone_login](https://docs.madelineproto.xyz/phone_login.html)($number);
$MadelineProto->[phoneLogin](https://docs.madelineproto.xyz/phoneLogin.html)($number);

$MadelineProto->[complete_phone_login](https://docs.madelineproto.xyz/complete_phone_login.html)($code);
$MadelineProto->[completePhoneLogin](https://docs.madelineproto.xyz/completePhoneLogin.html)($code);

$MadelineProto->[complete_2FA_login](https://docs.madelineproto.xyz/complete_2FA_login.html)($password);

$MadelineProto->[bot_login](https://docs.madelineproto.xyz/bot_login.html)($token);
$MadelineProto->[botLogin](https://docs.madelineproto.xyz/botLogin.html)($token);


$MadelineProto->[get_dialogs](https://docs.madelineproto.xyz/get_dialogs.html)();
$MadelineProto->[getDialogs](https://docs.madelineproto.xyz/getDialogs.html)();

$MadelineProto->[get_pwr_chat](https://docs.madelineproto.xyz/get_pwr_chat.html)($id);
$MadelineProto->[getPwrChat](https://docs.madelineproto.xyz/getPwrChat.html)($id);

$MadelineProto->[get_info](https://docs.madelineproto.xyz/get_info.html)($id);
$MadelineProto->[getInfo](https://docs.madelineproto.xyz/getInfo.html)($id);

$MadelineProto->[get_full_info](https://docs.madelineproto.xyz/get_full_info.html)($id);
$MadelineProto->[getFullInfo](https://docs.madelineproto.xyz/getFullInfo.html)($id);

$MadelineProto->[get_self](https://docs.madelineproto.xyz/get_self.html)();
$MadelineProto->[getSelf](https://docs.madelineproto.xyz/getSelf.html)();


$MadelineProto->[request_call](https://docs.madelineproto.xyz/request_call.html)($id);
$MadelineProto->[requestCall](https://docs.madelineproto.xyz/requestCall.html)($id);

$MadelineProto->[request_secret_chat](https://docs.madelineproto.xyz/request_secret_chat.html)($id);
$MadelineProto->[requestSecretChat](https://docs.madelineproto.xyz/requestSecretChat.html)($id);

***
<br><br>
Expand Down
6 changes: 3 additions & 3 deletions docs/API_docs/methods/auth_exportAuthorization.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
---
title: auth.exportAuthorization
description: You cannot use this method directly, use $MadelineProto->export_authorization() instead, see https://docs.madelineproto.xyz/docs/LOGIN.html
description: You cannot use this method directly, use $MadelineProto->exportAuthorization() instead, see https://docs.madelineproto.xyz/docs/LOGIN.html
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Method: auth.exportAuthorization
[Back to methods index](index.md)


You cannot use this method directly, use $MadelineProto->export_authorization() instead, see https://docs.madelineproto.xyz/docs/LOGIN.html
You cannot use this method directly, use $MadelineProto->exportAuthorization() instead, see https://docs.madelineproto.xyz/docs/LOGIN.html

### Parameters:

| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|dc\_id|[int](../types/int.md) | You cannot use this method directly, use $MadelineProto->export_authorization() instead, see https://docs.madelineproto.xyz/docs/LOGIN.html | Yes|
|dc\_id|[int](../types/int.md) | You cannot use this method directly, use $MadelineProto->exportAuthorization() instead, see https://docs.madelineproto.xyz/docs/LOGIN.html | Yes|


### Return type: [auth\_ExportedAuthorization](../types/auth_ExportedAuthorization.md)
Expand Down
8 changes: 4 additions & 4 deletions docs/API_docs/methods/auth_importAuthorization.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
---
title: auth.importAuthorization
description: You cannot use this method directly, use $MadelineProto->import_authorization($authorization) instead, see https://docs.madelineproto.xyz/docs/LOGIN.html
description: You cannot use this method directly, use $MadelineProto->importAuthorization($authorization) instead, see https://docs.madelineproto.xyz/docs/LOGIN.html
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Method: auth.importAuthorization
[Back to methods index](index.md)


You cannot use this method directly, use $MadelineProto->import_authorization($authorization) instead, see https://docs.madelineproto.xyz/docs/LOGIN.html
You cannot use this method directly, use $MadelineProto->importAuthorization($authorization) instead, see https://docs.madelineproto.xyz/docs/LOGIN.html

### Parameters:

| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|id|[int](../types/int.md) | You cannot use this method directly, use $MadelineProto->import_authorization($authorization) instead, see https://docs.madelineproto.xyz/docs/LOGIN.html | Yes|
|bytes|[bytes](../types/bytes.md) | You cannot use this method directly, use $MadelineProto->import_authorization($authorization) instead, see https://docs.madelineproto.xyz/docs/LOGIN.html | Yes|
|id|[int](../types/int.md) | You cannot use this method directly, use $MadelineProto->importAuthorization($authorization) instead, see https://docs.madelineproto.xyz/docs/LOGIN.html | Yes|
|bytes|[bytes](../types/bytes.md) | You cannot use this method directly, use $MadelineProto->importAuthorization($authorization) instead, see https://docs.madelineproto.xyz/docs/LOGIN.html | Yes|


### Return type: [auth\_Authorization](../types/auth_Authorization.md)
Expand Down
4 changes: 2 additions & 2 deletions docs/API_docs/methods/channels_getParticipants.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: channels.getParticipants
description: Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead)
description: Get channel/supergroup participants (you should use `$MadelineProto->getPwrChat($id)` instead)
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Method: channels.getParticipants
[Back to methods index](index.md)


Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead)
Get channel/supergroup participants (you should use `$MadelineProto->getPwrChat($id)` instead)

### Parameters:

Expand Down
2 changes: 1 addition & 1 deletion docs/API_docs/methods/help_editUserInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,4 +86,4 @@ You can also use normal markdown, note that to create mentions you must use the
[Mention by user id](mention:186785362)
```

MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php).
MadelineProto supports all html entities supported by [htmlEntityDecode](http://php.net/manual/en/function.html-entity-decode.php).
18 changes: 9 additions & 9 deletions docs/API_docs/methods/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png

* [Get all chats, broadcast a message to all chats](https://docs.madelineproto.xyz/docs/DIALOGS.html)

* [Get the full participant list of a channel/group/supergroup](https://docs.madelineproto.xyz/get_pwr_chat.html)
* [Get the full participant list of a channel/group/supergroup](https://docs.madelineproto.xyz/getPwrChat.html)

* [Get full info about a user/chat/supergroup/channel](https://docs.madelineproto.xyz/get_full_info.html)
* [Get full info about a user/chat/supergroup/channel](https://docs.madelineproto.xyz/getFullInfo.html)

* [Get info about a user/chat/supergroup/channel](https://docs.madelineproto.xyz/get_info.html)
* [Get info about a user/chat/supergroup/channel](https://docs.madelineproto.xyz/getInfo.html)

* [Get info about the currently logged-in user](https://docs.madelineproto.xyz/get_self.html)
* [Get info about the currently logged-in user](https://docs.madelineproto.xyz/getSelf.html)

* [Upload or download files up to 1.5 GB](https://docs.madelineproto.xyz/docs/FILES.html)

Expand Down Expand Up @@ -232,7 +232,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png

* <a href="channels_getMessages.html" name="channels_getMessages">Get channel/supergroup messages: channels.getMessages</a>

* <a href="channels_getParticipants.html" name="channels_getParticipants">Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead): channels.getParticipants</a>
* <a href="channels_getParticipants.html" name="channels_getParticipants">Get channel/supergroup participants (you should use `$MadelineProto->getPwrChat($id)` instead): channels.getParticipants</a>

* <a href="messages_getCommonChats.html" name="messages_getCommonChats">Get chats in common with a user: messages.getCommonChats</a>

Expand Down Expand Up @@ -388,7 +388,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png

* <a href="messages_getWebPagePreview.html" name="messages_getWebPagePreview">Get webpage preview: messages.getWebPagePreview</a>

* <a href="messages_getDialogs.html" name="messages_getDialogs">Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https://docs.madelineproto.xyz/docs/DIALOGS.html: messages.getDialogs</a>
* <a href="messages_getDialogs.html" name="messages_getDialogs">Gets list of chats: you should use $MadelineProto->getDialogs() instead: https://docs.madelineproto.xyz/docs/DIALOGS.html: messages.getDialogs</a>

* <a href="messages_searchGlobal.html" name="messages_searchGlobal">Global message search: messages.searchGlobal</a>

Expand Down Expand Up @@ -606,7 +606,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png

* <a href="auth_bindTempAuthKey.html" name="auth_bindTempAuthKey">You cannot use this method directly, instead modify the PFS and default_temp_auth_key_expires_in settings, see https://docs.madelineproto.xyz/docs/SETTINGS.html for more info: auth.bindTempAuthKey</a>

* <a href="messages_getDhConfig.html" name="messages_getDhConfig">You cannot use this method directly, instead use $MadelineProto->get_dh_config();: messages.getDhConfig</a>
* <a href="messages_getDhConfig.html" name="messages_getDhConfig">You cannot use this method directly, instead use $MadelineProto->getDhConfig();: messages.getDhConfig</a>

* <a href="messages_acceptEncryption.html" name="messages_acceptEncryption">You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling secret chats: messages.acceptEncryption</a>

Expand All @@ -628,9 +628,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png

* <a href="phone_requestCall.html" name="phone_requestCall">You cannot use this method directly, see https://docs.madelineproto.xyz#calls for more info on handling calls: phone.requestCall</a>

* <a href="auth_exportAuthorization.html" name="auth_exportAuthorization">You cannot use this method directly, use $MadelineProto->export_authorization() instead, see https://docs.madelineproto.xyz/docs/LOGIN.html: auth.exportAuthorization</a>
* <a href="auth_exportAuthorization.html" name="auth_exportAuthorization">You cannot use this method directly, use $MadelineProto->exportAuthorization() instead, see https://docs.madelineproto.xyz/docs/LOGIN.html: auth.exportAuthorization</a>

* <a href="auth_importAuthorization.html" name="auth_importAuthorization">You cannot use this method directly, use $MadelineProto->import_authorization($authorization) instead, see https://docs.madelineproto.xyz/docs/LOGIN.html: auth.importAuthorization</a>
* <a href="auth_importAuthorization.html" name="auth_importAuthorization">You cannot use this method directly, use $MadelineProto->importAuthorization($authorization) instead, see https://docs.madelineproto.xyz/docs/LOGIN.html: auth.importAuthorization</a>

* <a href="auth_importBotAuthorization.html" name="auth_importBotAuthorization">You cannot use this method directly, use the bot_login method instead (see https://docs.madelineproto.xyz for more info): auth.importBotAuthorization</a>

Expand Down
2 changes: 1 addition & 1 deletion docs/API_docs/methods/messages_editInlineBotMessage.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ You can also use normal markdown, note that to create mentions you must use the
[Mention by user id](mention:186785362)
```

MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php).
MadelineProto supports all html entities supported by [htmlEntityDecode](http://php.net/manual/en/function.html-entity-decode.php).
### Errors

| Code | Type | Description |
Expand Down
2 changes: 1 addition & 1 deletion docs/API_docs/methods/messages_editMessage.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ You can also use normal markdown, note that to create mentions you must use the
[Mention by user id](mention:186785362)
```

MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php).
MadelineProto supports all html entities supported by [htmlEntityDecode](http://php.net/manual/en/function.html-entity-decode.php).
### Errors

| Code | Type | Description |
Expand Down
8 changes: 4 additions & 4 deletions docs/API_docs/methods/messages_getDhConfig.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
---
title: messages.getDhConfig
description: You cannot use this method directly, instead use $MadelineProto->get_dh_config();
description: You cannot use this method directly, instead use $MadelineProto->getDhConfig();
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Method: messages.getDhConfig
[Back to methods index](index.md)


You cannot use this method directly, instead use $MadelineProto->get_dh_config();
You cannot use this method directly, instead use $MadelineProto->getDhConfig();

### Parameters:

| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|version|[int](../types/int.md) | You cannot use this method directly, instead use $MadelineProto->get_dh_config(); | Yes|
|random\_length|[int](../types/int.md) | You cannot use this method directly, instead use $MadelineProto->get_dh_config(); | Yes|
|version|[int](../types/int.md) | You cannot use this method directly, instead use $MadelineProto->getDhConfig(); | Yes|
|random\_length|[int](../types/int.md) | You cannot use this method directly, instead use $MadelineProto->getDhConfig(); | Yes|


### Return type: [messages\_DhConfig](../types/messages_DhConfig.md)
Expand Down
4 changes: 2 additions & 2 deletions docs/API_docs/methods/messages_getDialogs.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: messages.getDialogs
description: Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https://docs.madelineproto.xyz/docs/DIALOGS.html
description: Gets list of chats: you should use $MadelineProto->getDialogs() instead: https://docs.madelineproto.xyz/docs/DIALOGS.html
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Method: messages.getDialogs
[Back to methods index](index.md)


Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https://docs.madelineproto.xyz/docs/DIALOGS.html
Gets list of chats: you should use $MadelineProto->getDialogs() instead: https://docs.madelineproto.xyz/docs/DIALOGS.html

### Parameters:

Expand Down
2 changes: 1 addition & 1 deletion docs/API_docs/methods/messages_getWebPagePreview.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ You can also use normal markdown, note that to create mentions you must use the
[Mention by user id](mention:186785362)
```

MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php).
MadelineProto supports all html entities supported by [htmlEntityDecode](http://php.net/manual/en/function.html-entity-decode.php).
### Errors

| Code | Type | Description |
Expand Down
2 changes: 1 addition & 1 deletion docs/API_docs/methods/messages_saveDraft.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ You can also use normal markdown, note that to create mentions you must use the
[Mention by user id](mention:186785362)
```

MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php).
MadelineProto supports all html entities supported by [htmlEntityDecode](http://php.net/manual/en/function.html-entity-decode.php).
### Errors

| Code | Type | Description |
Expand Down
2 changes: 1 addition & 1 deletion docs/API_docs/methods/messages_sendMedia.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ You can also use normal markdown, note that to create mentions you must use the
[Mention by user id](mention:186785362)
```

MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php).
MadelineProto supports all html entities supported by [htmlEntityDecode](http://php.net/manual/en/function.html-entity-decode.php).
### Errors

| Code | Type | Description |
Expand Down
2 changes: 1 addition & 1 deletion docs/API_docs/methods/messages_sendMessage.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ You can also use normal markdown, note that to create mentions you must use the
[Mention by user id](mention:186785362)
```

MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php).
MadelineProto supports all html entities supported by [htmlEntityDecode](http://php.net/manual/en/function.html-entity-decode.php).
### Errors

| Code | Type | Description |
Expand Down
20 changes: 10 additions & 10 deletions docs/MTProto_docs/methods/api_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,29 +10,29 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png

$MadelineProto->[logout](https://docs.madelineproto.xyz/logout.html)();

$MadelineProto->[phone_login](https://docs.madelineproto.xyz/phone_login.html)($number);
$MadelineProto->[phoneLogin](https://docs.madelineproto.xyz/phoneLogin.html)($number);

$MadelineProto->[complete_phone_login](https://docs.madelineproto.xyz/complete_phone_login.html)($code);
$MadelineProto->[completePhoneLogin](https://docs.madelineproto.xyz/completePhoneLogin.html)($code);

$MadelineProto->[complete_2FA_login](https://docs.madelineproto.xyz/complete_2FA_login.html)($password);

$MadelineProto->[bot_login](https://docs.madelineproto.xyz/bot_login.html)($token);
$MadelineProto->[botLogin](https://docs.madelineproto.xyz/botLogin.html)($token);


$MadelineProto->[get_dialogs](https://docs.madelineproto.xyz/get_dialogs.html)();
$MadelineProto->[getDialogs](https://docs.madelineproto.xyz/getDialogs.html)();

$MadelineProto->[get_pwr_chat](https://docs.madelineproto.xyz/get_pwr_chat.html)($id);
$MadelineProto->[getPwrChat](https://docs.madelineproto.xyz/getPwrChat.html)($id);

$MadelineProto->[get_info](https://docs.madelineproto.xyz/get_info.html)($id);
$MadelineProto->[getInfo](https://docs.madelineproto.xyz/getInfo.html)($id);

$MadelineProto->[get_full_info](https://docs.madelineproto.xyz/get_full_info.html)($id);
$MadelineProto->[getFullInfo](https://docs.madelineproto.xyz/getFullInfo.html)($id);

$MadelineProto->[get_self](https://docs.madelineproto.xyz/get_self.html)();
$MadelineProto->[getSelf](https://docs.madelineproto.xyz/getSelf.html)();


$MadelineProto->[request_call](https://docs.madelineproto.xyz/request_call.html)($id);
$MadelineProto->[requestCall](https://docs.madelineproto.xyz/requestCall.html)($id);

$MadelineProto->[request_secret_chat](https://docs.madelineproto.xyz/request_secret_chat.html)($id);
$MadelineProto->[requestSecretChat](https://docs.madelineproto.xyz/requestSecretChat.html)($id);

***
<br><br>
Expand Down
8 changes: 4 additions & 4 deletions docs/MTProto_docs/methods/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png

* [Get all chats, broadcast a message to all chats](https://docs.madelineproto.xyz/docs/DIALOGS.html)

* [Get the full participant list of a channel/group/supergroup](https://docs.madelineproto.xyz/get_pwr_chat.html)
* [Get the full participant list of a channel/group/supergroup](https://docs.madelineproto.xyz/getPwrChat.html)

* [Get full info about a user/chat/supergroup/channel](https://docs.madelineproto.xyz/get_full_info.html)
* [Get full info about a user/chat/supergroup/channel](https://docs.madelineproto.xyz/getFullInfo.html)

* [Get info about a user/chat/supergroup/channel](https://docs.madelineproto.xyz/get_info.html)
* [Get info about a user/chat/supergroup/channel](https://docs.madelineproto.xyz/getInfo.html)

* [Get info about the currently logged-in user](https://docs.madelineproto.xyz/get_self.html)
* [Get info about the currently logged-in user](https://docs.madelineproto.xyz/getSelf.html)

* [Upload or download files up to 1.5 GB](https://docs.madelineproto.xyz/docs/FILES.html)

Expand Down
2 changes: 1 addition & 1 deletion docs/bot_login.md → docs/botLogin.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,5 @@ description: bot_login parameters, return type and example


```php
$authorization = yield $this->bot_login($token);
$authorization = yield $this->botLogin($token);
```

0 comments on commit 9f21080

Please sign in to comment.