1
0
mirror of https://github.com/danog/MadelineProto.git synced 2024-12-15 15:26:54 +01:00
MadelineProto/docs/TD_docs/constructors/webPage.md

63 lines
3.2 KiB
Markdown
Raw Normal View History

---
title: webPage
description: Describes web page preview
---
## Constructor: webPage
[Back to constructors index](index.md)
Describes web page preview
### Attributes:
| Name | Type | Required | Description |
2017-08-20 11:05:56 +02:00
|----------|---------------|----------|-------------|
|url|[string](../types/string.md) | Yes|Original URL of link|
|display\_url|[string](../types/string.md) | Yes|URL to display|
|type|[string](../types/string.md) | Yes|Type of web page: article, photo, audio, video, document, profile, app or something other|
|site\_name|[string](../types/string.md) | Yes|Short name of the site (i.e. Google Docs or App Store)|
|title|[string](../types/string.md) | Yes|Title of the content|
|description|[string](../types/string.md) | Yes|Description of the content|
|photo|[photo](../types/photo.md) | Yes|Image representing the content, nullable|
|embed\_url|[string](../types/string.md) | Yes|Url to show embedded preview|
|embed\_type|[string](../types/string.md) | Yes|MIME type of embedded preview, i.e. text/html or video/mp4|
|embed\_width|[int](../types/int.md) | Yes|Width of embedded preview|
|embed\_height|[int](../types/int.md) | Yes|Height of embedded preview|
|duration|[int](../types/int.md) | Yes|Duration of the content|
|author|[string](../types/string.md) | Yes|Author of the content|
|animation|[animation](../types/animation.md) | Yes|Preview as Animation if available, nullable|
|audio|[audio](../types/audio.md) | Yes|Preview as Audio if available, nullable|
|document|[document](../types/document.md) | Yes|Preview as Document if available (currently only for small pdf files and zip archives), nullable|
|sticker|[sticker](../types/sticker.md) | Yes|Preview as Sticker for small .webp files if available, nullable|
|video|[video](../types/video.md) | Yes|Preview as Video if available, nullable|
|voice|[voice](../types/voice.md) | Yes|Preview as Voice if available, nullable|
### Type: [WebPage](../types/WebPage.md)
### Example:
```
2017-07-23 16:33:46 +02:00
$webPage = ['_' => 'webPage', 'url' => 'string', 'display_url' => 'string', 'type' => 'string', 'site_name' => 'string', 'title' => 'string', 'description' => 'string', 'photo' => photo, 'embed_url' => 'string', 'embed_type' => 'string', 'embed_width' => int, 'embed_height' => int, 'duration' => int, 'author' => 'string', 'animation' => animation, 'audio' => audio, 'document' => document, 'sticker' => sticker, 'video' => video, 'voice' => voice];
```
2017-07-23 16:11:02 +02:00
[PWRTelegram](https://pwrtelegram.xyz) json-encoded version:
```
2017-07-23 16:33:46 +02:00
{"_": "webPage", "url": "string", "display_url": "string", "type": "string", "site_name": "string", "title": "string", "description": "string", "photo": photo, "embed_url": "string", "embed_type": "string", "embed_width": int, "embed_height": int, "duration": int, "author": "string", "animation": animation, "audio": audio, "document": document, "sticker": sticker, "video": video, "voice": voice}
2017-07-23 16:11:02 +02:00
```
Or, if you're into Lua:
```
2017-07-23 16:33:46 +02:00
webPage={_='webPage', url='string', display_url='string', type='string', site_name='string', title='string', description='string', photo=photo, embed_url='string', embed_type='string', embed_width=int, embed_height=int, duration=int, author='string', animation=animation, audio=audio, document=document, sticker=sticker, video=video, voice=voice}
```