Geochats
This commit is contained in:
parent
0c28cca665
commit
cbd913fba2
|
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
title: channelAdminLogEventActionChangeLocation
|
||||
description: Channel location changed
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelAdminLogEventActionChangeLocation
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Channel location changed
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|prev\_value|[ChannelLocation](../types/ChannelLocation.md) | Optional|Previous value|
|
||||
|new\_value|[ChannelLocation](../types/ChannelLocation.md) | Optional|New value|
|
||||
|
||||
|
||||
|
||||
### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$channelAdminLogEventActionChangeLocation = ['_' => 'channelAdminLogEventActionChangeLocation', 'prev_value' => ChannelLocation, 'new_value' => ChannelLocation];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
channelAdminLogEventActionChangeLocation={_='channelAdminLogEventActionChangeLocation', prev_value=ChannelLocation, new_value=ChannelLocation}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -19,6 +19,7 @@ Full channel
|
|||
|can\_set\_stickers|[Bool](../types/Bool.md) | Optional|Can set group stickerset?|
|
||||
|hidden\_prehistory|[Bool](../types/Bool.md) | Optional|Hidden prehistory?|
|
||||
|can\_view\_stats|[Bool](../types/Bool.md) | Optional|Can view stats?|
|
||||
|can\_set\_location|[Bool](../types/Bool.md) | Optional|Can set location?|
|
||||
|id|[int](../types/int.md) | Yes|ID|
|
||||
|about|[string](../types/string.md) | Yes|About|
|
||||
|participants\_count|[int](../types/int.md) | Optional|Participants count|
|
||||
|
|
@ -40,6 +41,7 @@ Full channel
|
|||
|available\_min\_id|[int](../types/int.md) | Optional|Available min ID|
|
||||
|folder\_id|[int](../types/int.md) | Optional|Folder ID|
|
||||
|linked\_chat\_id|[int](../types/int.md) | Optional|Linked chat ID|
|
||||
|location|[ChannelLocation](../types/ChannelLocation.md) | Optional|Location|
|
||||
|pts|[int](../types/int.md) | Yes|PTS|
|
||||
|
||||
|
||||
|
|
@ -50,14 +52,14 @@ Full channel
|
|||
### Example:
|
||||
|
||||
```php
|
||||
$channelFull = ['_' => 'channelFull', 'can_view_participants' => Bool, 'can_set_username' => Bool, 'can_set_stickers' => Bool, 'hidden_prehistory' => Bool, 'can_view_stats' => Bool, 'id' => int, 'about' => 'string', 'participants_count' => int, 'admins_count' => int, 'kicked_count' => int, 'banned_count' => int, 'online_count' => int, 'read_inbox_max_id' => int, 'read_outbox_max_id' => int, 'unread_count' => int, 'chat_photo' => Photo, 'notify_settings' => PeerNotifySettings, 'exported_invite' => ExportedChatInvite, 'bot_info' => [BotInfo, BotInfo], 'migrated_from_chat_id' => int, 'migrated_from_max_id' => int, 'pinned_msg_id' => int, 'stickerset' => StickerSet, 'available_min_id' => int, 'folder_id' => int, 'linked_chat_id' => int, 'pts' => int];
|
||||
$channelFull = ['_' => 'channelFull', 'can_view_participants' => Bool, 'can_set_username' => Bool, 'can_set_stickers' => Bool, 'hidden_prehistory' => Bool, 'can_view_stats' => Bool, 'can_set_location' => Bool, 'id' => int, 'about' => 'string', 'participants_count' => int, 'admins_count' => int, 'kicked_count' => int, 'banned_count' => int, 'online_count' => int, 'read_inbox_max_id' => int, 'read_outbox_max_id' => int, 'unread_count' => int, 'chat_photo' => Photo, 'notify_settings' => PeerNotifySettings, 'exported_invite' => ExportedChatInvite, 'bot_info' => [BotInfo, BotInfo], 'migrated_from_chat_id' => int, 'migrated_from_max_id' => int, 'pinned_msg_id' => int, 'stickerset' => StickerSet, 'available_min_id' => int, 'folder_id' => int, 'linked_chat_id' => int, 'location' => ChannelLocation, 'pts' => int];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
channelFull={_='channelFull', can_view_participants=Bool, can_set_username=Bool, can_set_stickers=Bool, hidden_prehistory=Bool, can_view_stats=Bool, id=int, about='string', participants_count=int, admins_count=int, kicked_count=int, banned_count=int, online_count=int, read_inbox_max_id=int, read_outbox_max_id=int, unread_count=int, chat_photo=Photo, notify_settings=PeerNotifySettings, exported_invite=ExportedChatInvite, bot_info={BotInfo}, migrated_from_chat_id=int, migrated_from_max_id=int, pinned_msg_id=int, stickerset=StickerSet, available_min_id=int, folder_id=int, linked_chat_id=int, pts=int}
|
||||
channelFull={_='channelFull', can_view_participants=Bool, can_set_username=Bool, can_set_stickers=Bool, hidden_prehistory=Bool, can_view_stats=Bool, can_set_location=Bool, id=int, about='string', participants_count=int, admins_count=int, kicked_count=int, banned_count=int, online_count=int, read_inbox_max_id=int, read_outbox_max_id=int, unread_count=int, chat_photo=Photo, notify_settings=PeerNotifySettings, exported_invite=ExportedChatInvite, bot_info={BotInfo}, migrated_from_chat_id=int, migrated_from_max_id=int, pinned_msg_id=int, stickerset=StickerSet, available_min_id=int, folder_id=int, linked_chat_id=int, location=ChannelLocation, pts=int}
|
||||
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
title: channelLocation
|
||||
description: Physical location (getchats)
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelLocation
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Physical location (getchats)
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|geo\_point|[GeoPoint](../types/GeoPoint.md) | Optional|Geo point|
|
||||
|address|[string](../types/string.md) | Yes|Physical address|
|
||||
|
||||
|
||||
|
||||
### Type: [ChannelLocation](../types/ChannelLocation.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$channelLocation = ['_' => 'channelLocation', 'geo_point' => GeoPoint, 'address' => 'string'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
channelLocation={_='channelLocation', geo_point=GeoPoint, address='string'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
title: channelLocationEmpty
|
||||
description: No physical location (normal chat/channel)
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: channelLocationEmpty
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
No physical location (normal chat/channel)
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [ChannelLocation](../types/ChannelLocation.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$channelLocationEmpty = ['_' => 'channelLocationEmpty'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
channelLocationEmpty={_='channelLocationEmpty'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -1,33 +0,0 @@
|
|||
---
|
||||
title: contactLinkContact
|
||||
description: Contact link contact
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: contactLinkContact
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Contact link contact
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [ContactLink](../types/ContactLink.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$contactLinkContact = ['_' => 'contactLinkContact'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
contactLinkContact={_='contactLinkContact'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -1,33 +0,0 @@
|
|||
---
|
||||
title: contactLinkNone
|
||||
description: Contact link none
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: contactLinkNone
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Contact link none
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [ContactLink](../types/ContactLink.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$contactLinkNone = ['_' => 'contactLinkNone'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
contactLinkNone={_='contactLinkNone'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -1,33 +0,0 @@
|
|||
---
|
||||
title: contactLinkUnknown
|
||||
description: Contact link unknown
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: contactLinkUnknown
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Contact link unknown
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [ContactLink](../types/ContactLink.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$contactLinkUnknown = ['_' => 'contactLinkUnknown'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
contactLinkUnknown={_='contactLinkUnknown'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -1,40 +0,0 @@
|
|||
---
|
||||
title: contacts.link
|
||||
description: Link
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: contacts.link
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Link
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|my\_link|[ContactLink](../types/ContactLink.md) | Yes|My link|
|
||||
|foreign\_link|[ContactLink](../types/ContactLink.md) | Yes|Foreign link|
|
||||
|user|[User](../types/User.md) | Optional|User|
|
||||
|
||||
|
||||
|
||||
### Type: [contacts\_Link](../types/contacts_Link.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$contacts_link = ['_' => 'contacts.link', 'my_link' => ContactLink, 'foreign_link' => ContactLink, 'user' => User];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
contacts_link={_='contacts.link', my_link=ContactLink, foreign_link=ContactLink, user=User}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -121,6 +121,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
|||
***
|
||||
<br><br>[$channelAdminLogEventActionChangeLinkedChat](../constructors/channelAdminLogEventActionChangeLinkedChat.md) = \['prev_value' => [int](../types/int.md), 'new_value' => [int](../types/int.md), \];<a name="channelAdminLogEventActionChangeLinkedChat"></a>
|
||||
|
||||
***
|
||||
<br><br>[$channelAdminLogEventActionChangeLocation](../constructors/channelAdminLogEventActionChangeLocation.md) = \['prev_value' => [ChannelLocation](../types/ChannelLocation.md), 'new_value' => [ChannelLocation](../types/ChannelLocation.md), \];<a name="channelAdminLogEventActionChangeLocation"></a>
|
||||
|
||||
***
|
||||
<br><br>[$channelAdminLogEventActionChangePhoto](../constructors/channelAdminLogEventActionChangePhoto.md) = \['prev_photo' => [Photo](../types/Photo.md), 'new_photo' => [Photo](../types/Photo.md), \];<a name="channelAdminLogEventActionChangePhoto"></a>
|
||||
|
||||
|
|
@ -179,7 +182,13 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
|||
<br><br>[$channelForbidden](../constructors/channelForbidden.md) = \['broadcast' => [Bool](../types/Bool.md), 'megagroup' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'access_hash' => [long](../types/long.md), 'title' => [string](../types/string.md), 'until_date' => [int](../types/int.md), \];<a name="channelForbidden"></a>
|
||||
|
||||
***
|
||||
<br><br>[$channelFull](../constructors/channelFull.md) = \['can_view_participants' => [Bool](../types/Bool.md), 'can_set_username' => [Bool](../types/Bool.md), 'can_set_stickers' => [Bool](../types/Bool.md), 'hidden_prehistory' => [Bool](../types/Bool.md), 'can_view_stats' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'about' => [string](../types/string.md), 'participants_count' => [int](../types/int.md), 'admins_count' => [int](../types/int.md), 'kicked_count' => [int](../types/int.md), 'banned_count' => [int](../types/int.md), 'online_count' => [int](../types/int.md), 'read_inbox_max_id' => [int](../types/int.md), 'read_outbox_max_id' => [int](../types/int.md), 'unread_count' => [int](../types/int.md), 'chat_photo' => [Photo](../types/Photo.md), 'notify_settings' => [PeerNotifySettings](../types/PeerNotifySettings.md), 'exported_invite' => [ExportedChatInvite](../types/ExportedChatInvite.md), 'bot_info' => \[[BotInfo](../types/BotInfo.md)\], 'migrated_from_chat_id' => [int](../types/int.md), 'migrated_from_max_id' => [int](../types/int.md), 'pinned_msg_id' => [int](../types/int.md), 'stickerset' => [StickerSet](../types/StickerSet.md), 'available_min_id' => [int](../types/int.md), 'folder_id' => [int](../types/int.md), 'linked_chat_id' => [int](../types/int.md), 'pts' => [int](../types/int.md), \];<a name="channelFull"></a>
|
||||
<br><br>[$channelFull](../constructors/channelFull.md) = \['can_view_participants' => [Bool](../types/Bool.md), 'can_set_username' => [Bool](../types/Bool.md), 'can_set_stickers' => [Bool](../types/Bool.md), 'hidden_prehistory' => [Bool](../types/Bool.md), 'can_view_stats' => [Bool](../types/Bool.md), 'can_set_location' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'about' => [string](../types/string.md), 'participants_count' => [int](../types/int.md), 'admins_count' => [int](../types/int.md), 'kicked_count' => [int](../types/int.md), 'banned_count' => [int](../types/int.md), 'online_count' => [int](../types/int.md), 'read_inbox_max_id' => [int](../types/int.md), 'read_outbox_max_id' => [int](../types/int.md), 'unread_count' => [int](../types/int.md), 'chat_photo' => [Photo](../types/Photo.md), 'notify_settings' => [PeerNotifySettings](../types/PeerNotifySettings.md), 'exported_invite' => [ExportedChatInvite](../types/ExportedChatInvite.md), 'bot_info' => \[[BotInfo](../types/BotInfo.md)\], 'migrated_from_chat_id' => [int](../types/int.md), 'migrated_from_max_id' => [int](../types/int.md), 'pinned_msg_id' => [int](../types/int.md), 'stickerset' => [StickerSet](../types/StickerSet.md), 'available_min_id' => [int](../types/int.md), 'folder_id' => [int](../types/int.md), 'linked_chat_id' => [int](../types/int.md), 'location' => [ChannelLocation](../types/ChannelLocation.md), 'pts' => [int](../types/int.md), \];<a name="channelFull"></a>
|
||||
|
||||
***
|
||||
<br><br>[$channelLocation](../constructors/channelLocation.md) = \['geo_point' => [GeoPoint](../types/GeoPoint.md), 'address' => [string](../types/string.md), \];<a name="channelLocation"></a>
|
||||
|
||||
***
|
||||
<br><br>[$channelLocationEmpty](../constructors/channelLocationEmpty.md) = \[\];<a name="channelLocationEmpty"></a>
|
||||
|
||||
***
|
||||
<br><br>[$channelMessagesFilter](../constructors/channelMessagesFilter.md) = \['exclude_new_messages' => [Bool](../types/Bool.md), 'ranges' => \[[MessageRange](../types/MessageRange.md)\], \];<a name="channelMessagesFilter"></a>
|
||||
|
|
@ -298,15 +307,6 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
|||
***
|
||||
<br><br>[$contactBlocked](../constructors/contactBlocked.md) = \['user_id' => [int](../types/int.md), 'date' => [int](../types/int.md), \];<a name="contactBlocked"></a>
|
||||
|
||||
***
|
||||
<br><br>[$contactLinkContact](../constructors/contactLinkContact.md) = \[\];<a name="contactLinkContact"></a>
|
||||
|
||||
***
|
||||
<br><br>[$contactLinkNone](../constructors/contactLinkNone.md) = \[\];<a name="contactLinkNone"></a>
|
||||
|
||||
***
|
||||
<br><br>[$contactLinkUnknown](../constructors/contactLinkUnknown.md) = \[\];<a name="contactLinkUnknown"></a>
|
||||
|
||||
***
|
||||
<br><br>[$contactStatus](../constructors/contactStatus.md) = \['user_id' => [int](../types/int.md), 'status' => [UserStatus](../types/UserStatus.md), \];<a name="contactStatus"></a>
|
||||
|
||||
|
|
@ -323,8 +323,6 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
|||
|
||||
[$contacts\_importedContacts](../constructors/contacts_importedContacts.md) = \['imported' => \[[ImportedContact](../types/ImportedContact.md)\], 'popular_invites' => \[[PopularContact](../types/PopularContact.md)\], 'retry_contacts' => \[[long](../types/long.md)\], 'users' => \[[User](../types/User.md)\], \];<a name="contacts_importedContacts"></a>
|
||||
|
||||
[$contacts\_link](../constructors/contacts_link.md) = \['my_link' => [ContactLink](../types/ContactLink.md), 'foreign_link' => [ContactLink](../types/ContactLink.md), 'user' => [User](../types/User.md), \];<a name="contacts_link"></a>
|
||||
|
||||
[$contacts\_resolvedPeer](../constructors/contacts_resolvedPeer.md) = \['peer' => [Peer](../types/Peer.md), 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], \];<a name="contacts_resolvedPeer"></a>
|
||||
|
||||
[$contacts\_topPeers](../constructors/contacts_topPeers.md) = \['categories' => \[[TopPeerCategoryPeers](../types/TopPeerCategoryPeers.md)\], 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], \];<a name="contacts_topPeers"></a>
|
||||
|
|
@ -937,6 +935,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
|||
***
|
||||
<br><br>[$inputReportReasonCopyright](../constructors/inputReportReasonCopyright.md) = \[\];<a name="inputReportReasonCopyright"></a>
|
||||
|
||||
***
|
||||
<br><br>[$inputReportReasonGeoIrrelevant](../constructors/inputReportReasonGeoIrrelevant.md) = \[\];<a name="inputReportReasonGeoIrrelevant"></a>
|
||||
|
||||
***
|
||||
<br><br>[$inputReportReasonOther](../constructors/inputReportReasonOther.md) = \['text' => [string](../types/string.md), \];<a name="inputReportReasonOther"></a>
|
||||
|
||||
|
|
@ -1171,6 +1172,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
|||
***
|
||||
<br><br>[$messageEmpty](../constructors/messageEmpty.md) = \['id' => [int](../types/int.md), \];<a name="messageEmpty"></a>
|
||||
|
||||
***
|
||||
<br><br>[$messageEntityBlockquote](../constructors/messageEntityBlockquote.md) = \['offset' => [int](../types/int.md), 'length' => [int](../types/int.md), \];<a name="messageEntityBlockquote"></a>
|
||||
|
||||
***
|
||||
<br><br>[$messageEntityBold](../constructors/messageEntityBold.md) = \['offset' => [int](../types/int.md), 'length' => [int](../types/int.md), \];<a name="messageEntityBold"></a>
|
||||
|
||||
|
|
@ -1204,9 +1208,15 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
|||
***
|
||||
<br><br>[$messageEntityPre](../constructors/messageEntityPre.md) = \['offset' => [int](../types/int.md), 'length' => [int](../types/int.md), 'language' => [string](../types/string.md), \];<a name="messageEntityPre"></a>
|
||||
|
||||
***
|
||||
<br><br>[$messageEntityStrike](../constructors/messageEntityStrike.md) = \['offset' => [int](../types/int.md), 'length' => [int](../types/int.md), \];<a name="messageEntityStrike"></a>
|
||||
|
||||
***
|
||||
<br><br>[$messageEntityTextUrl](../constructors/messageEntityTextUrl.md) = \['offset' => [int](../types/int.md), 'length' => [int](../types/int.md), 'url' => [string](../types/string.md), \];<a name="messageEntityTextUrl"></a>
|
||||
|
||||
***
|
||||
<br><br>[$messageEntityUnderline](../constructors/messageEntityUnderline.md) = \['offset' => [int](../types/int.md), 'length' => [int](../types/int.md), \];<a name="messageEntityUnderline"></a>
|
||||
|
||||
***
|
||||
<br><br>[$messageEntityUnknown](../constructors/messageEntityUnknown.md) = \['offset' => [int](../types/int.md), 'length' => [int](../types/int.md), \];<a name="messageEntityUnknown"></a>
|
||||
|
||||
|
|
@ -1507,11 +1517,14 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
|||
***
|
||||
<br><br>[$peerChat](../constructors/peerChat.md) = \['chat_id' => [int](../types/int.md), \];<a name="peerChat"></a>
|
||||
|
||||
***
|
||||
<br><br>[$peerLocated](../constructors/peerLocated.md) = \['peer' => [Peer](../types/Peer.md), 'expires' => [int](../types/int.md), 'distance' => [int](../types/int.md), \];<a name="peerLocated"></a>
|
||||
|
||||
***
|
||||
<br><br>[$peerNotifySettings](../constructors/peerNotifySettings.md) = \['show_previews' => [Bool](../types/Bool.md), 'silent' => [Bool](../types/Bool.md), 'mute_until' => [int](../types/int.md), 'sound' => [string](../types/string.md), \];<a name="peerNotifySettings"></a>
|
||||
|
||||
***
|
||||
<br><br>[$peerSettings](../constructors/peerSettings.md) = \['report_spam' => [Bool](../types/Bool.md), \];<a name="peerSettings"></a>
|
||||
<br><br>[$peerSettings](../constructors/peerSettings.md) = \['report_spam' => [Bool](../types/Bool.md), 'add_contact' => [Bool](../types/Bool.md), 'block_contact' => [Bool](../types/Bool.md), 'share_contact' => [Bool](../types/Bool.md), 'need_contacts_exception' => [Bool](../types/Bool.md), 'report_geo' => [Bool](../types/Bool.md), \];<a name="peerSettings"></a>
|
||||
|
||||
***
|
||||
<br><br>[$peerUser](../constructors/peerUser.md) = \['user_id' => [int](../types/int.md), \];<a name="peerUser"></a>
|
||||
|
|
@ -1836,7 +1849,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
|||
<br><br>[$stickerPack](../constructors/stickerPack.md) = \['emoticon' => [string](../types/string.md), 'documents' => \[[long](../types/long.md)\], \];<a name="stickerPack"></a>
|
||||
|
||||
***
|
||||
<br><br>[$stickerSet](../constructors/stickerSet.md) = \['archived' => [Bool](../types/Bool.md), 'official' => [Bool](../types/Bool.md), 'masks' => [Bool](../types/Bool.md), 'installed_date' => [int](../types/int.md), 'id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), 'title' => [string](../types/string.md), 'short_name' => [string](../types/string.md), 'thumb' => [PhotoSize](../types/PhotoSize.md), 'thumb_dc_id' => [int](../types/int.md), 'count' => [int](../types/int.md), 'hash' => [int](../types/int.md), \];<a name="stickerSet"></a>
|
||||
<br><br>[$stickerSet](../constructors/stickerSet.md) = \['archived' => [Bool](../types/Bool.md), 'official' => [Bool](../types/Bool.md), 'masks' => [Bool](../types/Bool.md), 'animated' => [Bool](../types/Bool.md), 'installed_date' => [int](../types/int.md), 'id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), 'title' => [string](../types/string.md), 'short_name' => [string](../types/string.md), 'thumb' => [PhotoSize](../types/PhotoSize.md), 'thumb_dc_id' => [int](../types/int.md), 'count' => [int](../types/int.md), 'hash' => [int](../types/int.md), \];<a name="stickerSet"></a>
|
||||
|
||||
***
|
||||
<br><br>[$stickerSetCovered](../constructors/stickerSetCovered.md) = \['set' => [StickerSet](../types/StickerSet.md), 'cover' => [Document](../types/Document.md), \];<a name="stickerSetCovered"></a>
|
||||
|
|
@ -2012,9 +2025,6 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
|||
***
|
||||
<br><br>[$updateConfig](../constructors/updateConfig.md) = \[\];<a name="updateConfig"></a>
|
||||
|
||||
***
|
||||
<br><br>[$updateContactLink](../constructors/updateContactLink.md) = \['user_id' => [int](../types/int.md), 'my_link' => [ContactLink](../types/ContactLink.md), 'foreign_link' => [ContactLink](../types/ContactLink.md), \];<a name="updateContactLink"></a>
|
||||
|
||||
***
|
||||
<br><br>[$updateContactsReset](../constructors/updateContactsReset.md) = \[\];<a name="updateContactsReset"></a>
|
||||
|
||||
|
|
@ -2087,6 +2097,12 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
|||
***
|
||||
<br><br>[$updateNotifySettings](../constructors/updateNotifySettings.md) = \['peer' => [NotifyPeer](../types/NotifyPeer.md), 'notify_settings' => [PeerNotifySettings](../types/PeerNotifySettings.md), \];<a name="updateNotifySettings"></a>
|
||||
|
||||
***
|
||||
<br><br>[$updatePeerLocated](../constructors/updatePeerLocated.md) = \['peers' => \[[PeerLocated](../types/PeerLocated.md)\], \];<a name="updatePeerLocated"></a>
|
||||
|
||||
***
|
||||
<br><br>[$updatePeerSettings](../constructors/updatePeerSettings.md) = \['peer' => [Peer](../types/Peer.md), 'settings' => [PeerSettings](../types/PeerSettings.md), \];<a name="updatePeerSettings"></a>
|
||||
|
||||
***
|
||||
<br><br>[$updatePhoneCall](../constructors/updatePhoneCall.md) = \['phone_call' => [PhoneCall](../types/PhoneCall.md), \];<a name="updatePhoneCall"></a>
|
||||
|
||||
|
|
@ -2221,7 +2237,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
|||
<br><br>[$userEmpty](../constructors/userEmpty.md) = \['id' => [int](../types/int.md), \];<a name="userEmpty"></a>
|
||||
|
||||
***
|
||||
<br><br>[$userFull](../constructors/userFull.md) = \['blocked' => [Bool](../types/Bool.md), 'phone_calls_available' => [Bool](../types/Bool.md), 'phone_calls_private' => [Bool](../types/Bool.md), 'can_pin_message' => [Bool](../types/Bool.md), 'user' => [User](../types/User.md), 'about' => [string](../types/string.md), 'link' => [contacts\_Link](../types/contacts_Link.md), 'profile_photo' => [Photo](../types/Photo.md), 'notify_settings' => [PeerNotifySettings](../types/PeerNotifySettings.md), 'bot_info' => [BotInfo](../types/BotInfo.md), 'pinned_msg_id' => [int](../types/int.md), 'common_chats_count' => [int](../types/int.md), 'folder_id' => [int](../types/int.md), \];<a name="userFull"></a>
|
||||
<br><br>[$userFull](../constructors/userFull.md) = \['blocked' => [Bool](../types/Bool.md), 'phone_calls_available' => [Bool](../types/Bool.md), 'phone_calls_private' => [Bool](../types/Bool.md), 'can_pin_message' => [Bool](../types/Bool.md), 'user' => [User](../types/User.md), 'about' => [string](../types/string.md), 'settings' => [PeerSettings](../types/PeerSettings.md), 'profile_photo' => [Photo](../types/Photo.md), 'notify_settings' => [PeerNotifySettings](../types/PeerNotifySettings.md), 'bot_info' => [BotInfo](../types/BotInfo.md), 'pinned_msg_id' => [int](../types/int.md), 'common_chats_count' => [int](../types/int.md), 'folder_id' => [int](../types/int.md), \];<a name="userFull"></a>
|
||||
|
||||
***
|
||||
<br><br>[$userProfilePhoto](../constructors/userProfilePhoto.md) = \['photo_id' => [long](../types/long.md), 'photo_small' => [FileLocation](../types/FileLocation.md), 'photo_big' => [FileLocation](../types/FileLocation.md), 'dc_id' => [int](../types/int.md), \];<a name="userProfilePhoto"></a>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
title: inputReportReasonGeoIrrelevant
|
||||
description: Irrelevant geochat
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: inputReportReasonGeoIrrelevant
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Irrelevant geochat
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [ReportReason](../types/ReportReason.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$inputReportReasonGeoIrrelevant = ['_' => 'inputReportReasonGeoIrrelevant'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
inputReportReasonGeoIrrelevant={_='inputReportReasonGeoIrrelevant'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
title: messageEntityBlockquote
|
||||
description: Quote
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: messageEntityBlockquote
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Quote
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|offset|[int](../types/int.md) | Yes|Offset|
|
||||
|length|[int](../types/int.md) | Yes|Length|
|
||||
|
||||
|
||||
|
||||
### Type: [MessageEntity](../types/MessageEntity.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$messageEntityBlockquote = ['_' => 'messageEntityBlockquote', 'offset' => int, 'length' => int];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
messageEntityBlockquote={_='messageEntityBlockquote', offset=int, length=int}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
title: messageEntityStrike
|
||||
description: Strikethrough
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: messageEntityStrike
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Strikethrough
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|offset|[int](../types/int.md) | Yes|Offset|
|
||||
|length|[int](../types/int.md) | Yes|Length|
|
||||
|
||||
|
||||
|
||||
### Type: [MessageEntity](../types/MessageEntity.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$messageEntityStrike = ['_' => 'messageEntityStrike', 'offset' => int, 'length' => int];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
messageEntityStrike={_='messageEntityStrike', offset=int, length=int}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
title: messageEntityUnderline
|
||||
description: Underline
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: messageEntityUnderline
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Underline
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|offset|[int](../types/int.md) | Yes|Offset|
|
||||
|length|[int](../types/int.md) | Yes|Length|
|
||||
|
||||
|
||||
|
||||
### Type: [MessageEntity](../types/MessageEntity.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$messageEntityUnderline = ['_' => 'messageEntityUnderline', 'offset' => int, 'length' => int];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
messageEntityUnderline={_='messageEntityUnderline', offset=int, length=int}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,40 @@
|
|||
---
|
||||
title: peerLocated
|
||||
description: Located peer
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: peerLocated
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Located peer
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|peer|[Peer](../types/Peer.md) | Yes|Peer|
|
||||
|expires|[int](../types/int.md) | Yes|Expiry date|
|
||||
|distance|[int](../types/int.md) | Yes|Distance|
|
||||
|
||||
|
||||
|
||||
### Type: [PeerLocated](../types/PeerLocated.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$peerLocated = ['_' => 'peerLocated', 'peer' => Peer, 'expires' => int, 'distance' => int];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
peerLocated={_='peerLocated', peer=Peer, expires=int, distance=int}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -15,6 +15,11 @@ Peer settings
|
|||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|report\_spam|[Bool](../types/Bool.md) | Optional|Report spam?|
|
||||
|add\_contact|[Bool](../types/Bool.md) | Optional|Can add as a contact?|
|
||||
|block\_contact|[Bool](../types/Bool.md) | Optional|Block contact|
|
||||
|share\_contact|[Bool](../types/Bool.md) | Optional|Share contact|
|
||||
|need\_contacts\_exception|[Bool](../types/Bool.md) | Optional|Contact exception|
|
||||
|report\_geo|[Bool](../types/Bool.md) | Optional|Geotype|
|
||||
|
||||
|
||||
|
||||
|
|
@ -24,14 +29,14 @@ Peer settings
|
|||
### Example:
|
||||
|
||||
```php
|
||||
$peerSettings = ['_' => 'peerSettings', 'report_spam' => Bool];
|
||||
$peerSettings = ['_' => 'peerSettings', 'report_spam' => Bool, 'add_contact' => Bool, 'block_contact' => Bool, 'share_contact' => Bool, 'need_contacts_exception' => Bool, 'report_geo' => Bool];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
peerSettings={_='peerSettings', report_spam=Bool}
|
||||
peerSettings={_='peerSettings', report_spam=Bool, add_contact=Bool, block_contact=Bool, share_contact=Bool, need_contacts_exception=Bool, report_geo=Bool}
|
||||
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -17,6 +17,7 @@ Sticker set
|
|||
|archived|[Bool](../types/Bool.md) | Optional|Archived?|
|
||||
|official|[Bool](../types/Bool.md) | Optional|Official?|
|
||||
|masks|[Bool](../types/Bool.md) | Optional|Masks?|
|
||||
|animated|[Bool](../types/Bool.md) | Optional|Animated stickerset?|
|
||||
|installed\_date|[int](../types/int.md) | Optional|Installed date|
|
||||
|id|[long](../types/long.md) | Yes|ID|
|
||||
|access\_hash|[long](../types/long.md) | Yes|Access hash|
|
||||
|
|
@ -35,14 +36,14 @@ Sticker set
|
|||
### Example:
|
||||
|
||||
```php
|
||||
$stickerSet = ['_' => 'stickerSet', 'archived' => Bool, 'official' => Bool, 'masks' => Bool, 'installed_date' => int, 'id' => long, 'access_hash' => long, 'title' => 'string', 'short_name' => 'string', 'thumb' => PhotoSize, 'thumb_dc_id' => int, 'count' => int, 'hash' => int];
|
||||
$stickerSet = ['_' => 'stickerSet', 'archived' => Bool, 'official' => Bool, 'masks' => Bool, 'animated' => Bool, 'installed_date' => int, 'id' => long, 'access_hash' => long, 'title' => 'string', 'short_name' => 'string', 'thumb' => PhotoSize, 'thumb_dc_id' => int, 'count' => int, 'hash' => int];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
stickerSet={_='stickerSet', archived=Bool, official=Bool, masks=Bool, installed_date=int, id=long, access_hash=long, title='string', short_name='string', thumb=PhotoSize, thumb_dc_id=int, count=int, hash=int}
|
||||
stickerSet={_='stickerSet', archived=Bool, official=Bool, masks=Bool, animated=Bool, installed_date=int, id=long, access_hash=long, title='string', short_name='string', thumb=PhotoSize, thumb_dc_id=int, count=int, hash=int}
|
||||
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -1,40 +0,0 @@
|
|||
---
|
||||
title: updateContactLink
|
||||
description: Update contact link
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: updateContactLink
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Update contact link
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|user\_id|[int](../types/int.md) | Yes|User ID|
|
||||
|my\_link|[ContactLink](../types/ContactLink.md) | Yes|My link|
|
||||
|foreign\_link|[ContactLink](../types/ContactLink.md) | Yes|Foreign link|
|
||||
|
||||
|
||||
|
||||
### Type: [Update](../types/Update.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$updateContactLink = ['_' => 'updateContactLink', 'user_id' => int, 'my_link' => ContactLink, 'foreign_link' => ContactLink];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
updateContactLink={_='updateContactLink', user_id=int, my_link=ContactLink, foreign_link=ContactLink}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
title: updatePeerLocated
|
||||
description: Peer location updated
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: updatePeerLocated
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Peer location updated
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|peers|Array of [PeerLocated](../types/PeerLocated.md) | Yes|Peers|
|
||||
|
||||
|
||||
|
||||
### Type: [Update](../types/Update.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$updatePeerLocated = ['_' => 'updatePeerLocated', 'peers' => [PeerLocated, PeerLocated]];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
updatePeerLocated={_='updatePeerLocated', peers={PeerLocated}}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
title: updatePeerSettings
|
||||
description: Peer settings updated
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: updatePeerSettings
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Peer settings updated
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|peer|[Peer](../types/Peer.md) | Yes|Peer|
|
||||
|settings|[PeerSettings](../types/PeerSettings.md) | Yes|Settings|
|
||||
|
||||
|
||||
|
||||
### Type: [Update](../types/Update.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$updatePeerSettings = ['_' => 'updatePeerSettings', 'peer' => Peer, 'settings' => PeerSettings];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
updatePeerSettings={_='updatePeerSettings', peer=Peer, settings=PeerSettings}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -20,7 +20,7 @@ User full
|
|||
|can\_pin\_message|[Bool](../types/Bool.md) | Optional|Can pin message?|
|
||||
|user|[User](../types/User.md) | Optional|User|
|
||||
|about|[string](../types/string.md) | Optional|About|
|
||||
|link|[contacts\_Link](../types/contacts_Link.md) | Yes|Link|
|
||||
|settings|[PeerSettings](../types/PeerSettings.md) | Yes|Peer settings|
|
||||
|profile\_photo|[Photo](../types/Photo.md) | Optional|Profile photo|
|
||||
|notify\_settings|[PeerNotifySettings](../types/PeerNotifySettings.md) | Yes|Notify settings|
|
||||
|bot\_info|[BotInfo](../types/BotInfo.md) | Optional|Bot info|
|
||||
|
|
@ -36,14 +36,14 @@ User full
|
|||
### Example:
|
||||
|
||||
```php
|
||||
$userFull = ['_' => 'userFull', 'blocked' => Bool, 'phone_calls_available' => Bool, 'phone_calls_private' => Bool, 'can_pin_message' => Bool, 'user' => User, 'about' => 'string', 'link' => contacts_Link, 'profile_photo' => Photo, 'notify_settings' => PeerNotifySettings, 'bot_info' => BotInfo, 'pinned_msg_id' => int, 'common_chats_count' => int, 'folder_id' => int];
|
||||
$userFull = ['_' => 'userFull', 'blocked' => Bool, 'phone_calls_available' => Bool, 'phone_calls_private' => Bool, 'can_pin_message' => Bool, 'user' => User, 'about' => 'string', 'settings' => PeerSettings, 'profile_photo' => Photo, 'notify_settings' => PeerNotifySettings, 'bot_info' => BotInfo, 'pinned_msg_id' => int, 'common_chats_count' => int, 'folder_id' => int];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
userFull={_='userFull', blocked=Bool, phone_calls_available=Bool, phone_calls_private=Bool, can_pin_message=Bool, user=User, about='string', link=contacts_Link, profile_photo=Photo, notify_settings=PeerNotifySettings, bot_info=BotInfo, pinned_msg_id=int, common_chats_count=int, folder_id=int}
|
||||
userFull={_='userFull', blocked=Bool, phone_calls_available=Bool, phone_calls_private=Bool, can_pin_message=Bool, user=User, about='string', settings=PeerSettings, profile_photo=Photo, notify_settings=PeerNotifySettings, bot_info=BotInfo, pinned_msg_id=int, common_chats_count=int, folder_id=int}
|
||||
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -1,9 +1,9 @@
|
|||
---
|
||||
title: MadelineProto API documentation (layer 100)
|
||||
description: MadelineProto API documentation (layer 100)
|
||||
title: MadelineProto API documentation (layer 102)
|
||||
description: MadelineProto API documentation (layer 102)
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# MadelineProto API documentation (layer 100)
|
||||
# MadelineProto API documentation (layer 102)
|
||||
|
||||
[Back to main documentation](..)
|
||||
|
||||
|
|
|
|||
|
|
@ -188,7 +188,7 @@ $MadelineProto->[bots->sendCustomRequest](bots_sendCustomRequest.md)(\['custom_m
|
|||
<br><br>
|
||||
$MadelineProto->[channels->checkUsername](channels_checkUsername.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'username' => [string](../types/string.md), \]) === [$Bool](../types/Bool.md)<a name="channels_checkUsername"></a>
|
||||
|
||||
$MadelineProto->[channels->createChannel](channels_createChannel.md)(\['broadcast' => [Bool](../types/Bool.md), 'megagroup' => [Bool](../types/Bool.md), 'title' => [string](../types/string.md), 'about' => [string](../types/string.md), \]) === [$Updates](../types/Updates.md)<a name="channels_createChannel"></a>
|
||||
$MadelineProto->[channels->createChannel](channels_createChannel.md)(\['broadcast' => [Bool](../types/Bool.md), 'megagroup' => [Bool](../types/Bool.md), 'title' => [string](../types/string.md), 'about' => [string](../types/string.md), 'geo_point' => [InputGeoPoint](../types/InputGeoPoint.md), 'address' => [string](../types/string.md), \]) === [$Updates](../types/Updates.md)<a name="channels_createChannel"></a>
|
||||
|
||||
$MadelineProto->[channels->deleteChannel](channels_deleteChannel.md)(\['channel' => [InputChannel](../types/InputChannel.md), \]) === [$Updates](../types/Updates.md)<a name="channels_deleteChannel"></a>
|
||||
|
||||
|
|
@ -202,6 +202,10 @@ $MadelineProto->[channels->editAdmin](channels_editAdmin.md)(\['channel' => [Inp
|
|||
|
||||
$MadelineProto->[channels->editBanned](channels_editBanned.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'user_id' => [InputUser](../types/InputUser.md), 'banned_rights' => [ChatBannedRights](../types/ChatBannedRights.md), \]) === [$Updates](../types/Updates.md)<a name="channels_editBanned"></a>
|
||||
|
||||
$MadelineProto->[channels->editCreator](channels_editCreator.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'user_id' => [InputUser](../types/InputUser.md), 'password' => [InputCheckPasswordSRP](../types/InputCheckPasswordSRP.md), \]) === [$Updates](../types/Updates.md)<a name="channels_editCreator"></a>
|
||||
|
||||
$MadelineProto->[channels->editLocation](channels_editLocation.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'geo_point' => [InputGeoPoint](../types/InputGeoPoint.md), 'address' => [string](../types/string.md), \]) === [$Bool](../types/Bool.md)<a name="channels_editLocation"></a>
|
||||
|
||||
$MadelineProto->[channels->editPhoto](channels_editPhoto.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'photo' => [InputChatPhoto](../types/InputChatPhoto.md), \]) === [$Updates](../types/Updates.md)<a name="channels_editPhoto"></a>
|
||||
|
||||
$MadelineProto->[channels->editTitle](channels_editTitle.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'title' => [string](../types/string.md), \]) === [$Updates](../types/Updates.md)<a name="channels_editTitle"></a>
|
||||
|
|
@ -210,9 +214,7 @@ $MadelineProto->[channels->exportMessageLink](channels_exportMessageLink.md)(\['
|
|||
|
||||
$MadelineProto->[channels->getAdminLog](channels_getAdminLog.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'q' => [string](../types/string.md), 'events_filter' => [ChannelAdminLogEventsFilter](../types/ChannelAdminLogEventsFilter.md), 'admins' => \[[InputUser](../types/InputUser.md)\], 'max_id' => [long](../types/long.md), 'min_id' => [long](../types/long.md), 'limit' => [int](../types/int.md), \]) === [$channels\_AdminLogResults](../types/channels_AdminLogResults.md)<a name="channels_getAdminLog"></a>
|
||||
|
||||
$MadelineProto->[channels->getAdminedPublicChannels](channels_getAdminedPublicChannels.md)(\[\]) === [$messages\_Chats](../types/messages_Chats.md)<a name="channels_getAdminedPublicChannels"></a>
|
||||
|
||||
$MadelineProto->[channels->getBroadcastsForDiscussion](channels_getBroadcastsForDiscussion.md)(\[\]) === [$messages\_Chats](../types/messages_Chats.md)<a name="channels_getBroadcastsForDiscussion"></a>
|
||||
$MadelineProto->[channels->getAdminedPublicChannels](channels_getAdminedPublicChannels.md)(\['by_location' => [Bool](../types/Bool.md), 'check_limit' => [Bool](../types/Bool.md), \]) === [$messages\_Chats](../types/messages_Chats.md)<a name="channels_getAdminedPublicChannels"></a>
|
||||
|
||||
$MadelineProto->[channels->getChannels](channels_getChannels.md)(\['id' => \[[InputChannel](../types/InputChannel.md)\], \]) === [$messages\_Chats](../types/messages_Chats.md)<a name="channels_getChannels"></a>
|
||||
|
||||
|
|
@ -252,13 +254,15 @@ $MadelineProto->[channels->updateUsername](channels_updateUsername.md)(\['channe
|
|||
|
||||
***
|
||||
<br><br>
|
||||
$MadelineProto->[contacts->acceptContact](contacts_acceptContact.md)(\['id' => [InputUser](../types/InputUser.md), \]) === [$Updates](../types/Updates.md)<a name="contacts_acceptContact"></a>
|
||||
|
||||
$MadelineProto->[contacts->addContact](contacts_addContact.md)(\['add_phone_privacy_exception' => [Bool](../types/Bool.md), 'id' => [InputUser](../types/InputUser.md), 'first_name' => [string](../types/string.md), 'last_name' => [string](../types/string.md), 'phone' => [string](../types/string.md), \]) === [$Updates](../types/Updates.md)<a name="contacts_addContact"></a>
|
||||
|
||||
$MadelineProto->[contacts->block](contacts_block.md)(\['id' => [InputUser](../types/InputUser.md), \]) === [$Bool](../types/Bool.md)<a name="contacts_block"></a>
|
||||
|
||||
$MadelineProto->[contacts->deleteByPhones](contacts_deleteByPhones.md)(\['phones' => \[[string](../types/string.md)\], \]) === [$Bool](../types/Bool.md)<a name="contacts_deleteByPhones"></a>
|
||||
|
||||
$MadelineProto->[contacts->deleteContact](contacts_deleteContact.md)(\['id' => [InputUser](../types/InputUser.md), \]) === [$contacts\_Link](../types/contacts_Link.md)<a name="contacts_deleteContact"></a>
|
||||
|
||||
$MadelineProto->[contacts->deleteContacts](contacts_deleteContacts.md)(\['id' => \[[InputUser](../types/InputUser.md)\], \]) === [$Bool](../types/Bool.md)<a name="contacts_deleteContacts"></a>
|
||||
$MadelineProto->[contacts->deleteContacts](contacts_deleteContacts.md)(\['id' => \[[InputUser](../types/InputUser.md)\], \]) === [$Updates](../types/Updates.md)<a name="contacts_deleteContacts"></a>
|
||||
|
||||
$MadelineProto->[contacts->getBlocked](contacts_getBlocked.md)(\['offset' => [int](../types/int.md), 'limit' => [int](../types/int.md), \]) === [$contacts\_Blocked](../types/contacts_Blocked.md)<a name="contacts_getBlocked"></a>
|
||||
|
||||
|
|
@ -266,6 +270,8 @@ $MadelineProto->[contacts->getContactIDs](contacts_getContactIDs.md)(\['hash' =>
|
|||
|
||||
$MadelineProto->[contacts->getContacts](contacts_getContacts.md)(\['hash' => [int](../types/int.md), \]) === [$contacts\_Contacts](../types/contacts_Contacts.md)<a name="contacts_getContacts"></a>
|
||||
|
||||
$MadelineProto->[contacts->getLocated](contacts_getLocated.md)(\['geo_point' => [InputGeoPoint](../types/InputGeoPoint.md), \]) === [$Updates](../types/Updates.md)<a name="contacts_getLocated"></a>
|
||||
|
||||
$MadelineProto->[contacts->getSaved](contacts_getSaved.md)(\[\]) === [$Vector\_of\_SavedContact](../types/SavedContact.md)<a name="contacts_getSaved"></a>
|
||||
|
||||
$MadelineProto->[contacts->getStatuses](contacts_getStatuses.md)(\[\]) === [$Vector\_of\_ContactStatus](../types/ContactStatus.md)<a name="contacts_getStatuses"></a>
|
||||
|
|
@ -502,7 +508,7 @@ $MadelineProto->[messages->getWebPage](messages_getWebPage.md)(\['url' => [strin
|
|||
|
||||
$MadelineProto->[messages->getWebPagePreview](messages_getWebPagePreview.md)(\['message' => [string](../types/string.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], \]) === [$MessageMedia](../types/MessageMedia.md)<a name="messages_getWebPagePreview"></a>
|
||||
|
||||
$MadelineProto->[messages->hideReportSpam](messages_hideReportSpam.md)(\['peer' => [InputPeer](../types/InputPeer.md), \]) === [$Bool](../types/Bool.md)<a name="messages_hideReportSpam"></a>
|
||||
$MadelineProto->[messages->hidePeerSettingsBar](messages_hidePeerSettingsBar.md)(\['peer' => [InputPeer](../types/InputPeer.md), \]) === [$Bool](../types/Bool.md)<a name="messages_hidePeerSettingsBar"></a>
|
||||
|
||||
$MadelineProto->[messages->importChatInvite](messages_importChatInvite.md)(\['hash' => [string](../types/string.md), \]) === [$Updates](../types/Updates.md)<a name="messages_importChatInvite"></a>
|
||||
|
||||
|
|
@ -550,7 +556,7 @@ $MadelineProto->[messages->search](messages_search.md)(\['peer' => [InputPeer](.
|
|||
|
||||
$MadelineProto->[messages->searchGifs](messages_searchGifs.md)(\['q' => [string](../types/string.md), 'offset' => [int](../types/int.md), \]) === [$messages\_FoundGifs](../types/messages_FoundGifs.md)<a name="messages_searchGifs"></a>
|
||||
|
||||
$MadelineProto->[messages->searchGlobal](messages_searchGlobal.md)(\['q' => [string](../types/string.md), 'offset_rate' => [int](../types/int.md), 'offset_peer' => [InputPeer](../types/InputPeer.md), 'offset_id' => [int](../types/int.md), 'limit' => [int](../types/int.md), \]) === [$messages\_Messages](../types/messages_Messages.md)<a name="messages_searchGlobal"></a>
|
||||
$MadelineProto->[messages->searchGlobal](messages_searchGlobal.md)(\['folder_id' => [int](../types/int.md), 'q' => [string](../types/string.md), 'offset_rate' => [int](../types/int.md), 'offset_peer' => [InputPeer](../types/InputPeer.md), 'offset_id' => [int](../types/int.md), 'limit' => [int](../types/int.md), \]) === [$messages\_Messages](../types/messages_Messages.md)<a name="messages_searchGlobal"></a>
|
||||
|
||||
$MadelineProto->[messages->searchStickerSets](messages_searchStickerSets.md)(\['exclude_featured' => [Bool](../types/Bool.md), 'q' => [string](../types/string.md), 'hash' => [int](../types/int.md), \]) === [$messages\_FoundStickerSets](../types/messages_FoundStickerSets.md)<a name="messages_searchStickerSets"></a>
|
||||
|
||||
|
|
|
|||
|
|
@ -17,6 +17,8 @@ Create channel/supergroup
|
|||
|megagroup|[Bool](../types/Bool.md) | Set this to true to create a supergroup | Optional|
|
||||
|title|[string](../types/string.md) | Supergroup/channel title | Yes|
|
||||
|about|[string](../types/string.md) | About text | Yes|
|
||||
|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Geopoint (geochats) | Optional|
|
||||
|address|[string](../types/string.md) | Physical address (geochats) | Optional|
|
||||
|
||||
|
||||
### Return type: [Updates](../types/Updates.md)
|
||||
|
|
@ -36,13 +38,13 @@ include 'madeline.php';
|
|||
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
|
||||
$MadelineProto->start();
|
||||
|
||||
$Updates = $MadelineProto->channels->createChannel(['broadcast' => Bool, 'megagroup' => Bool, 'title' => 'string', 'about' => 'string', ]);
|
||||
$Updates = $MadelineProto->channels->createChannel(['broadcast' => Bool, 'megagroup' => Bool, 'title' => 'string', 'about' => 'string', 'geo_point' => InputGeoPoint, 'address' => 'string', ]);
|
||||
```
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
Updates = channels.createChannel({broadcast=Bool, megagroup=Bool, title='string', about='string', })
|
||||
Updates = channels.createChannel({broadcast=Bool, megagroup=Bool, title='string', about='string', geo_point=InputGeoPoint, address='string', })
|
||||
```
|
||||
|
||||
### Errors this method can return:
|
||||
|
|
|
|||
|
|
@ -0,0 +1,46 @@
|
|||
---
|
||||
title: channels.editCreator
|
||||
description: Edit creator of channel
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Method: channels.editCreator
|
||||
[Back to methods index](index.md)
|
||||
|
||||
|
||||
Edit creator of channel
|
||||
|
||||
### Parameters:
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
|----------|---------------|-------------|----------|
|
||||
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Channel | Optional|
|
||||
|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | User ID | Optional|
|
||||
|password|[InputCheckPasswordSRP](../types/InputCheckPasswordSRP.md) | Password | Yes|
|
||||
|
||||
|
||||
### Return type: [Updates](../types/Updates.md)
|
||||
|
||||
### Can bots use this method: **YES**
|
||||
|
||||
|
||||
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
|
||||
|
||||
|
||||
```php
|
||||
if (!file_exists('madeline.php')) {
|
||||
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
|
||||
}
|
||||
include 'madeline.php';
|
||||
|
||||
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
|
||||
$MadelineProto->start();
|
||||
|
||||
$Updates = $MadelineProto->channels->editCreator(['channel' => InputChannel, 'user_id' => InputUser, 'password' => InputCheckPasswordSRP, ]);
|
||||
```
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
Updates = channels.editCreator({channel=InputChannel, user_id=InputUser, password=InputCheckPasswordSRP, })
|
||||
```
|
||||
|
||||
|
|
@ -0,0 +1,46 @@
|
|||
---
|
||||
title: channels.editLocation
|
||||
description: Edit location (geochats)
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Method: channels.editLocation
|
||||
[Back to methods index](index.md)
|
||||
|
||||
|
||||
Edit location (geochats)
|
||||
|
||||
### Parameters:
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
|----------|---------------|-------------|----------|
|
||||
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Channel | Optional|
|
||||
|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Geo point | Optional|
|
||||
|address|[string](../types/string.md) | Physical location (geochats) | Yes|
|
||||
|
||||
|
||||
### Return type: [Bool](../types/Bool.md)
|
||||
|
||||
### Can bots use this method: **YES**
|
||||
|
||||
|
||||
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
|
||||
|
||||
|
||||
```php
|
||||
if (!file_exists('madeline.php')) {
|
||||
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
|
||||
}
|
||||
include 'madeline.php';
|
||||
|
||||
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
|
||||
$MadelineProto->start();
|
||||
|
||||
$Bool = $MadelineProto->channels->editLocation(['channel' => InputChannel, 'geo_point' => InputGeoPoint, 'address' => 'string', ]);
|
||||
```
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
Bool = channels.editLocation({channel=InputChannel, geo_point=InputGeoPoint, address='string', })
|
||||
```
|
||||
|
||||
|
|
@ -9,6 +9,12 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
|||
|
||||
Get all supergroups/channels where you're admin
|
||||
|
||||
### Parameters:
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
|----------|---------------|-------------|----------|
|
||||
|by\_location|[Bool](../types/Bool.md) | Get channels by location | Optional|
|
||||
|check\_limit|[Bool](../types/Bool.md) | Check limit | Optional|
|
||||
|
||||
|
||||
### Return type: [messages\_Chats](../types/messages_Chats.md)
|
||||
|
|
@ -28,12 +34,12 @@ include 'madeline.php';
|
|||
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
|
||||
$MadelineProto->start();
|
||||
|
||||
$messages_Chats = $MadelineProto->channels->getAdminedPublicChannels();
|
||||
$messages_Chats = $MadelineProto->channels->getAdminedPublicChannels(['by_location' => Bool, 'check_limit' => Bool, ]);
|
||||
```
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
messages_Chats = channels.getAdminedPublicChannels({})
|
||||
messages_Chats = channels.getAdminedPublicChannels({by_location=Bool, check_limit=Bool, })
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,44 @@
|
|||
---
|
||||
title: contacts.acceptContact
|
||||
description: Accept contact
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Method: contacts.acceptContact
|
||||
[Back to methods index](index.md)
|
||||
|
||||
|
||||
Accept contact
|
||||
|
||||
### Parameters:
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
|----------|---------------|-------------|----------|
|
||||
|id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | ID | Optional|
|
||||
|
||||
|
||||
### Return type: [Updates](../types/Updates.md)
|
||||
|
||||
### Can bots use this method: **YES**
|
||||
|
||||
|
||||
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
|
||||
|
||||
|
||||
```php
|
||||
if (!file_exists('madeline.php')) {
|
||||
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
|
||||
}
|
||||
include 'madeline.php';
|
||||
|
||||
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
|
||||
$MadelineProto->start();
|
||||
|
||||
$Updates = $MadelineProto->contacts->acceptContact(['id' => InputUser, ]);
|
||||
```
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
Updates = contacts.acceptContact({id=InputUser, })
|
||||
```
|
||||
|
||||
|
|
@ -0,0 +1,48 @@
|
|||
---
|
||||
title: contacts.addContact
|
||||
description: Add contact
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Method: contacts.addContact
|
||||
[Back to methods index](index.md)
|
||||
|
||||
|
||||
Add contact
|
||||
|
||||
### Parameters:
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
|----------|---------------|-------------|----------|
|
||||
|add\_phone\_privacy\_exception|[Bool](../types/Bool.md) | Phone privacy exception? | Optional|
|
||||
|id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | ID | Optional|
|
||||
|first\_name|[string](../types/string.md) | First name | Yes|
|
||||
|last\_name|[string](../types/string.md) | Last name | Yes|
|
||||
|phone|[string](../types/string.md) | Phone number | Yes|
|
||||
|
||||
|
||||
### Return type: [Updates](../types/Updates.md)
|
||||
|
||||
### Can bots use this method: **YES**
|
||||
|
||||
|
||||
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
|
||||
|
||||
|
||||
```php
|
||||
if (!file_exists('madeline.php')) {
|
||||
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
|
||||
}
|
||||
include 'madeline.php';
|
||||
|
||||
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
|
||||
$MadelineProto->start();
|
||||
|
||||
$Updates = $MadelineProto->contacts->addContact(['add_phone_privacy_exception' => Bool, 'id' => InputUser, 'first_name' => 'string', 'last_name' => 'string', 'phone' => 'string', ]);
|
||||
```
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
Updates = contacts.addContact({add_phone_privacy_exception=Bool, id=InputUser, first_name='string', last_name='string', phone='string', })
|
||||
```
|
||||
|
||||
|
|
@ -16,7 +16,7 @@ Delete multiple contacts
|
|||
|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The contacts to delete | Yes|
|
||||
|
||||
|
||||
### Return type: [Bool](../types/Bool.md)
|
||||
### Return type: [Updates](../types/Updates.md)
|
||||
|
||||
### Can bots use this method: **NO**
|
||||
|
||||
|
|
@ -33,13 +33,13 @@ include 'madeline.php';
|
|||
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
|
||||
$MadelineProto->start();
|
||||
|
||||
$Bool = $MadelineProto->contacts->deleteContacts(['id' => [InputUser, InputUser], ]);
|
||||
$Updates = $MadelineProto->contacts->deleteContacts(['id' => [InputUser, InputUser], ]);
|
||||
```
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
Bool = contacts.deleteContacts({id={InputUser}, })
|
||||
Updates = contacts.deleteContacts({id={InputUser}, })
|
||||
```
|
||||
|
||||
### Errors this method can return:
|
||||
|
|
|
|||
|
|
@ -0,0 +1,44 @@
|
|||
---
|
||||
title: contacts.getLocated
|
||||
description: Get people nearby (geochats)
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Method: contacts.getLocated
|
||||
[Back to methods index](index.md)
|
||||
|
||||
|
||||
Get people nearby (geochats)
|
||||
|
||||
### Parameters:
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
|----------|---------------|-------------|----------|
|
||||
|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Current location | Optional|
|
||||
|
||||
|
||||
### Return type: [Updates](../types/Updates.md)
|
||||
|
||||
### Can bots use this method: **YES**
|
||||
|
||||
|
||||
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
|
||||
|
||||
|
||||
```php
|
||||
if (!file_exists('madeline.php')) {
|
||||
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
|
||||
}
|
||||
include 'madeline.php';
|
||||
|
||||
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
|
||||
$MadelineProto->start();
|
||||
|
||||
$Updates = $MadelineProto->contacts->getLocated(['geo_point' => InputGeoPoint, ]);
|
||||
```
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
Updates = contacts.getLocated({geo_point=InputGeoPoint, })
|
||||
```
|
||||
|
||||
|
|
@ -66,8 +66,13 @@ The following tags are currently supported:
|
|||
<strong>bold</strong>
|
||||
<em>italic</em>
|
||||
<i>italic</i>
|
||||
<u>underline</u>
|
||||
<s>strikethrough</s>
|
||||
<del>strikethrough</del>
|
||||
<strike>strikethrough</strike>
|
||||
<code>inline fixed-width code</code>
|
||||
<pre>pre-formatted fixed-width code block</pre>
|
||||
<blockquote>pre-formatted fixed-width code block</blockquote>
|
||||
<a href="https://github.com">URL</a>
|
||||
<a href="mention:@danogentili">Mention by username</a>
|
||||
<a href="mention:186785362">Mention by user id</a>
|
||||
|
|
|
|||
|
|
@ -32,6 +32,8 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
|||
|
||||
* <a href="messages_acceptUrlAuth.html" name="messages_acceptUrlAuth">Accept URL authorization: messages.acceptUrlAuth</a>
|
||||
|
||||
* <a href="contacts_acceptContact.html" name="contacts_acceptContact">Accept contact: contacts.acceptContact</a>
|
||||
|
||||
* <a href="account_acceptAuthorization.html" name="account_acceptAuthorization">Accept telegram passport authorization: account.acceptAuthorization</a>
|
||||
|
||||
* <a href="help_acceptTermsOfService.html" name="help_acceptTermsOfService">Accept telegram's TOS: help.acceptTermsOfService</a>
|
||||
|
|
@ -44,6 +46,8 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
|||
|
||||
* <a href="messages_addChatUser.html" name="messages_addChatUser">Add a user to a normal chat (use channels->inviteToChannel for supergroups): messages.addChatUser</a>
|
||||
|
||||
* <a href="contacts_addContact.html" name="contacts_addContact">Add contact: contacts.addContact</a>
|
||||
|
||||
* <a href="contacts_importContacts.html" name="contacts_importContacts">Add phone number as contact: contacts.importContacts</a>
|
||||
|
||||
* <a href="stickers_addStickerToSet.html" name="stickers_addStickerToSet">Add sticker to stickerset: stickers.addStickerToSet</a>
|
||||
|
|
@ -114,8 +118,6 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
|||
|
||||
* <a href="channels_deleteChannel.html" name="channels_deleteChannel">Delete a channel/supergroup: channels.deleteChannel</a>
|
||||
|
||||
* <a href="contacts_deleteContact.html" name="contacts_deleteContact">Delete a contact: contacts.deleteContact</a>
|
||||
|
||||
* <a href="messages_deleteChatUser.html" name="messages_deleteChatUser">Delete a user from a chat (not supergroup): messages.deleteChatUser</a>
|
||||
|
||||
* <a href="auth_resetAuthorizations.html" name="auth_resetAuthorizations">Delete all logged-in sessions.: auth.resetAuthorizations</a>
|
||||
|
|
@ -158,10 +160,14 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
|||
|
||||
* <a href="messages_editChatAbout.html" name="messages_editChatAbout">Edit chat info: messages.editChatAbout</a>
|
||||
|
||||
* <a href="channels_editCreator.html" name="channels_editCreator">Edit creator of channel: channels.editCreator</a>
|
||||
|
||||
* <a href="messages_editChatDefaultBannedRights.html" name="messages_editChatDefaultBannedRights">Edit default rights of chat: messages.editChatDefaultBannedRights</a>
|
||||
|
||||
* <a href="folders_editPeerFolders.html" name="folders_editPeerFolders">Edit folder: folders.editPeerFolders</a>
|
||||
|
||||
* <a href="channels_editLocation.html" name="channels_editLocation">Edit location (geochats): channels.editLocation</a>
|
||||
|
||||
* <a href="messages_editChatPhoto.html" name="messages_editChatPhoto">Edit the photo of a normal chat (not supergroup): messages.editChatPhoto</a>
|
||||
|
||||
* <a href="channels_editPhoto.html" name="channels_editPhoto">Edit the photo of a supergroup/channel: channels.editPhoto</a>
|
||||
|
|
@ -224,8 +230,6 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
|||
|
||||
* <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_getBroadcastsForDiscussion.html" name="channels_getBroadcastsForDiscussion">Get channels for discussion: channels.getBroadcastsForDiscussion</a>
|
||||
|
||||
* <a href="messages_getCommonChats.html" name="messages_getCommonChats">Get chats in common with a user: messages.getCommonChats</a>
|
||||
|
||||
* <a href="contacts_getContactIDs.html" name="contacts_getContactIDs">Get contacts by IDs: contacts.getContactIDs</a>
|
||||
|
|
@ -304,6 +308,8 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
|||
|
||||
* <a href="payments_getPaymentReceipt.html" name="payments_getPaymentReceipt">Get payment receipt: payments.getPaymentReceipt</a>
|
||||
|
||||
* <a href="contacts_getLocated.html" name="contacts_getLocated">Get people nearby (geochats): contacts.getLocated</a>
|
||||
|
||||
* <a href="messages_getPinnedDialogs.html" name="messages_getPinnedDialogs">Get pinned dialogs: messages.getPinnedDialogs</a>
|
||||
|
||||
* <a href="messages_getPollResults.html" name="messages_getPollResults">Get poll results: messages.getPollResults</a>
|
||||
|
|
@ -370,7 +376,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
|||
|
||||
* <a href="messages_searchGlobal.html" name="messages_searchGlobal">Global message search: messages.searchGlobal</a>
|
||||
|
||||
* <a href="messages_hideReportSpam.html" name="messages_hideReportSpam">Hide report spam popup: messages.hideReportSpam</a>
|
||||
* <a href="messages_hidePeerSettingsBar.html" name="messages_hidePeerSettingsBar">Hide peer settings bar: messages.hidePeerSettingsBar</a>
|
||||
|
||||
* <a href="messages_importChatInvite.html" name="messages_importChatInvite">Import chat invite: messages.importChatInvite</a>
|
||||
|
||||
|
|
|
|||
|
|
@ -75,8 +75,13 @@ The following tags are currently supported:
|
|||
<strong>bold</strong>
|
||||
<em>italic</em>
|
||||
<i>italic</i>
|
||||
<u>underline</u>
|
||||
<s>strikethrough</s>
|
||||
<del>strikethrough</del>
|
||||
<strike>strikethrough</strike>
|
||||
<code>inline fixed-width code</code>
|
||||
<pre>pre-formatted fixed-width code block</pre>
|
||||
<blockquote>pre-formatted fixed-width code block</blockquote>
|
||||
<a href="https://github.com">URL</a>
|
||||
<a href="mention:@danogentili">Mention by username</a>
|
||||
<a href="mention:186785362">Mention by user id</a>
|
||||
|
|
|
|||
|
|
@ -76,8 +76,13 @@ The following tags are currently supported:
|
|||
<strong>bold</strong>
|
||||
<em>italic</em>
|
||||
<i>italic</i>
|
||||
<u>underline</u>
|
||||
<s>strikethrough</s>
|
||||
<del>strikethrough</del>
|
||||
<strike>strikethrough</strike>
|
||||
<code>inline fixed-width code</code>
|
||||
<pre>pre-formatted fixed-width code block</pre>
|
||||
<blockquote>pre-formatted fixed-width code block</blockquote>
|
||||
<a href="https://github.com">URL</a>
|
||||
<a href="mention:@danogentili">Mention by username</a>
|
||||
<a href="mention:186785362">Mention by user id</a>
|
||||
|
|
|
|||
|
|
@ -65,8 +65,13 @@ The following tags are currently supported:
|
|||
<strong>bold</strong>
|
||||
<em>italic</em>
|
||||
<i>italic</i>
|
||||
<u>underline</u>
|
||||
<s>strikethrough</s>
|
||||
<del>strikethrough</del>
|
||||
<strike>strikethrough</strike>
|
||||
<code>inline fixed-width code</code>
|
||||
<pre>pre-formatted fixed-width code block</pre>
|
||||
<blockquote>pre-formatted fixed-width code block</blockquote>
|
||||
<a href="https://github.com">URL</a>
|
||||
<a href="mention:@danogentili">Mention by username</a>
|
||||
<a href="mention:186785362">Mention by user id</a>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,44 @@
|
|||
---
|
||||
title: messages.hidePeerSettingsBar
|
||||
description: Hide peer settings bar
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Method: messages.hidePeerSettingsBar
|
||||
[Back to methods index](index.md)
|
||||
|
||||
|
||||
Hide peer settings bar
|
||||
|
||||
### Parameters:
|
||||
|
||||
| Name | Type | Description | Required |
|
||||
|----------|---------------|-------------|----------|
|
||||
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Peer | Optional|
|
||||
|
||||
|
||||
### Return type: [Bool](../types/Bool.md)
|
||||
|
||||
### Can bots use this method: **YES**
|
||||
|
||||
|
||||
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
|
||||
|
||||
|
||||
```php
|
||||
if (!file_exists('madeline.php')) {
|
||||
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
|
||||
}
|
||||
include 'madeline.php';
|
||||
|
||||
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
|
||||
$MadelineProto->start();
|
||||
|
||||
$Bool = $MadelineProto->messages->hidePeerSettingsBar(['peer' => InputPeer, ]);
|
||||
```
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
Bool = messages.hidePeerSettingsBar({peer=InputPeer, })
|
||||
```
|
||||
|
||||
|
|
@ -68,8 +68,13 @@ The following tags are currently supported:
|
|||
<strong>bold</strong>
|
||||
<em>italic</em>
|
||||
<i>italic</i>
|
||||
<u>underline</u>
|
||||
<s>strikethrough</s>
|
||||
<del>strikethrough</del>
|
||||
<strike>strikethrough</strike>
|
||||
<code>inline fixed-width code</code>
|
||||
<pre>pre-formatted fixed-width code block</pre>
|
||||
<blockquote>pre-formatted fixed-width code block</blockquote>
|
||||
<a href="https://github.com">URL</a>
|
||||
<a href="mention:@danogentili">Mention by username</a>
|
||||
<a href="mention:186785362">Mention by user id</a>
|
||||
|
|
|
|||
|
|
@ -13,6 +13,7 @@ Global message search
|
|||
|
||||
| Name | Type | Description | Required |
|
||||
|----------|---------------|-------------|----------|
|
||||
|folder\_id|[int](../types/int.md) | Folder ID | Optional|
|
||||
|q|[string](../types/string.md) | The query | Yes|
|
||||
|offset\_rate|[int](../types/int.md) | Offset rate | Yes|
|
||||
|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | 0 or the peer offset | Optional|
|
||||
|
|
@ -37,13 +38,13 @@ include 'madeline.php';
|
|||
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
|
||||
$MadelineProto->start();
|
||||
|
||||
$messages_Messages = $MadelineProto->messages->searchGlobal(['q' => 'string', 'offset_rate' => int, 'offset_peer' => InputPeer, 'offset_id' => int, 'limit' => int, ]);
|
||||
$messages_Messages = $MadelineProto->messages->searchGlobal(['folder_id' => int, 'q' => 'string', 'offset_rate' => int, 'offset_peer' => InputPeer, 'offset_id' => int, 'limit' => int, ]);
|
||||
```
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
messages_Messages = messages.searchGlobal({q='string', offset_rate=int, offset_peer=InputPeer, offset_id=int, limit=int, })
|
||||
messages_Messages = messages.searchGlobal({folder_id=int, q='string', offset_rate=int, offset_peer=InputPeer, offset_id=int, limit=int, })
|
||||
```
|
||||
|
||||
### Errors this method can return:
|
||||
|
|
|
|||
|
|
@ -78,8 +78,13 @@ The following tags are currently supported:
|
|||
<strong>bold</strong>
|
||||
<em>italic</em>
|
||||
<i>italic</i>
|
||||
<u>underline</u>
|
||||
<s>strikethrough</s>
|
||||
<del>strikethrough</del>
|
||||
<strike>strikethrough</strike>
|
||||
<code>inline fixed-width code</code>
|
||||
<pre>pre-formatted fixed-width code block</pre>
|
||||
<blockquote>pre-formatted fixed-width code block</blockquote>
|
||||
<a href="https://github.com">URL</a>
|
||||
<a href="mention:@danogentili">Mention by username</a>
|
||||
<a href="mention:186785362">Mention by user id</a>
|
||||
|
|
|
|||
|
|
@ -78,8 +78,13 @@ The following tags are currently supported:
|
|||
<strong>bold</strong>
|
||||
<em>italic</em>
|
||||
<i>italic</i>
|
||||
<u>underline</u>
|
||||
<s>strikethrough</s>
|
||||
<del>strikethrough</del>
|
||||
<strike>strikethrough</strike>
|
||||
<code>inline fixed-width code</code>
|
||||
<pre>pre-formatted fixed-width code block</pre>
|
||||
<blockquote>pre-formatted fixed-width code block</blockquote>
|
||||
<a href="https://github.com">URL</a>
|
||||
<a href="mention:@danogentili">Mention by username</a>
|
||||
<a href="mention:186785362">Mention by user id</a>
|
||||
|
|
|
|||
|
|
@ -48,6 +48,8 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
|||
|
||||
[channelAdminLogEventActionChangeLinkedChat](../constructors/channelAdminLogEventActionChangeLinkedChat.md)
|
||||
|
||||
[channelAdminLogEventActionChangeLocation](../constructors/channelAdminLogEventActionChangeLocation.md)
|
||||
|
||||
|
||||
|
||||
### Methods that return an object of this type (methods):
|
||||
|
|
|
|||
|
|
@ -0,0 +1,22 @@
|
|||
---
|
||||
title: ChannelLocation
|
||||
description: constructors and methods of type ChannelLocation
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Type: ChannelLocation
|
||||
[Back to types index](index.md)
|
||||
|
||||
|
||||
|
||||
### Possible values (constructors):
|
||||
|
||||
[channelLocationEmpty](../constructors/channelLocationEmpty.md)
|
||||
|
||||
[channelLocation](../constructors/channelLocation.md)
|
||||
|
||||
|
||||
|
||||
### Methods that return an object of this type (methods):
|
||||
|
||||
|
||||
|
||||
|
|
@ -1,24 +0,0 @@
|
|||
---
|
||||
title: ContactLink
|
||||
description: constructors and methods of type ContactLink
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Type: ContactLink
|
||||
[Back to types index](index.md)
|
||||
|
||||
|
||||
|
||||
### Possible values (constructors):
|
||||
|
||||
[contactLinkUnknown](../constructors/contactLinkUnknown.md)
|
||||
|
||||
[contactLinkNone](../constructors/contactLinkNone.md)
|
||||
|
||||
[contactLinkContact](../constructors/contactLinkContact.md)
|
||||
|
||||
|
||||
|
||||
### Methods that return an object of this type (methods):
|
||||
|
||||
|
||||
|
||||
|
|
@ -40,6 +40,12 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
|||
|
||||
[messageEntityCashtag](../constructors/messageEntityCashtag.md)
|
||||
|
||||
[messageEntityUnderline](../constructors/messageEntityUnderline.md)
|
||||
|
||||
[messageEntityStrike](../constructors/messageEntityStrike.md)
|
||||
|
||||
[messageEntityBlockquote](../constructors/messageEntityBlockquote.md)
|
||||
|
||||
|
||||
|
||||
### Methods that return an object of this type (methods):
|
||||
|
|
|
|||
|
|
@ -0,0 +1,20 @@
|
|||
---
|
||||
title: PeerLocated
|
||||
description: constructors and methods of type PeerLocated
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Type: PeerLocated
|
||||
[Back to types index](index.md)
|
||||
|
||||
|
||||
|
||||
### Possible values (constructors):
|
||||
|
||||
[peerLocated](../constructors/peerLocated.md)
|
||||
|
||||
|
||||
|
||||
### Methods that return an object of this type (methods):
|
||||
|
||||
|
||||
|
||||
|
|
@ -22,6 +22,8 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
|||
|
||||
[inputReportReasonCopyright](../constructors/inputReportReasonCopyright.md)
|
||||
|
||||
[inputReportReasonGeoIrrelevant](../constructors/inputReportReasonGeoIrrelevant.md)
|
||||
|
||||
|
||||
|
||||
### Methods that return an object of this type (methods):
|
||||
|
|
|
|||
|
|
@ -30,8 +30,6 @@ Contains notifications about data changes
|
|||
|
||||
[updateUserPhoto](../constructors/updateUserPhoto.md)
|
||||
|
||||
[updateContactLink](../constructors/updateContactLink.md)
|
||||
|
||||
[updateNewEncryptedMessage](../constructors/updateNewEncryptedMessage.md)
|
||||
|
||||
[updateEncryptedChatTyping](../constructors/updateEncryptedChatTyping.md)
|
||||
|
|
@ -152,6 +150,10 @@ Contains notifications about data changes
|
|||
|
||||
[updateFolderPeers](../constructors/updateFolderPeers.md)
|
||||
|
||||
[updatePeerSettings](../constructors/updatePeerSettings.md)
|
||||
|
||||
[updatePeerLocated](../constructors/updatePeerLocated.md)
|
||||
|
||||
|
||||
|
||||
### Methods that return an object of this type (methods):
|
||||
|
|
|
|||
|
|
@ -30,6 +30,14 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
|||
|
||||
[$MadelineProto->account->getNotifyExceptions](../methods/account_getNotifyExceptions.md)
|
||||
|
||||
[$MadelineProto->contacts->deleteContacts](../methods/contacts_deleteContacts.md)
|
||||
|
||||
[$MadelineProto->contacts->addContact](../methods/contacts_addContact.md)
|
||||
|
||||
[$MadelineProto->contacts->acceptContact](../methods/contacts_acceptContact.md)
|
||||
|
||||
[$MadelineProto->contacts->getLocated](../methods/contacts_getLocated.md)
|
||||
|
||||
[$MadelineProto->messages->sendMessage](../methods/messages_sendMessage.md)
|
||||
|
||||
[$MadelineProto->messages->sendMedia](../methods/messages_sendMedia.md)
|
||||
|
|
@ -96,6 +104,8 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
|||
|
||||
[$MadelineProto->channels->togglePreHistoryHidden](../methods/channels_togglePreHistoryHidden.md)
|
||||
|
||||
[$MadelineProto->channels->editCreator](../methods/channels_editCreator.md)
|
||||
|
||||
[$MadelineProto->phone->discardCall](../methods/phone_discardCall.md)
|
||||
|
||||
[$MadelineProto->phone->setCallRating](../methods/phone_setCallRating.md)
|
||||
|
|
|
|||
|
|
@ -1,22 +0,0 @@
|
|||
---
|
||||
title: contacts_Link
|
||||
description: constructors and methods of type contacts_Link
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Type: contacts\_Link
|
||||
[Back to types index](index.md)
|
||||
|
||||
|
||||
|
||||
### Possible values (constructors):
|
||||
|
||||
[contacts\_link](../constructors/contacts_link.md)
|
||||
|
||||
|
||||
|
||||
### Methods that return an object of this type (methods):
|
||||
|
||||
[$MadelineProto->contacts->deleteContact](../methods/contacts_deleteContact.md)
|
||||
|
||||
|
||||
|
||||
|
|
@ -35,6 +35,8 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
|||
|
||||
[ChannelAdminLogEventsFilter](ChannelAdminLogEventsFilter.md)<a name="ChannelAdminLogEventsFilter"></a>
|
||||
|
||||
[ChannelLocation](ChannelLocation.md)<a name="ChannelLocation"></a>
|
||||
|
||||
[ChannelMessagesFilter](ChannelMessagesFilter.md)<a name="ChannelMessagesFilter"></a>
|
||||
|
||||
[ChannelParticipant](ChannelParticipant.md)<a name="ChannelParticipant"></a>
|
||||
|
|
@ -67,8 +69,6 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
|||
|
||||
[ContactBlocked](ContactBlocked.md)<a name="ContactBlocked"></a>
|
||||
|
||||
[ContactLink](ContactLink.md)<a name="ContactLink"></a>
|
||||
|
||||
[ContactStatus](ContactStatus.md)<a name="ContactStatus"></a>
|
||||
|
||||
[DataJSON](DataJSON.md)<a name="DataJSON"></a>
|
||||
|
|
@ -279,6 +279,8 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
|||
|
||||
[Peer](Peer.md)<a name="Peer"></a>
|
||||
|
||||
[PeerLocated](PeerLocated.md)<a name="PeerLocated"></a>
|
||||
|
||||
[PeerNotifySettings](PeerNotifySettings.md)<a name="PeerNotifySettings"></a>
|
||||
|
||||
[PeerSettings](PeerSettings.md)<a name="PeerSettings"></a>
|
||||
|
|
@ -443,8 +445,6 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
|||
|
||||
[contacts\_ImportedContacts](contacts_ImportedContacts.md)<a name="contacts_ImportedContacts"></a>
|
||||
|
||||
[contacts\_Link](contacts_Link.md)<a name="contacts_Link"></a>
|
||||
|
||||
[contacts\_ResolvedPeer](contacts_ResolvedPeer.md)<a name="contacts_ResolvedPeer"></a>
|
||||
|
||||
[contacts\_TopPeers](contacts_TopPeers.md)<a name="contacts_TopPeers"></a>
|
||||
|
|
|
|||
|
|
@ -32,7 +32,5 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
|||
|
||||
[$MadelineProto->channels->getGroupsForDiscussion](../methods/channels_getGroupsForDiscussion.md)
|
||||
|
||||
[$MadelineProto->channels->getBroadcastsForDiscussion](../methods/channels_getBroadcastsForDiscussion.md)
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -25,6 +25,7 @@ Powered by [amphp](https://amphp.org), MadelineProto wraps the AMPHP APIs to pro
|
|||
* [Async echo](#async-echo-does-not-block-the-main-thread)
|
||||
* [MadelineProto artax HTTP client](#madelineproto-artax-http-client)
|
||||
* [Async forking](#async-forking-does-green-thread-forking)
|
||||
* [Async flock](#async-flock)
|
||||
* [Combining async operations](#combining-async-operations)
|
||||
* [MadelineProto async loop APIs](#async-loop-apis)
|
||||
* [Loop](#loop)
|
||||
|
|
@ -323,6 +324,21 @@ $MadelineProto->callFork((function () use ($MadelineProto) {
|
|||
})());
|
||||
```
|
||||
|
||||
#### Async flock
|
||||
|
||||
```php
|
||||
$unlock = yield $MadelineProto->flock($filePath, LOCK_SH);
|
||||
try {
|
||||
// ...
|
||||
} finally {
|
||||
$unlock();
|
||||
}
|
||||
```
|
||||
|
||||
This will asynchronously wait for a lock on `$filePath` (creating it if it doesn't exist).
|
||||
The locking mode can be `LOCK_SH` (shared locks), `LOCK_EX` (exclusive locks), as with the PHP `flock` function.
|
||||
A third optional parameter can be set, to specify a polling interval in seconds (0.1 by default).
|
||||
|
||||
#### Combining async operations
|
||||
|
||||
These methods can be used to execute multiple async operations simultaneously and wait for the result of all of them.
|
||||
|
|
|
|||
|
|
@ -447,4 +447,4 @@ $output_file_name = yield $MadelineProto->download_to_file(
|
|||
);
|
||||
```
|
||||
|
||||
<a href="https://docs.madelineproto.xyz/docs/CHAT_INFO.html">Next section</a>
|
||||
<a href="https://docs.madelineproto.xyz/docs/CHAT_INFO.html">Next section</a>
|
||||
|
|
@ -435,4 +435,4 @@ The settings array can be accessed and modified in the instantiated class by acc
|
|||
$MadelineProto->settings['updates']['handle_updates'] = true; // reenable update fetching
|
||||
```
|
||||
|
||||
<a href="https://docs.madelineproto.xyz/docs/SELF.html">Next section</a>
|
||||
<a href="https://docs.madelineproto.xyz/docs/SELF.html">Next section</a>
|
||||
|
|
@ -79,6 +79,7 @@ Tip: if you receive an error (or nothing), [send us](https://t.me/pwrtelegramgro
|
|||
* [Async echo](https://docs.madelineproto.xyz/docs/ASYNC.html#async-echo-does-not-block-the-main-thread)
|
||||
* [MadelineProto artax HTTP client](https://docs.madelineproto.xyz/docs/ASYNC.html#madelineproto-artax-http-client)
|
||||
* [Async forking](https://docs.madelineproto.xyz/docs/ASYNC.html#async-forking-does-green-thread-forking)
|
||||
* [Async flock](https://docs.madelineproto.xyz/docs/ASYNC.html#async-flock)
|
||||
* [Combining async operations](https://docs.madelineproto.xyz/docs/ASYNC.html#combining-async-operations)
|
||||
* [MadelineProto async loop APIs](https://docs.madelineproto.xyz/docs/ASYNC.html#async-loop-apis)
|
||||
* [Loop](https://docs.madelineproto.xyz/docs/ASYNC.html#loop)
|
||||
|
|
@ -179,12 +180,14 @@ Tip: if you receive an error (or nothing), [send us](https://t.me/pwrtelegramgro
|
|||
* [Make a phone call and play a song](https://docs.madelineproto.xyz/docs/CALLS.html)
|
||||
* [Create a secret chat bot](https://docs.madelineproto.xyz/docs/SECRET_CHATS.html)
|
||||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/messages_acceptUrlAuth.html" name="messages_acceptUrlAuth">Accept URL authorization: messages.acceptUrlAuth</a>
|
||||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/contacts_acceptContact.html" name="contacts_acceptContact">Accept contact: contacts.acceptContact</a>
|
||||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/account_acceptAuthorization.html" name="account_acceptAuthorization">Accept telegram passport authorization: account.acceptAuthorization</a>
|
||||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/help_acceptTermsOfService.html" name="help_acceptTermsOfService">Accept telegram's TOS: help.acceptTermsOfService</a>
|
||||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/messages_installStickerSet.html" name="messages_installStickerSet">Add a sticker set: messages.installStickerSet</a>
|
||||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/messages_faveSticker.html" name="messages_faveSticker">Add a sticker to favorites: messages.faveSticker</a>
|
||||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/messages_saveRecentSticker.html" name="messages_saveRecentSticker">Add a sticker to recent stickers: messages.saveRecentSticker</a>
|
||||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/messages_addChatUser.html" name="messages_addChatUser">Add a user to a normal chat (use channels->inviteToChannel for supergroups): messages.addChatUser</a>
|
||||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/contacts_addContact.html" name="contacts_addContact">Add contact: contacts.addContact</a>
|
||||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/contacts_importContacts.html" name="contacts_importContacts">Add phone number as contact: contacts.importContacts</a>
|
||||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/stickers_addStickerToSet.html" name="stickers_addStickerToSet">Add sticker to stickerset: stickers.addStickerToSet</a>
|
||||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/channels_inviteToChannel.html" name="channels_inviteToChannel">Add users to channel/supergroup: channels.inviteToChannel</a>
|
||||
|
|
@ -220,7 +223,6 @@ Tip: if you receive an error (or nothing), [send us](https://t.me/pwrtelegramgro
|
|||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/account_resetAuthorization.html" name="account_resetAuthorization">Delete a certain session: account.resetAuthorization</a>
|
||||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/account_resetWebAuthorization.html" name="account_resetWebAuthorization">Delete a certain telegram web login authorization: account.resetWebAuthorization</a>
|
||||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/channels_deleteChannel.html" name="channels_deleteChannel">Delete a channel/supergroup: channels.deleteChannel</a>
|
||||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/contacts_deleteContact.html" name="contacts_deleteContact">Delete a contact: contacts.deleteContact</a>
|
||||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/messages_deleteChatUser.html" name="messages_deleteChatUser">Delete a user from a chat (not supergroup): messages.deleteChatUser</a>
|
||||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/auth_resetAuthorizations.html" name="auth_resetAuthorizations">Delete all logged-in sessions.: auth.resetAuthorizations</a>
|
||||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/channels_deleteUserHistory.html" name="channels_deleteUserHistory">Delete all messages of a user in a channel/supergroup: channels.deleteUserHistory</a>
|
||||
|
|
@ -242,8 +244,10 @@ Tip: if you receive an error (or nothing), [send us](https://t.me/pwrtelegramgro
|
|||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/channels_editAdmin.html" name="channels_editAdmin">Edit admin permissions of a user in a channel/supergroup: channels.editAdmin</a>
|
||||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/messages_editChatAdmin.html" name="messages_editChatAdmin">Edit admin permissions: messages.editChatAdmin</a>
|
||||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/messages_editChatAbout.html" name="messages_editChatAbout">Edit chat info: messages.editChatAbout</a>
|
||||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/channels_editCreator.html" name="channels_editCreator">Edit creator of channel: channels.editCreator</a>
|
||||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/messages_editChatDefaultBannedRights.html" name="messages_editChatDefaultBannedRights">Edit default rights of chat: messages.editChatDefaultBannedRights</a>
|
||||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/folders_editPeerFolders.html" name="folders_editPeerFolders">Edit folder: folders.editPeerFolders</a>
|
||||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/channels_editLocation.html" name="channels_editLocation">Edit location (geochats): channels.editLocation</a>
|
||||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/messages_editChatPhoto.html" name="messages_editChatPhoto">Edit the photo of a normal chat (not supergroup): messages.editChatPhoto</a>
|
||||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/channels_editPhoto.html" name="channels_editPhoto">Edit the photo of a supergroup/channel: channels.editPhoto</a>
|
||||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/messages_editChatTitle.html" name="messages_editChatTitle">Edit the title of a normal chat (not supergroup): messages.editChatTitle</a>
|
||||
|
|
@ -275,7 +279,6 @@ Tip: if you receive an error (or nothing), [send us](https://t.me/pwrtelegramgro
|
|||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/phone_getCallConfig.html" name="phone_getCallConfig">Get call configuration: phone.getCallConfig</a>
|
||||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/channels_getMessages.html" name="channels_getMessages">Get channel/supergroup messages: channels.getMessages</a>
|
||||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/channels_getParticipants.html" name="channels_getParticipants">Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead): channels.getParticipants</a>
|
||||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/channels_getBroadcastsForDiscussion.html" name="channels_getBroadcastsForDiscussion">Get channels for discussion: channels.getBroadcastsForDiscussion</a>
|
||||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/messages_getCommonChats.html" name="messages_getCommonChats">Get chats in common with a user: messages.getCommonChats</a>
|
||||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/contacts_getContactIDs.html" name="contacts_getContactIDs">Get contacts by IDs: contacts.getContactIDs</a>
|
||||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/help_getDeepLinkInfo.html" name="help_getDeepLinkInfo">Get deep link info: help.getDeepLinkInfo</a>
|
||||
|
|
@ -315,6 +318,7 @@ Tip: if you receive an error (or nothing), [send us](https://t.me/pwrtelegramgro
|
|||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/help_getPassportConfig.html" name="help_getPassportConfig">Get passport config: help.getPassportConfig</a>
|
||||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/payments_getPaymentForm.html" name="payments_getPaymentForm">Get payment form: payments.getPaymentForm</a>
|
||||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/payments_getPaymentReceipt.html" name="payments_getPaymentReceipt">Get payment receipt: payments.getPaymentReceipt</a>
|
||||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/contacts_getLocated.html" name="contacts_getLocated">Get people nearby (geochats): contacts.getLocated</a>
|
||||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/messages_getPinnedDialogs.html" name="messages_getPinnedDialogs">Get pinned dialogs: messages.getPinnedDialogs</a>
|
||||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/messages_getPollResults.html" name="messages_getPollResults">Get poll results: messages.getPollResults</a>
|
||||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/messages_getHistory.html" name="messages_getHistory">Get previous messages of a group: messages.getHistory</a>
|
||||
|
|
@ -348,7 +352,7 @@ Tip: if you receive an error (or nothing), [send us](https://t.me/pwrtelegramgro
|
|||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/messages_getWebPagePreview.html" name="messages_getWebPagePreview">Get webpage preview: messages.getWebPagePreview</a>
|
||||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/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="https://docs.madelineproto.xyz/API_docs/methods/messages_searchGlobal.html" name="messages_searchGlobal">Global message search: messages.searchGlobal</a>
|
||||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/messages_hideReportSpam.html" name="messages_hideReportSpam">Hide report spam popup: messages.hideReportSpam</a>
|
||||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/messages_hidePeerSettingsBar.html" name="messages_hidePeerSettingsBar">Hide peer settings bar: messages.hidePeerSettingsBar</a>
|
||||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/messages_importChatInvite.html" name="messages_importChatInvite">Import chat invite: messages.importChatInvite</a>
|
||||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/initConnection.html" name="initConnection">Initializes connection and save information on the user's device and application.: initConnection</a>
|
||||
* <a href="https://docs.madelineproto.xyz/API_docs/methods/account_installWallPaper.html" name="account_installWallPaper">Install wallpaper: account.installWallPaper</a>
|
||||
|
|
|
|||
|
|
@ -66,8 +66,13 @@ The following tags are currently supported:
|
|||
<strong>bold</strong>
|
||||
<em>italic</em>
|
||||
<i>italic</i>
|
||||
<u>underline</u>
|
||||
<s>strikethrough</s>
|
||||
<del>strikethrough</del>
|
||||
<strike>strikethrough</strike>
|
||||
<code>inline fixed-width code</code>
|
||||
<pre>pre-formatted fixed-width code block</pre>
|
||||
<blockquote>pre-formatted fixed-width code block</blockquote>
|
||||
<a href="https://github.com">URL</a>
|
||||
<a href="mention:@danogentili">Mention by username</a>
|
||||
<a href="mention:186785362">Mention by user id</a>
|
||||
|
|
|
|||
|
|
@ -75,8 +75,13 @@ The following tags are currently supported:
|
|||
<strong>bold</strong>
|
||||
<em>italic</em>
|
||||
<i>italic</i>
|
||||
<u>underline</u>
|
||||
<s>strikethrough</s>
|
||||
<del>strikethrough</del>
|
||||
<strike>strikethrough</strike>
|
||||
<code>inline fixed-width code</code>
|
||||
<pre>pre-formatted fixed-width code block</pre>
|
||||
<blockquote>pre-formatted fixed-width code block</blockquote>
|
||||
<a href="https://github.com">URL</a>
|
||||
<a href="mention:@danogentili">Mention by username</a>
|
||||
<a href="mention:186785362">Mention by user id</a>
|
||||
|
|
|
|||
|
|
@ -76,8 +76,13 @@ The following tags are currently supported:
|
|||
<strong>bold</strong>
|
||||
<em>italic</em>
|
||||
<i>italic</i>
|
||||
<u>underline</u>
|
||||
<s>strikethrough</s>
|
||||
<del>strikethrough</del>
|
||||
<strike>strikethrough</strike>
|
||||
<code>inline fixed-width code</code>
|
||||
<pre>pre-formatted fixed-width code block</pre>
|
||||
<blockquote>pre-formatted fixed-width code block</blockquote>
|
||||
<a href="https://github.com">URL</a>
|
||||
<a href="mention:@danogentili">Mention by username</a>
|
||||
<a href="mention:186785362">Mention by user id</a>
|
||||
|
|
|
|||
|
|
@ -65,8 +65,13 @@ The following tags are currently supported:
|
|||
<strong>bold</strong>
|
||||
<em>italic</em>
|
||||
<i>italic</i>
|
||||
<u>underline</u>
|
||||
<s>strikethrough</s>
|
||||
<del>strikethrough</del>
|
||||
<strike>strikethrough</strike>
|
||||
<code>inline fixed-width code</code>
|
||||
<pre>pre-formatted fixed-width code block</pre>
|
||||
<blockquote>pre-formatted fixed-width code block</blockquote>
|
||||
<a href="https://github.com">URL</a>
|
||||
<a href="mention:@danogentili">Mention by username</a>
|
||||
<a href="mention:186785362">Mention by user id</a>
|
||||
|
|
|
|||
|
|
@ -68,8 +68,13 @@ The following tags are currently supported:
|
|||
<strong>bold</strong>
|
||||
<em>italic</em>
|
||||
<i>italic</i>
|
||||
<u>underline</u>
|
||||
<s>strikethrough</s>
|
||||
<del>strikethrough</del>
|
||||
<strike>strikethrough</strike>
|
||||
<code>inline fixed-width code</code>
|
||||
<pre>pre-formatted fixed-width code block</pre>
|
||||
<blockquote>pre-formatted fixed-width code block</blockquote>
|
||||
<a href="https://github.com">URL</a>
|
||||
<a href="mention:@danogentili">Mention by username</a>
|
||||
<a href="mention:186785362">Mention by user id</a>
|
||||
|
|
|
|||
|
|
@ -78,8 +78,13 @@ The following tags are currently supported:
|
|||
<strong>bold</strong>
|
||||
<em>italic</em>
|
||||
<i>italic</i>
|
||||
<u>underline</u>
|
||||
<s>strikethrough</s>
|
||||
<del>strikethrough</del>
|
||||
<strike>strikethrough</strike>
|
||||
<code>inline fixed-width code</code>
|
||||
<pre>pre-formatted fixed-width code block</pre>
|
||||
<blockquote>pre-formatted fixed-width code block</blockquote>
|
||||
<a href="https://github.com">URL</a>
|
||||
<a href="mention:@danogentili">Mention by username</a>
|
||||
<a href="mention:186785362">Mention by user id</a>
|
||||
|
|
|
|||
|
|
@ -78,8 +78,13 @@ The following tags are currently supported:
|
|||
<strong>bold</strong>
|
||||
<em>italic</em>
|
||||
<i>italic</i>
|
||||
<u>underline</u>
|
||||
<s>strikethrough</s>
|
||||
<del>strikethrough</del>
|
||||
<strike>strikethrough</strike>
|
||||
<code>inline fixed-width code</code>
|
||||
<pre>pre-formatted fixed-width code block</pre>
|
||||
<blockquote>pre-formatted fixed-width code block</blockquote>
|
||||
<a href="https://github.com">URL</a>
|
||||
<a href="mention:@danogentili">Mention by username</a>
|
||||
<a href="mention:186785362">Mention by user id</a>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,15 @@
|
|||
---
|
||||
title: MadelineProto API documentation (layer v102)
|
||||
description: MadelineProto API documentation (layer v102)
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# MadelineProto API documentation (layer v102)
|
||||
|
||||
[Back to main documentation](..)
|
||||
|
||||
|
||||
[Methods](methods/)
|
||||
|
||||
[Constructors](constructors/)
|
||||
|
||||
[Types](types/)
|
||||
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,40 @@
|
|||
---
|
||||
title: accessPointRule
|
||||
description: Access point rule
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: accessPointRule
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Access point rule
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|phone\_prefix\_rules|[string](../types/string.md) | Yes|Phone prefix rules|
|
||||
|dc\_id|[int](../types/int.md) | Yes|DC ID|
|
||||
|ips|Array of [IpPort](../types/IpPort.md) | Yes|Ips|
|
||||
|
||||
|
||||
|
||||
### Type: [AccessPointRule](../types/AccessPointRule.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$accessPointRule = ['_' => 'accessPointRule', 'phone_prefix_rules' => 'string', 'dc_id' => int, 'ips' => [IpPort, IpPort]];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
accessPointRule={_='accessPointRule', phone_prefix_rules='string', dc_id=int, ips={IpPort}}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
title: accountDaysTTL
|
||||
description: Account TTL in days
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: accountDaysTTL
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Account TTL in days
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|days|[int](../types/int.md) | Yes|Days|
|
||||
|
||||
|
||||
|
||||
### Type: [AccountDaysTTL](../types/AccountDaysTTL.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$accountDaysTTL = ['_' => 'accountDaysTTL', 'days' => int];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
accountDaysTTL={_='accountDaysTTL', days=int}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,42 @@
|
|||
---
|
||||
title: account.authorizationForm
|
||||
description: Telegram passport authorization form
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.authorizationForm
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Telegram passport authorization form
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|required\_types|Array of [SecureRequiredType](../types/SecureRequiredType.md) | Yes|Required types|
|
||||
|values|Array of [SecureValue](../types/SecureValue.md) | Yes|Values|
|
||||
|errors|Array of [SecureValueError](../types/SecureValueError.md) | Yes|Errors|
|
||||
|users|Array of [User](../types/User.md) | Yes|Users|
|
||||
|privacy\_policy\_url|[string](../types/string.md) | Optional|Privacy policy URL|
|
||||
|
||||
|
||||
|
||||
### Type: [account\_AuthorizationForm](../types/account_AuthorizationForm.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$account_authorizationForm = ['_' => 'account.authorizationForm', 'required_types' => [SecureRequiredType, SecureRequiredType], 'values' => [SecureValue, SecureValue], 'errors' => [SecureValueError, SecureValueError], 'users' => [User, User], 'privacy_policy_url' => 'string'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
account_authorizationForm={_='account.authorizationForm', required_types={SecureRequiredType}, values={SecureValue}, errors={SecureValueError}, users={User}, privacy_policy_url='string'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
title: account.authorizations
|
||||
description: Authorized clients for this account
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.authorizations
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Authorized clients for this account
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|authorizations|Array of [Authorization](../types/Authorization.md) | Yes|Authorizations|
|
||||
|
||||
|
||||
|
||||
### Type: [account\_Authorizations](../types/account_Authorizations.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$account_authorizations = ['_' => 'account.authorizations', 'authorizations' => [Authorization, Authorization]];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
account_authorizations={_='account.authorizations', authorizations={Authorization}}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,40 @@
|
|||
---
|
||||
title: account.autoDownloadSettings
|
||||
description: Autodownload settings
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.autoDownloadSettings
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Autodownload settings
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|low|[AutoDownloadSettings](../types/AutoDownloadSettings.md) | Yes|Low preset?|
|
||||
|medium|[AutoDownloadSettings](../types/AutoDownloadSettings.md) | Yes|Medium preset?|
|
||||
|high|[AutoDownloadSettings](../types/AutoDownloadSettings.md) | Yes|High preset?|
|
||||
|
||||
|
||||
|
||||
### Type: [account\_AutoDownloadSettings](../types/account_AutoDownloadSettings.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$account_autoDownloadSettings = ['_' => 'account.autoDownloadSettings', 'low' => AutoDownloadSettings, 'medium' => AutoDownloadSettings, 'high' => AutoDownloadSettings];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
account_autoDownloadSettings={_='account.autoDownloadSettings', low=AutoDownloadSettings, medium=AutoDownloadSettings, high=AutoDownloadSettings}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,48 @@
|
|||
---
|
||||
title: account.password
|
||||
description: Password
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.password
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Password
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|has\_recovery|[Bool](../types/Bool.md) | Optional|Has recovery?|
|
||||
|has\_secure\_values|[Bool](../types/Bool.md) | Optional|Has secure values?|
|
||||
|has\_password|[Bool](../types/Bool.md) | Optional|Has password?|
|
||||
|current\_algo|[PasswordKdfAlgo](../types/PasswordKdfAlgo.md) | Optional|Current algo|
|
||||
|srp\_B|[bytes](../types/bytes.md) | Optional|Srp b|
|
||||
|srp\_id|[long](../types/long.md) | Optional|Srp ID|
|
||||
|hint|[string](../types/string.md) | Optional|Hint|
|
||||
|email\_unconfirmed\_pattern|[string](../types/string.md) | Optional|Email unconfirmed pattern|
|
||||
|new\_algo|[PasswordKdfAlgo](../types/PasswordKdfAlgo.md) | Yes|New algo|
|
||||
|new\_secure\_algo|[SecurePasswordKdfAlgo](../types/SecurePasswordKdfAlgo.md) | Yes|New secure algo|
|
||||
|secure\_random|[bytes](../types/bytes.md) | Yes|Secure random|
|
||||
|
||||
|
||||
|
||||
### Type: [account\_Password](../types/account_Password.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$account_password = ['_' => 'account.password', 'has_recovery' => Bool, 'has_secure_values' => Bool, 'has_password' => Bool, 'current_algo' => PasswordKdfAlgo, 'srp_B' => 'bytes', 'srp_id' => long, 'hint' => 'string', 'email_unconfirmed_pattern' => 'string', 'new_algo' => PasswordKdfAlgo, 'new_secure_algo' => SecurePasswordKdfAlgo, 'secure_random' => 'bytes'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
account_password={_='account.password', has_recovery=Bool, has_secure_values=Bool, has_password=Bool, current_algo=PasswordKdfAlgo, srp_B='bytes', srp_id=long, hint='string', email_unconfirmed_pattern='string', new_algo=PasswordKdfAlgo, new_secure_algo=SecurePasswordKdfAlgo, secure_random='bytes'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,42 @@
|
|||
---
|
||||
title: account.passwordInputSettings
|
||||
description: 2FA password settings
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.passwordInputSettings
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
2FA password settings
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|new\_algo|[PasswordKdfAlgo](../types/PasswordKdfAlgo.md) | Optional|New algo|
|
||||
|new\_password\_hash|[bytes](../types/bytes.md) | Optional|`hash('sha256', $new_salt.$new_password.$new_salt, true)`|
|
||||
|hint|[string](../types/string.md) | Optional|Hint|
|
||||
|email|[string](../types/string.md) | Optional|Email|
|
||||
|new\_secure\_settings|[SecureSecretSettings](../types/SecureSecretSettings.md) | Optional|New secure settings|
|
||||
|
||||
|
||||
|
||||
### Type: [account\_PasswordInputSettings](../types/account_PasswordInputSettings.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$account_passwordInputSettings = ['_' => 'account.passwordInputSettings', 'new_algo' => PasswordKdfAlgo, 'new_password_hash' => 'bytes', 'hint' => 'string', 'email' => 'string', 'new_secure_settings' => SecureSecretSettings];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
account_passwordInputSettings={_='account.passwordInputSettings', new_algo=PasswordKdfAlgo, new_password_hash='bytes', hint='string', email='string', new_secure_settings=SecureSecretSettings}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
title: account.passwordSettings
|
||||
description: Password settings
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.passwordSettings
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Password settings
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|email|[string](../types/string.md) | Optional|Email|
|
||||
|secure\_settings|[SecureSecretSettings](../types/SecureSecretSettings.md) | Optional|Secure settings|
|
||||
|
||||
|
||||
|
||||
### Type: [account\_PasswordSettings](../types/account_PasswordSettings.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$account_passwordSettings = ['_' => 'account.passwordSettings', 'email' => 'string', 'secure_settings' => SecureSecretSettings];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
account_passwordSettings={_='account.passwordSettings', email='string', secure_settings=SecureSecretSettings}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,40 @@
|
|||
---
|
||||
title: account.privacyRules
|
||||
description: Privacy rules
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.privacyRules
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Privacy rules
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|rules|Array of [PrivacyRule](../types/PrivacyRule.md) | Yes|Rules|
|
||||
|chats|Array of [Chat](../types/Chat.md) | Yes|Chats allowed?|
|
||||
|users|Array of [User](../types/User.md) | Yes|Users|
|
||||
|
||||
|
||||
|
||||
### Type: [account\_PrivacyRules](../types/account_PrivacyRules.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$account_privacyRules = ['_' => 'account.privacyRules', 'rules' => [PrivacyRule, PrivacyRule], 'chats' => [Chat, Chat], 'users' => [User, User]];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
account_privacyRules={_='account.privacyRules', rules={PrivacyRule}, chats={Chat}, users={User}}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
title: account.sentEmailCode
|
||||
description: Sent email code
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.sentEmailCode
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Sent email code
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|email\_pattern|[string](../types/string.md) | Yes|Email pattern|
|
||||
|length|[int](../types/int.md) | Yes|Length|
|
||||
|
||||
|
||||
|
||||
### Type: [account\_SentEmailCode](../types/account_SentEmailCode.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$account_sentEmailCode = ['_' => 'account.sentEmailCode', 'email_pattern' => 'string', 'length' => int];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
account_sentEmailCode={_='account.sentEmailCode', email_pattern='string', length=int}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
title: account.takeout
|
||||
description: Takeout
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.takeout
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Takeout
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|id|[long](../types/long.md) | Yes|ID|
|
||||
|
||||
|
||||
|
||||
### Type: [account\_Takeout](../types/account_Takeout.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$account_takeout = ['_' => 'account.takeout', 'id' => long];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
account_takeout={_='account.takeout', id=long}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
title: account.tmpPassword
|
||||
description: Tmp password
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.tmpPassword
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Tmp password
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|tmp\_password|[bytes](../types/bytes.md) | Yes|Tmp password|
|
||||
|valid\_until|[int](../types/int.md) | Yes|Valid until|
|
||||
|
||||
|
||||
|
||||
### Type: [account\_TmpPassword](../types/account_TmpPassword.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$account_tmpPassword = ['_' => 'account.tmpPassword', 'tmp_password' => 'bytes', 'valid_until' => int];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
account_tmpPassword={_='account.tmpPassword', tmp_password='bytes', valid_until=int}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
title: account.wallPapers
|
||||
description: Wallpapers
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.wallPapers
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Wallpapers
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|hash|[int](../types/int.md) | Yes|Hash|
|
||||
|wallpapers|Array of [WallPaper](../types/WallPaper.md) | Yes|Wallpapers|
|
||||
|
||||
|
||||
|
||||
### Type: [account\_WallPapers](../types/account_WallPapers.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$account_wallPapers = ['_' => 'account.wallPapers', 'hash' => int, 'wallpapers' => [WallPaper, WallPaper]];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
account_wallPapers={_='account.wallPapers', hash=int, wallpapers={WallPaper}}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
title: account.wallPapersNotModified
|
||||
description: No wallpapers were modified
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.wallPapersNotModified
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
No wallpapers were modified
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [account\_WallPapers](../types/account_WallPapers.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$account_wallPapersNotModified = ['_' => 'account.wallPapersNotModified'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
account_wallPapersNotModified={_='account.wallPapersNotModified'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
title: account.webAuthorizations
|
||||
description: Telegram login authorizations
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: account.webAuthorizations
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Telegram login authorizations
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|authorizations|Array of [WebAuthorization](../types/WebAuthorization.md) | Yes|Authorizations|
|
||||
|users|Array of [User](../types/User.md) | Yes|Users|
|
||||
|
||||
|
||||
|
||||
### Type: [account\_WebAuthorizations](../types/account_WebAuthorizations.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$account_webAuthorizations = ['_' => 'account.webAuthorizations', 'authorizations' => [WebAuthorization, WebAuthorization], 'users' => [User, User]];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
account_webAuthorizations={_='account.webAuthorizations', authorizations={WebAuthorization}, users={User}}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
title: auth.authorization
|
||||
description: Authorization
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: auth.authorization
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Authorization
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|tmp\_sessions|[int](../types/int.md) | Optional|Temporary sessions|
|
||||
|user|[User](../types/User.md) | Optional|User|
|
||||
|
||||
|
||||
|
||||
### Type: [auth\_Authorization](../types/auth_Authorization.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$auth_authorization = ['_' => 'auth.authorization', 'tmp_sessions' => int, 'user' => User];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
auth_authorization={_='auth.authorization', tmp_sessions=int, user=User}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
title: auth.checkedPhone
|
||||
description: Checked phone
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: auth.checkedPhone
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Checked phone
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|phone\_registered|[Bool](../types/Bool.md) | Yes|Phone registered?|
|
||||
|
||||
|
||||
|
||||
### Type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$auth_checkedPhone = ['_' => 'auth.checkedPhone', 'phone_registered' => Bool];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
auth_checkedPhone={_='auth.checkedPhone', phone_registered=Bool}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
title: auth.codeTypeCall
|
||||
description: Auth code type: call
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: auth.codeTypeCall
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Auth code type: call
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [auth\_CodeType](../types/auth_CodeType.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$auth_codeTypeCall = ['_' => 'auth.codeTypeCall'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
auth_codeTypeCall={_='auth.codeTypeCall'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
title: auth.codeTypeFlashCall
|
||||
description: Auth code type: flash call
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: auth.codeTypeFlashCall
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Auth code type: flash call
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [auth\_CodeType](../types/auth_CodeType.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$auth_codeTypeFlashCall = ['_' => 'auth.codeTypeFlashCall'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
auth_codeTypeFlashCall={_='auth.codeTypeFlashCall'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
title: auth.codeTypeSms
|
||||
description: Auth code type: SMS
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: auth.codeTypeSms
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Auth code type: SMS
|
||||
|
||||
|
||||
|
||||
|
||||
### Type: [auth\_CodeType](../types/auth_CodeType.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$auth_codeTypeSms = ['_' => 'auth.codeTypeSms'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
auth_codeTypeSms={_='auth.codeTypeSms'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
title: auth.exportedAuthorization
|
||||
description: Exported authorization
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: auth.exportedAuthorization
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Exported authorization
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|id|[int](../types/int.md) | Yes|ID|
|
||||
|bytes|[bytes](../types/bytes.md) | Yes|Bytes|
|
||||
|
||||
|
||||
|
||||
### Type: [auth\_ExportedAuthorization](../types/auth_ExportedAuthorization.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$auth_exportedAuthorization = ['_' => 'auth.exportedAuthorization', 'id' => int, 'bytes' => 'bytes'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
auth_exportedAuthorization={_='auth.exportedAuthorization', id=int, bytes='bytes'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
title: auth.passwordRecovery
|
||||
description: Password recovery
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: auth.passwordRecovery
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Password recovery
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|email\_pattern|[string](../types/string.md) | Yes|Email pattern|
|
||||
|
||||
|
||||
|
||||
### Type: [auth\_PasswordRecovery](../types/auth_PasswordRecovery.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$auth_passwordRecovery = ['_' => 'auth.passwordRecovery', 'email_pattern' => 'string'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
auth_passwordRecovery={_='auth.passwordRecovery', email_pattern='string'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,43 @@
|
|||
---
|
||||
title: auth.sentCode
|
||||
description: Sent code
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: auth.sentCode
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Sent code
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|phone\_registered|[Bool](../types/Bool.md) | Optional|Phone registered?|
|
||||
|type|[auth\_SentCodeType](../types/auth_SentCodeType.md) | Yes|Type|
|
||||
|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash|
|
||||
|next\_type|[auth\_CodeType](../types/auth_CodeType.md) | Optional|Next type|
|
||||
|timeout|[int](../types/int.md) | Optional|Timeout|
|
||||
|terms\_of\_service|[help\_TermsOfService](../types/help_TermsOfService.md) | Optional|Terms of service|
|
||||
|
||||
|
||||
|
||||
### Type: [auth\_SentCode](../types/auth_SentCode.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$auth_sentCode = ['_' => 'auth.sentCode', 'phone_registered' => Bool, 'type' => auth_SentCodeType, 'phone_code_hash' => 'string', 'next_type' => auth_CodeType, 'timeout' => int, 'terms_of_service' => help_TermsOfService];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
auth_sentCode={_='auth.sentCode', phone_registered=Bool, type=auth_SentCodeType, phone_code_hash='string', next_type=auth_CodeType, timeout=int, terms_of_service=help_TermsOfService}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
title: auth.sentCodeTypeApp
|
||||
description: Sent code type app
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: auth.sentCodeTypeApp
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Sent code type app
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|length|[int](../types/int.md) | Yes|Length|
|
||||
|
||||
|
||||
|
||||
### Type: [auth\_SentCodeType](../types/auth_SentCodeType.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$auth_sentCodeTypeApp = ['_' => 'auth.sentCodeTypeApp', 'length' => int];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
auth_sentCodeTypeApp={_='auth.sentCodeTypeApp', length=int}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
title: auth.sentCodeTypeCall
|
||||
description: Sent code type call
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: auth.sentCodeTypeCall
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Sent code type call
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|length|[int](../types/int.md) | Yes|Length|
|
||||
|
||||
|
||||
|
||||
### Type: [auth\_SentCodeType](../types/auth_SentCodeType.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$auth_sentCodeTypeCall = ['_' => 'auth.sentCodeTypeCall', 'length' => int];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
auth_sentCodeTypeCall={_='auth.sentCodeTypeCall', length=int}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
title: auth.sentCodeTypeFlashCall
|
||||
description: Sent code type flash call
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: auth.sentCodeTypeFlashCall
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Sent code type flash call
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|pattern|[string](../types/string.md) | Yes|Pattern|
|
||||
|
||||
|
||||
|
||||
### Type: [auth\_SentCodeType](../types/auth_SentCodeType.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$auth_sentCodeTypeFlashCall = ['_' => 'auth.sentCodeTypeFlashCall', 'pattern' => 'string'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
auth_sentCodeTypeFlashCall={_='auth.sentCodeTypeFlashCall', pattern='string'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
title: auth.sentCodeTypeSms
|
||||
description: Sent code type sms
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: auth.sentCodeTypeSms
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Sent code type sms
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|length|[int](../types/int.md) | Yes|Length|
|
||||
|
||||
|
||||
|
||||
### Type: [auth\_SentCodeType](../types/auth_SentCodeType.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$auth_sentCodeTypeSms = ['_' => 'auth.sentCodeTypeSms', 'length' => int];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
auth_sentCodeTypeSms={_='auth.sentCodeTypeSms', length=int}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,52 @@
|
|||
---
|
||||
title: authorization
|
||||
description: Authorization
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: authorization
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Authorization
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|current|[Bool](../types/Bool.md) | Optional|Current?|
|
||||
|official\_app|[Bool](../types/Bool.md) | Optional|Official app?|
|
||||
|password\_pending|[Bool](../types/Bool.md) | Optional|Password pending?|
|
||||
|hash|[long](../types/long.md) | Yes|Hash|
|
||||
|device\_model|[string](../types/string.md) | Yes|Device model|
|
||||
|platform|[string](../types/string.md) | Yes|Platform|
|
||||
|system\_version|[string](../types/string.md) | Yes|System version|
|
||||
|api\_id|[int](../types/int.md) | Yes|Api ID|
|
||||
|app\_name|[string](../types/string.md) | Yes|App name|
|
||||
|app\_version|[string](../types/string.md) | Yes|App version|
|
||||
|date\_created|[int](../types/int.md) | Yes|Date created|
|
||||
|date\_active|[int](../types/int.md) | Yes|Date active|
|
||||
|ip|[string](../types/string.md) | Yes|Ip|
|
||||
|country|[string](../types/string.md) | Yes|Country|
|
||||
|region|[string](../types/string.md) | Yes|Region|
|
||||
|
||||
|
||||
|
||||
### Type: [Authorization](../types/Authorization.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$authorization = ['_' => 'authorization', 'current' => Bool, 'official_app' => Bool, 'password_pending' => Bool, 'hash' => long, 'device_model' => 'string', 'platform' => 'string', 'system_version' => 'string', 'api_id' => int, 'app_name' => 'string', 'app_version' => 'string', 'date_created' => int, 'date_active' => int, 'ip' => 'string', 'country' => 'string', 'region' => 'string'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
authorization={_='authorization', current=Bool, official_app=Bool, password_pending=Bool, hash=long, device_model='string', platform='string', system_version='string', api_id=int, app_name='string', app_version='string', date_created=int, date_active=int, ip='string', country='string', region='string'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,44 @@
|
|||
---
|
||||
title: autoDownloadSettings
|
||||
description: Autodownload settings
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: autoDownloadSettings
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Autodownload settings
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|disabled|[Bool](../types/Bool.md) | Optional|Disabled?|
|
||||
|video\_preload\_large|[Bool](../types/Bool.md) | Optional|Preload large videos?|
|
||||
|audio\_preload\_next|[Bool](../types/Bool.md) | Optional|Preload audios?|
|
||||
|phonecalls\_less\_data|[Bool](../types/Bool.md) | Optional|Use less data in phonecalls?|
|
||||
|photo\_size\_max|[int](../types/int.md) | Yes|Maximum photo file size to preload|
|
||||
|video\_size\_max|[int](../types/int.md) | Yes|Maximum video file size to preload|
|
||||
|file\_size\_max|[int](../types/int.md) | Yes|Maximum file size to preload|
|
||||
|
||||
|
||||
|
||||
### Type: [AutoDownloadSettings](../types/AutoDownloadSettings.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$autoDownloadSettings = ['_' => 'autoDownloadSettings', 'disabled' => Bool, 'video_preload_large' => Bool, 'audio_preload_next' => Bool, 'phonecalls_less_data' => Bool, 'photo_size_max' => int, 'video_size_max' => int, 'file_size_max' => int];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
autoDownloadSettings={_='autoDownloadSettings', disabled=Bool, video_preload_large=Bool, audio_preload_next=Bool, phonecalls_less_data=Bool, photo_size_max=int, video_size_max=int, file_size_max=int}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
---
|
||||
title: boolFalse
|
||||
description: Represents a boolean with value equal to false
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# boolFalse
|
||||
[Back to constructor index](index.md)
|
||||
|
||||
Represents a boolean with value equal to `false`.
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
---
|
||||
title: boolTrue
|
||||
description: Represents a boolean with value equal to true
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# boolTrue
|
||||
[Back to constructor index](index.md)
|
||||
|
||||
Represents a boolean with value equal to `true`.
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
title: botCommand
|
||||
description: Bot command
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: botCommand
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Bot command
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|command|[string](../types/string.md) | Yes|Command|
|
||||
|description|[string](../types/string.md) | Yes|Description|
|
||||
|
||||
|
||||
|
||||
### Type: [BotCommand](../types/BotCommand.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$botCommand = ['_' => 'botCommand', 'command' => 'string', 'description' => 'string'];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
botCommand={_='botCommand', command='string', description='string'}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,40 @@
|
|||
---
|
||||
title: botInfo
|
||||
description: Bot info
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: botInfo
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Bot info
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|user\_id|[int](../types/int.md) | Yes|User ID|
|
||||
|description|[string](../types/string.md) | Yes|Description|
|
||||
|commands|Array of [BotCommand](../types/BotCommand.md) | Yes|Commands|
|
||||
|
||||
|
||||
|
||||
### Type: [BotInfo](../types/BotInfo.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$botInfo = ['_' => 'botInfo', 'user_id' => int, 'description' => 'string', 'commands' => [BotCommand, BotCommand]];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
botInfo={_='botInfo', user_id=int, description='string', commands={BotCommand}}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,44 @@
|
|||
---
|
||||
title: botInlineMediaResult
|
||||
description: Bot inline media result
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: botInlineMediaResult
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Bot inline media result
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|id|[string](../types/string.md) | Yes|ID|
|
||||
|type|[string](../types/string.md) | Yes|Type|
|
||||
|photo|[Photo](../types/Photo.md) | Optional|Photo|
|
||||
|document|[Document](../types/Document.md) | Optional|Document|
|
||||
|title|[string](../types/string.md) | Optional|Title|
|
||||
|description|[string](../types/string.md) | Optional|Description|
|
||||
|send\_message|[BotInlineMessage](../types/BotInlineMessage.md) | Yes|Send message|
|
||||
|
||||
|
||||
|
||||
### Type: [BotInlineResult](../types/BotInlineResult.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$botInlineMediaResult = ['_' => 'botInlineMediaResult', 'id' => 'string', 'type' => 'string', 'photo' => Photo, 'document' => Document, 'title' => 'string', 'description' => 'string', 'send_message' => BotInlineMessage];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
botInlineMediaResult={_='botInlineMediaResult', id='string', type='string', photo=Photo, document=Document, title='string', description='string', send_message=BotInlineMessage}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,46 @@
|
|||
---
|
||||
title: botInlineMessageMediaAuto
|
||||
description: Bot inline message media auto
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: botInlineMessageMediaAuto
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Bot inline message media auto
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|message|[string](../types/string.md) | Yes|Message|
|
||||
|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities|
|
||||
|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Reply markup|
|
||||
|
||||
|
||||
|
||||
### Type: [BotInlineMessage](../types/BotInlineMessage.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$botInlineMessageMediaAuto = ['_' => 'botInlineMessageMediaAuto', 'message' => 'string', 'entities' => [MessageEntity, MessageEntity], 'reply_markup' => ReplyMarkup];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
botInlineMessageMediaAuto={_='botInlineMessageMediaAuto', message='string', entities={MessageEntity}, reply_markup=ReplyMarkup}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Usage of reply_markup
|
||||
|
||||
You can provide bot API reply_markup objects here.
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,48 @@
|
|||
---
|
||||
title: botInlineMessageMediaContact
|
||||
description: Bot inline message media contact
|
||||
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||||
---
|
||||
# Constructor: botInlineMessageMediaContact
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Bot inline message media contact
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|phone\_number|[string](../types/string.md) | Yes|Phone number|
|
||||
|first\_name|[string](../types/string.md) | Yes|First name|
|
||||
|last\_name|[string](../types/string.md) | Yes|Last name|
|
||||
|vcard|[string](../types/string.md) | Yes|Vcard|
|
||||
|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Reply markup|
|
||||
|
||||
|
||||
|
||||
### Type: [BotInlineMessage](../types/BotInlineMessage.md)
|
||||
|
||||
|
||||
### Example:
|
||||
|
||||
```php
|
||||
$botInlineMessageMediaContact = ['_' => 'botInlineMessageMediaContact', 'phone_number' => 'string', 'first_name' => 'string', 'last_name' => 'string', 'vcard' => 'string', 'reply_markup' => ReplyMarkup];
|
||||
```
|
||||
|
||||
|
||||
Or, if you're into Lua:
|
||||
|
||||
```lua
|
||||
botInlineMessageMediaContact={_='botInlineMessageMediaContact', phone_number='string', first_name='string', last_name='string', vcard='string', reply_markup=ReplyMarkup}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Usage of reply_markup
|
||||
|
||||
You can provide bot API reply_markup objects here.
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue