com.jcabi.github

Interface Hooks

@Immutable
public interface Hooks

Github hooks.

Since:

0.8

Version:

$Id: 201c2c4c3217fe9e63960003e92410209ae3509b $

Author:

Paul Polishchuk (ppol@ua.fm)

See Also:

Hooks API

Method Summary

Modifier and Type	Method and Description
Hook	create(String name, Map<String,String> config, boolean active) Create new hook.
Hook	get(int number) Get specific hook by number.
Iterable<Hook>	iterate() Iterate them all.
void	remove(int number) Remove hook by ID.
Repo	repo() Owner of them.

Method Detail

repo

Repo repo()

Owner of them.

Returns:

Repo

iterate

Iterable<Hook> iterate()

Iterate them all.

Returns:

Iterator of hooks

See Also:

List

remove

void remove(int number)
     throws IOException

Remove hook by ID.

Parameters:

number - ID of the label to remove

Throws:

IOException - If there is any I/O problem

See Also:

List

get

Hook get(int number)

Get specific hook by number.

Parameters:

number - Hook number

Returns:

Hook

See Also:

Get single hook

create

Hook create(String name,
            Map<String,String> config,
            boolean active)
     throws IOException

Create new hook.

Parameters:

name - Hook name

config - Configuration for the hook

active - Actually trigger the hook when the events occur?

Returns:

Hook

Throws:

IOException - If there is any I/O problem

See Also:

Create a hook

To do:

#1106:30min Add support for the "events" parameter of the hook creation API. It's a list of strings of the names of events which the hook will be triggered for.