MadelineProto/docs/API_docs/constructors/document.md

51 lines
1.4 KiB
Markdown
Raw Normal View History

2016-12-20 13:15:22 +01:00
---
title: document
2016-12-20 13:32:11 +01:00
description: document attributes, type and example
2016-12-20 13:15:22 +01:00
---
## Constructor: document
2016-12-20 13:15:22 +01:00
[Back to constructors index](index.md)
### Attributes:
| Name | Type | Required |
2017-08-20 11:05:56 +02:00
|----------|---------------|----------|
|id|[long](../types/long.md) | Yes|
|access\_hash|[long](../types/long.md) | Yes|
|date|[int](../types/int.md) | Yes|
|mime\_type|[string](../types/string.md) | Yes|
|size|[int](../types/int.md) | Yes|
|thumb|[PhotoSize](../types/PhotoSize.md) | Optional|
|dc\_id|[int](../types/int.md) | Yes|
|version|[int](../types/int.md) | Yes|
|attributes|Array of [DocumentAttribute](../types/DocumentAttribute.md) | Yes|
2016-12-19 18:56:05 +01:00
### Type: [Document](../types/Document.md)
### Example:
```
2017-07-23 16:33:46 +02:00
$document = ['_' => 'document', 'id' => long, 'access_hash' => long, 'date' => int, 'mime_type' => 'string', 'size' => int, 'thumb' => PhotoSize, 'dc_id' => int, 'version' => int, 'attributes' => [DocumentAttribute]];
```
2017-07-23 16:11:02 +02:00
[PWRTelegram](https://pwrtelegram.xyz) json-encoded version:
```
2017-07-23 16:33:46 +02:00
{"_": "document", "id": long, "access_hash": long, "date": int, "mime_type": "string", "size": int, "thumb": PhotoSize, "dc_id": int, "version": int, "attributes": [DocumentAttribute]}
2017-07-23 16:11:02 +02:00
```
Or, if you're into Lua:
```
2017-07-23 16:33:46 +02:00
document={_='document', id=long, access_hash=long, date=int, mime_type='string', size=int, thumb=PhotoSize, dc_id=int, version=int, attributes={DocumentAttribute}}
```