Package org.kohsuke.github

Class GHHook

java.lang.Object

org.kohsuke.github.GHObject

org.kohsuke.github.GHHook

public abstract class GHHook
extends GHObject

The type GHHook.

Author:

Kohsuke Kawaguchi

Field Summary

Fields inherited from class org.kohsuke.github.GHObject

responseHeaderFields

Constructor Summary

Constructors

Constructor	Description
GHHook()

Method Summary

Modifier and Type	Method	Description
void	delete()	Deletes this hook.
Map<String,String>	getConfig()	Gets config.
EnumSet<GHEvent>	getEvents()	Gets events.
URL	getHtmlUrl()	Deprecated. This object has no HTML URL.
String	getName()	Gets name.
GitHub	getRoot()	Deprecated. For access to the GitHub instance, use a local copy instead of pulling it out of objects.
boolean	isActive()	Is active boolean.
void	ping()	Ping.

Methods inherited from class org.kohsuke.github.GHObject

getCreatedAt, getId, getNodeId, getResponseHeaderFields, getUpdatedAt, getUrl, setResponseHeaderFields, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

GHHook

public GHHook()

Method Details

getName

public String getName()

Gets name.

Returns:

the name

getEvents

public EnumSet<GHEvent> getEvents()

Gets events.

Returns:

the events

isActive

public boolean isActive()

Is active boolean.

Returns:

the boolean

getConfig

public Map<String,String> getConfig()

Gets config.

Returns:

the config

ping

public void ping()
          throws IOException

Ping.

Throws:

IOException - the io exception

See Also:

• Ping hook

delete

public void delete()
            throws IOException

Deletes this hook.

Throws:

IOException - the io exception

getHtmlUrl

public URL getHtmlUrl()

Deprecated.

This object has no HTML URL.

Gets the html url.

Specified by:

getHtmlUrl in class GHObject

Returns:

the html url

getRoot

@Deprecated
public GitHub getRoot()

Deprecated.

For access to the GitHub instance, use a local copy instead of pulling it out of objects.

Get the root GitHub instance for this object.

Returns:

the root GitHub instance