com.atlassian.bitbucket.hook.repository

Interface RepositoryHookDetails

public interface RepositoryHookDetails

Contains the static (ie non-repository specific) details of a repository hook.

Method Summary

Modifier and Type	Method and Description
String	getConfigFormKey()
String	getDescription()
String	getKey()
String	getName()
Set<ScopeType>	getSupportedScopes()
RepositoryHookType	getType()
String	getVersion()

Method Detail

getKey

@Nonnull
String getKey()

Returns:

The unique key of this hook, which will be in the form group-id.plugin-id:module-key

getName

@Nonnull
String getName()

Returns:

The human-readable name of this hook

getType

@Nonnull
RepositoryHookType getType()

Returns:

The type of hook (ie pre or post receive)

getDescription

@Nullable
String getDescription()

Returns:

The optional description of this hook, or null

getVersion

@Nonnull
String getVersion()

Returns:

The version of this hook (ie the plugin version)

getConfigFormKey

@Nullable
String getConfigFormKey()

Returns:

The optional configuration form key if provided, or null

getSupportedScopes

@Nonnull
Set<ScopeType> getSupportedScopes()

Returns:

The scopes at which this hook can be configured

Since:

5.2