public interface

RepositoryHookDetails

com.atlassian.bitbucket.hook.repository.RepositoryHookDetails

Class Overview

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

Summary

Public Methods
@Nullable String getConfigFormKey()
@Nullable String getDescription()
@Nonnull String getKey()
@Nonnull String getName()
@Nonnull Set<ScopeType> getSupportedScopes()
@Nonnull RepositoryHookType getType()
@Nonnull String getVersion()

Public Methods

@Nullable public String getConfigFormKey ()

Returns
  • The optional configuration form key if provided, or null

@Nullable public String getDescription ()

Returns
  • The optional description of this hook, or null

@Nonnull public String getKey ()

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

@Nonnull public String getName ()

Returns
  • The human-readable name of this hook

@Nonnull public Set<ScopeType> getSupportedScopes ()

Returns
  • The scopes at which this hook can be configured

@Nonnull public RepositoryHookType getType ()

Returns
  • The type of hook (ie pre or post receive)

@Nonnull public String getVersion ()

Returns
  • The version of this hook (ie the plugin version)