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.Discussion, GHEventPayload.DiscussionComment, GHEventPayload.Fork, GHEventPayload.Installation, GHEventPayload.InstallationRepositories, GHEventPayload.Issue, GHEventPayload.IssueComment, GHEventPayload.Label, GHEventPayload.Ping, GHEventPayload.ProjectsV2Item, GHEventPayload.Public, GHEventPayload.PullRequest, GHEventPayload.PullRequestReview, GHEventPayload.PullRequestReviewComment, GHEventPayload.Push, GHEventPayload.Release, GHEventPayload.Repository, GHEventPayload.Star, GHEventPayload.Status, GHEventPayload.WorkflowDispatch, GHEventPayload.WorkflowJob, GHEventPayload.WorkflowRun
public abstract class GHEventPayload extends Object
Base type for types used in databinding of the event payload.
See Also:

  • Method Details

    • getAction

      public String getAction()
      Gets the action for the triggered event. Most but not all webhook payloads contain an action property that contains the specific activity that triggered the event.
      Returns:
      event action

    • 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

      @Deprecated public void setSender(GHUser sender)
      Deprecated.
      Do not use this method. It was added due to incomplete understanding of Jackson binding.
      Sets sender.
      Parameters:
      sender - the sender

    • getRepository

      public GHRepository getRepository()
      Gets repository.
      Returns:
      the repository

    • setRepository

      @Deprecated public void setRepository(GHRepository repository)
      Deprecated.
      Do not use this method. It was added due to incomplete understanding of Jackson binding.
      Sets repository.
      Parameters:
      repository - the repository

    • getOrganization

      public GHOrganization getOrganization()
      Gets organization.
      Returns:
      the organization

    • setOrganization

      @Deprecated public void setOrganization(GHOrganization organization)
      Deprecated.
      Do not use this method. It was added due to incomplete understanding of Jackson binding.
      Sets organization.
      Parameters:
      organization - the organization

    • getInstallation

      public GHAppInstallation getInstallation()
      Gets installation.
      Returns:
      the installation

    • 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