MadelineProtoDocs/docs/API_docs/constructors/dcOption.md

47 lines
1.8 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
title: dcOption
2019-12-27 17:48:04 +01:00
description: Data centre
2018-04-04 19:52:48 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2018-04-01 13:19:25 +02:00
---
2018-04-05 01:19:57 +02:00
# Constructor: dcOption
2018-04-01 13:19:25 +02:00
[Back to constructors index](index.md)
2019-12-27 17:48:04 +01:00
Data centre
2018-12-26 02:56:50 +01:00
2018-04-01 13:19:25 +02:00
### Attributes:
2018-12-26 02:56:50 +01:00
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
2019-12-27 17:48:04 +01:00
|ipv6|[Bool](../types/Bool.md) | Optional|Whether the specified IP is an IPv6 address|
|media\_only|[Bool](../types/Bool.md) | Optional|Whether this DC should only be used to [download or upload files](https://core.telegram.org/api/files)|
|tcpo\_only|[Bool](../types/Bool.md) | Optional|Whether this DC only supports connection with [transport obfuscation](https://core.telegram.org/mtproto/mtproto-transports#transport-obfuscation)|
|cdn|[Bool](../types/Bool.md) | Optional|Whether this is a [CDN DC](https://core.telegram.org/cdn).|
|static|[Bool](../types/Bool.md) | Optional|If set, this IP should be used when connecting through a proxy|
|id|[int](../types/int.md) | Yes|DC ID|
|ip\_address|[string](../types/string.md) | Yes|IP address of DC|
2018-12-26 02:56:50 +01:00
|port|[int](../types/int.md) | Yes|Port|
2019-12-27 17:48:04 +01:00
|secret|[bytes](../types/bytes.md) | Optional|If the `tcpo_only` flag is set, specifies the secret to use when connecting using [transport obfuscation](https://core.telegram.org/mtproto/mtproto-transports#transport-obfuscation)|
2018-04-01 13:19:25 +02:00
### Type: [DcOption](../types/DcOption.md)
### Example:
```php
2018-06-29 13:59:08 +02:00
$dcOption = ['_' => 'dcOption', 'ipv6' => Bool, 'media_only' => Bool, 'tcpo_only' => Bool, 'cdn' => Bool, 'static' => Bool, 'id' => int, 'ip_address' => 'string', 'port' => int, 'secret' => 'bytes'];
2018-04-01 13:19:25 +02:00
```
Or, if you're into Lua:
2018-04-01 13:19:25 +02:00
```lua
2018-06-29 13:59:08 +02:00
dcOption={_='dcOption', ipv6=Bool, media_only=Bool, tcpo_only=Bool, cdn=Bool, static=Bool, id=int, ip_address='string', port=int, secret='bytes'}
2018-04-01 13:19:25 +02:00
```