Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
danog committed Mar 6, 2020
1 parent 75d0676 commit 1e19673
Show file tree
Hide file tree
Showing 41 changed files with 573 additions and 18 deletions.
40 changes: 40 additions & 0 deletions docs/API_docs/constructors/accessPointRule.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: accessPointRule
description: Access point rule
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Constructor: accessPointRule
[Back to constructors index](index.md)



Access point rule

### Attributes:

| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|phone\_prefix\_rules|[string](../types/string.md) | Yes|Phone prefix rules|
|dc\_id|[int](../types/int.md) | Yes|DC ID|
|ips|Array of [IpPort](../types/IpPort.md) | Yes|Ips|



### Type: [AccessPointRule](../types/AccessPointRule.md)


### Example:

```php
$accessPointRule = ['_' => 'accessPointRule', 'phone_prefix_rules' => 'string', 'dc_id' => int, 'ips' => [IpPort, IpPort]];
```


Or, if you're into Lua:

```lua
accessPointRule={_='accessPointRule', phone_prefix_rules='string', dc_id=int, ips={IpPort}}

```


37 changes: 37 additions & 0 deletions docs/API_docs/constructors/bankCardOpenUrl.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: bankCardOpenUrl
description: bankCardOpenUrl attributes, type and example
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Constructor: bankCardOpenUrl
[Back to constructors index](index.md)



### Attributes:

| Name | Type | Required |
|----------|---------------|----------|
|url|[string](../types/string.md) | Yes|
|name|[string](../types/string.md) | Yes|



### Type: [BankCardOpenUrl](../types/BankCardOpenUrl.md)


### Example:

```php
$bankCardOpenUrl = ['_' => 'bankCardOpenUrl', 'url' => 'string', 'name' => 'string'];
```


Or, if you're into Lua:

```lua
bankCardOpenUrl={_='bankCardOpenUrl', url='string', name='string'}

```


41 changes: 41 additions & 0 deletions docs/API_docs/constructors/help.configSimple.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
title: help.configSimple
description: Config simple
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
redirect_from: /API_docs/constructors/help_configSimple.html
---
# Constructor: help.configSimple
[Back to constructors index](index.md)



Config simple

### Attributes:

| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|date|[int](../types/int.md) | Yes|Date|
|expires|[int](../types/int.md) | Yes|Expires|
|rules|Array of [AccessPointRule](../types/AccessPointRule.md) | Yes|Rules|



### Type: [help.ConfigSimple](../types/help.ConfigSimple.md)


### Example:

```php
$help.configSimple = ['_' => 'help.configSimple', 'date' => int, 'expires' => int, 'rules' => [AccessPointRule, AccessPointRule]];
```


Or, if you're into Lua:

```lua
help.configSimple={_='help.configSimple', date=int, expires=int, rules={AccessPointRule}}

```


27 changes: 24 additions & 3 deletions docs/API_docs/constructors/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
# Constructors
[Back to API documentation index](..)

***
<br><br>[$accessPointRule](../constructors/accessPointRule.md) = \['phone_prefix_rules' => [string](../types/string.md), 'dc_id' => [int](../types/int.md), 'ips' => \[[IpPort](../types/IpPort.md)\], \];<a name="accessPointRule"></a>

***
<br><br>[$account.authorizationForm](../constructors/account.authorizationForm.md) = \['required_types' => \[[SecureRequiredType](../types/SecureRequiredType.md)\], 'values' => \[[SecureValue](../types/SecureValue.md)\], 'errors' => \[[SecureValueError](../types/SecureValueError.md)\], 'users' => \[[User](../types/User.md)\], 'privacy_policy_url' => [string](../types/string.md), \];<a name="account.authorizationForm"></a>

Expand Down Expand Up @@ -108,6 +111,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
***
<br><br>[$autoDownloadSettings](../constructors/autoDownloadSettings.md) = \['disabled' => [Bool](../types/Bool.md), 'video_preload_large' => [Bool](../types/Bool.md), 'audio_preload_next' => [Bool](../types/Bool.md), 'phonecalls_less_data' => [Bool](../types/Bool.md), 'photo_size_max' => [int](../types/int.md), 'video_size_max' => [int](../types/int.md), 'file_size_max' => [int](../types/int.md), 'video_upload_maxbitrate' => [int](../types/int.md), \];<a name="autoDownloadSettings"></a>

***
<br><br>[$bankCardOpenUrl](../constructors/bankCardOpenUrl.md) = \['url' => [string](../types/string.md), 'name' => [string](../types/string.md), \];<a name="bankCardOpenUrl"></a>

***
<br><br>[$baseThemeArctic](../constructors/baseThemeArctic.md) = \[\];<a name="baseThemeArctic"></a>

Expand Down Expand Up @@ -615,6 +621,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
***
<br><br>[$help.appUpdate](../constructors/help.appUpdate.md) = \['can_not_skip' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'version' => [string](../types/string.md), 'text' => [string](../types/string.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], 'document' => [Document](../types/Document.md), 'url' => [string](../types/string.md), \];<a name="help.appUpdate"></a>

***
<br><br>[$help.configSimple](../constructors/help.configSimple.md) = \['date' => [int](../types/int.md), 'expires' => [int](../types/int.md), 'rules' => \[[AccessPointRule](../types/AccessPointRule.md)\], \];<a name="help.configSimple"></a>

***
<br><br>[$help.deepLinkInfo](../constructors/help.deepLinkInfo.md) = \['update_app' => [Bool](../types/Bool.md), 'message' => [string](../types/string.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], \];<a name="help.deepLinkInfo"></a>

Expand Down Expand Up @@ -1122,6 +1131,12 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
***
<br><br>[$invoice](../constructors/invoice.md) = \['test' => [Bool](../types/Bool.md), 'name_requested' => [Bool](../types/Bool.md), 'phone_requested' => [Bool](../types/Bool.md), 'email_requested' => [Bool](../types/Bool.md), 'shipping_address_requested' => [Bool](../types/Bool.md), 'flexible' => [Bool](../types/Bool.md), 'phone_to_provider' => [Bool](../types/Bool.md), 'email_to_provider' => [Bool](../types/Bool.md), 'currency' => [string](../types/string.md), 'prices' => \[[LabeledPrice](../types/LabeledPrice.md)\], \];<a name="invoice"></a>

***
<br><br>[$ipPort](../constructors/ipPort.md) = \['ipv4' => [int](../types/int.md), 'port' => [int](../types/int.md), \];<a name="ipPort"></a>

***
<br><br>[$ipPortSecret](../constructors/ipPortSecret.md) = \['ipv4' => [int](../types/int.md), 'port' => [int](../types/int.md), 'secret' => [bytes](../types/bytes.md), \];<a name="ipPortSecret"></a>

***
<br><br>[$jsonArray](../constructors/jsonArray.md) = \['value' => \[[JSONValue](../types/JSONValue.md)\], \];<a name="jsonArray"></a>

Expand Down Expand Up @@ -1272,6 +1287,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
***
<br><br>[$messageEmpty](../constructors/messageEmpty.md) = \['id' => [int](../types/int.md), \];<a name="messageEmpty"></a>

***
<br><br>[$messageEntityBankCard](../constructors/messageEntityBankCard.md) = \['offset' => [int](../types/int.md), 'length' => [int](../types/int.md), \];<a name="messageEntityBankCard"></a>

***
<br><br>[$messageEntityBlockquote](../constructors/messageEntityBlockquote.md) = \['offset' => [int](../types/int.md), 'length' => [int](../types/int.md), \];<a name="messageEntityBlockquote"></a>

Expand Down Expand Up @@ -1521,9 +1539,6 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
***
<br><br>[$notifyUsers](../constructors/notifyUsers.md) = \[\];<a name="notifyUsers"></a>

***
<br><br>[$null](../constructors/null.md) = \[\];<a name="null"></a>

***
<br><br>[$page](../constructors/page.md) = \['part' => [Bool](../types/Bool.md), 'rtl' => [Bool](../types/Bool.md), 'v2' => [Bool](../types/Bool.md), 'url' => [string](../types/string.md), 'blocks' => \[[PageBlock](../types/PageBlock.md)\], 'photos' => \[[Photo](../types/Photo.md)\], 'documents' => \[[Document](../types/Document.md)\], \];<a name="page"></a>

Expand Down Expand Up @@ -1653,6 +1668,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
***
<br><br>[$paymentSavedCredentialsCard](../constructors/paymentSavedCredentialsCard.md) = \['id' => [string](../types/string.md), 'title' => [string](../types/string.md), \];<a name="paymentSavedCredentialsCard"></a>

***
<br><br>[$payments.bankCardData](../constructors/payments.bankCardData.md) = \['title' => [string](../types/string.md), 'open_urls' => \[[BankCardOpenUrl](../types/BankCardOpenUrl.md)\], \];<a name="payments.bankCardData"></a>

***
<br><br>[$payments.paymentForm](../constructors/payments.paymentForm.md) = \['can_save_credentials' => [Bool](../types/Bool.md), 'password_missing' => [Bool](../types/Bool.md), 'bot_id' => [int](../types/int.md), 'invoice' => [Invoice](../types/Invoice.md), 'provider_id' => [int](../types/int.md), 'url' => [string](../types/string.md), 'native_provider' => [string](../types/string.md), 'native_params' => [DataJSON](../types/DataJSON.md), 'saved_info' => [PaymentRequestedInfo](../types/PaymentRequestedInfo.md), 'saved_credentials' => [PaymentSavedCredentials](../types/PaymentSavedCredentials.md), 'users' => \[[User](../types/User.md)\], \];<a name="payments.paymentForm"></a>

Expand Down Expand Up @@ -1683,6 +1701,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
***
<br><br>[$peerNotifySettings](../constructors/peerNotifySettings.md) = \['show_previews' => [Bool](../types/Bool.md), 'silent' => [Bool](../types/Bool.md), 'mute_until' => [int](../types/int.md), 'sound' => [string](../types/string.md), \];<a name="peerNotifySettings"></a>

***
<br><br>[$peerSelfLocated](../constructors/peerSelfLocated.md) = \['expires' => [int](../types/int.md), \];<a name="peerSelfLocated"></a>

***
<br><br>[$peerSettings](../constructors/peerSettings.md) = \['report_spam' => [Bool](../types/Bool.md), 'add_contact' => [Bool](../types/Bool.md), 'block_contact' => [Bool](../types/Bool.md), 'share_contact' => [Bool](../types/Bool.md), 'need_contacts_exception' => [Bool](../types/Bool.md), 'report_geo' => [Bool](../types/Bool.md), \];<a name="peerSettings"></a>

Expand Down
39 changes: 39 additions & 0 deletions docs/API_docs/constructors/ipPort.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: ipPort
description: Ip port
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Constructor: ipPort
[Back to constructors index](index.md)



Ip port

### Attributes:

| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|ipv4|[int](../types/int.md) | Yes|Ipv4|
|port|[int](../types/int.md) | Yes|Port|



### Type: [IpPort](../types/IpPort.md)


### Example:

```php
$ipPort = ['_' => 'ipPort', 'ipv4' => int, 'port' => int];
```


Or, if you're into Lua:

```lua
ipPort={_='ipPort', ipv4=int, port=int}

```


40 changes: 40 additions & 0 deletions docs/API_docs/constructors/ipPortSecret.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: ipPortSecret
description: Ip port secret
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Constructor: ipPortSecret
[Back to constructors index](index.md)



Ip port secret

### Attributes:

| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|ipv4|[int](../types/int.md) | Yes|Ipv4|
|port|[int](../types/int.md) | Yes|Port|
|secret|[bytes](../types/bytes.md) | Yes|Secret|



### Type: [IpPort](../types/IpPort.md)


### Example:

```php
$ipPortSecret = ['_' => 'ipPortSecret', 'ipv4' => int, 'port' => int, 'secret' => 'bytes'];
```


Or, if you're into Lua:

```lua
ipPortSecret={_='ipPortSecret', ipv4=int, port=int, secret='bytes'}

```


37 changes: 37 additions & 0 deletions docs/API_docs/constructors/messageEntityBankCard.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: messageEntityBankCard
description: messageEntityBankCard attributes, type and example
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Constructor: messageEntityBankCard
[Back to constructors index](index.md)



### Attributes:

| Name | Type | Required |
|----------|---------------|----------|
|offset|[int](../types/int.md) | Yes|
|length|[int](../types/int.md) | Yes|



### Type: [MessageEntity](../types/MessageEntity.md)


### Example:

```php
$messageEntityBankCard = ['_' => 'messageEntityBankCard', 'offset' => int, 'length' => int];
```


Or, if you're into Lua:

```lua
messageEntityBankCard={_='messageEntityBankCard', offset=int, length=int}

```


38 changes: 38 additions & 0 deletions docs/API_docs/constructors/payments.bankCardData.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: payments.bankCardData
description: payments.bankCardData attributes, type and example
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
redirect_from: /API_docs/constructors/payments_bankCardData.html
---
# Constructor: payments.bankCardData
[Back to constructors index](index.md)



### Attributes:

| Name | Type | Required |
|----------|---------------|----------|
|title|[string](../types/string.md) | Yes|
|open\_urls|Array of [BankCardOpenUrl](../types/BankCardOpenUrl.md) | Yes|



### Type: [payments.BankCardData](../types/payments.BankCardData.md)


### Example:

```php
$payments.bankCardData = ['_' => 'payments.bankCardData', 'title' => 'string', 'open_urls' => [BankCardOpenUrl, BankCardOpenUrl]];
```


Or, if you're into Lua:

```lua
payments.bankCardData={_='payments.bankCardData', title='string', open_urls={BankCardOpenUrl}}

```


36 changes: 36 additions & 0 deletions docs/API_docs/constructors/peerSelfLocated.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
title: peerSelfLocated
description: peerSelfLocated attributes, type and example
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Constructor: peerSelfLocated
[Back to constructors index](index.md)



### Attributes:

| Name | Type | Required |
|----------|---------------|----------|
|expires|[int](../types/int.md) | Yes|



### Type: [PeerLocated](../types/PeerLocated.md)


### Example:

```php
$peerSelfLocated = ['_' => 'peerSelfLocated', 'expires' => int];
```


Or, if you're into Lua:

```lua
peerSelfLocated={_='peerSelfLocated', expires=int}

```


Loading

0 comments on commit 1e19673

Please sign in to comment.