Module org.kohsuke.github.api

Package org.kohsuke.github

Class GHEventInfo

java.lang.Object

org.kohsuke.github.GHEventInfo

public class GHEventInfo
extends Object

Represents an event.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GHEventInfo.GHEventRepository	Inside the event JSON model, GitHub uses a slightly different format.

Constructor Summary

Constructors

Constructor	Description
GHEventInfo()	Create default GHEventInfo instance

Method Summary

Modifier and Type	Method	Description
GHUser	getActor()	Gets actor.
String	getActorLogin()	Gets actor login.
Instant	getCreatedAt()	Gets created at.
long	getId()	Gets id.
GHOrganization	getOrganization()	Gets organization.
<T extends GHEventPayload> T	getPayload(Class<T> type)	Retrieves the payload.
GHRepository	getRepository()	Gets repository.
GHEvent	getType()	Gets type.

Methods inherited from class java.lang.Object

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

Constructor Details

GHEventInfo

public GHEventInfo()

Create default GHEventInfo instance

Method Details

getActor

public GHUser getActor()
                throws IOException

Gets actor.

Returns:

the GHUser actor for this event.

Throws:

IOException - on error

getActorLogin

public String getActorLogin()

Gets actor login.

Returns:

the login of the actor.

getCreatedAt

@WithBridgeMethods(value=java.util.Date.class,
                   adapterMethod="instantToDate")
public Instant getCreatedAt()

Gets created at.

Returns:

the created at

getId

public long getId()

Gets id.

Returns:

the id

getOrganization

public GHOrganization getOrganization()
                               throws IOException

Gets organization.

Returns:

the organization

Throws:

IOException - the io exception

getPayload

public <T extends GHEventPayload> T getPayload(Class<T> type)
                                        throws IOException

Retrieves the payload.

Type Parameters:

T - the type parameter

Parameters:

type - Specify one of the GHEventPayload subtype that defines a type-safe access to the payload. This must match the event type.

Returns:

parsed event payload

Throws:

IOException - if payload cannot be parsed

getRepository

public GHRepository getRepository()
                           throws IOException

Gets repository.

Returns:

Repository where the change was made.

Throws:

IOException - on error

getType

public GHEvent getType()

Gets type.

Returns:

the type