formtask

type FileFormTaskBuilder ¶

type FileFormTaskBuilder struct {
	FormTaskBuilderBase[upload.UploadResult]
	// contains filtered or unexported fields
}

func NewFileFormTaskBuilder(id taskid.TaskImplementationID[upload.UploadResult], priority int, label string, verifier upload.UploadFileVerifier) *FileFormTaskBuilder

func (b *FileFormTaskBuilder) Build(labelOpts ...common_task.LabelOpt) common_task.Task[upload.UploadResult]

func (b *FileFormTaskBuilder) WithDependencies(dependencies []taskid.UntypedTaskReference) *FileFormTaskBuilder

func (b *FileFormTaskBuilder) WithDescription(description string) *FileFormTaskBuilder

type FormTaskBuilderBase ¶

type FormTaskBuilderBase[T any] struct {
	// contains filtered or unexported fields
}

FormTaskBuilderBase provides common functionality for form task builders

func NewFormTaskBuilderBase[T any](id taskid.TaskImplementationID[T], priority int, label string) FormTaskBuilderBase[T]

func (b *FormTaskBuilderBase[T]) SetupBaseFormField(field *inspectionmetadata.ParameterFormFieldBase)

func (b *FormTaskBuilderBase[T]) WithDependencies(dependencies []taskid.UntypedTaskReference) *FormTaskBuilderBase[T]

func (b *FormTaskBuilderBase[T]) WithDescription(description string) *FormTaskBuilderBase[T]

type TextFormDefaultValueGenerator ¶

type TextFormDefaultValueGenerator = func(ctx context.Context, previousValues []string) (string, error)

TextFormDefaultValueGenerator is a function type to generate the default value.

type TextFormHintGenerator ¶

type TextFormHintGenerator = func(ctx context.Context, value string, convertedValue any) (string, inspectionmetadata.ParameterHintType, error)

TextFormHintGenerator is a function type to generate a hint string

type TextFormReadonlyProvider ¶

type TextFormReadonlyProvider = func(ctx context.Context) (bool, error)

TextFormReadonlyProvider is a function type to compute if the field is allowed edit or not.

type TextFormSuggestionsProvider ¶

type TextFormSuggestionsProvider = func(ctx context.Context, value string, previousValues []string) ([]string, error)

TextFormSuggestionsProvider is a function to return the list of strings shown in the autocomplete. Return nil instead of emptry string array means the autocomplete is disabled for the field.

type TextFormTaskBuilder ¶

type TextFormTaskBuilder[T any] struct {
	FormTaskBuilderBase[T]
	// contains filtered or unexported fields
}

TextFormTaskBuilder is an utility to construct an instance of task for input form field. This will generate the task instance with `Build()` method call after chaining several configuration methods.

func NewTextFormTaskBuilder[T any](id taskid.TaskImplementationID[T], priority int, fieldLabel string) *TextFormTaskBuilder[T]

func (b *TextFormTaskBuilder[T]) Build(labelOpts ...common_task.LabelOpt) common_task.Task[T]

func (b *TextFormTaskBuilder[T]) WithConverter(converter TextFormValueConverter[T]) *TextFormTaskBuilder[T]

func (b *TextFormTaskBuilder[T]) WithDefaultValueConstant(defValue string, preferPrevValue bool) *TextFormTaskBuilder[T]

func (b *TextFormTaskBuilder[T]) WithDefaultValueFunc(defFunc TextFormDefaultValueGenerator) *TextFormTaskBuilder[T]

func (b *TextFormTaskBuilder[T]) WithDependencies(dependencies []taskid.UntypedTaskReference) *TextFormTaskBuilder[T]

func (b *TextFormTaskBuilder[T]) WithDescription(description string) *TextFormTaskBuilder[T]

func (b *TextFormTaskBuilder[T]) WithHintFunc(hintFunc TextFormHintGenerator) *TextFormTaskBuilder[T]

func (b *TextFormTaskBuilder[T]) WithReadonlyFunc(readonlyFunc TextFormReadonlyProvider) *TextFormTaskBuilder[T]

func (b *TextFormTaskBuilder[T]) WithSuggestionsConstant(suggestions []string) *TextFormTaskBuilder[T]

func (b *TextFormTaskBuilder[T]) WithSuggestionsFunc(suggestionsFunc TextFormSuggestionsProvider) *TextFormTaskBuilder[T]

func (b *TextFormTaskBuilder[T]) WithValidatingTiming(timing inspectionmetadata.TextFormValidationTimingType) *TextFormTaskBuilder[T]

func (b *TextFormTaskBuilder[T]) WithValidator(validator TextFormValidator) *TextFormTaskBuilder[T]

type TextFormValidator ¶

type TextFormValidator = func(ctx context.Context, value string) (string, error)

TextFormValidator is a function to check if the given value is valid or not. Returns "" as the result when it has no error, otherwise the returned value is used as an error message on frontend. Returning an error as the 2nd returning value is only when the validator detects an unrecoverble error.

type TextFormValueConverter ¶

type TextFormValueConverter[T any] = func(ctx context.Context, value string) (T, error)

TextFormValueConverter is a function type to convert the given string value to another type stored in the variable set.