2017-03-11 19:54:51 +01:00
|
|
|
---
|
|
|
|
title: updateFileGenerationStart
|
|
|
|
description: File generation process need to be started by the client
|
|
|
|
---
|
|
|
|
## Constructor: updateFileGenerationStart
|
|
|
|
[Back to constructors index](index.md)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
File generation process need to be started by the client
|
|
|
|
|
|
|
|
### Attributes:
|
|
|
|
|
|
|
|
| Name | Type | Required | Description |
|
|
|
|
|----------|:-------------:|:--------:|------------:|
|
|
|
|
|generation\_id|[long](../types/long.md) | Yes|Unique identifier for the generation process|
|
|
|
|
|original\_path|[string](../types/string.md) | Yes|Path to a file from which new file is generated, may be empty|
|
|
|
|
|destination\_path|[string](../types/string.md) | Yes|Path to a file which should be created and to which new file should be generated|
|
|
|
|
|conversion|[string](../types/string.md) | Yes|String specifying conversion applied to the original file|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### Type: [Update](../types/Update.md)
|
|
|
|
|
|
|
|
|
|
|
|
### Example:
|
|
|
|
|
|
|
|
```
|
2017-07-23 16:33:46 +02:00
|
|
|
$updateFileGenerationStart = ['_' => 'updateFileGenerationStart', 'generation_id' => long, 'original_path' => 'string', 'destination_path' => 'string', 'conversion' => 'string'];
|
2017-03-11 19:54:51 +01:00
|
|
|
```
|
|
|
|
|
2017-07-23 16:11:02 +02:00
|
|
|
[PWRTelegram](https://pwrtelegram.xyz) json-encoded version:
|
|
|
|
|
|
|
|
```
|
2017-07-23 16:33:46 +02:00
|
|
|
{"_": "updateFileGenerationStart", "generation_id": long, "original_path": "string", "destination_path": "string", "conversion": "string"}
|
2017-07-23 16:11:02 +02:00
|
|
|
```
|
|
|
|
|
|
|
|
|
2017-03-11 19:54:51 +01:00
|
|
|
Or, if you're into Lua:
|
|
|
|
|
|
|
|
|
|
|
|
```
|
2017-07-23 16:33:46 +02:00
|
|
|
updateFileGenerationStart={_='updateFileGenerationStart', generation_id=long, original_path='string', destination_path='string', conversion='string'}
|
2017-03-11 19:54:51 +01:00
|
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|