MadelineProtoDocs/docs/API_docs/constructors/dcOption.md

53 lines
1.5 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
title: dcOption
2018-12-26 02:56:50 +01:00
description: DC option
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)
2018-12-26 02:56:50 +01:00
DC option
2018-04-01 13:19:25 +02:00
### Attributes:
2018-12-26 02:56:50 +01:00
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|ipv6|[Bool](../types/Bool.md) | Optional|Ipv6?|
|media\_only|[Bool](../types/Bool.md) | Optional|Media only?|
|tcpo\_only|[Bool](../types/Bool.md) | Optional|Tcpo only?|
|cdn|[Bool](../types/Bool.md) | Optional|Cdn?|
|static|[Bool](../types/Bool.md) | Optional|Static?|
|id|[int](../types/int.md) | Yes|ID|
|ip\_address|[string](../types/string.md) | Yes|Ip address|
|port|[int](../types/int.md) | Yes|Port|
|secret|[bytes](../types/bytes.md) | Optional|Secret|
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
```
[PWRTelegram](https://pwrtelegram.xyz) json-encoded version:
```
2018-06-29 13:59:08 +02:00
{"_": "dcOption", "ipv6": Bool, "media_only": Bool, "tcpo_only": Bool, "cdn": Bool, "static": Bool, "id": int, "ip_address": "string", "port": int, "secret": {"_": "bytes", "bytes":"base64 encoded 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
```