Build documentation

This commit is contained in:
Daniil Gentili 2018-03-23 16:23:49 +01:00
parent 867abcfcdd
commit 1cb3c35ac8
1970 changed files with 12661 additions and 10733 deletions

View File

@ -12,10 +12,10 @@ Register device for push notifications
| Name | Type | Required | Description | | Name | Type | Required | Description |
|----------|---------------|----------|-------------| |----------|---------------|----------|-------------|
|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| |token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and oTher, see source code of official apps for more info|
|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| |token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info|
|app\_sandbox|[CLICK ME Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?| |app\_sandbox|[CLICK ME Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?|
|other\_uids|Array of [CLICK ME int](../types/int.md) | Yes|Other UUIDs| |other\_uids|Array of [CLICK ME int](../types/int.md) | Yes||
### Return type: [Bool](../types/Bool.md) ### Return type: [Bool](../types/Bool.md)

View File

@ -12,9 +12,9 @@ Stop sending PUSH notifications to app
| Name | Type | Required | Description | | Name | Type | Required | Description |
|----------|---------------|----------|-------------| |----------|---------------|----------|-------------|
|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| |token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info|
|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| |token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info|
|other\_uids|Array of [CLICK ME int](../types/int.md) | Yes|Other UUIDs| |other\_uids|Array of [CLICK ME int](../types/int.md) | Yes||
### Return type: [Bool](../types/Bool.md) ### Return type: [Bool](../types/Bool.md)

View File

@ -1,17 +1,19 @@
--- ---
title: bots.answerWebhookJSONQuery title: bots.answerWebhookJSONQuery
description: bots.answerWebhookJSONQuery parameters, return type and example description: Send webhook request via bot API
--- ---
## Method: bots.answerWebhookJSONQuery ## Method: bots.answerWebhookJSONQuery
[Back to methods index](index.md) [Back to methods index](index.md)
Send webhook request via bot API
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|query\_id|[CLICK ME long](../types/long.md) | Yes| |query\_id|[CLICK ME long](../types/long.md) | Yes|The query ID|
|data|[CLICK ME DataJSON](../types/DataJSON.md) | Yes| |data|[CLICK ME DataJSON](../types/DataJSON.md) | Yes|The parameters|
### Return type: [Bool](../types/Bool.md) ### Return type: [Bool](../types/Bool.md)

View File

@ -1,17 +1,19 @@
--- ---
title: bots.sendCustomRequest title: bots.sendCustomRequest
description: bots.sendCustomRequest parameters, return type and example description: Send a custom request to the bot API
--- ---
## Method: bots.sendCustomRequest ## Method: bots.sendCustomRequest
[Back to methods index](index.md) [Back to methods index](index.md)
Send a custom request to the bot API
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|custom\_method|[CLICK ME string](../types/string.md) | Yes| |custom\_method|[CLICK ME string](../types/string.md) | Yes|The method to call|
|params|[CLICK ME DataJSON](../types/DataJSON.md) | Yes| |params|[CLICK ME DataJSON](../types/DataJSON.md) | Yes|Method parameters|
### Return type: [DataJSON](../types/DataJSON.md) ### Return type: [DataJSON](../types/DataJSON.md)

View File

@ -1,17 +1,19 @@
--- ---
title: channels.checkUsername title: channels.checkUsername
description: channels.checkUsername parameters, return type and example description: Check if this username is free and can be assigned to a channel/supergroup
--- ---
## Method: channels.checkUsername ## Method: channels.checkUsername
[Back to methods index](index.md) [Back to methods index](index.md)
Check if this username is free and can be assigned to a channel/supergroup
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup|
|username|[CLICK ME string](../types/string.md) | Yes| |username|[CLICK ME string](../types/string.md) | Yes|The new username for this channel/supergroup|
### Return type: [Bool](../types/Bool.md) ### Return type: [Bool](../types/Bool.md)

View File

@ -1,19 +1,21 @@
--- ---
title: channels.createChannel title: channels.createChannel
description: channels.createChannel parameters, return type and example description: Create channel/supergroup
--- ---
## Method: channels.createChannel ## Method: channels.createChannel
[Back to methods index](index.md) [Back to methods index](index.md)
Create channel/supergroup
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional| |broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a channel|
|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional| |megagroup|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup|
|title|[CLICK ME string](../types/string.md) | Yes| |title|[CLICK ME string](../types/string.md) | Yes|Supergroup/channel title|
|about|[CLICK ME string](../types/string.md) | Yes| |about|[CLICK ME string](../types/string.md) | Yes|About text|
### Return type: [Updates](../types/Updates.md) ### Return type: [Updates](../types/Updates.md)

View File

@ -1,16 +1,18 @@
--- ---
title: channels.deleteChannel title: channels.deleteChannel
description: channels.deleteChannel parameters, return type and example description: Delete a channel/supergroup
--- ---
## Method: channels.deleteChannel ## Method: channels.deleteChannel
[Back to methods index](index.md) [Back to methods index](index.md)
Delete a channel/supergroup
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to delete|
### Return type: [Updates](../types/Updates.md) ### Return type: [Updates](../types/Updates.md)

View File

@ -1,17 +1,19 @@
--- ---
title: channels.deleteHistory title: channels.deleteHistory
description: channels.deleteHistory parameters, return type and example description: Delete the history of a supergroup/channel
--- ---
## Method: channels.deleteHistory ## Method: channels.deleteHistory
[Back to methods index](index.md) [Back to methods index](index.md)
Delete the history of a supergroup/channel
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup|
|max\_id|[CLICK ME int](../types/int.md) | Yes| |max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to delete|
### Return type: [Bool](../types/Bool.md) ### Return type: [Bool](../types/Bool.md)

View File

@ -1,17 +1,19 @@
--- ---
title: channels.deleteMessages title: channels.deleteMessages
description: channels.deleteMessages parameters, return type and example description: Delete channel/supergroup messages
--- ---
## Method: channels.deleteMessages ## Method: channels.deleteMessages
[Back to methods index](index.md) [Back to methods index](index.md)
Delete channel/supergroup messages
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup|
|id|Array of [CLICK ME int](../types/int.md) | Yes| |id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to delete|
### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md)

View File

@ -1,17 +1,19 @@
--- ---
title: channels.deleteUserHistory title: channels.deleteUserHistory
description: channels.deleteUserHistory parameters, return type and example description: Delete all messages of a user in a channel/supergroup
--- ---
## Method: channels.deleteUserHistory ## Method: channels.deleteUserHistory
[Back to methods index](index.md) [Back to methods index](index.md)
Delete all messages of a user in a channel/supergroup
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup|
|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user|
### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md)

View File

@ -1,17 +1,19 @@
--- ---
title: channels.editAbout title: channels.editAbout
description: channels.editAbout parameters, return type and example description: Edit the about text of a channel/supergroup
--- ---
## Method: channels.editAbout ## Method: channels.editAbout
[Back to methods index](index.md) [Back to methods index](index.md)
Edit the about text of a channel/supergroup
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel|
|about|[CLICK ME string](../types/string.md) | Yes| |about|[CLICK ME string](../types/string.md) | Yes|The new about text|
### Return type: [Bool](../types/Bool.md) ### Return type: [Bool](../types/Bool.md)

View File

@ -1,18 +1,20 @@
--- ---
title: channels.editAdmin title: channels.editAdmin
description: channels.editAdmin parameters, return type and example description: Edit admin permissions of a user in a channel/supergroup
--- ---
## Method: channels.editAdmin ## Method: channels.editAdmin
[Back to methods index](index.md) [Back to methods index](index.md)
Edit admin permissions of a user in a channel/supergroup
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel|
|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user|
|admin\_rights|[CLICK ME ChannelAdminRights](../types/ChannelAdminRights.md) | Yes| |admin\_rights|[CLICK ME ChannelAdminRights](../types/ChannelAdminRights.md) | Yes|The new admin rights|
### Return type: [Updates](../types/Updates.md) ### Return type: [Updates](../types/Updates.md)

View File

@ -1,18 +1,20 @@
--- ---
title: channels.editBanned title: channels.editBanned
description: channels.editBanned parameters, return type and example description: Kick or ban a user from a channel/supergroup
--- ---
## Method: channels.editBanned ## Method: channels.editBanned
[Back to methods index](index.md) [Back to methods index](index.md)
Kick or ban a user from a channel/supergroup
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup|
|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to kick/ban|
|banned\_rights|[CLICK ME ChannelBannedRights](../types/ChannelBannedRights.md) | Yes| |banned\_rights|[CLICK ME ChannelBannedRights](../types/ChannelBannedRights.md) | Yes|Banned/kicked permissions|
### Return type: [Updates](../types/Updates.md) ### Return type: [Updates](../types/Updates.md)

View File

@ -1,17 +1,19 @@
--- ---
title: channels.editPhoto title: channels.editPhoto
description: channels.editPhoto parameters, return type and example description: Edit the photo of a supergroup/channel
--- ---
## Method: channels.editPhoto ## Method: channels.editPhoto
[Back to methods index](index.md) [Back to methods index](index.md)
Edit the photo of a supergroup/channel
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel|
|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional| |photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo|
### Return type: [Updates](../types/Updates.md) ### Return type: [Updates](../types/Updates.md)

View File

@ -1,17 +1,19 @@
--- ---
title: channels.editTitle title: channels.editTitle
description: channels.editTitle parameters, return type and example description: Edit the title of a supergroup/channel
--- ---
## Method: channels.editTitle ## Method: channels.editTitle
[Back to methods index](index.md) [Back to methods index](index.md)
Edit the title of a supergroup/channel
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel|
|title|[CLICK ME string](../types/string.md) | Yes| |title|[CLICK ME string](../types/string.md) | Yes|The new channel/supergroup title|
### Return type: [Updates](../types/Updates.md) ### Return type: [Updates](../types/Updates.md)

View File

@ -1,16 +1,18 @@
--- ---
title: channels.exportInvite title: channels.exportInvite
description: channels.exportInvite parameters, return type and example description: Export the invite link of a channel
--- ---
## Method: channels.exportInvite ## Method: channels.exportInvite
[Back to methods index](index.md) [Back to methods index](index.md)
Export the invite link of a channel
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel|
### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md)

View File

@ -1,18 +1,20 @@
--- ---
title: channels.exportMessageLink title: channels.exportMessageLink
description: channels.exportMessageLink parameters, return type and example description: Get the link of a message in a channel
--- ---
## Method: channels.exportMessageLink ## Method: channels.exportMessageLink
[Back to methods index](index.md) [Back to methods index](index.md)
Get the link of a message in a channel
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup|
|id|[CLICK ME int](../types/int.md) | Yes| |id|[CLICK ME int](../types/int.md) | Yes|The ID of the message|
|grouped|[CLICK ME Bool](../types/Bool.md) | Yes| |grouped|[CLICK ME Bool](../types/Bool.md) | Yes|Is this an album?|
### Return type: [ExportedMessageLink](../types/ExportedMessageLink.md) ### Return type: [ExportedMessageLink](../types/ExportedMessageLink.md)

View File

@ -1,22 +1,24 @@
--- ---
title: channels.getAdminLog title: channels.getAdminLog
description: channels.getAdminLog parameters, return type and example description: Get admin log of a channel/supergruop
--- ---
## Method: channels.getAdminLog ## Method: channels.getAdminLog
[Back to methods index](index.md) [Back to methods index](index.md)
Get admin log of a channel/supergruop
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup|
|q|[CLICK ME string](../types/string.md) | Yes| |q|[CLICK ME string](../types/string.md) | Yes|Search query|
|events\_filter|[CLICK ME ChannelAdminLogEventsFilter](../types/ChannelAdminLogEventsFilter.md) | Optional| |events\_filter|[CLICK ME ChannelAdminLogEventsFilter](../types/ChannelAdminLogEventsFilter.md) | Optional|Event filter|
|admins|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| |admins|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|Fetch only actions from these admins|
|max\_id|[CLICK ME long](../types/long.md) | Yes| |max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum message ID to fetch|
|min\_id|[CLICK ME long](../types/long.md) | Yes| |min\_id|[CLICK ME long](../types/long.md) | Yes|Minimum message ID to fetch|
|limit|[CLICK ME int](../types/int.md) | Yes| |limit|[CLICK ME int](../types/int.md) | Yes|Number of results to fetch|
### Return type: [channels\_AdminLogResults](../types/channels_AdminLogResults.md) ### Return type: [channels\_AdminLogResults](../types/channels_AdminLogResults.md)

View File

@ -1,11 +1,13 @@
--- ---
title: channels.getAdminedPublicChannels title: channels.getAdminedPublicChannels
description: channels.getAdminedPublicChannels parameters, return type and example description: Get all supergroups/channels where you're admin
--- ---
## Method: channels.getAdminedPublicChannels ## Method: channels.getAdminedPublicChannels
[Back to methods index](index.md) [Back to methods index](index.md)
Get all supergroups/channels where you're admin
### Return type: [messages\_Chats](../types/messages_Chats.md) ### Return type: [messages\_Chats](../types/messages_Chats.md)

View File

@ -1,16 +1,18 @@
--- ---
title: channels.getChannels title: channels.getChannels
description: channels.getChannels parameters, return type and example description: Get info about multiple channels/supergroups
--- ---
## Method: channels.getChannels ## Method: channels.getChannels
[Back to methods index](index.md) [Back to methods index](index.md)
Get info about multiple channels/supergroups
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|id|Array of [Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Yes| |id|Array of [Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Yes|The channel/supergroup MTProto IDs|
### Return type: [messages\_Chats](../types/messages_Chats.md) ### Return type: [messages\_Chats](../types/messages_Chats.md)

View File

@ -1,17 +1,19 @@
--- ---
title: channels.getMessages title: channels.getMessages
description: channels.getMessages parameters, return type and example description: Get channel/supergroup messages
--- ---
## Method: channels.getMessages ## Method: channels.getMessages
[Back to methods index](index.md) [Back to methods index](index.md)
Get channel/supergroup messages
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup|
|id|Array of [Message ID or InputMessage](../types/InputMessage.md) | Yes| |id|Array of [Message ID or InputMessage](../types/InputMessage.md) | Yes|The message IDs|
### Return type: [messages\_Messages](../types/messages_Messages.md) ### Return type: [messages\_Messages](../types/messages_Messages.md)

View File

@ -1,17 +1,19 @@
--- ---
title: channels.getParticipant title: channels.getParticipant
description: channels.getParticipant parameters, return type and example description: Get info about a certain channel/supergroup participant
--- ---
## Method: channels.getParticipant ## Method: channels.getParticipant
[Back to methods index](index.md) [Back to methods index](index.md)
Get info about a certain channel/supergroup participant
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup|
|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to fetch info about|
### Return type: [channels\_ChannelParticipant](../types/channels_ChannelParticipant.md) ### Return type: [channels\_ChannelParticipant](../types/channels_ChannelParticipant.md)

View File

@ -1,20 +1,22 @@
--- ---
title: channels.getParticipants title: channels.getParticipants
description: channels.getParticipants parameters, return type and example description: Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead)
--- ---
## Method: channels.getParticipants ## Method: channels.getParticipants
[Back to methods index](index.md) [Back to methods index](index.md)
Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead)
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel|
|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes| |filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter|
|offset|[CLICK ME int](../types/int.md) | Yes| |offset|[CLICK ME int](../types/int.md) | Yes|Offset|
|limit|[CLICK ME int](../types/int.md) | Yes| |limit|[CLICK ME int](../types/int.md) | Yes|Limit|
|hash|[CLICK ME int](../types/int.md) | Yes| |hash|[CLICK ME int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(ids of previously fetched participant IDs)|
### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md)

View File

@ -1,17 +1,19 @@
--- ---
title: channels.inviteToChannel title: channels.inviteToChannel
description: channels.inviteToChannel parameters, return type and example description: Add users to channel/supergroup
--- ---
## Method: channels.inviteToChannel ## Method: channels.inviteToChannel
[Back to methods index](index.md) [Back to methods index](index.md)
Add users to channel/supergroup
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup|
|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes| |users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add|
### Return type: [Updates](../types/Updates.md) ### Return type: [Updates](../types/Updates.md)

View File

@ -1,16 +1,18 @@
--- ---
title: channels.joinChannel title: channels.joinChannel
description: channels.joinChannel parameters, return type and example description: Join a channel/supergroup
--- ---
## Method: channels.joinChannel ## Method: channels.joinChannel
[Back to methods index](index.md) [Back to methods index](index.md)
Join a channel/supergroup
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to join|
### Return type: [Updates](../types/Updates.md) ### Return type: [Updates](../types/Updates.md)

View File

@ -1,16 +1,18 @@
--- ---
title: channels.leaveChannel title: channels.leaveChannel
description: channels.leaveChannel parameters, return type and example description: Leave a channel/supergroup
--- ---
## Method: channels.leaveChannel ## Method: channels.leaveChannel
[Back to methods index](index.md) [Back to methods index](index.md)
Leave a channel/supergroup
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to leave|
### Return type: [Updates](../types/Updates.md) ### Return type: [Updates](../types/Updates.md)

View File

@ -1,17 +1,19 @@
--- ---
title: channels.readHistory title: channels.readHistory
description: channels.readHistory parameters, return type and example description: Mark channel/supergroup history as read
--- ---
## Method: channels.readHistory ## Method: channels.readHistory
[Back to methods index](index.md) [Back to methods index](index.md)
Mark channel/supergroup history as read
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup|
|max\_id|[CLICK ME int](../types/int.md) | Yes| |max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read|
### Return type: [Bool](../types/Bool.md) ### Return type: [Bool](../types/Bool.md)

View File

@ -1,17 +1,19 @@
--- ---
title: channels.readMessageContents title: channels.readMessageContents
description: channels.readMessageContents parameters, return type and example description: Mark channel/supergroup messages as read
--- ---
## Method: channels.readMessageContents ## Method: channels.readMessageContents
[Back to methods index](index.md) [Back to methods index](index.md)
Mark channel/supergroup messages as read
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel|
|id|Array of [CLICK ME int](../types/int.md) | Yes| |id|Array of [CLICK ME int](../types/int.md) | Yes|List of message IDs|
### Return type: [Bool](../types/Bool.md) ### Return type: [Bool](../types/Bool.md)

View File

@ -1,18 +1,20 @@
--- ---
title: channels.reportSpam title: channels.reportSpam
description: channels.reportSpam parameters, return type and example description: Report a supergroup/channel for spam
--- ---
## Method: channels.reportSpam ## Method: channels.reportSpam
[Back to methods index](index.md) [Back to methods index](index.md)
Report a supergroup/channel for spam
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel|
|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that added you to this channel|
|id|Array of [CLICK ME int](../types/int.md) | Yes| |id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to report|
### Return type: [Bool](../types/Bool.md) ### Return type: [Bool](../types/Bool.md)

View File

@ -1,17 +1,19 @@
--- ---
title: channels.setStickers title: channels.setStickers
description: channels.setStickers parameters, return type and example description: Set the supergroup/channel stickerpack
--- ---
## Method: channels.setStickers ## Method: channels.setStickers
[Back to methods index](index.md) [Back to methods index](index.md)
Set the supergroup/channel stickerpack
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergoup|
|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| |stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset|
### Return type: [Bool](../types/Bool.md) ### Return type: [Bool](../types/Bool.md)

View File

@ -1,17 +1,19 @@
--- ---
title: channels.toggleInvites title: channels.toggleInvites
description: channels.toggleInvites parameters, return type and example description: Allow or disallow any user to invite users to this channel/supergroup
--- ---
## Method: channels.toggleInvites ## Method: channels.toggleInvites
[Back to methods index](index.md) [Back to methods index](index.md)
Allow or disallow any user to invite users to this channel/supergroup
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup|
|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| |enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Allow or disallow|
### Return type: [Updates](../types/Updates.md) ### Return type: [Updates](../types/Updates.md)

View File

@ -1,17 +1,19 @@
--- ---
title: channels.togglePreHistoryHidden title: channels.togglePreHistoryHidden
description: channels.togglePreHistoryHidden parameters, return type and example description: Enable or disable hidden history for new channel/supergroup users
--- ---
## Method: channels.togglePreHistoryHidden ## Method: channels.togglePreHistoryHidden
[Back to methods index](index.md) [Back to methods index](index.md)
Enable or disable hidden history for new channel/supergroup users
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup|
|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| |enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable or disable hidden history for new channel/supergroup users|
### Return type: [Updates](../types/Updates.md) ### Return type: [Updates](../types/Updates.md)

View File

@ -1,17 +1,19 @@
--- ---
title: channels.toggleSignatures title: channels.toggleSignatures
description: channels.toggleSignatures parameters, return type and example description: Toggle channel signatures
--- ---
## Method: channels.toggleSignatures ## Method: channels.toggleSignatures
[Back to methods index](index.md) [Back to methods index](index.md)
Toggle channel signatures
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup|
|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| |enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable or disable channel signatures?|
### Return type: [Updates](../types/Updates.md) ### Return type: [Updates](../types/Updates.md)

View File

@ -1,18 +1,20 @@
--- ---
title: channels.updatePinnedMessage title: channels.updatePinnedMessage
description: channels.updatePinnedMessage parameters, return type and example description: Set the pinned message of a channel/supergroup
--- ---
## Method: channels.updatePinnedMessage ## Method: channels.updatePinnedMessage
[Back to methods index](index.md) [Back to methods index](index.md)
Set the pinned message of a channel/supergroup
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|silent|[CLICK ME Bool](../types/Bool.md) | Optional| |silent|[CLICK ME Bool](../types/Bool.md) | Optional|Pin silently|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup|
|id|[CLICK ME int](../types/int.md) | Yes| |id|[CLICK ME int](../types/int.md) | Yes|The ID of the message to pin|
### Return type: [Updates](../types/Updates.md) ### Return type: [Updates](../types/Updates.md)

View File

@ -1,17 +1,19 @@
--- ---
title: channels.updateUsername title: channels.updateUsername
description: channels.updateUsername parameters, return type and example description: Update the username of a supergroup/channel
--- ---
## Method: channels.updateUsername ## Method: channels.updateUsername
[Back to methods index](index.md) [Back to methods index](index.md)
Update the username of a supergroup/channel
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| |channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup|
|username|[CLICK ME string](../types/string.md) | Yes| |username|[CLICK ME string](../types/string.md) | Yes|The new username|
### Return type: [Bool](../types/Bool.md) ### Return type: [Bool](../types/Bool.md)

View File

@ -12,7 +12,7 @@ Get blocked users
| Name | Type | Required | Description | | Name | Type | Required | Description |
|----------|---------------|----------|-------------| |----------|---------------|----------|-------------|
|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| |offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, Then set to the number of blocked contacts previously fetched|
|limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| |limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch|

View File

@ -18,7 +18,7 @@ Get most used chats
|phone\_calls|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch phone calls?| |phone\_calls|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch phone calls?|
|groups|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch groups?| |groups|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch groups?|
|channels|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch channels and supergroups?| |channels|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch channels and supergroups?|
|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then `$offset += $contacts_TopPeers['categories']['count'];`| |offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, Then `$offset += $contacts_TopPeers['categories']['count'];`|
|limit|[CLICK ME int](../types/int.md) | Yes|How many results to fetch| |limit|[CLICK ME int](../types/int.md) | Yes|How many results to fetch|
|hash|[CLICK ME int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched peer ids);| |hash|[CLICK ME int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched peer ids);|

View File

@ -1,16 +1,18 @@
--- ---
title: help.getAppChangelog title: help.getAppChangelog
description: help.getAppChangelog parameters, return type and example description: Get the changelog of this app
--- ---
## Method: help.getAppChangelog ## Method: help.getAppChangelog
[Back to methods index](index.md) [Back to methods index](index.md)
Get the changelog of this app
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|prev\_app\_version|[CLICK ME string](../types/string.md) | Yes| |prev\_app\_version|[CLICK ME string](../types/string.md) | Yes|Previous app version|
### Return type: [Updates](../types/Updates.md) ### Return type: [Updates](../types/Updates.md)

View File

@ -1,11 +1,13 @@
--- ---
title: help.getAppUpdate title: help.getAppUpdate
description: help.getAppUpdate parameters, return type and example description: Get info about app updates
--- ---
## Method: help.getAppUpdate ## Method: help.getAppUpdate
[Back to methods index](index.md) [Back to methods index](index.md)
Get info about app updates
### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md)

View File

@ -1,11 +1,13 @@
--- ---
title: help.getCdnConfig title: help.getCdnConfig
description: help.getCdnConfig parameters, return type and example description: Get CDN configuration
--- ---
## Method: help.getCdnConfig ## Method: help.getCdnConfig
[Back to methods index](index.md) [Back to methods index](index.md)
Get CDN configuration
### Return type: [CdnConfig](../types/CdnConfig.md) ### Return type: [CdnConfig](../types/CdnConfig.md)

View File

@ -1,11 +1,13 @@
--- ---
title: help.getConfig title: help.getConfig
description: help.getConfig parameters, return type and example description: Get server configuration
--- ---
## Method: help.getConfig ## Method: help.getConfig
[Back to methods index](index.md) [Back to methods index](index.md)
Get server configuration
### Return type: [Config](../types/Config.md) ### Return type: [Config](../types/Config.md)

View File

@ -1,11 +1,13 @@
--- ---
title: help.getInviteText title: help.getInviteText
description: help.getInviteText parameters, return type and example description: Get invitation text
--- ---
## Method: help.getInviteText ## Method: help.getInviteText
[Back to methods index](index.md) [Back to methods index](index.md)
Get invitation text
### Return type: [help\_InviteText](../types/help_InviteText.md) ### Return type: [help\_InviteText](../types/help_InviteText.md)

View File

@ -1,11 +1,13 @@
--- ---
title: help.getNearestDc title: help.getNearestDc
description: help.getNearestDc parameters, return type and example description: Get nearest datacenter
--- ---
## Method: help.getNearestDc ## Method: help.getNearestDc
[Back to methods index](index.md) [Back to methods index](index.md)
Get nearest datacenter
### Return type: [NearestDc](../types/NearestDc.md) ### Return type: [NearestDc](../types/NearestDc.md)

View File

@ -1,16 +1,18 @@
--- ---
title: help.getRecentMeUrls title: help.getRecentMeUrls
description: help.getRecentMeUrls parameters, return type and example description: Get recent t.me URLs
--- ---
## Method: help.getRecentMeUrls ## Method: help.getRecentMeUrls
[Back to methods index](index.md) [Back to methods index](index.md)
Get recent t.me URLs
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|referer|[CLICK ME string](../types/string.md) | Yes| |referer|[CLICK ME string](../types/string.md) | Yes|Referrer|
### Return type: [help\_RecentMeUrls](../types/help_RecentMeUrls.md) ### Return type: [help\_RecentMeUrls](../types/help_RecentMeUrls.md)

View File

@ -1,11 +1,13 @@
--- ---
title: help.getSupport title: help.getSupport
description: help.getSupport parameters, return type and example description: Get info of support user
--- ---
## Method: help.getSupport ## Method: help.getSupport
[Back to methods index](index.md) [Back to methods index](index.md)
Get info of support user
### Return type: [help\_Support](../types/help_Support.md) ### Return type: [help\_Support](../types/help_Support.md)

View File

@ -1,11 +1,13 @@
--- ---
title: help.getTermsOfService title: help.getTermsOfService
description: help.getTermsOfService parameters, return type and example description: Get terms of service
--- ---
## Method: help.getTermsOfService ## Method: help.getTermsOfService
[Back to methods index](index.md) [Back to methods index](index.md)
Get terms of service
### Return type: [help\_TermsOfService](../types/help_TermsOfService.md) ### Return type: [help\_TermsOfService](../types/help_TermsOfService.md)

View File

@ -1,16 +1,18 @@
--- ---
title: help.saveAppLog title: help.saveAppLog
description: help.saveAppLog parameters, return type and example description: Log data for developer of this app
--- ---
## Method: help.saveAppLog ## Method: help.saveAppLog
[Back to methods index](index.md) [Back to methods index](index.md)
Log data for developer of this app
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes| |events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list|
### Return type: [Bool](../types/Bool.md) ### Return type: [Bool](../types/Bool.md)

View File

@ -1,17 +1,19 @@
--- ---
title: help.setBotUpdatesStatus title: help.setBotUpdatesStatus
description: help.setBotUpdatesStatus parameters, return type and example description: Set the update status of webhook
--- ---
## Method: help.setBotUpdatesStatus ## Method: help.setBotUpdatesStatus
[Back to methods index](index.md) [Back to methods index](index.md)
Set the update status of webhook
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|pending\_updates\_count|[CLICK ME int](../types/int.md) | Yes| |pending\_updates\_count|[CLICK ME int](../types/int.md) | Yes|Pending update count|
|message|[CLICK ME string](../types/string.md) | Yes| |message|[CLICK ME string](../types/string.md) | Yes|Message|
### Return type: [Bool](../types/Bool.md) ### Return type: [Bool](../types/Bool.md)

View File

@ -1,16 +1,18 @@
--- ---
title: messages.checkChatInvite title: messages.checkChatInvite
description: messages.checkChatInvite parameters, return type and example description: Check if an invitation link is valid
--- ---
## Method: messages.checkChatInvite ## Method: messages.checkChatInvite
[Back to methods index](index.md) [Back to methods index](index.md)
Check if an invitation link is valid
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|hash|[CLICK ME string](../types/string.md) | Yes| |hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format|
### Return type: [ChatInvite](../types/ChatInvite.md) ### Return type: [ChatInvite](../types/ChatInvite.md)

View File

@ -1,16 +1,18 @@
--- ---
title: messages.clearRecentStickers title: messages.clearRecentStickers
description: messages.clearRecentStickers parameters, return type and example description: Clear all recent stickers
--- ---
## Method: messages.clearRecentStickers ## Method: messages.clearRecentStickers
[Back to methods index](index.md) [Back to methods index](index.md)
Clear all recent stickers
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|attached|[CLICK ME Bool](../types/Bool.md) | Optional| |attached|[CLICK ME Bool](../types/Bool.md) | Optional|Clear recent stickers attached to images?|
### Return type: [Bool](../types/Bool.md) ### Return type: [Bool](../types/Bool.md)

View File

@ -12,7 +12,7 @@ Delete a user from a chat (not supergroup)
| Name | Type | Required | Description | | Name | Type | Required | Description |
|----------|---------------|----------|-------------| |----------|---------------|----------|-------------|
|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat|
|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)|

View File

@ -1,18 +1,20 @@
--- ---
title: messages.editChatAdmin title: messages.editChatAdmin
description: messages.editChatAdmin parameters, return type and example description: Edit admin permissions
--- ---
## Method: messages.editChatAdmin ## Method: messages.editChatAdmin
[Back to methods index](index.md) [Back to methods index](index.md)
Edit admin permissions
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)|
|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID|
|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes| |is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes|Should the user be admin?|
### Return type: [Bool](../types/Bool.md) ### Return type: [Bool](../types/Bool.md)

View File

@ -12,7 +12,7 @@ Edit the photo of a normal chat (not supergroup)
| Name | Type | Required | Description | | Name | Type | Required | Description |
|----------|---------------|----------|-------------| |----------|---------------|----------|-------------|
|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat|
|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| |photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto|

View File

@ -12,7 +12,7 @@ Edit the title of a normal chat (not supergroup)
| Name | Type | Required | Description | | Name | Type | Required | Description |
|----------|---------------|----------|-------------| |----------|---------------|----------|-------------|
|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat|
|title|[CLICK ME string](../types/string.md) | Yes|The new title| |title|[CLICK ME string](../types/string.md) | Yes|The new title|

View File

@ -1,23 +1,25 @@
--- ---
title: messages.editInlineBotMessage title: messages.editInlineBotMessage
description: messages.editInlineBotMessage parameters, return type and example description: Edit a sent inline message
--- ---
## Method: messages.editInlineBotMessage ## Method: messages.editInlineBotMessage
[Back to methods index](index.md) [Back to methods index](index.md)
Edit a sent inline message
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional| |no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview|
|stop\_geo\_live|[CLICK ME Bool](../types/Bool.md) | Optional| |stop\_geo\_live|[CLICK ME Bool](../types/Bool.md) | Optional|Stop live location|
|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes| |id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID|
|message|[CLICK ME string](../types/string.md) | Optional| |message|[CLICK ME string](../types/string.md) | Optional|The new message|
|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional| |reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard|
|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional| |entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)|
|parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message|
|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional| |geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|The new location|
### Return type: [Bool](../types/Bool.md) ### Return type: [Bool](../types/Bool.md)

View File

@ -1,24 +1,26 @@
--- ---
title: messages.editMessage title: messages.editMessage
description: messages.editMessage parameters, return type and example description: Edit a message
--- ---
## Method: messages.editMessage ## Method: messages.editMessage
[Back to methods index](index.md) [Back to methods index](index.md)
Edit a message
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional| |no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview|
|stop\_geo\_live|[CLICK ME Bool](../types/Bool.md) | Optional| |stop\_geo\_live|[CLICK ME Bool](../types/Bool.md) | Optional|Stop live location|
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat|
|id|[CLICK ME int](../types/int.md) | Yes| |id|[CLICK ME int](../types/int.md) | Yes|The message ID|
|message|[CLICK ME string](../types/string.md) | Optional| |message|[CLICK ME string](../types/string.md) | Optional|The new message|
|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional| |reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard|
|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional| |entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)|
|parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message|
|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional| |geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|The new location|
### Return type: [Updates](../types/Updates.md) ### Return type: [Updates](../types/Updates.md)

View File

@ -1,16 +1,18 @@
--- ---
title: messages.exportChatInvite title: messages.exportChatInvite
description: messages.exportChatInvite parameters, return type and example description: Export chat invite
--- ---
## Method: messages.exportChatInvite ## Method: messages.exportChatInvite
[Back to methods index](index.md) [Back to methods index](index.md)
Export chat invite
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat id |
### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md)

View File

@ -1,17 +1,19 @@
--- ---
title: messages.faveSticker title: messages.faveSticker
description: messages.faveSticker parameters, return type and example description: Add a sticker to favorites
--- ---
## Method: messages.faveSticker ## Method: messages.faveSticker
[Back to methods index](index.md) [Back to methods index](index.md)
Add a sticker to favorites
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional| |id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker to add to favorites|
|unfave|[CLICK ME Bool](../types/Bool.md) | Yes| |unfave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove it from favorites?|
### Return type: [Bool](../types/Bool.md) ### Return type: [Bool](../types/Bool.md)

View File

@ -1,16 +1,18 @@
--- ---
title: messages.getAllChats title: messages.getAllChats
description: messages.getAllChats parameters, return type and example description: Get all chats (not supergroups or channels)
--- ---
## Method: messages.getAllChats ## Method: messages.getAllChats
[Back to methods index](index.md) [Back to methods index](index.md)
Get all chats (not supergroups or channels)
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|except\_ids|Array of [CLICK ME int](../types/int.md) | Yes| |except\_ids|Array of [CLICK ME int](../types/int.md) | Yes|Do not fetch these chats (MTProto id)|
### Return type: [messages\_Chats](../types/messages_Chats.md) ### Return type: [messages\_Chats](../types/messages_Chats.md)

View File

@ -1,11 +1,13 @@
--- ---
title: messages.getAllDrafts title: messages.getAllDrafts
description: messages.getAllDrafts parameters, return type and example description: Get all message drafts
--- ---
## Method: messages.getAllDrafts ## Method: messages.getAllDrafts
[Back to methods index](index.md) [Back to methods index](index.md)
Get all message drafts
### Return type: [Updates](../types/Updates.md) ### Return type: [Updates](../types/Updates.md)

View File

@ -1,16 +1,18 @@
--- ---
title: messages.getAllStickers title: messages.getAllStickers
description: messages.getAllStickers parameters, return type and example description: Get all stickerpacks
--- ---
## Method: messages.getAllStickers ## Method: messages.getAllStickers
[Back to methods index](index.md) [Back to methods index](index.md)
Get all stickerpacks
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|hash|[CLICK ME int](../types/int.md) | Yes| |hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']|
### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md)

View File

@ -1,18 +1,20 @@
--- ---
title: messages.getArchivedStickers title: messages.getArchivedStickers
description: messages.getArchivedStickers parameters, return type and example description: Get all archived stickers
--- ---
## Method: messages.getArchivedStickers ## Method: messages.getArchivedStickers
[Back to methods index](index.md) [Back to methods index](index.md)
Get all archived stickers
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|masks|[CLICK ME Bool](../types/Bool.md) | Optional| |masks|[CLICK ME Bool](../types/Bool.md) | Optional|Get masks?|
|offset\_id|[CLICK ME long](../types/long.md) | Yes| |offset\_id|[CLICK ME long](../types/long.md) | Yes|Sticker ID offset|
|limit|[CLICK ME int](../types/int.md) | Yes| |limit|[CLICK ME int](../types/int.md) | Yes|Number of stickers to fetch|
### Return type: [messages\_ArchivedStickers](../types/messages_ArchivedStickers.md) ### Return type: [messages\_ArchivedStickers](../types/messages_ArchivedStickers.md)

View File

@ -1,16 +1,18 @@
--- ---
title: messages.getAttachedStickers title: messages.getAttachedStickers
description: messages.getAttachedStickers parameters, return type and example description: Get stickers attachable to images
--- ---
## Method: messages.getAttachedStickers ## Method: messages.getAttachedStickers
[Back to methods index](index.md) [Back to methods index](index.md)
Get stickers attachable to images
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|media|[CLICK ME InputStickeredMedia](../types/InputStickeredMedia.md) | Yes| |media|[CLICK ME InputStickeredMedia](../types/InputStickeredMedia.md) | Yes|The stickered media|
### Return type: [Vector\_of\_StickerSetCovered](../types/StickerSetCovered.md) ### Return type: [Vector\_of\_StickerSetCovered](../types/StickerSetCovered.md)

View File

@ -1,19 +1,21 @@
--- ---
title: messages.getBotCallbackAnswer title: messages.getBotCallbackAnswer
description: messages.getBotCallbackAnswer parameters, return type and example description: Get the callback answer of a bot (after clicking a button)
--- ---
## Method: messages.getBotCallbackAnswer ## Method: messages.getBotCallbackAnswer
[Back to methods index](index.md) [Back to methods index](index.md)
Get the callback answer of a bot (after clicking a button)
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|game|[CLICK ME Bool](../types/Bool.md) | Optional| |game|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a game?|
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat|
|msg\_id|[CLICK ME int](../types/int.md) | Yes| |msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID|
|data|[CLICK ME bytes](../types/bytes.md) | Optional| |data|[CLICK ME bytes](../types/bytes.md) | Optional|The data to send to the bot|
### Return type: [messages\_BotCallbackAnswer](../types/messages_BotCallbackAnswer.md) ### Return type: [messages\_BotCallbackAnswer](../types/messages_BotCallbackAnswer.md)

View File

@ -1,18 +1,20 @@
--- ---
title: messages.getCommonChats title: messages.getCommonChats
description: messages.getCommonChats parameters, return type and example description: Get chats in common with a user
--- ---
## Method: messages.getCommonChats ## Method: messages.getCommonChats
[Back to methods index](index.md) [Back to methods index](index.md)
Get chats in common with a user
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user|
|max\_id|[CLICK ME int](../types/int.md) | Yes| |max\_id|[CLICK ME int](../types/int.md) | Yes|The maximum chat ID to fetch|
|limit|[CLICK ME int](../types/int.md) | Yes| |limit|[CLICK ME int](../types/int.md) | Yes|Number of results to fetch|
### Return type: [messages\_Chats](../types/messages_Chats.md) ### Return type: [messages\_Chats](../types/messages_Chats.md)

View File

@ -1,18 +1,20 @@
--- ---
title: messages.getDocumentByHash title: messages.getDocumentByHash
description: messages.getDocumentByHash parameters, return type and example description: Get document by SHA256 hash
--- ---
## Method: messages.getDocumentByHash ## Method: messages.getDocumentByHash
[Back to methods index](index.md) [Back to methods index](index.md)
Get document by SHA256 hash
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|sha256|[CLICK ME bytes](../types/bytes.md) | Yes| |sha256|[CLICK ME bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`|
|size|[CLICK ME int](../types/int.md) | Yes| |size|[CLICK ME int](../types/int.md) | Yes|The file size|
|mime\_type|[CLICK ME string](../types/string.md) | Yes| |mime\_type|[CLICK ME string](../types/string.md) | Yes|The mime type of the file|
### Return type: [Document](../types/Document.md) ### Return type: [Document](../types/Document.md)

View File

@ -1,16 +1,18 @@
--- ---
title: messages.getFavedStickers title: messages.getFavedStickers
description: messages.getFavedStickers parameters, return type and example description: Get favorite stickers
--- ---
## Method: messages.getFavedStickers ## Method: messages.getFavedStickers
[Back to methods index](index.md) [Back to methods index](index.md)
Get favorite stickers
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|hash|[CLICK ME int](../types/int.md) | Yes| |hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']|
### Return type: [messages\_FavedStickers](../types/messages_FavedStickers.md) ### Return type: [messages\_FavedStickers](../types/messages_FavedStickers.md)

View File

@ -1,16 +1,18 @@
--- ---
title: messages.getFeaturedStickers title: messages.getFeaturedStickers
description: messages.getFeaturedStickers parameters, return type and example description: Get featured stickers
--- ---
## Method: messages.getFeaturedStickers ## Method: messages.getFeaturedStickers
[Back to methods index](index.md) [Back to methods index](index.md)
Get featured stickers
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|hash|[CLICK ME int](../types/int.md) | Yes| |hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']|
### Return type: [messages\_FeaturedStickers](../types/messages_FeaturedStickers.md) ### Return type: [messages\_FeaturedStickers](../types/messages_FeaturedStickers.md)

View File

@ -1,18 +1,20 @@
--- ---
title: messages.getGameHighScores title: messages.getGameHighScores
description: messages.getGameHighScores parameters, return type and example description: Get high scores of a game
--- ---
## Method: messages.getGameHighScores ## Method: messages.getGameHighScores
[Back to methods index](index.md) [Back to methods index](index.md)
Get high scores of a game
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat|
|id|[CLICK ME int](../types/int.md) | Yes| |id|[CLICK ME int](../types/int.md) | Yes|The message ID|
|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores|
### Return type: [messages\_HighScores](../types/messages_HighScores.md) ### Return type: [messages\_HighScores](../types/messages_HighScores.md)

View File

@ -1,20 +1,22 @@
--- ---
title: messages.getInlineBotResults title: messages.getInlineBotResults
description: messages.getInlineBotResults parameters, return type and example description: Call inline bot
--- ---
## Method: messages.getInlineBotResults ## Method: messages.getInlineBotResults
[Back to methods index](index.md) [Back to methods index](index.md)
Call inline bot
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| |bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call|
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to call the bot|
|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional| |geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location|
|query|[CLICK ME string](../types/string.md) | Yes| |query|[CLICK ME string](../types/string.md) | Yes|The query to send to the bot|
|offset|[CLICK ME string](../types/string.md) | Yes| |offset|[CLICK ME string](../types/string.md) | Yes|The offset to send to the bot|
### Return type: [messages\_BotResults](../types/messages_BotResults.md) ### Return type: [messages\_BotResults](../types/messages_BotResults.md)

View File

@ -1,17 +1,19 @@
--- ---
title: messages.getInlineGameHighScores title: messages.getInlineGameHighScores
description: messages.getInlineGameHighScores parameters, return type and example description: Get high scores of a game sent in an inline message
--- ---
## Method: messages.getInlineGameHighScores ## Method: messages.getInlineGameHighScores
[Back to methods index](index.md) [Back to methods index](index.md)
Get high scores of a game sent in an inline message
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes| |id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The inline message|
|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores|
### Return type: [messages\_HighScores](../types/messages_HighScores.md) ### Return type: [messages\_HighScores](../types/messages_HighScores.md)

View File

@ -1,16 +1,18 @@
--- ---
title: messages.getMaskStickers title: messages.getMaskStickers
description: messages.getMaskStickers parameters, return type and example description: Get masks
--- ---
## Method: messages.getMaskStickers ## Method: messages.getMaskStickers
[Back to methods index](index.md) [Back to methods index](index.md)
Get masks
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|hash|[CLICK ME int](../types/int.md) | Yes| |hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']|
### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md)

View File

@ -1,17 +1,19 @@
--- ---
title: messages.getMessageEditData title: messages.getMessageEditData
description: messages.getMessageEditData parameters, return type and example description: Check if about to edit a message or a media caption
--- ---
## Method: messages.getMessageEditData ## Method: messages.getMessageEditData
[Back to methods index](index.md) [Back to methods index](index.md)
Check if about to edit a message or a media caption
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat|
|id|[CLICK ME int](../types/int.md) | Yes| |id|[CLICK ME int](../types/int.md) | Yes|The message ID|
### Return type: [messages\_MessageEditData](../types/messages_MessageEditData.md) ### Return type: [messages\_MessageEditData](../types/messages_MessageEditData.md)

View File

@ -1,18 +1,20 @@
--- ---
title: messages.getMessagesViews title: messages.getMessagesViews
description: messages.getMessagesViews parameters, return type and example description: Get and increase message views
--- ---
## Method: messages.getMessagesViews ## Method: messages.getMessagesViews
[Back to methods index](index.md) [Back to methods index](index.md)
Get and increase message views
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located|
|id|Array of [CLICK ME int](../types/int.md) | Yes| |id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs messages to get|
|increment|[CLICK ME Bool](../types/Bool.md) | Yes| |increment|[CLICK ME Bool](../types/Bool.md) | Yes|Increase message views?|
### Return type: [Vector\_of\_int](../types/int.md) ### Return type: [Vector\_of\_int](../types/int.md)

View File

@ -1,16 +1,18 @@
--- ---
title: messages.getPeerDialogs title: messages.getPeerDialogs
description: messages.getPeerDialogs parameters, return type and example description: Get dialog info of peers
--- ---
## Method: messages.getPeerDialogs ## Method: messages.getPeerDialogs
[Back to methods index](index.md) [Back to methods index](index.md)
Get dialog info of peers
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes| |peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|The peers|
### Return type: [messages\_PeerDialogs](../types/messages_PeerDialogs.md) ### Return type: [messages\_PeerDialogs](../types/messages_PeerDialogs.md)

View File

@ -1,11 +1,13 @@
--- ---
title: messages.getPinnedDialogs title: messages.getPinnedDialogs
description: messages.getPinnedDialogs parameters, return type and example description: Get pinned dialogs
--- ---
## Method: messages.getPinnedDialogs ## Method: messages.getPinnedDialogs
[Back to methods index](index.md) [Back to methods index](index.md)
Get pinned dialogs
### Return type: [messages\_PeerDialogs](../types/messages_PeerDialogs.md) ### Return type: [messages\_PeerDialogs](../types/messages_PeerDialogs.md)

View File

@ -1,17 +1,19 @@
--- ---
title: messages.getRecentLocations title: messages.getRecentLocations
description: messages.getRecentLocations parameters, return type and example description: Get recent locations
--- ---
## Method: messages.getRecentLocations ## Method: messages.getRecentLocations
[Back to methods index](index.md) [Back to methods index](index.md)
Get recent locations
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to search locations|
|limit|[CLICK ME int](../types/int.md) | Yes| |limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return|
### Return type: [messages\_Messages](../types/messages_Messages.md) ### Return type: [messages\_Messages](../types/messages_Messages.md)

View File

@ -1,17 +1,19 @@
--- ---
title: messages.getRecentStickers title: messages.getRecentStickers
description: messages.getRecentStickers parameters, return type and example description: Get recent stickers
--- ---
## Method: messages.getRecentStickers ## Method: messages.getRecentStickers
[Back to methods index](index.md) [Back to methods index](index.md)
Get recent stickers
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|attached|[CLICK ME Bool](../types/Bool.md) | Optional| |attached|[CLICK ME Bool](../types/Bool.md) | Optional|Get stickers attached to image?|
|hash|[CLICK ME int](../types/int.md) | Yes| |hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']|
### Return type: [messages\_RecentStickers](../types/messages_RecentStickers.md) ### Return type: [messages\_RecentStickers](../types/messages_RecentStickers.md)

View File

@ -1,16 +1,18 @@
--- ---
title: messages.getSavedGifs title: messages.getSavedGifs
description: messages.getSavedGifs parameters, return type and example description: Get saved gifs
--- ---
## Method: messages.getSavedGifs ## Method: messages.getSavedGifs
[Back to methods index](index.md) [Back to methods index](index.md)
Get saved gifs
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|hash|[CLICK ME int](../types/int.md) | Yes| |hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']|
### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md)

View File

@ -1,16 +1,18 @@
--- ---
title: messages.getStickerSet title: messages.getStickerSet
description: messages.getStickerSet parameters, return type and example description: Get a stickerset
--- ---
## Method: messages.getStickerSet ## Method: messages.getStickerSet
[Back to methods index](index.md) [Back to methods index](index.md)
Get a stickerset
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| |stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get|
### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md)

View File

@ -1,17 +1,19 @@
--- ---
title: messages.getStickers title: messages.getStickers
description: messages.getStickers parameters, return type and example description: Get stickers
--- ---
## Method: messages.getStickers ## Method: messages.getStickers
[Back to methods index](index.md) [Back to methods index](index.md)
Get stickers
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|emoticon|[CLICK ME string](../types/string.md) | Yes| |emoticon|[CLICK ME string](../types/string.md) | Yes|Search by emoji|
|hash|[CLICK ME string](../types/string.md) | Yes| |hash|[CLICK ME string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)|
### Return type: [messages\_Stickers](../types/messages_Stickers.md) ### Return type: [messages\_Stickers](../types/messages_Stickers.md)

View File

@ -1,21 +1,23 @@
--- ---
title: messages.getUnreadMentions title: messages.getUnreadMentions
description: messages.getUnreadMentions parameters, return type and example description: Get unread mentions
--- ---
## Method: messages.getUnreadMentions ## Method: messages.getUnreadMentions
[Back to methods index](index.md) [Back to methods index](index.md)
Get unread mentions
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to get unread mentions|
|offset\_id|[CLICK ME int](../types/int.md) | Yes| |offset\_id|[CLICK ME int](../types/int.md) | Yes|The offset|
|add\_offset|[CLICK ME int](../types/int.md) | Yes| |add\_offset|[CLICK ME int](../types/int.md) | Yes|The additional offset|
|limit|[CLICK ME int](../types/int.md) | Yes| |limit|[CLICK ME int](../types/int.md) | Yes|The number of results to fetch|
|max\_id|[CLICK ME int](../types/int.md) | Yes| |max\_id|[CLICK ME int](../types/int.md) | Yes|The maximum message ID to fetch|
|min\_id|[CLICK ME int](../types/int.md) | Yes| |min\_id|[CLICK ME int](../types/int.md) | Yes|The minumum message ID to fetch|
### Return type: [messages\_Messages](../types/messages_Messages.md) ### Return type: [messages\_Messages](../types/messages_Messages.md)

View File

@ -1,17 +1,19 @@
--- ---
title: messages.getWebPage title: messages.getWebPage
description: messages.getWebPage parameters, return type and example description: Get webpage preview
--- ---
## Method: messages.getWebPage ## Method: messages.getWebPage
[Back to methods index](index.md) [Back to methods index](index.md)
Get webpage preview
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|url|[CLICK ME string](../types/string.md) | Yes| |url|[CLICK ME string](../types/string.md) | Yes|URL|
|hash|[CLICK ME int](../types/int.md) | Yes| |hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']|
### Return type: [WebPage](../types/WebPage.md) ### Return type: [WebPage](../types/WebPage.md)

View File

@ -1,17 +1,19 @@
--- ---
title: messages.getWebPagePreview title: messages.getWebPagePreview
description: messages.getWebPagePreview parameters, return type and example description: Get webpage preview
--- ---
## Method: messages.getWebPagePreview ## Method: messages.getWebPagePreview
[Back to methods index](index.md) [Back to methods index](index.md)
Get webpage preview
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|message|[CLICK ME string](../types/string.md) | Yes| |message|[CLICK ME string](../types/string.md) | Yes|Extract preview from this message|
|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional| |entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|Entities for styled text|
|parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message|

View File

@ -1,16 +1,18 @@
--- ---
title: messages.importChatInvite title: messages.importChatInvite
description: messages.importChatInvite parameters, return type and example description: Import chat invite
--- ---
## Method: messages.importChatInvite ## Method: messages.importChatInvite
[Back to methods index](index.md) [Back to methods index](index.md)
Import chat invite
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|hash|[CLICK ME string](../types/string.md) | Yes| |hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format|
### Return type: [Updates](../types/Updates.md) ### Return type: [Updates](../types/Updates.md)

View File

@ -1,17 +1,19 @@
--- ---
title: messages.installStickerSet title: messages.installStickerSet
description: messages.installStickerSet parameters, return type and example description: Add a sticker set
--- ---
## Method: messages.installStickerSet ## Method: messages.installStickerSet
[Back to methods index](index.md) [Back to methods index](index.md)
Add a sticker set
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| |stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add|
|archived|[CLICK ME Bool](../types/Bool.md) | Yes| |archived|[CLICK ME Bool](../types/Bool.md) | Yes|Archive this set?|
### Return type: [messages\_StickerSetInstallResult](../types/messages_StickerSetInstallResult.md) ### Return type: [messages\_StickerSetInstallResult](../types/messages_StickerSetInstallResult.md)

View File

@ -1,16 +1,18 @@
--- ---
title: messages.migrateChat title: messages.migrateChat
description: messages.migrateChat parameters, return type and example description: Convert chat to supergroup
--- ---
## Method: messages.migrateChat ## Method: messages.migrateChat
[Back to methods index](index.md) [Back to methods index](index.md)
Convert chat to supergroup
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| |chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat to convert|
### Return type: [Updates](../types/Updates.md) ### Return type: [Updates](../types/Updates.md)

View File

@ -1,17 +1,19 @@
--- ---
title: messages.readEncryptedHistory title: messages.readEncryptedHistory
description: messages.readEncryptedHistory parameters, return type and example description: Mark messages as read in secret chats
--- ---
## Method: messages.readEncryptedHistory ## Method: messages.readEncryptedHistory
[Back to methods index](index.md) [Back to methods index](index.md)
Mark messages as read in secret chats
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read|
|max\_date|[CLICK ME int](../types/int.md) | Yes| |max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark|
### Return type: [Bool](../types/Bool.md) ### Return type: [Bool](../types/Bool.md)

View File

@ -1,16 +1,18 @@
--- ---
title: messages.readFeaturedStickers title: messages.readFeaturedStickers
description: messages.readFeaturedStickers parameters, return type and example description: Mark new featured stickers as read
--- ---
## Method: messages.readFeaturedStickers ## Method: messages.readFeaturedStickers
[Back to methods index](index.md) [Back to methods index](index.md)
Mark new featured stickers as read
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|id|Array of [CLICK ME long](../types/long.md) | Yes| |id|Array of [CLICK ME long](../types/long.md) | Yes|The stickers to mark as read|
### Return type: [Bool](../types/Bool.md) ### Return type: [Bool](../types/Bool.md)

View File

@ -1,16 +1,18 @@
--- ---
title: messages.readMentions title: messages.readMentions
description: messages.readMentions parameters, return type and example description: Mark mentions as read
--- ---
## Method: messages.readMentions ## Method: messages.readMentions
[Back to methods index](index.md) [Back to methods index](index.md)
Mark mentions as read
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat|
### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md)

View File

@ -1,16 +1,18 @@
--- ---
title: messages.readMessageContents title: messages.readMessageContents
description: messages.readMessageContents parameters, return type and example description: Mark message as read
--- ---
## Method: messages.readMessageContents ## Method: messages.readMessageContents
[Back to methods index](index.md) [Back to methods index](index.md)
Mark message as read
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|id|Array of [CLICK ME int](../types/int.md) | Yes| |id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)|
### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md)

View File

@ -1,77 +1,13 @@
--- ---
title: messages.receivedQueue title: messages.receivedQueue
description: messages.receivedQueue parameters, return type and example description: You cannot use this method directly
--- ---
## Method: messages.receivedQueue ## Method: messages.receivedQueue
[Back to methods index](index.md) [Back to methods index](index.md)
### Parameters: **You cannot use this method directly**
| Name | Type | Required |
|----------|---------------|----------|
|max\_qts|[CLICK ME int](../types/int.md) | Yes|
### Return type: [Vector\_of\_long](../types/long.md)
### Can bots use this method: **YES**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|MSG_WAIT_FAILED|A waiting call returned an error|
### MadelineProto Example:
```
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
}
include 'madeline.php';
// !!! This API id/API hash combination will not work !!!
// !!! You must get your own @ my.telegram.org !!!
$api_id = 0;
$api_hash = '';
$MadelineProto = new \danog\MadelineProto\API('session.madeline', ['app_info' => ['api_id' => $api_id, 'api_hash' => $api_hash]]);
$MadelineProto->start();
$Vector_of_long = $MadelineProto->messages->receivedQueue(['max_qts' => int, ]);
```
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
### As a bot:
POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline`
Parameters:
* method - messages.receivedQueue
* params - `{"max_qts": int, }`
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.receivedQueue`
Parameters:
max_qts - Json encoded int
Or, if you're into Lua:
```
Vector_of_long = messages.receivedQueue({max_qts=int, })
```

View File

@ -1,17 +1,19 @@
--- ---
title: messages.reorderPinnedDialogs title: messages.reorderPinnedDialogs
description: messages.reorderPinnedDialogs parameters, return type and example description: Reorder pinned dialogs
--- ---
## Method: messages.reorderPinnedDialogs ## Method: messages.reorderPinnedDialogs
[Back to methods index](index.md) [Back to methods index](index.md)
Reorder pinned dialogs
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|force|[CLICK ME Bool](../types/Bool.md) | Optional| |force|[CLICK ME Bool](../types/Bool.md) | Optional|Force reordering|
|order|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes| |order|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|New order|
### Return type: [Bool](../types/Bool.md) ### Return type: [Bool](../types/Bool.md)

View File

@ -1,17 +1,19 @@
--- ---
title: messages.reorderStickerSets title: messages.reorderStickerSets
description: messages.reorderStickerSets parameters, return type and example description: Reorder sticker sets
--- ---
## Method: messages.reorderStickerSets ## Method: messages.reorderStickerSets
[Back to methods index](index.md) [Back to methods index](index.md)
Reorder sticker sets
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|masks|[CLICK ME Bool](../types/Bool.md) | Optional| |masks|[CLICK ME Bool](../types/Bool.md) | Optional|Reorder masks?|
|order|Array of [CLICK ME long](../types/long.md) | Yes| |order|Array of [CLICK ME long](../types/long.md) | Yes|The order|
### Return type: [Bool](../types/Bool.md) ### Return type: [Bool](../types/Bool.md)

View File

@ -1,16 +1,18 @@
--- ---
title: messages.reportEncryptedSpam title: messages.reportEncryptedSpam
description: messages.reportEncryptedSpam parameters, return type and example description: Report for spam a secret chat
--- ---
## Method: messages.reportEncryptedSpam ## Method: messages.reportEncryptedSpam
[Back to methods index](index.md) [Back to methods index](index.md)
Report for spam a secret chat
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| |peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat to report|
### Return type: [Bool](../types/Bool.md) ### Return type: [Bool](../types/Bool.md)

View File

@ -1,20 +1,22 @@
--- ---
title: messages.saveDraft title: messages.saveDraft
description: messages.saveDraft parameters, return type and example description: Save a message draft
--- ---
## Method: messages.saveDraft ## Method: messages.saveDraft
[Back to methods index](index.md) [Back to methods index](index.md)
Save a message draft
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional| |no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview|
|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional| |reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID|
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| |peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat|
|message|[CLICK ME string](../types/string.md) | Yes| |message|[CLICK ME string](../types/string.md) | Yes|The message|
|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional| |entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)|
|parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message|

View File

@ -1,17 +1,19 @@
--- ---
title: messages.saveGif title: messages.saveGif
description: messages.saveGif parameters, return type and example description: Save a GIF
--- ---
## Method: messages.saveGif ## Method: messages.saveGif
[Back to methods index](index.md) [Back to methods index](index.md)
Save a GIF
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional| |id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save|
|unsave|[CLICK ME Bool](../types/Bool.md) | Yes| |unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the gif?|
### Return type: [Bool](../types/Bool.md) ### Return type: [Bool](../types/Bool.md)

View File

@ -1,18 +1,20 @@
--- ---
title: messages.saveRecentSticker title: messages.saveRecentSticker
description: messages.saveRecentSticker parameters, return type and example description: Add a sticker to recent stickers
--- ---
## Method: messages.saveRecentSticker ## Method: messages.saveRecentSticker
[Back to methods index](index.md) [Back to methods index](index.md)
Add a sticker to recent stickers
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|attached|[CLICK ME Bool](../types/Bool.md) | Optional| |attached|[CLICK ME Bool](../types/Bool.md) | Optional|Get stickers attached to image?|
|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional| |id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker|
|unsave|[CLICK ME Bool](../types/Bool.md) | Yes| |unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?|
### Return type: [Bool](../types/Bool.md) ### Return type: [Bool](../types/Bool.md)

View File

@ -1,17 +1,19 @@
--- ---
title: messages.searchGifs title: messages.searchGifs
description: messages.searchGifs parameters, return type and example description: Search gifs
--- ---
## Method: messages.searchGifs ## Method: messages.searchGifs
[Back to methods index](index.md) [Back to methods index](index.md)
Search gifs
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|q|[CLICK ME string](../types/string.md) | Yes| |q|[CLICK ME string](../types/string.md) | Yes|The search query|
|offset|[CLICK ME int](../types/int.md) | Yes| |offset|[CLICK ME int](../types/int.md) | Yes|The offset |
### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md)

View File

@ -1,20 +1,22 @@
--- ---
title: messages.searchGlobal title: messages.searchGlobal
description: messages.searchGlobal parameters, return type and example description: Global message search
--- ---
## Method: messages.searchGlobal ## Method: messages.searchGlobal
[Back to methods index](index.md) [Back to methods index](index.md)
Global message search
### Parameters: ### Parameters:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|q|[CLICK ME string](../types/string.md) | Yes| |q|[CLICK ME string](../types/string.md) | Yes|The query|
|offset\_date|[CLICK ME int](../types/int.md) | Yes| |offset\_date|[CLICK ME int](../types/int.md) | Yes|0 or the date offset|
|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| |offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset|
|offset\_id|[CLICK ME int](../types/int.md) | Yes| |offset\_id|[CLICK ME int](../types/int.md) | Yes|0 or the message ID offset|
|limit|[CLICK ME int](../types/int.md) | Yes| |limit|[CLICK ME int](../types/int.md) | Yes|The number of results to return|
### Return type: [messages\_Messages](../types/messages_Messages.md) ### Return type: [messages\_Messages](../types/messages_Messages.md)

Some files were not shown because too many files have changed in this diff Show More