Deprecated API

Contents

• Interfaces
• Classes
• Enums
• Fields
• Methods
• Constructors
• Enum Constants

Interfaces

Interface	Description
org.kohsuke.github.Reactable

Classes

Class	Description
org.kohsuke.github.extras.OkHttp3Connector
org.kohsuke.github.GHCheckRunBuilder
org.kohsuke.github.GHCommit.GHAuthor	Use GitUser instead.
org.kohsuke.github.GHCommitSearchBuilder
org.kohsuke.github.GHCompare.User	use GitUser instead.
org.kohsuke.github.GHLabel.Creator
org.kohsuke.github.GHLabel.Setter
org.kohsuke.github.GHLabel.Updater
org.kohsuke.github.GHPullRequestCommitDetail.Authorship	Use GitUser
org.kohsuke.github.GHReaction

Enums

Enum	Description
org.kohsuke.github.EnforcementLevel

Fields

Field	Description
org.kohsuke.github.GHRateLimit.limit	This value should never have been made public. Use GHRateLimit.getLimit()
org.kohsuke.github.GHRateLimit.remaining	This value should never have been made public. Use GHRateLimit.getRemaining()
org.kohsuke.github.GHRateLimit.reset	This value should never have been made public. Use GHRateLimit.getResetDate()

Methods

Method	Description
org.kohsuke.github.GHApp.getInstallationById(long)
org.kohsuke.github.GHApp.getInstallationByOrganization(String)
org.kohsuke.github.GHApp.getInstallationByRepository(String, String)
org.kohsuke.github.GHApp.getInstallationByUser(String)
org.kohsuke.github.GHApp.listInstallations()
org.kohsuke.github.GHApp.setDescription(String)	Do not use this method. It was added due to incomplete understanding of Jackson binding.
org.kohsuke.github.GHApp.setEvents(List<GHEvent>)	Do not use this method. It was added due to incomplete understanding of Jackson binding.
org.kohsuke.github.GHApp.setExternalUrl(String)	Do not use this method. It was added due to incomplete understanding of Jackson binding.
org.kohsuke.github.GHApp.setInstallationsCount(long)	Do not use this method. It was added due to incomplete understanding of Jackson binding.
org.kohsuke.github.GHApp.setName(String)	Do not use this method. It was added due to incomplete understanding of Jackson binding.
org.kohsuke.github.GHApp.setOwner(GHUser)	Do not use this method. It was added due to incomplete understanding of Jackson binding.
org.kohsuke.github.GHApp.setPermissions(Map<String, String>)	Do not use this method. It was added due to incomplete understanding of Jackson binding.
org.kohsuke.github.GHAppCreateTokenBuilder.create()
org.kohsuke.github.GHAppCreateTokenBuilder.permissions(Map<String, GHPermissionType>)
org.kohsuke.github.GHAppCreateTokenBuilder.repositoryIds(List<Long>)
org.kohsuke.github.GHAppInstallation.createToken(Map<String, GHPermissionType>)	Use GHAppInstallation.createToken() instead.
org.kohsuke.github.GHAppInstallation.deleteInstallation()
org.kohsuke.github.GHAppInstallation.setAccessTokenUrl(String)	Do not use this method. It was added due to incomplete understanding of Jackson binding.
org.kohsuke.github.GHAppInstallation.setAccount(GHUser)	Do not use this method. It was added due to incomplete understanding of Jackson binding.
org.kohsuke.github.GHAppInstallation.setAppId(long)	Do not use this method. It was added due to incomplete understanding of Jackson binding.
org.kohsuke.github.GHAppInstallation.setEvents(List<GHEvent>)	Do not use this method. It was added due to incomplete understanding of Jackson binding.
org.kohsuke.github.GHAppInstallation.setPermissions(Map<String, GHPermissionType>)	Do not use this method. It was added due to incomplete understanding of Jackson binding.
org.kohsuke.github.GHAppInstallation.setRepositoriesUrl(String)	Do not use this method. It was added due to incomplete understanding of Jackson binding.
org.kohsuke.github.GHAppInstallation.setRepositorySelection(GHRepositorySelection)	Do not use this method. It was added due to incomplete understanding of Jackson binding.
org.kohsuke.github.GHAppInstallation.setRoot(GitHub)	Do not use this method. It was added due to incomplete understanding of Jackson binding.
org.kohsuke.github.GHAppInstallation.setSingleFileName(String)	Do not use this method. It was added due to incomplete understanding of Jackson binding.
org.kohsuke.github.GHAppInstallation.setTargetId(long)	Do not use this method. It was added due to incomplete understanding of Jackson binding.
org.kohsuke.github.GHAppInstallation.setTargetType(GHTargetType)	Do not use this method. It was added due to incomplete understanding of Jackson binding.
org.kohsuke.github.GHAppInstallationToken.setPermissions(Map<String, String>)	Do not use this method. It was added due to incomplete understanding of Jackson binding.
org.kohsuke.github.GHAppInstallationToken.setRepositories(List<GHRepository>)	Do not use this method. It was added due to incomplete understanding of Jackson binding.
org.kohsuke.github.GHAppInstallationToken.setRepositorySelection(GHRepositorySelection)	Do not use this method. It was added due to incomplete understanding of Jackson binding.
org.kohsuke.github.GHAppInstallationToken.setRoot(GitHub)	Do not use this method. It was added due to incomplete understanding of Jackson binding.
org.kohsuke.github.GHAppInstallationToken.setToken(String)	Do not use this method. It was added due to incomplete understanding of Jackson binding.
org.kohsuke.github.GHAsset.getHtmlUrl()	This object has no HTML URL.
org.kohsuke.github.GHAuthorization.getApiURL()	use GHObject.getUrl()
org.kohsuke.github.GHAuthorization.getHtmlUrl()	This object has no HTML URL.
org.kohsuke.github.GHBranch.enableProtection()
org.kohsuke.github.GHBranch.getProtectionUrl()
org.kohsuke.github.GHBranch.isProtected()
org.kohsuke.github.GHBranchProtection.disableSignedCommits()
org.kohsuke.github.GHBranchProtection.enabledSignedCommits()
org.kohsuke.github.GHBranchProtection.getRequiredSignatures()
org.kohsuke.github.GHCommit.getCheckRuns()
org.kohsuke.github.GHCommitComment.createReaction(ReactionContent)
org.kohsuke.github.GHCommitComment.listReactions()
org.kohsuke.github.GHCommitStatus.getHtmlUrl()	This object has no HTML URL.
org.kohsuke.github.GHContent.getContent()	Use GHContent.read()
org.kohsuke.github.GHContent.getEncodedContent()	Use GHContent.read()
org.kohsuke.github.GHDeployment.getHtmlUrl()	This object has no HTML URL.
org.kohsuke.github.GHDeploymentStatus.getHtmlUrl()	This object has no HTML URL.
org.kohsuke.github.GHDiscussion.set()
org.kohsuke.github.GHDiscussion.update()
org.kohsuke.github.GHGist.getId()	Use GHGist.getGistId() instead.
org.kohsuke.github.GHHook.getHtmlUrl()	This object has no HTML URL.
org.kohsuke.github.GHIssue.createReaction(ReactionContent)
org.kohsuke.github.GHIssue.getApiURL()	use GHObject.getUrl()
org.kohsuke.github.GHIssue.listReactions()
org.kohsuke.github.GHIssueComment.createReaction(ReactionContent)
org.kohsuke.github.GHIssueComment.getUserName()
org.kohsuke.github.GHIssueComment.listReactions()
org.kohsuke.github.GHLabel.set()
org.kohsuke.github.GHLabel.setColor(String)	use GHLabel.set() or GHLabel.update() instead
org.kohsuke.github.GHLabel.setDescription(String)	use GHLabel.set() or GHLabel.update() instead
org.kohsuke.github.GHLabel.update()
org.kohsuke.github.GHMyself.getEmails()	Use GHMyself.getEmails2()
org.kohsuke.github.GHMyself.listAllRepositories()	Use GHMyself.listRepositories()
org.kohsuke.github.GHObject.getResponseHeaderFields()
org.kohsuke.github.GHOrganization.createRepository(String, String, String, String, boolean)	Use GHOrganization.createRepository(String) that uses a builder pattern to let you control every aspect.
org.kohsuke.github.GHOrganization.createTeam(String, GHOrganization.Permission, Collection<GHRepository>)	https://developer.github.com/v3/teams/#create-team deprecates permission field use GHOrganization.createTeam(String)
org.kohsuke.github.GHOrganization.getMembers()	use GHOrganization.listMembers()
org.kohsuke.github.GHOrganization.getTeam(int)	Use GHOrganization.getTeam(long)
org.kohsuke.github.GHPerson.getGravatarId()	No longer available in the v3 API.
org.kohsuke.github.GHPerson.iterateRepositories(int)	Use GHPerson.listRepositories()
org.kohsuke.github.GHProject.getNode_id()	Use GHObject.getNodeId()
org.kohsuke.github.GHPullRequest.createReview(String, GHPullRequestReviewState, GHPullRequestReviewComment...)	Use GHPullRequest.createReview()
org.kohsuke.github.GHPullRequest.getIssueUpdatedAt()
org.kohsuke.github.GHPullRequestReview.submit(String, GHPullRequestReviewState)	Former preview method that changed when it got public. Left here for backward compatibility. Use GHPullRequestReview.submit(String, GHPullRequestReviewEvent)
org.kohsuke.github.GHPullRequestReviewComment.createReaction(ReactionContent)
org.kohsuke.github.GHPullRequestReviewComment.draft(String, String, int)	You should be using GHPullRequestReviewBuilder.comment(String, String, int)
org.kohsuke.github.GHPullRequestReviewComment.listReactions()
org.kohsuke.github.GHPullRequestReviewState.action()	This was an internal method accidentally exposed. Left here for compatibility.
org.kohsuke.github.GHReaction.getHtmlUrl()
org.kohsuke.github.GHRelease.setDraft(boolean)	Use GHRelease.update()
org.kohsuke.github.GHRepository.createCheckRun(String, String)
org.kohsuke.github.GHRepository.createContent(String, String, String)
org.kohsuke.github.GHRepository.createDeployStatus(int, GHDeploymentState)	Use getDeployment(deploymentId).createStatus(ghDeploymentState)
org.kohsuke.github.GHRepository.getCheckRuns(String)
org.kohsuke.github.GHRepository.getDeploymentStatuses(int)	Use getDeployment(id).listStatuses()
org.kohsuke.github.GHRepository.getForks()	use GHRepository.getForksCount() instead
org.kohsuke.github.GHRepository.getMasterBranch()	Renamed to GHRepository.getDefaultBranch()
org.kohsuke.github.GHRepository.getMilestones()	Use GHRepository.listMilestones(GHIssueState)
org.kohsuke.github.GHRepository.getPostCommitHooks()	Use GHRepository.getHooks() and GHRepository.createHook(String, Map, Collection, boolean)
org.kohsuke.github.GHRepository.getReleases()	use GHRepository.listReleases()
org.kohsuke.github.GHRepository.getWatchers()	use GHRepository.getWatchersCount() instead
org.kohsuke.github.GHRepository.gitHttpTransportUrl()	Typo of GHRepository.getHttpTransportUrl()
org.kohsuke.github.GHRepository.listPullRequests(GHIssueState)	Use GHRepository.queryPullRequests()
org.kohsuke.github.GHRepositoryStatistics.getContributorStats(boolean)
org.kohsuke.github.GHRequestedAction.getHtmlUrl()	This object has no HTML URL.
org.kohsuke.github.GHThread.getHtmlUrl()	This object has no HTML URL.
org.kohsuke.github.GHTreeBuilder.entry(String, String, String, String, String)	use GHTreeBuilder.add(String, String, boolean) or GHTreeBuilder.add(String, byte[], boolean) instead.
org.kohsuke.github.GHTreeBuilder.shaEntry(String, String, boolean)	use GHTreeBuilder.add(String, String, boolean) or GHTreeBuilder.add(String, byte[], boolean) instead.
org.kohsuke.github.GHTreeBuilder.textEntry(String, String, boolean)	use GHTreeBuilder.add(String, String, boolean) or GHTreeBuilder.add(String, byte[], boolean) instead.
org.kohsuke.github.GitHub.connect(String, String, String)	Use GitHub.connectUsingOAuth(String).
org.kohsuke.github.GitHub.connectToEnterprise(String, String)	Use GitHub.connectToEnterpriseWithOAuth(String, String, String)
org.kohsuke.github.GitHub.connectUsingPassword(String, String)	Use GitHub.connectUsingOAuth(String) instead.
org.kohsuke.github.GitHub.createRepository(String, String, String, boolean)	Use GitHub.createRepository(String) that uses a builder pattern to let you control every aspect.
org.kohsuke.github.GitHub.getApp()
org.kohsuke.github.GitHub.getMappingObjectReader()	DO NOT USE THIS METHOD. Provided for backward compatibility with projects that did their own jackson mapping of this project's data objects, such as Jenkins Blue Ocean.
org.kohsuke.github.GitHub.getMappingObjectWriter()	DO NOT USE THIS METHOD. Provided for backward compatibility with projects that did their own jackson mapping of this project's data objects, such as Jenkins Blue Ocean.
org.kohsuke.github.GitHub.getTeam(int)	Use GHOrganization.getTeam(long)
org.kohsuke.github.GitHub.searchCommits()
org.kohsuke.github.GitHub.setConnector(HttpConnector)	HttpConnector should not be changed. If you find yourself needing to do this, file an issue.
org.kohsuke.github.GitHubBuilder.fromEnvironment(String, String, String)	Use GitHubBuilder.fromEnvironment() to pick up standard set of environment variables, so that different clients of this library will all recognize one consistent set of coordinates.
org.kohsuke.github.PagedIterable.asList()	Use PagedIterable.toList() instead.
org.kohsuke.github.PagedIterable.asSet()	Use PagedIterable.toSet() instead.
org.kohsuke.github.Reactable.createReaction(ReactionContent)
org.kohsuke.github.Reactable.listReactions()

Constructors

Constructor	Description
org.kohsuke.github.extras.OkHttp3Connector(OkUrlFactory)
org.kohsuke.github.GHDeploymentStatusBuilder(GHRepository, int, GHDeploymentState)	Use GHDeployment.createStatus(GHDeploymentState)

Enum Constants

Enum Constant	Description
org.kohsuke.github.GHPullRequestReviewState.REQUEST_CHANGES	This was the thing when this API was in preview, but it changed when it became public. Use GHPullRequestReviewState.CHANGES_REQUESTED. Left here for compatibility.