Package org.kohsuke.github

Class GHEventPayload

java.lang.Object

org.kohsuke.github.GHEventPayload

Direct Known Subclasses:

GHEventPayload.CheckRun, GHEventPayload.CheckSuite, GHEventPayload.CommitComment, GHEventPayload.Create, GHEventPayload.Delete, GHEventPayload.Deployment, GHEventPayload.DeploymentStatus, GHEventPayload.Fork, GHEventPayload.Installation, GHEventPayload.InstallationRepositories, GHEventPayload.Issue, GHEventPayload.IssueComment, GHEventPayload.Ping, GHEventPayload.Public, GHEventPayload.PullRequest, GHEventPayload.PullRequestReview, GHEventPayload.PullRequestReviewComment, GHEventPayload.Push, GHEventPayload.Release, GHEventPayload.Repository, GHEventPayload.Status

public abstract class GHEventPayload
extends Object

Base type for types used in databinding of the event payload.

See Also:

GitHub#parseEventPayload(Reader, Class), GHEventInfo#getPayload(Class)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GHEventPayload.CheckRun	A check run event has been created, rerequested, completed, or has a requested_action.
static class	GHEventPayload.CheckSuite	A check suite event has been requested, rerequested or completed.
static class	GHEventPayload.CommitComment	A comment was added to a commit
static class	GHEventPayload.Create	A repository, branch, or tag was created
static class	GHEventPayload.Delete	A branch, or tag was deleted
static class	GHEventPayload.Deployment	A deployment
static class	GHEventPayload.DeploymentStatus	A deployment
static class	GHEventPayload.Fork	A user forked a repository
static class	GHEventPayload.Installation	An installation has been installed, uninstalled, or its permissions have been changed.
static class	GHEventPayload.InstallationRepositories	A repository has been added or removed from an installation.
static class	GHEventPayload.Issue	A Issue has been assigned, unassigned, labeled, unlabeled, opened, edited, milestoned, demilestoned, closed, or reopened.
static class	GHEventPayload.IssueComment	A comment was added to an issue
static class	GHEventPayload.Ping	A ping.
static class	GHEventPayload.Public	A repository was made public.
static class	GHEventPayload.PullRequest	A pull request status has changed.
static class	GHEventPayload.PullRequestReview	A review was added to a pull request
static class	GHEventPayload.PullRequestReviewComment	A review comment was added to a pull request
static class	GHEventPayload.Push	A commit was pushed.
static class	GHEventPayload.Release	A release was added to the repo
static class	GHEventPayload.Repository	A repository was created, deleted, made public, or made private.
static class	GHEventPayload.Status	A git commit status was changed.

Field Summary

Fields

Modifier and Type	Field	Description
protected GitHub	root

Method Summary

Modifier and Type	Method	Description
GHUser	getSender()	Gets the sender or null if accessed via the events API.
void	setSender(GHUser sender)	Sets sender.

Methods inherited from class java.lang.Object

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

Field Detail

root

protected GitHub root

Method Detail

getSender

public GHUser getSender()

Gets the sender or null if accessed via the events API.

Returns:

the sender or null if accessed via the events API.

setSender

public void setSender(GHUser sender)

Sets sender.

Parameters:

sender - the sender