Finish documenting methods
This commit is contained in:
parent
86d146c977
commit
0e76373a35
@ -12,10 +12,10 @@ Register device for push notifications
|
||||
|
||||
| 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|[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\_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|
|
||||
|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\_uids|Array of [CLICK ME int](../types/int.md) | Yes|Other UIDs|
|
||||
|
||||
|
||||
### Return type: [Bool](../types/Bool.md)
|
||||
|
@ -12,9 +12,9 @@ Stop sending PUSH notifications to app
|
||||
|
||||
| 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|[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||
|
||||
|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|
|
||||
|other\_uids|Array of [CLICK ME int](../types/int.md) | Yes|Other UIDs|
|
||||
|
||||
|
||||
### Return type: [Bool](../types/Bool.md)
|
||||
|
@ -1,12 +1,12 @@
|
||||
---
|
||||
title: channels.getAdminLog
|
||||
description: Get admin log of a channel/supergruop
|
||||
description: Get admin log of a channel/supergroup
|
||||
---
|
||||
## Method: channels.getAdminLog
|
||||
[Back to methods index](index.md)
|
||||
|
||||
|
||||
Get admin log of a channel/supergruop
|
||||
Get admin log of a channel/supergroup
|
||||
|
||||
### Parameters:
|
||||
|
||||
|
@ -12,7 +12,7 @@ Get blocked users
|
||||
|
||||
| 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|
|
||||
|
||||
|
||||
|
@ -18,7 +18,7 @@ Get most used chats
|
||||
|phone\_calls|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch phone calls?|
|
||||
|groups|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch groups?|
|
||||
|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|
|
||||
|hash|[CLICK ME int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched peer ids);|
|
||||
|
||||
|
@ -1,16 +1,18 @@
|
||||
---
|
||||
title: langpack.getDifference
|
||||
description: langpack.getDifference parameters, return type and example
|
||||
description: Get language pack updates
|
||||
---
|
||||
## Method: langpack.getDifference
|
||||
[Back to methods index](index.md)
|
||||
|
||||
|
||||
Get language pack updates
|
||||
|
||||
### Parameters:
|
||||
|
||||
| Name | Type | Required |
|
||||
|----------|---------------|----------|
|
||||
|from\_version|[CLICK ME int](../types/int.md) | Yes|
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|from\_version|[CLICK ME int](../types/int.md) | Yes|Previous version|
|
||||
|
||||
|
||||
### Return type: [LangPackDifference](../types/LangPackDifference.md)
|
||||
|
@ -1,16 +1,18 @@
|
||||
---
|
||||
title: langpack.getLangPack
|
||||
description: langpack.getLangPack parameters, return type and example
|
||||
description: Get language pack
|
||||
---
|
||||
## Method: langpack.getLangPack
|
||||
[Back to methods index](index.md)
|
||||
|
||||
|
||||
Get language pack
|
||||
|
||||
### Parameters:
|
||||
|
||||
| Name | Type | Required |
|
||||
|----------|---------------|----------|
|
||||
|lang\_code|[CLICK ME string](../types/string.md) | Yes|
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code|
|
||||
|
||||
|
||||
### Return type: [LangPackDifference](../types/LangPackDifference.md)
|
||||
|
@ -1,11 +1,13 @@
|
||||
---
|
||||
title: langpack.getLanguages
|
||||
description: langpack.getLanguages parameters, return type and example
|
||||
description: Get available languages
|
||||
---
|
||||
## Method: langpack.getLanguages
|
||||
[Back to methods index](index.md)
|
||||
|
||||
|
||||
Get available languages
|
||||
|
||||
|
||||
|
||||
### Return type: [Vector\_of\_LangPackLanguage](../types/LangPackLanguage.md)
|
||||
|
@ -1,17 +1,19 @@
|
||||
---
|
||||
title: langpack.getStrings
|
||||
description: langpack.getStrings parameters, return type and example
|
||||
description: Get language pack strings
|
||||
---
|
||||
## Method: langpack.getStrings
|
||||
[Back to methods index](index.md)
|
||||
|
||||
|
||||
Get language pack strings
|
||||
|
||||
### Parameters:
|
||||
|
||||
| Name | Type | Required |
|
||||
|----------|---------------|----------|
|
||||
|lang\_code|[CLICK ME string](../types/string.md) | Yes|
|
||||
|keys|Array of [CLICK ME string](../types/string.md) | Yes|
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code|
|
||||
|keys|Array of [CLICK ME string](../types/string.md) | Yes|Keys|
|
||||
|
||||
|
||||
### Return type: [Vector\_of\_LangPackString](../types/LangPackString.md)
|
||||
|
@ -1,11 +1,13 @@
|
||||
---
|
||||
title: phone.getCallConfig
|
||||
description: phone.getCallConfig parameters, return type and example
|
||||
description: Get call configuration
|
||||
---
|
||||
## Method: phone.getCallConfig
|
||||
[Back to methods index](index.md)
|
||||
|
||||
|
||||
Get call configuration
|
||||
|
||||
|
||||
|
||||
### Return type: [DataJSON](../types/DataJSON.md)
|
||||
|
@ -1,16 +1,18 @@
|
||||
---
|
||||
title: phone.receivedCall
|
||||
description: phone.receivedCall parameters, return type and example
|
||||
description: Notify server that you received a call (server will refuse all incoming calls until the current call is over)
|
||||
---
|
||||
## Method: phone.receivedCall
|
||||
[Back to methods index](index.md)
|
||||
|
||||
|
||||
Notify server that you received a call (server will refuse all incoming calls until the current call is over)
|
||||
|
||||
### Parameters:
|
||||
|
||||
| Name | Type | Required |
|
||||
|----------|---------------|----------|
|
||||
|peer|[CLICK ME InputPhoneCall](../types/InputPhoneCall.md) | Yes|
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|peer|[CLICK ME InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call you received|
|
||||
|
||||
|
||||
### Return type: [Bool](../types/Bool.md)
|
||||
|
@ -1,17 +1,19 @@
|
||||
---
|
||||
title: phone.saveCallDebug
|
||||
description: phone.saveCallDebug parameters, return type and example
|
||||
description: Save call debugging info
|
||||
---
|
||||
## Method: phone.saveCallDebug
|
||||
[Back to methods index](index.md)
|
||||
|
||||
|
||||
Save call debugging info
|
||||
|
||||
### Parameters:
|
||||
|
||||
| Name | Type | Required |
|
||||
|----------|---------------|----------|
|
||||
|peer|[CLICK ME InputPhoneCall](../types/InputPhoneCall.md) | Yes|
|
||||
|debug|[CLICK ME DataJSON](../types/DataJSON.md) | Yes|
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|peer|[CLICK ME InputPhoneCall](../types/InputPhoneCall.md) | Yes|The call|
|
||||
|debug|[CLICK ME DataJSON](../types/DataJSON.md) | Yes|Debugging info|
|
||||
|
||||
|
||||
### Return type: [Bool](../types/Bool.md)
|
||||
|
@ -1,18 +1,20 @@
|
||||
---
|
||||
title: phone.setCallRating
|
||||
description: phone.setCallRating parameters, return type and example
|
||||
description: Set phone call rating
|
||||
---
|
||||
## Method: phone.setCallRating
|
||||
[Back to methods index](index.md)
|
||||
|
||||
|
||||
Set phone call rating
|
||||
|
||||
### Parameters:
|
||||
|
||||
| Name | Type | Required |
|
||||
|----------|---------------|----------|
|
||||
|peer|[CLICK ME InputPhoneCall](../types/InputPhoneCall.md) | Yes|
|
||||
|rating|[CLICK ME int](../types/int.md) | Yes|
|
||||
|comment|[CLICK ME string](../types/string.md) | Yes|
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|peer|[CLICK ME InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call|
|
||||
|rating|[CLICK ME int](../types/int.md) | Yes|Rating (1-5 stars)|
|
||||
|comment|[CLICK ME string](../types/string.md) | Yes|An optional comment|
|
||||
|
||||
|
||||
### Return type: [Updates](../types/Updates.md)
|
||||
|
@ -1,20 +1,22 @@
|
||||
---
|
||||
title: resPQ
|
||||
description: resPQ attributes, type and example
|
||||
description: Contains pq to factorize
|
||||
---
|
||||
## Constructor: resPQ
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Contains pq to factorize
|
||||
|
||||
### Attributes:
|
||||
|
||||
| Name | Type | Required |
|
||||
|----------|---------------|----------|
|
||||
|nonce|[int128](../types/int128.md) | Yes|
|
||||
|server\_nonce|[int128](../types/int128.md) | Yes|
|
||||
|pq|[bytes](../types/bytes.md) | Yes|
|
||||
|server\_public\_key\_fingerprints|Array of [long](../types/long.md) | Yes|
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|nonce|[int128](../types/int128.md) | Yes|Nonce|
|
||||
|server\_nonce|[int128](../types/int128.md) | Yes|Server nonce|
|
||||
|pq|[bytes](../types/bytes.md) | Yes||
|
||||
|server\_public\_key\_fingerprints|Array of [long](../types/long.md) | Yes||
|
||||
|
||||
|
||||
|
||||
|
@ -1,12 +1,14 @@
|
||||
---
|
||||
title: vector
|
||||
description: vector attributes, type and example
|
||||
description: Array
|
||||
---
|
||||
## Constructor: vector
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Array
|
||||
|
||||
|
||||
|
||||
|
||||
|
@ -13,7 +13,7 @@ Makes the server send messages waiting in the buffer
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|max\_delay|[CLICK ME int](../types/int.md) | Yes|Denotes the maximum number of milliseconds that has elapsed between the first message for this session and the transmission of an HTTP response|
|
||||
|wait\_after|[CLICK ME int](../types/int.md) | Yes|after the receipt of the latest message for a particular session, the server waits anoTher wait_after milliseconds in case There are more messages. If There are no additional messages, the result is transmitted (a container with all the messages).|
|
||||
|wait\_after|[CLICK ME int](../types/int.md) | Yes|after the receipt of the latest message for a particular session, the server waits another wait_after milliseconds in case there are more messages. If there are no additional messages, the result is transmitted (a container with all the messages).|
|
||||
|max\_wait|[CLICK ME int](../types/int.md) | Yes|If more messages appear, the wait_after timer is reset.|
|
||||
|
||||
|
||||
|
@ -1,12 +1,14 @@
|
||||
---
|
||||
title: vector
|
||||
description: vector attributes, type and example
|
||||
description: Array
|
||||
---
|
||||
## Constructor: vector
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Array
|
||||
|
||||
|
||||
|
||||
|
||||
|
@ -12,13 +12,13 @@ Register device for push notifications
|
||||
|
||||
| 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|[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|
|
||||
|device\_model|[CLICK ME string](../types/string.md) | Yes||
|
||||
|system\_version|[CLICK ME string](../types/string.md) | Yes||
|
||||
|app\_version|[CLICK ME string](../types/string.md) | Yes||
|
||||
|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|
|
||||
|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model|
|
||||
|system\_version|[CLICK ME string](../types/string.md) | Yes|System version|
|
||||
|app\_version|[CLICK ME string](../types/string.md) | Yes|App version|
|
||||
|app\_sandbox|[CLICK ME Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?|
|
||||
|lang\_code|[CLICK ME string](../types/string.md) | Yes||
|
||||
|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code|
|
||||
|
||||
|
||||
### Return type: [Bool](../types/Bool.md)
|
||||
|
@ -12,8 +12,8 @@ Stop sending PUSH notifications to app
|
||||
|
||||
| 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|[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\_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|
|
||||
|
||||
|
||||
### Return type: [Bool](../types/Bool.md)
|
||||
|
@ -1,17 +1,19 @@
|
||||
---
|
||||
title: auth.sendCall
|
||||
description: auth.sendCall parameters, return type and example
|
||||
description: Send verification phone call
|
||||
---
|
||||
## Method: auth.sendCall
|
||||
[Back to methods index](index.md)
|
||||
|
||||
|
||||
Send verification phone call
|
||||
|
||||
### Parameters:
|
||||
|
||||
| Name | Type | Required |
|
||||
|----------|---------------|----------|
|
||||
|phone\_number|[CLICK ME string](../types/string.md) | Yes|
|
||||
|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number|
|
||||
|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|The phone code hash|
|
||||
|
||||
|
||||
### Return type: [Bool](../types/Bool.md)
|
||||
|
@ -1,17 +1,19 @@
|
||||
---
|
||||
title: auth.sendSms
|
||||
description: auth.sendSms parameters, return type and example
|
||||
description: Send SMS verification code
|
||||
---
|
||||
## Method: auth.sendSms
|
||||
[Back to methods index](index.md)
|
||||
|
||||
|
||||
Send SMS verification code
|
||||
|
||||
### Parameters:
|
||||
|
||||
| Name | Type | Required |
|
||||
|----------|---------------|----------|
|
||||
|phone\_number|[CLICK ME string](../types/string.md) | Yes|
|
||||
|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number|
|
||||
|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code ash|
|
||||
|
||||
|
||||
### Return type: [Bool](../types/Bool.md)
|
||||
|
@ -12,7 +12,7 @@ Get blocked users
|
||||
|
||||
| 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|
|
||||
|
||||
|
||||
|
@ -12,7 +12,7 @@ Get info about a certain contact
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|hash|[CLICK ME string](../types/string.md) | Yes||
|
||||
|hash|[CLICK ME string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);|
|
||||
|
||||
|
||||
### Return type: [contacts\_Contacts](../types/contacts_Contacts.md)
|
||||
|
@ -1,16 +1,18 @@
|
||||
---
|
||||
title: contacts.getSuggested
|
||||
description: contacts.getSuggested parameters, return type and example
|
||||
description: Get suggested contacts
|
||||
---
|
||||
## Method: contacts.getSuggested
|
||||
[Back to methods index](index.md)
|
||||
|
||||
|
||||
Get suggested contacts
|
||||
|
||||
### Parameters:
|
||||
|
||||
| Name | Type | Required |
|
||||
|----------|---------------|----------|
|
||||
|limit|[CLICK ME int](../types/int.md) | Yes|
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return|
|
||||
|
||||
|
||||
### Return type: [contacts\_Suggested](../types/contacts_Suggested.md)
|
||||
|
@ -13,7 +13,7 @@ Add phone number as contact
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|contacts|Array of [CLICK ME InputContact](../types/InputContact.md) | Yes|The numbers to import|
|
||||
|replace|[CLICK ME Bool](../types/Bool.md) | Yes||
|
||||
|replace|[CLICK ME Bool](../types/Bool.md) | Yes|Replace contacts?|
|
||||
|
||||
|
||||
### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md)
|
||||
|
@ -12,10 +12,10 @@ Get info about app updates
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|device\_model|[CLICK ME string](../types/string.md) | Yes||
|
||||
|system\_version|[CLICK ME string](../types/string.md) | Yes||
|
||||
|app\_version|[CLICK ME string](../types/string.md) | Yes||
|
||||
|lang\_code|[CLICK ME string](../types/string.md) | Yes||
|
||||
|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model|
|
||||
|system\_version|[CLICK ME string](../types/string.md) | Yes|System version|
|
||||
|app\_version|[CLICK ME string](../types/string.md) | Yes|App version|
|
||||
|lang\_code|[CLICK ME string](../types/string.md) | Yes|Langauge code|
|
||||
|
||||
|
||||
### Return type: [help\_AppUpdate](../types/help_AppUpdate.md)
|
||||
|
@ -12,7 +12,7 @@ Get invitation text
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|lang\_code|[CLICK ME string](../types/string.md) | Yes||
|
||||
|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language|
|
||||
|
||||
|
||||
### Return type: [help\_InviteText](../types/help_InviteText.md)
|
||||
|
@ -1,16 +1,18 @@
|
||||
---
|
||||
title: invokeWithLayer18
|
||||
description: invokeWithLayer18 parameters, return type and example
|
||||
description: Invoke this method with layer 18
|
||||
---
|
||||
## Method: invokeWithLayer18
|
||||
[Back to methods index](index.md)
|
||||
|
||||
|
||||
Invoke this method with layer 18
|
||||
|
||||
### Parameters:
|
||||
|
||||
| Name | Type | Required |
|
||||
|----------|---------------|----------|
|
||||
|query|[CLICK ME !X](../types/!X.md) | Yes|
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|query|[CLICK ME !X](../types/!X.md) | Yes|The method call|
|
||||
|
||||
|
||||
### Return type: [X](../types/X.md)
|
||||
|
@ -13,7 +13,7 @@ Delete chat history
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it|
|
||||
|offset|[CLICK ME int](../types/int.md) | Yes||
|
||||
|offset|[CLICK ME int](../types/int.md) | Yes|Offset|
|
||||
|
||||
|
||||
### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md)
|
||||
|
@ -1,17 +1,19 @@
|
||||
---
|
||||
title: messages.forwardMessage
|
||||
description: messages.forwardMessage parameters, return type and example
|
||||
description: Forward message
|
||||
---
|
||||
## Method: messages.forwardMessage
|
||||
[Back to methods index](index.md)
|
||||
|
||||
|
||||
Forward message
|
||||
|
||||
### Parameters:
|
||||
|
||||
| Name | Type | Required |
|
||||
|----------|---------------|----------|
|
||||
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|
|
||||
|id|[CLICK ME int](../types/int.md) | Yes|
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message|
|
||||
|id|[CLICK ME int](../types/int.md) | Yes|The message ID|
|
||||
|
||||
|
||||
### Return type: [messages\_StatedMessage](../types/messages_StatedMessage.md)
|
||||
|
@ -12,7 +12,7 @@ Forward messages
|
||||
|
||||
| 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|Peer|
|
||||
|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs|
|
||||
|
||||
|
||||
|
@ -12,8 +12,8 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|offset|[CLICK ME int](../types/int.md) | Yes||
|
||||
|max\_id|[CLICK ME int](../types/int.md) | Yes||
|
||||
|offset|[CLICK ME int](../types/int.md) | Yes|Offset|
|
||||
|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum ID of result to return|
|
||||
|limit|[CLICK ME int](../types/int.md) | Yes|Number of dialogs to fetch|
|
||||
|
||||
|
||||
|
@ -13,7 +13,7 @@ Get previous messages of a group
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat|
|
||||
|offset|[CLICK ME int](../types/int.md) | Yes||
|
||||
|offset|[CLICK ME int](../types/int.md) | Yes|Message ID offset|
|
||||
|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to fetch|
|
||||
|limit|[CLICK ME int](../types/int.md) | Yes|Number of messages to fetch|
|
||||
|
||||
|
@ -14,8 +14,8 @@ Mark messages as read
|
||||
|----------|---------------|----------|-------------|
|
||||
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read|
|
||||
|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read|
|
||||
|offset|[CLICK ME int](../types/int.md) | Yes||
|
||||
|read\_contents|[CLICK ME Bool](../types/Bool.md) | Yes||
|
||||
|offset|[CLICK ME int](../types/int.md) | Yes|Offset|
|
||||
|read\_contents|[CLICK ME Bool](../types/Bool.md) | Yes|Mark messages as read?|
|
||||
|
||||
|
||||
### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md)
|
||||
|
@ -17,7 +17,7 @@ Search peers or messages
|
||||
|filter|[CLICK ME MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter|
|
||||
|min\_date|[CLICK ME int](../types/int.md) | Yes|Minumum date of results to fetch|
|
||||
|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of results to fetch|
|
||||
|offset|[CLICK ME int](../types/int.md) | Yes||
|
||||
|offset|[CLICK ME int](../types/int.md) | Yes|Offset |
|
||||
|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id to return|
|
||||
|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return|
|
||||
|
||||
|
@ -1,18 +1,20 @@
|
||||
---
|
||||
title: messages.sendBroadcast
|
||||
description: messages.sendBroadcast parameters, return type and example
|
||||
description: Send a message to all users in the chat list
|
||||
---
|
||||
## Method: messages.sendBroadcast
|
||||
[Back to methods index](index.md)
|
||||
|
||||
|
||||
Send a message to all users in the chat list
|
||||
|
||||
### Parameters:
|
||||
|
||||
| Name | Type | Required |
|
||||
|----------|---------------|----------|
|
||||
|contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|
|
||||
|message|[CLICK ME string](../types/string.md) | Yes|
|
||||
|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to which send the message|
|
||||
|message|[CLICK ME string](../types/string.md) | Yes|The message|
|
||||
|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media|
|
||||
|
||||
|
||||
### Return type: [messages\_StatedMessages](../types/messages_StatedMessages.md)
|
||||
|
@ -14,7 +14,7 @@ Get the profile photos of a user
|
||||
|----------|---------------|----------|-------------|
|
||||
|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user|
|
||||
|offset|[CLICK ME int](../types/int.md) | Yes|Offset|
|
||||
|max\_id|[CLICK ME int](../types/int.md) | Yes||
|
||||
|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum ID of photo to return|
|
||||
|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return|
|
||||
|
||||
|
||||
|
@ -13,7 +13,7 @@ Update the profile photo (use photos->uploadProfilePhoto to upload the photo)
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use|
|
||||
|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes||
|
||||
|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info|
|
||||
|
||||
|
||||
### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md)
|
||||
|
@ -13,9 +13,9 @@ Upload profile photo
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo|
|
||||
|caption|[CLICK ME string](../types/string.md) | Yes||
|
||||
|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional||
|
||||
|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes||
|
||||
|caption|[CLICK ME string](../types/string.md) | Yes|Caption type|
|
||||
|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location|
|
||||
|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info|
|
||||
|
||||
|
||||
### Return type: [photos\_Photo](../types/photos_Photo.md)
|
||||
|
@ -1,12 +1,14 @@
|
||||
---
|
||||
title: vector
|
||||
description: vector attributes, type and example
|
||||
description: Array
|
||||
---
|
||||
## Constructor: vector
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Array
|
||||
|
||||
|
||||
|
||||
|
||||
|
@ -12,13 +12,13 @@ Register device for push notifications
|
||||
|
||||
| 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|[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|
|
||||
|device\_model|[CLICK ME string](../types/string.md) | Yes||
|
||||
|system\_version|[CLICK ME string](../types/string.md) | Yes||
|
||||
|app\_version|[CLICK ME string](../types/string.md) | Yes||
|
||||
|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|
|
||||
|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model|
|
||||
|system\_version|[CLICK ME string](../types/string.md) | Yes|System version|
|
||||
|app\_version|[CLICK ME string](../types/string.md) | Yes|App version|
|
||||
|app\_sandbox|[CLICK ME Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?|
|
||||
|lang\_code|[CLICK ME string](../types/string.md) | Yes||
|
||||
|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code|
|
||||
|
||||
|
||||
### Return type: [Bool](../types/Bool.md)
|
||||
|
@ -12,8 +12,8 @@ Stop sending PUSH notifications to app
|
||||
|
||||
| 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|[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\_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|
|
||||
|
||||
|
||||
### Return type: [Bool](../types/Bool.md)
|
||||
|
@ -1,17 +1,19 @@
|
||||
---
|
||||
title: auth.sendCall
|
||||
description: auth.sendCall parameters, return type and example
|
||||
description: Send verification phone call
|
||||
---
|
||||
## Method: auth.sendCall
|
||||
[Back to methods index](index.md)
|
||||
|
||||
|
||||
Send verification phone call
|
||||
|
||||
### Parameters:
|
||||
|
||||
| Name | Type | Required |
|
||||
|----------|---------------|----------|
|
||||
|phone\_number|[CLICK ME string](../types/string.md) | Yes|
|
||||
|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number|
|
||||
|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|The phone code hash|
|
||||
|
||||
|
||||
### Return type: [Bool](../types/Bool.md)
|
||||
|
@ -1,17 +1,19 @@
|
||||
---
|
||||
title: auth.sendSms
|
||||
description: auth.sendSms parameters, return type and example
|
||||
description: Send SMS verification code
|
||||
---
|
||||
## Method: auth.sendSms
|
||||
[Back to methods index](index.md)
|
||||
|
||||
|
||||
Send SMS verification code
|
||||
|
||||
### Parameters:
|
||||
|
||||
| Name | Type | Required |
|
||||
|----------|---------------|----------|
|
||||
|phone\_number|[CLICK ME string](../types/string.md) | Yes|
|
||||
|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number|
|
||||
|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code ash|
|
||||
|
||||
|
||||
### Return type: [Bool](../types/Bool.md)
|
||||
|
@ -12,7 +12,7 @@ Get blocked users
|
||||
|
||||
| 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|
|
||||
|
||||
|
||||
|
@ -12,7 +12,7 @@ Get info about a certain contact
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|hash|[CLICK ME string](../types/string.md) | Yes||
|
||||
|hash|[CLICK ME string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);|
|
||||
|
||||
|
||||
### Return type: [contacts\_Contacts](../types/contacts_Contacts.md)
|
||||
|
@ -1,16 +1,18 @@
|
||||
---
|
||||
title: contacts.getSuggested
|
||||
description: contacts.getSuggested parameters, return type and example
|
||||
description: Get suggested contacts
|
||||
---
|
||||
## Method: contacts.getSuggested
|
||||
[Back to methods index](index.md)
|
||||
|
||||
|
||||
Get suggested contacts
|
||||
|
||||
### Parameters:
|
||||
|
||||
| Name | Type | Required |
|
||||
|----------|---------------|----------|
|
||||
|limit|[CLICK ME int](../types/int.md) | Yes|
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return|
|
||||
|
||||
|
||||
### Return type: [contacts\_Suggested](../types/contacts_Suggested.md)
|
||||
|
@ -13,7 +13,7 @@ Add phone number as contact
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|contacts|Array of [CLICK ME InputContact](../types/InputContact.md) | Yes|The numbers to import|
|
||||
|replace|[CLICK ME Bool](../types/Bool.md) | Yes||
|
||||
|replace|[CLICK ME Bool](../types/Bool.md) | Yes|Replace contacts?|
|
||||
|
||||
|
||||
### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md)
|
||||
|
@ -12,10 +12,10 @@ Get info about app updates
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|device\_model|[CLICK ME string](../types/string.md) | Yes||
|
||||
|system\_version|[CLICK ME string](../types/string.md) | Yes||
|
||||
|app\_version|[CLICK ME string](../types/string.md) | Yes||
|
||||
|lang\_code|[CLICK ME string](../types/string.md) | Yes||
|
||||
|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model|
|
||||
|system\_version|[CLICK ME string](../types/string.md) | Yes|System version|
|
||||
|app\_version|[CLICK ME string](../types/string.md) | Yes|App version|
|
||||
|lang\_code|[CLICK ME string](../types/string.md) | Yes|Langauge code|
|
||||
|
||||
|
||||
### Return type: [help\_AppUpdate](../types/help_AppUpdate.md)
|
||||
|
@ -12,7 +12,7 @@ Get invitation text
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|lang\_code|[CLICK ME string](../types/string.md) | Yes||
|
||||
|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language|
|
||||
|
||||
|
||||
### Return type: [help\_InviteText](../types/help_InviteText.md)
|
||||
|
@ -13,7 +13,7 @@ Delete chat history
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it|
|
||||
|offset|[CLICK ME int](../types/int.md) | Yes||
|
||||
|offset|[CLICK ME int](../types/int.md) | Yes|Offset|
|
||||
|
||||
|
||||
### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md)
|
||||
|
@ -1,17 +1,19 @@
|
||||
---
|
||||
title: messages.forwardMessage
|
||||
description: messages.forwardMessage parameters, return type and example
|
||||
description: Forward message
|
||||
---
|
||||
## Method: messages.forwardMessage
|
||||
[Back to methods index](index.md)
|
||||
|
||||
|
||||
Forward message
|
||||
|
||||
### Parameters:
|
||||
|
||||
| Name | Type | Required |
|
||||
|----------|---------------|----------|
|
||||
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|
|
||||
|id|[CLICK ME int](../types/int.md) | Yes|
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message|
|
||||
|id|[CLICK ME int](../types/int.md) | Yes|The message ID|
|
||||
|
||||
|
||||
### Return type: [messages\_StatedMessage](../types/messages_StatedMessage.md)
|
||||
|
@ -12,7 +12,7 @@ Forward messages
|
||||
|
||||
| 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|Peer|
|
||||
|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs|
|
||||
|
||||
|
||||
|
@ -12,7 +12,7 @@ Get all stickerpacks
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|hash|[CLICK ME string](../types/string.md) | Yes||
|
||||
|hash|[CLICK ME string](../types/string.md) | Yes|Previously fetched stickers|
|
||||
|
||||
|
||||
### Return type: [messages\_AllStickers](../types/messages_AllStickers.md)
|
||||
|
@ -12,8 +12,8 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|offset|[CLICK ME int](../types/int.md) | Yes||
|
||||
|max\_id|[CLICK ME int](../types/int.md) | Yes||
|
||||
|offset|[CLICK ME int](../types/int.md) | Yes|Offset|
|
||||
|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum ID of result to return|
|
||||
|limit|[CLICK ME int](../types/int.md) | Yes|Number of dialogs to fetch|
|
||||
|
||||
|
||||
|
@ -13,7 +13,7 @@ Get previous messages of a group
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat|
|
||||
|offset|[CLICK ME int](../types/int.md) | Yes||
|
||||
|offset|[CLICK ME int](../types/int.md) | Yes|Message ID offset|
|
||||
|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to fetch|
|
||||
|limit|[CLICK ME int](../types/int.md) | Yes|Number of messages to fetch|
|
||||
|
||||
|
@ -14,8 +14,8 @@ Mark messages as read
|
||||
|----------|---------------|----------|-------------|
|
||||
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read|
|
||||
|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read|
|
||||
|offset|[CLICK ME int](../types/int.md) | Yes||
|
||||
|read\_contents|[CLICK ME Bool](../types/Bool.md) | Yes||
|
||||
|offset|[CLICK ME int](../types/int.md) | Yes|Offset|
|
||||
|read\_contents|[CLICK ME Bool](../types/Bool.md) | Yes|Mark messages as read?|
|
||||
|
||||
|
||||
### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md)
|
||||
|
@ -17,7 +17,7 @@ Search peers or messages
|
||||
|filter|[CLICK ME MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter|
|
||||
|min\_date|[CLICK ME int](../types/int.md) | Yes|Minumum date of results to fetch|
|
||||
|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of results to fetch|
|
||||
|offset|[CLICK ME int](../types/int.md) | Yes||
|
||||
|offset|[CLICK ME int](../types/int.md) | Yes|Offset |
|
||||
|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id to return|
|
||||
|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return|
|
||||
|
||||
|
@ -1,18 +1,20 @@
|
||||
---
|
||||
title: messages.sendBroadcast
|
||||
description: messages.sendBroadcast parameters, return type and example
|
||||
description: Send a message to all users in the chat list
|
||||
---
|
||||
## Method: messages.sendBroadcast
|
||||
[Back to methods index](index.md)
|
||||
|
||||
|
||||
Send a message to all users in the chat list
|
||||
|
||||
### Parameters:
|
||||
|
||||
| Name | Type | Required |
|
||||
|----------|---------------|----------|
|
||||
|contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|
|
||||
|message|[CLICK ME string](../types/string.md) | Yes|
|
||||
|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to which send the message|
|
||||
|message|[CLICK ME string](../types/string.md) | Yes|The message|
|
||||
|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media|
|
||||
|
||||
|
||||
### Return type: [messages\_StatedMessages](../types/messages_StatedMessages.md)
|
||||
|
@ -14,7 +14,7 @@ Get the profile photos of a user
|
||||
|----------|---------------|----------|-------------|
|
||||
|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user|
|
||||
|offset|[CLICK ME int](../types/int.md) | Yes|Offset|
|
||||
|max\_id|[CLICK ME int](../types/int.md) | Yes||
|
||||
|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum ID of photo to return|
|
||||
|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return|
|
||||
|
||||
|
||||
|
@ -13,7 +13,7 @@ Update the profile photo (use photos->uploadProfilePhoto to upload the photo)
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use|
|
||||
|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes||
|
||||
|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info|
|
||||
|
||||
|
||||
### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md)
|
||||
|
@ -13,9 +13,9 @@ Upload profile photo
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo|
|
||||
|caption|[CLICK ME string](../types/string.md) | Yes||
|
||||
|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional||
|
||||
|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes||
|
||||
|caption|[CLICK ME string](../types/string.md) | Yes|Caption type|
|
||||
|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location|
|
||||
|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info|
|
||||
|
||||
|
||||
### Return type: [photos\_Photo](../types/photos_Photo.md)
|
||||
|
@ -1,12 +1,14 @@
|
||||
---
|
||||
title: vector
|
||||
description: vector attributes, type and example
|
||||
description: Array
|
||||
---
|
||||
## Constructor: vector
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Array
|
||||
|
||||
|
||||
|
||||
|
||||
|
@ -12,13 +12,13 @@ Register device for push notifications
|
||||
|
||||
| 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|[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|
|
||||
|device\_model|[CLICK ME string](../types/string.md) | Yes||
|
||||
|system\_version|[CLICK ME string](../types/string.md) | Yes||
|
||||
|app\_version|[CLICK ME string](../types/string.md) | Yes||
|
||||
|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|
|
||||
|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model|
|
||||
|system\_version|[CLICK ME string](../types/string.md) | Yes|System version|
|
||||
|app\_version|[CLICK ME string](../types/string.md) | Yes|App version|
|
||||
|app\_sandbox|[CLICK ME Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?|
|
||||
|lang\_code|[CLICK ME string](../types/string.md) | Yes||
|
||||
|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code|
|
||||
|
||||
|
||||
### Return type: [Bool](../types/Bool.md)
|
||||
|
@ -1,19 +1,21 @@
|
||||
---
|
||||
title: account.setPassword
|
||||
description: account.setPassword parameters, return type and example
|
||||
description: Set 2FA password
|
||||
---
|
||||
## Method: account.setPassword
|
||||
[Back to methods index](index.md)
|
||||
|
||||
|
||||
Set 2FA password
|
||||
|
||||
### Parameters:
|
||||
|
||||
| Name | Type | Required |
|
||||
|----------|---------------|----------|
|
||||
|current\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|
|
||||
|new\_salt|[CLICK ME bytes](../types/bytes.md) | Yes|
|
||||
|new\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|
|
||||
|hint|[CLICK ME string](../types/string.md) | Yes|
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|current\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`|
|
||||
|new\_salt|[CLICK ME bytes](../types/bytes.md) | Yes|New salt|
|
||||
|new\_password\_hash|[CLICK ME bytes](../types/bytes.md) | Yes|`hash('sha256', $new_salt.$new_password.$new_salt, true)`|
|
||||
|hint|[CLICK ME string](../types/string.md) | Yes|Hint|
|
||||
|
||||
|
||||
### Return type: [Bool](../types/Bool.md)
|
||||
|
@ -12,8 +12,8 @@ Stop sending PUSH notifications to app
|
||||
|
||||
| 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|[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\_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|
|
||||
|
||||
|
||||
### Return type: [Bool](../types/Bool.md)
|
||||
|
@ -1,17 +1,19 @@
|
||||
---
|
||||
title: auth.sendCall
|
||||
description: auth.sendCall parameters, return type and example
|
||||
description: Send verification phone call
|
||||
---
|
||||
## Method: auth.sendCall
|
||||
[Back to methods index](index.md)
|
||||
|
||||
|
||||
Send verification phone call
|
||||
|
||||
### Parameters:
|
||||
|
||||
| Name | Type | Required |
|
||||
|----------|---------------|----------|
|
||||
|phone\_number|[CLICK ME string](../types/string.md) | Yes|
|
||||
|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number|
|
||||
|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|The phone code hash|
|
||||
|
||||
|
||||
### Return type: [Bool](../types/Bool.md)
|
||||
|
@ -1,17 +1,19 @@
|
||||
---
|
||||
title: auth.sendSms
|
||||
description: auth.sendSms parameters, return type and example
|
||||
description: Send SMS verification code
|
||||
---
|
||||
## Method: auth.sendSms
|
||||
[Back to methods index](index.md)
|
||||
|
||||
|
||||
Send SMS verification code
|
||||
|
||||
### Parameters:
|
||||
|
||||
| Name | Type | Required |
|
||||
|----------|---------------|----------|
|
||||
|phone\_number|[CLICK ME string](../types/string.md) | Yes|
|
||||
|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number|
|
||||
|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code ash|
|
||||
|
||||
|
||||
### Return type: [Bool](../types/Bool.md)
|
||||
|
@ -12,7 +12,7 @@ Get blocked users
|
||||
|
||||
| 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|
|
||||
|
||||
|
||||
|
@ -12,7 +12,7 @@ Get info about a certain contact
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|hash|[CLICK ME string](../types/string.md) | Yes||
|
||||
|hash|[CLICK ME string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);|
|
||||
|
||||
|
||||
### Return type: [contacts\_Contacts](../types/contacts_Contacts.md)
|
||||
|
@ -1,16 +1,18 @@
|
||||
---
|
||||
title: contacts.getSuggested
|
||||
description: contacts.getSuggested parameters, return type and example
|
||||
description: Get suggested contacts
|
||||
---
|
||||
## Method: contacts.getSuggested
|
||||
[Back to methods index](index.md)
|
||||
|
||||
|
||||
Get suggested contacts
|
||||
|
||||
### Parameters:
|
||||
|
||||
| Name | Type | Required |
|
||||
|----------|---------------|----------|
|
||||
|limit|[CLICK ME int](../types/int.md) | Yes|
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return|
|
||||
|
||||
|
||||
### Return type: [contacts\_Suggested](../types/contacts_Suggested.md)
|
||||
|
@ -13,7 +13,7 @@ Add phone number as contact
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|contacts|Array of [CLICK ME InputContact](../types/InputContact.md) | Yes|The numbers to import|
|
||||
|replace|[CLICK ME Bool](../types/Bool.md) | Yes||
|
||||
|replace|[CLICK ME Bool](../types/Bool.md) | Yes|Replace contacts?|
|
||||
|
||||
|
||||
### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md)
|
||||
|
@ -1,16 +1,18 @@
|
||||
---
|
||||
title: geochats.checkin
|
||||
description: geochats.checkin parameters, return type and example
|
||||
description: Join a geochat
|
||||
---
|
||||
## Method: geochats.checkin
|
||||
[Back to methods index](index.md)
|
||||
|
||||
|
||||
Join a geochat
|
||||
|
||||
### Parameters:
|
||||
|
||||
| Name | Type | Required |
|
||||
|----------|---------------|----------|
|
||||
|peer|[CLICK ME InputGeoChat](../types/InputGeoChat.md) | Yes|
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|peer|[CLICK ME InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat|
|
||||
|
||||
|
||||
### Return type: [geochats\_StatedMessage](../types/geochats_StatedMessage.md)
|
||||
|
@ -1,19 +1,21 @@
|
||||
---
|
||||
title: geochats.createGeoChat
|
||||
description: geochats.createGeoChat parameters, return type and example
|
||||
description: Create geochat
|
||||
---
|
||||
## Method: geochats.createGeoChat
|
||||
[Back to methods index](index.md)
|
||||
|
||||
|
||||
Create geochat
|
||||
|
||||
### Parameters:
|
||||
|
||||
| Name | Type | Required |
|
||||
|----------|---------------|----------|
|
||||
|title|[CLICK ME string](../types/string.md) | Yes|
|
||||
|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|
|
||||
|address|[CLICK ME string](../types/string.md) | Yes|
|
||||
|venue|[CLICK ME string](../types/string.md) | Yes|
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|title|[CLICK ME string](../types/string.md) | Yes|Geochat title|
|
||||
|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|Geochat location|
|
||||
|address|[CLICK ME string](../types/string.md) | Yes|Geochat address|
|
||||
|venue|[CLICK ME string](../types/string.md) | Yes|Geochat venue |
|
||||
|
||||
|
||||
### Return type: [geochats\_StatedMessage](../types/geochats_StatedMessage.md)
|
||||
|
@ -1,17 +1,19 @@
|
||||
---
|
||||
title: geochats.editChatPhoto
|
||||
description: geochats.editChatPhoto parameters, return type and example
|
||||
description: Edit geochat photo
|
||||
---
|
||||
## Method: geochats.editChatPhoto
|
||||
[Back to methods index](index.md)
|
||||
|
||||
|
||||
Edit geochat photo
|
||||
|
||||
### Parameters:
|
||||
|
||||
| Name | Type | Required |
|
||||
|----------|---------------|----------|
|
||||
|peer|[CLICK ME InputGeoChat](../types/InputGeoChat.md) | Yes|
|
||||
|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|peer|[CLICK ME InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat|
|
||||
|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo|
|
||||
|
||||
|
||||
### Return type: [geochats\_StatedMessage](../types/geochats_StatedMessage.md)
|
||||
|
@ -1,18 +1,20 @@
|
||||
---
|
||||
title: geochats.editChatTitle
|
||||
description: geochats.editChatTitle parameters, return type and example
|
||||
description: Edit geochat title
|
||||
---
|
||||
## Method: geochats.editChatTitle
|
||||
[Back to methods index](index.md)
|
||||
|
||||
|
||||
Edit geochat title
|
||||
|
||||
### Parameters:
|
||||
|
||||
| Name | Type | Required |
|
||||
|----------|---------------|----------|
|
||||
|peer|[CLICK ME InputGeoChat](../types/InputGeoChat.md) | Yes|
|
||||
|title|[CLICK ME string](../types/string.md) | Yes|
|
||||
|address|[CLICK ME string](../types/string.md) | Yes|
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|peer|[CLICK ME InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat|
|
||||
|title|[CLICK ME string](../types/string.md) | Yes|The new title|
|
||||
|address|[CLICK ME string](../types/string.md) | Yes|The new address|
|
||||
|
||||
|
||||
### Return type: [geochats\_StatedMessage](../types/geochats_StatedMessage.md)
|
||||
|
@ -1,16 +1,18 @@
|
||||
---
|
||||
title: geochats.getFullChat
|
||||
description: geochats.getFullChat parameters, return type and example
|
||||
description: Get full info about a geochat
|
||||
---
|
||||
## Method: geochats.getFullChat
|
||||
[Back to methods index](index.md)
|
||||
|
||||
|
||||
Get full info about a geochat
|
||||
|
||||
### Parameters:
|
||||
|
||||
| Name | Type | Required |
|
||||
|----------|---------------|----------|
|
||||
|peer|[CLICK ME InputGeoChat](../types/InputGeoChat.md) | Yes|
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|peer|[CLICK ME InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat|
|
||||
|
||||
|
||||
### Return type: [messages\_ChatFull](../types/messages_ChatFull.md)
|
||||
|
@ -1,19 +1,21 @@
|
||||
---
|
||||
title: geochats.getHistory
|
||||
description: geochats.getHistory parameters, return type and example
|
||||
description: Get geochat history
|
||||
---
|
||||
## Method: geochats.getHistory
|
||||
[Back to methods index](index.md)
|
||||
|
||||
|
||||
Get geochat history
|
||||
|
||||
### Parameters:
|
||||
|
||||
| Name | Type | Required |
|
||||
|----------|---------------|----------|
|
||||
|peer|[CLICK ME InputGeoChat](../types/InputGeoChat.md) | Yes|
|
||||
|offset|[CLICK ME int](../types/int.md) | Yes|
|
||||
|max\_id|[CLICK ME int](../types/int.md) | Yes|
|
||||
|limit|[CLICK ME int](../types/int.md) | Yes|
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|peer|[CLICK ME InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat|
|
||||
|offset|[CLICK ME int](../types/int.md) | Yes|Offset|
|
||||
|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID|
|
||||
|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return|
|
||||
|
||||
|
||||
### Return type: [geochats\_Messages](../types/geochats_Messages.md)
|
||||
|
@ -1,18 +1,20 @@
|
||||
---
|
||||
title: geochats.getLocated
|
||||
description: geochats.getLocated parameters, return type and example
|
||||
description: Get nearby geochats
|
||||
---
|
||||
## Method: geochats.getLocated
|
||||
[Back to methods index](index.md)
|
||||
|
||||
|
||||
Get nearby geochats
|
||||
|
||||
### Parameters:
|
||||
|
||||
| Name | Type | Required |
|
||||
|----------|---------------|----------|
|
||||
|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|
|
||||
|radius|[CLICK ME int](../types/int.md) | Yes|
|
||||
|limit|[CLICK ME int](../types/int.md) | Yes|
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|Current location|
|
||||
|radius|[CLICK ME int](../types/int.md) | Yes|Radius|
|
||||
|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return|
|
||||
|
||||
|
||||
### Return type: [geochats\_Located](../types/geochats_Located.md)
|
||||
|
@ -1,17 +1,19 @@
|
||||
---
|
||||
title: geochats.getRecents
|
||||
description: geochats.getRecents parameters, return type and example
|
||||
description: Get recent geochats
|
||||
---
|
||||
## Method: geochats.getRecents
|
||||
[Back to methods index](index.md)
|
||||
|
||||
|
||||
Get recent geochats
|
||||
|
||||
### Parameters:
|
||||
|
||||
| Name | Type | Required |
|
||||
|----------|---------------|----------|
|
||||
|offset|[CLICK ME int](../types/int.md) | Yes|
|
||||
|limit|[CLICK ME int](../types/int.md) | Yes|
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|offset|[CLICK ME int](../types/int.md) | Yes|offset|
|
||||
|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return|
|
||||
|
||||
|
||||
### Return type: [geochats\_Messages](../types/geochats_Messages.md)
|
||||
|
@ -1,23 +1,25 @@
|
||||
---
|
||||
title: geochats.search
|
||||
description: geochats.search parameters, return type and example
|
||||
description: Search messages in geocha
|
||||
---
|
||||
## Method: geochats.search
|
||||
[Back to methods index](index.md)
|
||||
|
||||
|
||||
Search messages in geocha
|
||||
|
||||
### Parameters:
|
||||
|
||||
| Name | Type | Required |
|
||||
|----------|---------------|----------|
|
||||
|peer|[CLICK ME InputGeoChat](../types/InputGeoChat.md) | Yes|
|
||||
|q|[CLICK ME string](../types/string.md) | Yes|
|
||||
|filter|[CLICK ME MessagesFilter](../types/MessagesFilter.md) | Yes|
|
||||
|min\_date|[CLICK ME int](../types/int.md) | Yes|
|
||||
|max\_date|[CLICK ME int](../types/int.md) | Yes|
|
||||
|offset|[CLICK ME int](../types/int.md) | Yes|
|
||||
|max\_id|[CLICK ME int](../types/int.md) | Yes|
|
||||
|limit|[CLICK ME int](../types/int.md) | Yes|
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|peer|[CLICK ME InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat|
|
||||
|q|[CLICK ME string](../types/string.md) | Yes|The search query|
|
||||
|filter|[CLICK ME MessagesFilter](../types/MessagesFilter.md) | Yes|Search filter|
|
||||
|min\_date|[CLICK ME int](../types/int.md) | Yes|Minumum date|
|
||||
|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date|
|
||||
|offset|[CLICK ME int](../types/int.md) | Yes|Offset|
|
||||
|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID|
|
||||
|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return|
|
||||
|
||||
|
||||
### Return type: [geochats\_Messages](../types/geochats_Messages.md)
|
||||
|
@ -1,17 +1,19 @@
|
||||
---
|
||||
title: geochats.sendMedia
|
||||
description: geochats.sendMedia parameters, return type and example
|
||||
description: Send media to geochat
|
||||
---
|
||||
## Method: geochats.sendMedia
|
||||
[Back to methods index](index.md)
|
||||
|
||||
|
||||
Send media to geochat
|
||||
|
||||
### Parameters:
|
||||
|
||||
| Name | Type | Required |
|
||||
|----------|---------------|----------|
|
||||
|peer|[CLICK ME InputGeoChat](../types/InputGeoChat.md) | Yes|
|
||||
|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|peer|[CLICK ME InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat|
|
||||
|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media|
|
||||
|
||||
|
||||
### Return type: [geochats\_StatedMessage](../types/geochats_StatedMessage.md)
|
||||
|
@ -1,17 +1,19 @@
|
||||
---
|
||||
title: geochats.sendMessage
|
||||
description: geochats.sendMessage parameters, return type and example
|
||||
description: Send message to geochat
|
||||
---
|
||||
## Method: geochats.sendMessage
|
||||
[Back to methods index](index.md)
|
||||
|
||||
|
||||
Send message to geochat
|
||||
|
||||
### Parameters:
|
||||
|
||||
| Name | Type | Required |
|
||||
|----------|---------------|----------|
|
||||
|peer|[CLICK ME InputGeoChat](../types/InputGeoChat.md) | Yes|
|
||||
|message|[CLICK ME string](../types/string.md) | Yes|
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|peer|[CLICK ME InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat|
|
||||
|message|[CLICK ME string](../types/string.md) | Yes|The message|
|
||||
|
||||
|
||||
### Return type: [geochats\_StatedMessage](../types/geochats_StatedMessage.md)
|
||||
|
@ -1,17 +1,19 @@
|
||||
---
|
||||
title: geochats.setTyping
|
||||
description: geochats.setTyping parameters, return type and example
|
||||
description: Send typing notification to geochat
|
||||
---
|
||||
## Method: geochats.setTyping
|
||||
[Back to methods index](index.md)
|
||||
|
||||
|
||||
Send typing notification to geochat
|
||||
|
||||
### Parameters:
|
||||
|
||||
| Name | Type | Required |
|
||||
|----------|---------------|----------|
|
||||
|peer|[CLICK ME InputGeoChat](../types/InputGeoChat.md) | Yes|
|
||||
|typing|[CLICK ME Bool](../types/Bool.md) | Yes|
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|peer|[CLICK ME InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat|
|
||||
|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Typing or not typing|
|
||||
|
||||
|
||||
### Return type: [Bool](../types/Bool.md)
|
||||
|
@ -12,10 +12,10 @@ Get info about app updates
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|device\_model|[CLICK ME string](../types/string.md) | Yes||
|
||||
|system\_version|[CLICK ME string](../types/string.md) | Yes||
|
||||
|app\_version|[CLICK ME string](../types/string.md) | Yes||
|
||||
|lang\_code|[CLICK ME string](../types/string.md) | Yes||
|
||||
|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model|
|
||||
|system\_version|[CLICK ME string](../types/string.md) | Yes|System version|
|
||||
|app\_version|[CLICK ME string](../types/string.md) | Yes|App version|
|
||||
|lang\_code|[CLICK ME string](../types/string.md) | Yes|Langauge code|
|
||||
|
||||
|
||||
### Return type: [help\_AppUpdate](../types/help_AppUpdate.md)
|
||||
|
@ -12,7 +12,7 @@ Get invitation text
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|lang\_code|[CLICK ME string](../types/string.md) | Yes||
|
||||
|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language|
|
||||
|
||||
|
||||
### Return type: [help\_InviteText](../types/help_InviteText.md)
|
||||
|
@ -13,7 +13,7 @@ Delete chat history
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it|
|
||||
|offset|[CLICK ME int](../types/int.md) | Yes||
|
||||
|offset|[CLICK ME int](../types/int.md) | Yes|Offset|
|
||||
|
||||
|
||||
### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md)
|
||||
|
@ -1,17 +1,19 @@
|
||||
---
|
||||
title: messages.forwardMessage
|
||||
description: messages.forwardMessage parameters, return type and example
|
||||
description: Forward message
|
||||
---
|
||||
## Method: messages.forwardMessage
|
||||
[Back to methods index](index.md)
|
||||
|
||||
|
||||
Forward message
|
||||
|
||||
### Parameters:
|
||||
|
||||
| Name | Type | Required |
|
||||
|----------|---------------|----------|
|
||||
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|
|
||||
|id|[CLICK ME int](../types/int.md) | Yes|
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message|
|
||||
|id|[CLICK ME int](../types/int.md) | Yes|The message ID|
|
||||
|
||||
|
||||
### Return type: [messages\_StatedMessage](../types/messages_StatedMessage.md)
|
||||
|
@ -12,7 +12,7 @@ Forward messages
|
||||
|
||||
| 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|Peer|
|
||||
|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs|
|
||||
|
||||
|
||||
|
@ -12,7 +12,7 @@ Get all stickerpacks
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|hash|[CLICK ME string](../types/string.md) | Yes||
|
||||
|hash|[CLICK ME string](../types/string.md) | Yes|Previously fetched stickers|
|
||||
|
||||
|
||||
### Return type: [messages\_AllStickers](../types/messages_AllStickers.md)
|
||||
|
@ -12,8 +12,8 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https:
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|offset|[CLICK ME int](../types/int.md) | Yes||
|
||||
|max\_id|[CLICK ME int](../types/int.md) | Yes||
|
||||
|offset|[CLICK ME int](../types/int.md) | Yes|Offset|
|
||||
|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum ID of result to return|
|
||||
|limit|[CLICK ME int](../types/int.md) | Yes|Number of dialogs to fetch|
|
||||
|
||||
|
||||
|
@ -13,7 +13,7 @@ Get previous messages of a group
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat|
|
||||
|offset|[CLICK ME int](../types/int.md) | Yes||
|
||||
|offset|[CLICK ME int](../types/int.md) | Yes|Message ID offset|
|
||||
|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to fetch|
|
||||
|limit|[CLICK ME int](../types/int.md) | Yes|Number of messages to fetch|
|
||||
|
||||
|
@ -14,7 +14,7 @@ Mark messages as read
|
||||
|----------|---------------|----------|-------------|
|
||||
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read|
|
||||
|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read|
|
||||
|offset|[CLICK ME int](../types/int.md) | Yes||
|
||||
|offset|[CLICK ME int](../types/int.md) | Yes|Offset|
|
||||
|
||||
|
||||
### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md)
|
||||
|
@ -17,7 +17,7 @@ Search peers or messages
|
||||
|filter|[CLICK ME MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter|
|
||||
|min\_date|[CLICK ME int](../types/int.md) | Yes|Minumum date of results to fetch|
|
||||
|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of results to fetch|
|
||||
|offset|[CLICK ME int](../types/int.md) | Yes||
|
||||
|offset|[CLICK ME int](../types/int.md) | Yes|Offset |
|
||||
|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id to return|
|
||||
|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return|
|
||||
|
||||
|
@ -1,18 +1,20 @@
|
||||
---
|
||||
title: messages.sendBroadcast
|
||||
description: messages.sendBroadcast parameters, return type and example
|
||||
description: Send a message to all users in the chat list
|
||||
---
|
||||
## Method: messages.sendBroadcast
|
||||
[Back to methods index](index.md)
|
||||
|
||||
|
||||
Send a message to all users in the chat list
|
||||
|
||||
### Parameters:
|
||||
|
||||
| Name | Type | Required |
|
||||
|----------|---------------|----------|
|
||||
|contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|
|
||||
|message|[CLICK ME string](../types/string.md) | Yes|
|
||||
|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to which send the message|
|
||||
|message|[CLICK ME string](../types/string.md) | Yes|The message|
|
||||
|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media|
|
||||
|
||||
|
||||
### Return type: [messages\_StatedMessages](../types/messages_StatedMessages.md)
|
||||
|
@ -14,7 +14,7 @@ Get the profile photos of a user
|
||||
|----------|---------------|----------|-------------|
|
||||
|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user|
|
||||
|offset|[CLICK ME int](../types/int.md) | Yes|Offset|
|
||||
|max\_id|[CLICK ME int](../types/int.md) | Yes||
|
||||
|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum ID of photo to return|
|
||||
|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return|
|
||||
|
||||
|
||||
|
@ -13,7 +13,7 @@ Update the profile photo (use photos->uploadProfilePhoto to upload the photo)
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use|
|
||||
|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes||
|
||||
|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info|
|
||||
|
||||
|
||||
### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md)
|
||||
|
@ -13,9 +13,9 @@ Upload profile photo
|
||||
| Name | Type | Required | Description |
|
||||
|----------|---------------|----------|-------------|
|
||||
|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo|
|
||||
|caption|[CLICK ME string](../types/string.md) | Yes||
|
||||
|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional||
|
||||
|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes||
|
||||
|caption|[CLICK ME string](../types/string.md) | Yes|Caption type|
|
||||
|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location|
|
||||
|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info|
|
||||
|
||||
|
||||
### Return type: [photos\_Photo](../types/photos_Photo.md)
|
||||
|
@ -1,12 +1,14 @@
|
||||
---
|
||||
title: vector
|
||||
description: vector attributes, type and example
|
||||
description: Array
|
||||
---
|
||||
## Constructor: vector
|
||||
[Back to constructors index](index.md)
|
||||
|
||||
|
||||
|
||||
Array
|
||||
|
||||
|
||||
|
||||
|
||||
|
@ -12,13 +12,13 @@ Register device for push notifications
|
||||
|
||||
| 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|[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|
|
||||
|device\_model|[CLICK ME string](../types/string.md) | Yes||
|
||||
|system\_version|[CLICK ME string](../types/string.md) | Yes||
|
||||
|app\_version|[CLICK ME string](../types/string.md) | Yes||
|
||||
|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|
|
||||
|device\_model|[CLICK ME string](../types/string.md) | Yes|Device model|
|
||||
|system\_version|[CLICK ME string](../types/string.md) | Yes|System version|
|
||||
|app\_version|[CLICK ME string](../types/string.md) | Yes|App version|
|
||||
|app\_sandbox|[CLICK ME Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?|
|
||||
|lang\_code|[CLICK ME string](../types/string.md) | Yes||
|
||||
|lang\_code|[CLICK ME string](../types/string.md) | Yes|Language code|
|
||||
|
||||
|
||||
### Return type: [Bool](../types/Bool.md)
|
||||
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user