flamenco/web/manager-api/docs/AvailableJobSetting.md
Sybren A. Stüvel e990603311 OAPI: Add generated JavaScript API client
This adds a JS client for the OAPI interface, and introduces the SocketIO
stuff into Flamenco Manager itself.

To build & run:
- in `web/manager-api` run `npm install`
- in `web/manager-api` run `npm link`
- in `web/app` run `npm install`
- in `web/app` run `npm link flamenco-manager`
- in `web/app` run `yarn serve`

This may not be a complete list, but at least some of those steps are
necessary.
2022-04-01 16:40:54 +02:00

20 lines
1.6 KiB
Markdown

# flamencoManager.AvailableJobSetting
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**key** | **String** | Identifier for the setting, must be unique within the job type. |
**type** | [**AvailableJobSettingType**](AvailableJobSettingType.md) | |
**subtype** | [**AvailableJobSettingSubtype**](AvailableJobSettingSubtype.md) | | [optional]
**choices** | **[String]** | When given, limit the valid values to these choices. Only usable with string type. | [optional]
**propargs** | **Object** | Any extra arguments to the bpy.props.SomeProperty() call used to create this property. | [optional]
**description** | **Object** | The description/tooltip shown in the user interface. | [optional]
**_default** | **Object** | The default value shown to the user when determining this setting. | [optional]
**_eval** | **String** | Python expression to be evaluated in order to determine the default value for this setting. | [optional]
**visible** | **Boolean** | Whether to show this setting in the UI of a job submitter (like a Blender add-on). Set to `false` when it is an internal setting that shouldn't be shown to end users. | [optional] [default to true]
**required** | **Boolean** | Whether to immediately reject a job definition, of this type, without this particular setting. | [optional] [default to false]
**editable** | **Boolean** | Whether to allow editing this setting after the job has been submitted. Would imply deleting all existing tasks for this job, and recompiling it. | [optional] [default to false]