Table of Contents

Class ResQueServeUIParameterAttribute

Namespace
XENBIT.ResQueServe.Abstractions.Attributes
Assembly
RQS.Abstractions.dll

Marks a property as a parameter for a ResQueServe task.

[AttributeUsage(AttributeTargets.Property)]
public class ResQueServeUIParameterAttribute : Attribute
Inheritance
ResQueServeUIParameterAttribute
Inherited Members

Constructors

ResQueServeUIParameterAttribute(string, string?)

Initializes a new instance of the ResQueServeUIParameterAttribute class.

public ResQueServeUIParameterAttribute(string displayName, string? description)

Parameters

displayName string

The name of the parameter to display.

description string

The description of the parameter.

Properties

DefaultValue

Gets or sets the default value for this parameter.

public object? DefaultValue { get; set; }

Property Value

object

Description

Gets the description of the parameter.

public string? Description { get; }

Property Value

string

DisplayName

Gets the name of the parameter.

public string DisplayName { get; }

Property Value

string

IsRequired

Gets or sets whether this parameter is required.

public bool IsRequired { get; set; }

Property Value

bool

IsSecret

Gets or sets whether this parameter is a secret (e.g. bearer token). Value will never be displayed on frontend.

public bool IsSecret { get; set; }

Property Value

bool

Order

Gets or sets the order in which this parameter should be displayed in a UI.

public int Order { get; set; }

Property Value

int

ValidationPattern

Gets or sets a validation pattern (regex) for string parameters.

public string? ValidationPattern { get; set; }

Property Value

string