ParameterDescriptionProvider (javadoc 2024.12-174331 API)

All Superinterfaces:

ServerExtension, TeamCityExtension

All Known Implementing Classes:

AbstractParameterDescriptionProvider, BuildStepsParameterDescriptionProvider, DefaultParametersDescription
```
@UserImplemented(adapterClass=AbstractParameterDescriptionProvider.class)
public interface ParameterDescriptionProvider
extends ServerExtension
```
Provides a human readable description for a parameter with given name. Note that build parameter (i.e. parameter passed to a build) will have corresponding prefix (system. or env.).

Since:

5.0

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`String`	`describe(String paramName)`	Returns description of the parameter or null if this extension does not know anything about this parameter.
`default String`	`describe(String param, ParameterDescriptionProviderContext context)`	Returns description of the parameter or null if this extension does not know anything about this parameter.
`boolean`	`isVisible(String paramName)`	Called to check if parameter should be shown in the UI

- Method Detail
  - describe
```
default String describe(@NotNull
                        String param,
                        @NotNull
                        ParameterDescriptionProviderContext context)
```
    Returns description of the parameter or null if this extension does not know anything about this parameter.
    
    Parameters:
    
    paramName - name of the parameter (may have system. or env. prefix)
    
    context - provides some additional context for the parameter description rendering
    
    Returns:
    
    description or null
    
    Since:
    
    2022.03
  - describe
```
@Nullable
String describe(@NotNull
                String paramName)
```
    Returns description of the parameter or null if this extension does not know anything about this parameter.
    
    Parameters:
    
    paramName - name of the parameter (may have system. or env. prefix)
    
    Returns:
    
    description or null
    
    Since:
    
    5.0
  - isVisible
```
boolean isVisible(@NotNull
                  String paramName)
```
    Called to check if parameter should be shown in the UI
    
    Parameters:
    
    paramName - name of parameter
    
    Returns:
    
    true to let parameter be shown in the UI, false to hide parameter
    
    Since:
    
    7.0