MadelineProtoDocs/old_docs/API_docs_v44/constructors/document.md

48 lines
1.6 KiB
Markdown
Raw Permalink Normal View History

2018-04-01 13:19:25 +02:00
---
title: document
2018-12-26 02:56:50 +01:00
description: Document
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: document
2018-04-01 13:19:25 +02:00
[Back to constructors index](index.md)
2018-12-26 02:56:50 +01:00
Document
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
|id|[long](../types/long.md) | Yes|Document ID|
|access\_hash|[long](../types/long.md) | Yes|Check sum, dependant on document ID|
2020-10-01 18:05:42 +02:00
|file\_reference|[bytes](../types/bytes.md) | Yes|[File reference](https://core.telegram.org/api/file_reference)|
2019-12-27 17:48:04 +01:00
|date|[int](../types/int.md) | Yes|Creation date|
|mime\_type|[string](../types/string.md) | Yes|MIME type|
2018-12-26 02:56:50 +01:00
|size|[int](../types/int.md) | Yes|Size|
2020-10-01 18:05:42 +02:00
|thumbs|Array of [PhotoSize](../types/PhotoSize.md) | Optional|Thumbnails|
|video\_thumbs|Array of [VideoSize](../types/VideoSize.md) | Optional|
2018-12-26 02:56:50 +01:00
|dc\_id|[int](../types/int.md) | Yes|DC ID|
|attributes|Array of [DocumentAttribute](../types/DocumentAttribute.md) | Yes|Attributes|
2018-04-01 13:19:25 +02:00
### Type: [Document](../types/Document.md)
### Example:
```php
2020-10-01 18:05:42 +02:00
$document = ['_' => 'document', 'id' => long, 'access_hash' => long, 'file_reference' => 'bytes', 'date' => int, 'mime_type' => 'string', 'size' => int, 'thumbs' => [PhotoSize, PhotoSize], 'video_thumbs' => [VideoSize, VideoSize], 'dc_id' => int, 'attributes' => [DocumentAttribute, DocumentAttribute]];
2018-04-01 13:19:25 +02:00
```
Or, if you're into Lua:
2018-04-01 13:19:25 +02:00
```lua
2020-10-01 18:05:42 +02:00
document={_='document', id=long, access_hash=long, file_reference='bytes', date=int, mime_type='string', size=int, thumbs={PhotoSize}, video_thumbs={VideoSize}, dc_id=int, attributes={DocumentAttribute}}
2018-04-01 13:19:25 +02:00
```