MadelineProtoDocs/old_docs/API_docs_v2/methods/help.getInviteText.md

47 lines
1.2 KiB
Markdown
Raw Permalink Normal View History

2018-04-01 13:19:25 +02:00
---
2020-06-16 17:50:25 +02:00
title: help.getInviteText
description: Returns localized text of a text message with an invitation.
2018-04-04 19:52:48 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2020-06-16 17:50:25 +02:00
redirect_from: /API_docs/methods/help_getInviteText.html
2018-04-01 13:19:25 +02:00
---
2020-06-16 17:50:25 +02:00
# Method: help.getInviteText
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
2020-06-16 17:50:25 +02:00
Returns localized text of a text message with an invitation.
2018-04-01 13:19:25 +02:00
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
2020-06-16 17:50:25 +02:00
|lang\_code|[string](../types/string.md) | | Yes|
2018-04-01 13:19:25 +02:00
2020-06-16 17:50:25 +02:00
### Return type: [help.InviteText](../types/help.InviteText.md)
2018-04-01 13:19:25 +02:00
2019-06-30 15:12:21 +02:00
### Can bots use this method: **NO**
2018-04-01 13:19:25 +02:00
2019-06-02 13:49:54 +02:00
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
2018-04-01 13:19:25 +02:00
```php
2018-04-01 13:19:25 +02:00
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
}
include 'madeline.php';
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$MadelineProto->start();
2020-06-16 17:50:25 +02:00
$help.InviteText = $MadelineProto->help->getInviteText(['lang_code' => 'string', ]);
2018-04-01 13:19:25 +02:00
```
Or, if you're into Lua:
```lua
2020-06-16 17:50:25 +02:00
help.InviteText = help.getInviteText({lang_code='string', })
2018-04-01 13:19:25 +02:00
```