NotifierDescriptor (javadoc 2024.12-174331 API)

All Superinterfaces:

ServerExtension, TeamCityExtension

All Known Subinterfaces:

BuildTypeNotifierDescriptor, UserNotifierDescriptor
```
public interface NotifierDescriptor
extends ServerExtension
```
Generic descriptor for Notificator Implementations should extends either UserNotifierDescriptor or BuildTypeNotifierDescriptor (or both) to indicate what settings they support

Since:

2020.1

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`getDisplayName()`	Get notifier display name that will be used in UI
`String`	`getEditParametersUrl()`	Get url to page for editing notifier parameters If null is returned, default UI for editing parameters returned from [getParameters] will be rendered
`Map<String,ControlDescription>`	`getParameters()`	Get avaiable notifier parameters
`String`	`getType()`	Get type of connected notifier
`Collection<InvalidProperty>`	`validate(Map<String,String> parameters)`	Validate input parameters before they are persisted If there are no errors in input parameters, empty collection should be returned

- Method Detail
  - getType
```
@NotNull
String getType()
```
    Get type of connected notifier
    
    Returns:
    
    notifier type
  - getDisplayName
```
@NotNull
String getDisplayName()
```
    Get notifier display name that will be used in UI
    
    Returns:
    
    notifier display name
  - getParameters
```
@NotNull
Map<String,ControlDescription> getParameters()
```
    Get avaiable notifier parameters
    
    Returns:
    
    map {parameter name} -> {parameter control description}
  - validate
```
@NotNull
Collection<InvalidProperty> validate(@NotNull
                                     Map<String,String> parameters)
```
    Validate input parameters before they are persisted If there are no errors in input parameters, empty collection should be returned
    
    Parameters:
    
    parameters - input parameters
    
    Returns:
    
    validation errors. Returned collection should be empty if there are no errors in input parameters
  - getEditParametersUrl
```
@Nullable
String getEditParametersUrl()
```
    Get url to page for editing notifier parameters If null is returned, default UI for editing parameters returned from [getParameters] will be rendered
    
    Returns:
    
    url to page for editing notifier parameters or null if default UI for editing parameteres should be rendered