SpaceFolderParam
Space folder param spec. When used, the end user will be able to select a space folder from the list of available space folders. The config stores only the space folder id, not the full space folder object.
The accessible value in task is a Space folder. See the documentation of the credentials type for more info.
Attributes
PRIVATE_VISIBILITY: LiteralPROTECTED_VISIBILITY: LiteralPUBLIC_VISIBILITY: Literaladditional_info: Optionaldefault_value: Optionalhuman_name: Optionaloptional: boolshort_description: Optionalvisibility: LiteralFunctions
__init__
optional :
bool - False See default value
visibility :
Literal - public Visibility of the param, see doc on type ParamSpecVisibilty for more info
human_name :
Optional - Select a folder Human readable name of the param, showed in the interface
short_description :
Optional Description of the param, showed in the interface
build
Method call before the value is used (in task or view) to apply some transformation if needed by the ParamSpec. This does not affect the value in the database.
value :
Any Return type :
SpaceFolder get_default_value
Return type :
Any to_dto
Return type :
ParamSpecDTO to_simple_dto
Return type :
ParamSpecSimpleDTO validate
Validate the value of the param and return the modified value if needed. This method is called when the param is set in the config before saving it in the database. The returned value must be serializable in json.
value :
Any Return type :
str empty @classmethod
Return type :
ParamSpec get_additional_infos @classmethod
Return type :
Dict get_default_value_param_spec @classmethod
Return type :
SpaceFolderParam get_str_type @classmethod
Return type :
ParamSpecTypeStr load_from_dto @classmethod
spec_dto :
ParamSpecDTO Return type :
ParamSpec to_param_spec_info_specs @classmethod
Return type :
ParamSpecInfoSpecs