GitHubError (GitHub Integration Plugin 0.7.0 API)

java.lang.Object
- com.github.kostyasha.github.integration.generic.errors.GitHubError

All Implemented Interfaces:

ExtensionPoint

Direct Known Subclasses:

GitHubHookRegistrationError, GitHubRepoProviderError
```
public abstract class GitHubError
extends Object
implements ExtensionPoint
```
Custom errors that participate in list of GitHubErrorsAction. index.groovy

Author:

Kanstantsin Shautsou

Nested Class Summary
- Nested classes/interfaces inherited from interface hudson.ExtensionPoint
  ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors
Constructor Description

GitHubError(String description)

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getHtmlDescription()`	Raw displayed html content as description.
`abstract String`	`getTitle()`
`boolean`	`isVisible()`	Whether to show error on job page.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GitHubError

public GitHubError(@NonNull
                   String description)

Method Detail
- getTitle
```
@NonNull
public abstract String getTitle()
```
- isVisible
```
public boolean isVisible()
```
  Whether to show error on job page. Useful when error visibility will be known after delay.
- getHtmlDescription
```
@NonNull
public String getHtmlDescription()
```
  Raw displayed html content as description.