MadelineProto/docs/TD_docs/methods/getOption.md

74 lines
1.5 KiB
Markdown
Raw Normal View History

---
title: getOption
description: Returns value of an option by its name. See list of available options on https: core.telegram.org/tdlib/options
---
## Method: getOption
[Back to methods index](index.md)
2017-06-06 18:39:21 +02:00
YOU CANNOT USE THIS METHOD IN MADELINEPROTO
Returns value of an option by its name. See list of available options on https: core.telegram.org/tdlib/options
### Params:
| Name | Type | Required | Description |
2017-08-20 11:05:56 +02:00
|----------|---------------|----------|-------------|
|name|[string](../types/string.md) | Yes|Name of the option|
### Return type: [OptionValue](../types/OptionValue.md)
### Example:
```
$MadelineProto = new \danog\MadelineProto\API();
if (isset($token)) { // Login as a bot
2017-06-19 18:56:47 +02:00
$MadelineProto->bot_login($token);
}
if (isset($number)) { // Login as a user
$sentCode = $MadelineProto->phone_login($number);
echo 'Enter the code you received: ';
$code = '';
for ($x = 0; $x < $sentCode['type']['length']; $x++) {
$code .= fgetc(STDIN);
}
$MadelineProto->complete_phone_login($code);
}
2017-07-23 16:33:46 +02:00
$OptionValue = $MadelineProto->getOption(['name' => 'string', ]);
```
2017-07-24 01:32:29 +02:00
Or, if you're using the [PWRTelegram HTTP API](https://pwrtelegram.xyz):
2017-07-23 16:11:02 +02:00
### As a bot:
POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline`
Parameters:
* method - getOption
2017-07-23 16:40:54 +02:00
* params - `{"name": "string", }`
2017-07-23 16:11:02 +02:00
2017-07-23 16:34:36 +02:00
2017-07-23 16:11:02 +02:00
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/getOption`
Parameters:
name - Json encoded string
2017-07-23 16:40:54 +02:00
2017-07-23 16:11:02 +02:00
2017-08-20 19:09:52 +02:00
Or, if you're into Lua:
```
2017-07-23 16:33:46 +02:00
OptionValue = getOption({name='string', })
```