MadelineProtoDocs/old_docs/API_docs_v27/constructors/config.md

54 lines
3.3 KiB
Markdown
Raw Normal View History

2018-04-01 13:24:46 +02:00
---
title: config
2019-12-27 17:48:04 +01:00
description: Current configuration
2018-04-04 19:52:48 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2018-04-01 13:24:46 +02:00
---
2018-04-05 01:19:57 +02:00
# Constructor: config
2018-04-01 13:24:46 +02:00
[Back to constructors index](index.md)
2019-12-27 17:48:04 +01:00
Current configuration
2018-12-26 02:56:50 +01:00
2018-04-01 13:24:46 +02:00
### Attributes:
2018-12-26 02:56:50 +01:00
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
2019-12-27 17:48:04 +01:00
|date|[int](../types/int.md) | Yes|Current date at the server|
|expires|[int](../types/int.md) | Yes|Expiration date of this config: when it expires it'll have to be refetched using [help.getConfig](../methods/help.getConfig.md)|
|test\_mode|[Bool](../types/Bool.md) | Yes|Whether we're connected to the test DCs|
|this\_dc|[int](../types/int.md) | Yes|ID of the DC that returned the reply|
2018-12-26 02:56:50 +01:00
|dc\_options|Array of [DcOption](../types/DcOption.md) | Yes|DC options|
2019-12-27 17:48:04 +01:00
|chat\_size\_max|[int](../types/int.md) | Yes|Maximum member count for normal [groups](https://core.telegram.org/api/channel)|
2018-12-26 02:56:50 +01:00
|broadcast\_size\_max|[int](../types/int.md) | Yes|Broadcast size max|
2019-12-27 17:48:04 +01:00
|forwarded\_count\_max|[int](../types/int.md) | Yes|Maximum number of messages that can be forwarded at once using [messages.forwardMessages](../methods/messages.forwardMessages.md).|
|online\_update\_period\_ms|[int](../types/int.md) | Yes|The client should [update its online status](../methods/account.updateStatus.md) every N milliseconds|
|offline\_blur\_timeout\_ms|[int](../types/int.md) | Yes|Delay before offline status needs to be sent to the server|
|offline\_idle\_timeout\_ms|[int](../types/int.md) | Yes|Time without any user activity after which it should be treated offline|
|online\_cloud\_timeout\_ms|[int](../types/int.md) | Yes|If we are offline, but were online from some other client in last `online_cloud_timeout_ms` milliseconds after we had gone offline, then delay offline notification for `notify_cloud_delay_ms` milliseconds.|
|notify\_cloud\_delay\_ms|[int](../types/int.md) | Yes|If we are offline, but online from some other client then delay sending the offline notification for `notify_cloud_delay_ms` milliseconds.|
|notify\_default\_delay\_ms|[int](../types/int.md) | Yes|If some other client is online, then delay notification for `notification_default_delay_ms` milliseconds|
2018-12-26 02:56:50 +01:00
|chat\_big\_size|[int](../types/int.md) | Yes|Chat big size|
|disabled\_features|Array of [DisabledFeature](../types/DisabledFeature.md) | Yes|Disabled features|
2018-04-01 13:24:46 +02:00
### Type: [Config](../types/Config.md)
### Example:
```php
2018-04-01 13:24:46 +02:00
$config = ['_' => 'config', 'date' => int, 'expires' => int, 'test_mode' => Bool, 'this_dc' => int, 'dc_options' => [DcOption, DcOption], 'chat_size_max' => int, 'broadcast_size_max' => int, 'forwarded_count_max' => int, 'online_update_period_ms' => int, 'offline_blur_timeout_ms' => int, 'offline_idle_timeout_ms' => int, 'online_cloud_timeout_ms' => int, 'notify_cloud_delay_ms' => int, 'notify_default_delay_ms' => int, 'chat_big_size' => int, 'disabled_features' => [DisabledFeature, DisabledFeature]];
```
Or, if you're into Lua:
2018-04-01 13:24:46 +02:00
```lua
2018-04-01 13:24:46 +02:00
config={_='config', date=int, expires=int, test_mode=Bool, this_dc=int, dc_options={DcOption}, chat_size_max=int, broadcast_size_max=int, forwarded_count_max=int, online_update_period_ms=int, offline_blur_timeout_ms=int, offline_idle_timeout_ms=int, online_cloud_timeout_ms=int, notify_cloud_delay_ms=int, notify_default_delay_ms=int, chat_big_size=int, disabled_features={DisabledFeature}}
```