Package org.kohsuke.github

Class GHEventPayload.Installation

java.lang.Object

org.kohsuke.github.GHEventPayload

org.kohsuke.github.GHEventPayload.Installation

Enclosing class:

GHEventPayload

public static class GHEventPayload.Installation
extends GHEventPayload

An installation has been installed, uninstalled, or its permissions have been changed.

See Also:

• installation event
• GitHub App Installation

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GHEventPayload.Installation.Repository	A special minimal implementation of a GHRepository which contains only fields from "Properties of repositories" from here

Nested classes/interfaces inherited from class org.kohsuke.github.GHEventPayload

GHEventPayload.CheckRun, GHEventPayload.CheckSuite, GHEventPayload.CommentChanges, 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.Member, GHEventPayload.Membership, GHEventPayload.Ping, GHEventPayload.ProjectsV2Item, GHEventPayload.Public, GHEventPayload.PullRequest, GHEventPayload.PullRequestReview, GHEventPayload.PullRequestReviewComment, GHEventPayload.Push, GHEventPayload.Release, GHEventPayload.Star, GHEventPayload.Status, GHEventPayload.Team, GHEventPayload.TeamAdd, GHEventPayload.WorkflowDispatch, GHEventPayload.WorkflowJob, GHEventPayload.WorkflowRun

Constructor Summary

Constructors

Constructor	Description
Installation()

Method Summary

Modifier and Type	Method	Description
List<GHEventPayload.Installation.Repository>	getRawRepositories()	Returns a list of raw, unpopulated repositories.
List<GHRepository>	getRepositories()	Gets repositories.
GitHub	getRoot()	Deprecated. For access to the GitHub instance, use a local copy instead of pulling it out of objects.

Methods inherited from class org.kohsuke.github.GHEventPayload

getAction, getInstallation, getOrganization, getRepository, getSender, setOrganization, setRepository, setSender

Methods inherited from class java.lang.Object

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

Constructor Details

Installation

public Installation()

Method Details

getRepositories

public List<GHRepository> getRepositories()

Gets repositories. For the "deleted" action please rather call getRawRepositories()

Returns:

the repositories

getRawRepositories

public List<GHEventPayload.Installation.Repository> getRawRepositories()

Returns a list of raw, unpopulated repositories. Useful when calling from within Installation event with action "deleted". You can't fetch the info for repositories of an already deleted installation.

Returns:

the list of raw Repository records

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