-
Deprecated Interfaces
-
Deprecated ClassesClassDescriptionSwitch to
GitHubAbuseLimitHandler.UseOkHttpGitHubConnectorinstead.This class depends on an unsupported version of OkHttp. Switch toOkHttpGitHubConnector.UseGitUserinstead.useGitUserinstead.UseGitUserSwitch toGitHubRateLimitHandleror even better provideRateLimitCheckers.
-
Deprecated Enums
-
Deprecated FieldsFieldDescriptionThis field should never have been made public. Use
GHRateLimit.getLimit()This field should never have been made public. UseGHRateLimit.getRemaining()This field should never have been made public. UseGHRateLimit.getResetDate()
-
Deprecated MethodsMethodDescriptionorg.kohsuke.github.authorization.ImmutableAuthorizationProvider.fromLoginAndPassword
(String, String) Login with password credentials are no longer supported by GitHubThis method is present only to provide backward compatibility with other deprecated components.Do not use this method. It was added due to incomplete understanding of Jackson binding.Do not use this method. It was added due to incomplete understanding of Jackson binding.Do not use this method. It was added due to incomplete understanding of Jackson binding.Do not use this method. It was added due to incomplete understanding of Jackson binding.Do not use this method. It was added due to incomplete understanding of Jackson binding.Do not use this method. It was added due to incomplete understanding of Jackson binding.Do not use this method. It was added due to incomplete understanding of Jackson binding.UseGHAppInstallation.createToken()instead.This method cannot work on aGHAppInstallationretrieved fromGHApp.listInstallations()(for example), except when resorting to unsupported hacks involvingGHAppInstallation.setRoot(GitHub)to switch from an application client to an installation client. This method will be removed. You should instead use an installation client (with an installation token, not a JWT), retrieve aGHAuthenticatedAppInstallationfromGitHub.getInstallation(), then callGHAuthenticatedAppInstallation.listRepositories().Do not use this method. It was added due to incomplete understanding of Jackson binding.Do not use this method. It was added due to incomplete understanding of Jackson binding.Do not use this method. It was added due to incomplete understanding of Jackson binding.Do not use this method. It was added due to incomplete understanding of Jackson binding.Do not use this method. It was added due to incomplete understanding of Jackson binding.Do not use this method. It was added due to incomplete understanding of Jackson binding.Do not use this method. It was added due to incomplete understanding of Jackson binding.Do not use this method. It was added due to incomplete understanding of Jackson binding.Do not use this method. It was added due to incomplete understanding of Jackson binding.Do not use this method. It was added due to incomplete understanding of Jackson binding.Do not use this method. It was added due to incomplete understanding of Jackson binding.Do not use this method. It was added due to incomplete understanding of Jackson binding.Do not use this method. It was added due to incomplete understanding of Jackson binding.Do not use this method. It was added due to incomplete understanding of Jackson binding.Do not use this method. It was added due to incomplete understanding of Jackson binding.Do not use this method. It was added due to incomplete understanding of Jackson binding.This object has no HTML URL.This object has no HTML URL.This object has no HTML URL.UseGHCommit.listFiles()instead.This object has no HTML URL.UseGHContent.read()UseGHContent.read()UseGHRepositoryBuilder.isTemplate(boolean)method insteadThis object has no HTML URL.until preview feature has graduated to stableuntil preview feature has graduated to stableuntil preview feature has graduated to stableuntil preview feature has graduated to stableuntil preview feature has graduated to stableuntil preview feature has graduated to stableThis object has no HTML URL.until preview feature has graduated to stableTarget url is deprecated in favor ofgetLogUrluntil preview feature has graduated to stableuntil preview feature has graduated to stableuntil preview feature has graduated to stableuntil preview feature has graduated to stableTarget url is deprecated in favor oflogUrlDo not use this method. It was added due to incomplete understanding of Jackson binding.Do not use this method. It was added due to incomplete understanding of Jackson binding.Do not use this method. It was added due to incomplete understanding of Jackson binding.Do not use this method. It was added due to incomplete understanding of Jackson binding.Do not use this method. It was added due to incomplete understanding of Jackson binding.Do not use this method. It was added due to incomplete understanding of Jackson binding.Do not use this method. It was added due to incomplete understanding of Jackson binding.Do not use this method. It was added due to incomplete understanding of Jackson binding.Do not use this method. It was added due to incomplete understanding of Jackson binding.Do not use this method. It was added due to incomplete understanding of Jackson binding.Do not use this method. It was added due to incomplete understanding of Jackson binding.Do not use this method. It was added due to incomplete understanding of Jackson binding.Do not use this method. It was added due to incomplete understanding of Jackson binding.Do not use this method. It was added due to incomplete understanding of Jackson binding.Do not use this method. It was added due to incomplete understanding of Jackson binding.Do not use this method. It was added due to incomplete understanding of Jackson binding.Do not use this method. It was added due to incomplete understanding of Jackson binding.Do not use this method. It was added due to incomplete understanding of Jackson binding.Do not use this method. It was added due to incomplete understanding of Jackson binding.UseGHGist.getGistId()instead.This object has no HTML URL.useGHLabel.set()orGHLabel.update()insteaduseGHLabel.set()orGHLabel.update()insteadUseGHOrganization.createRepository(String)that uses a builder pattern to let you control every aspect.UseGHOrganization.createRepository(String)that uses a builder pattern to let you control every aspect.UseGHOrganization.createTeam(String)that uses a builder pattern to let you control every aspect.https://developer.github.com/v3/teams/#create-team deprecates permission field useGHOrganization.createTeam(String)https://developer.github.com/v3/teams/#create-team deprecates permission field useGHOrganization.createTeam(String)UseGHOrganization.createTeam(String)that uses a builder pattern to let you control every aspect.No longer available in the v3 API.Former preview method that changed when it got public. Left here for backward compatibility. UseGHPullRequestReview.submit(String, GHPullRequestReviewEvent)You should be usingGHPullRequestReviewBuilder.comment(String, String, int)This was an internal method accidentally exposed. Left here for compatibility.this API is no longer supported by GitHub, keeping it as is for old versions of GitHub EnterpriseThis should be the default behavior ofGHRelease.getAssets()in a future release. This method is introduced in addition to enable a transition to using cached asset information while keeping the existing logic in place for backwards compatibility.The behavior of this method will change in a future release. It will then provide cached assets as provided byGHRelease.assets(). UseGHRelease.listAssets()instead to fetch up-to-date information of assets.Do not use this method. It was added due to incomplete understanding of Jackson binding.#addCollaborators(Collection, GHOrganization.RolePermission)#addCollaborators(GHOrganization.RolePermission, GHUser)UsegetDeployment(deploymentId).createStatus(ghDeploymentState)UsegetDeployment(id).listStatuses()useGHRepository.getForksCount()insteadRenamed toGHRepository.getDefaultBranch()useGHRepository.getWatchersCount()insteaduseGHRepositorySearchBuilder.fork(GHFork)instead.useGHRepositorySearchBuilder.fork(GHFork)instead.This object has no HTML URL.This object has no HTML URL.Use with caution. Login with password is not a preferred method.UseGitHub.connectUsingOAuth(String)instead.UseGitHub.createRepository(String)that uses a builder pattern to let you control every aspect.HttpConnector has been replaced by GitHubConnector which is generally not useful outside of this library. If you are using this method, file an issue describing your use case.Do not use this method. It was added due to misunderstanding of the type of parameter. UseGitHub.getRepositoryById(long)insteadimplement aRateLimitCheckerand add it viaGitHubBuilder.withRateLimitChecker(RateLimitChecker).implement aRateLimitCheckerand add it viaGitHubBuilder.withRateLimitChecker(RateLimitChecker).HttpConnector should not be changed. If you find yourself needing to do this, file an issue.UseGitHubBuilder.fromEnvironment()to pick up standard set of environment variables, so that different clients of this library will all recognize one consistent set of coordinates.UseGitHubBuilder.fromEnvironment()to pick up standard set of environment variables, so that different clients of this library will all recognize one consistent set of coordinates.UsePagedIterable.toList()instead.UsePagedIterable.toSet()instead.
-
Deprecated Constructors
-
Deprecated Enum ConstantsEnum ConstantDescriptionThis was the thing when this API was in preview, but it changed when it became public. Use
GHPullRequestReviewState.CHANGES_REQUESTED. Left here for compatibility.
GitHubConnectorinstead.