Deprecated API

Contents

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

Deprecated Interfaces

Interface	Description
org.kohsuke.github.HttpConnector	Use GitHubConnector instead.

Deprecated Classes

Class	Description
org.kohsuke.github.AbuseLimitHandler	Switch to GitHubAbuseLimitHandler.
org.kohsuke.github.authorization.OrgAppInstallationAuthorizationProvider
org.kohsuke.github.extras.okhttp3.ObsoleteUrlFactory
org.kohsuke.github.extras.okhttp3.OkHttpConnector	Use OkHttpGitHubConnector instead.
org.kohsuke.github.extras.OkHttp3Connector
org.kohsuke.github.extras.OkHttpConnector	This class depends on an unsupported version of OkHttp. Switch to OkHttpGitHubConnector.
org.kohsuke.github.GHCommit.GHAuthor	Use GitUser instead.
org.kohsuke.github.GHCompare.User	use GitUser instead.
org.kohsuke.github.GHPullRequestCommitDetail.Authorship	Use GitUser
org.kohsuke.github.RateLimitHandler	Switch to GitHubRateLimitHandler or even better provide RateLimitCheckers.

Deprecated Enums

Enum	Description
org.kohsuke.github.EnforcementLevel
org.kohsuke.github.GHRepositorySearchBuilder.Fork	Kept for backward compatibility. Use GHFork instead.

Deprecated Fields

Field	Description
org.kohsuke.github.AbuseLimitHandler.FAIL
org.kohsuke.github.AbuseLimitHandler.WAIT
org.kohsuke.github.GHRateLimit.limit	This field should never have been made public. Use GHRateLimit.getLimit()
org.kohsuke.github.GHRateLimit.remaining	This field should never have been made public. Use GHRateLimit.getRemaining()
org.kohsuke.github.GHRateLimit.reset	This field should never have been made public. Use GHRateLimit.getResetDate()
org.kohsuke.github.RateLimitHandler.FAIL
org.kohsuke.github.RateLimitHandler.WAIT

Deprecated Methods

Method	Description
org.kohsuke.github.AbuseLimitHandler.onError(IOException, HttpURLConnection)
org.kohsuke.github.authorization.ImmutableAuthorizationProvider.fromLoginAndPassword(String, String)	Login with password credentials are no longer supported by GitHub
org.kohsuke.github.connector.GitHubConnectorResponse.toHttpURLConnection()	This method is present only to provide backward compatibility with other deprecated components.
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.GHAppInstallation.createToken(Map<String, GHPermissionType>)	Use GHAppInstallation.createToken() instead.
org.kohsuke.github.GHAppInstallation.listRepositories()	This method cannot work on a GHAppInstallation retrieved from GHApp.listInstallations() (for example), except when resorting to unsupported hacks involving GHAppInstallation.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 a GHAuthenticatedAppInstallation from GitHub.getInstallation(), then call GHAuthenticatedAppInstallation.listRepositories().
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.GHArtifact.getHtmlUrl()	This object has no HTML URL.
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(EnforcementLevel, Collection<String>)
org.kohsuke.github.GHCommit.getFiles()	Use GHCommit.listFiles() instead.
org.kohsuke.github.GHCommitStatus.getHtmlUrl()	This object has no HTML URL.
org.kohsuke.github.GHCompare.wrap(GHRepository)
org.kohsuke.github.GHContent.getContent()	Use GHContent.read()
org.kohsuke.github.GHContent.getEncodedContent()	Use GHContent.read()
org.kohsuke.github.GHContentSearchBuilder.fork(String)	use GHContentSearchBuilder.fork(GHFork).
org.kohsuke.github.GHCreateRepositoryBuilder.templateRepository(boolean)	Use GHRepositoryBuilder.isTemplate(boolean) method instead
org.kohsuke.github.GHDeployKey.wrap(GHRepository)
org.kohsuke.github.GHDeployment.getHtmlUrl()	This object has no HTML URL.
org.kohsuke.github.GHDeployment.getOriginalEnvironment()	until preview feature has graduated to stable
org.kohsuke.github.GHDeployment.isProductionEnvironment()	until preview feature has graduated to stable
org.kohsuke.github.GHDeployment.isTransientEnvironment()	until preview feature has graduated to stable
org.kohsuke.github.GHDeploymentBuilder.productionEnvironment(boolean)	until preview feature has graduated to stable
org.kohsuke.github.GHDeploymentBuilder.transientEnvironment(boolean)	until preview feature has graduated to stable
org.kohsuke.github.GHDeploymentStatus.getEnvironmentUrl()	until preview feature has graduated to stable
org.kohsuke.github.GHDeploymentStatus.getHtmlUrl()	This object has no HTML URL.
org.kohsuke.github.GHDeploymentStatus.getLogUrl()	until preview feature has graduated to stable
org.kohsuke.github.GHDeploymentStatus.getTargetUrl()	Target url is deprecated in favor of getLogUrl
org.kohsuke.github.GHDeploymentStatus.wrap(GHRepository)
org.kohsuke.github.GHDeploymentStatusBuilder.autoInactive(boolean)	until preview feature has graduated to stable
org.kohsuke.github.GHDeploymentStatusBuilder.environment(String)	until preview feature has graduated to stable
org.kohsuke.github.GHDeploymentStatusBuilder.environmentUrl(String)	until preview feature has graduated to stable
org.kohsuke.github.GHDeploymentStatusBuilder.logUrl(String)	until preview feature has graduated to stable
org.kohsuke.github.GHDeploymentStatusBuilder.targetUrl(String)	Target url is deprecated in favor of logUrl
org.kohsuke.github.GHEventPayload.CheckRun.setCheckRun(GHCheckRun)	Do not use this method. It was added due to incomplete understanding of Jackson binding.
org.kohsuke.github.GHEventPayload.CheckRun.setRequestedAction(GHRequestedAction)	Do not use this method. It was added due to incomplete understanding of Jackson binding.
org.kohsuke.github.GHEventPayload.CommitComment.setComment(GHCommitComment)	Do not use this method. It was added due to incomplete understanding of Jackson binding.
org.kohsuke.github.GHEventPayload.Deployment.setDeployment(GHDeployment)	Do not use this method. It was added due to incomplete understanding of Jackson binding.
org.kohsuke.github.GHEventPayload.DeploymentStatus.setDeployment(GHDeployment)	Do not use this method. It was added due to incomplete understanding of Jackson binding.
org.kohsuke.github.GHEventPayload.DeploymentStatus.setDeploymentStatus(GHDeploymentStatus)	Do not use this method. It was added due to incomplete understanding of Jackson binding.
org.kohsuke.github.GHEventPayload.Fork.setForkee(GHRepository)	Do not use this method. It was added due to incomplete understanding of Jackson binding.
org.kohsuke.github.GHEventPayload.Issue.setIssue(GHIssue)	Do not use this method. It was added due to incomplete understanding of Jackson binding.
org.kohsuke.github.GHEventPayload.IssueComment.setComment(GHIssueComment)	Do not use this method. It was added due to incomplete understanding of Jackson binding.
org.kohsuke.github.GHEventPayload.IssueComment.setIssue(GHIssue)	Do not use this method. It was added due to incomplete understanding of Jackson binding.
org.kohsuke.github.GHEventPayload.Push.Pusher.setEmail(String)	Do not use this method. It was added due to incomplete understanding of Jackson binding.
org.kohsuke.github.GHEventPayload.Push.Pusher.setName(String)	Do not use this method. It was added due to incomplete understanding of Jackson binding.
org.kohsuke.github.GHEventPayload.Push.setPusher(GHEventPayload.Push.Pusher)	Do not use this method. It was added due to incomplete understanding of Jackson binding.
org.kohsuke.github.GHEventPayload.Release.setRelease(GHRelease)	Do not use this method. It was added due to incomplete understanding of Jackson binding.
org.kohsuke.github.GHEventPayload.setOrganization(GHOrganization)	Do not use this method. It was added due to incomplete understanding of Jackson binding.
org.kohsuke.github.GHEventPayload.setRepository(GHRepository)	Do not use this method. It was added due to incomplete understanding of Jackson binding.
org.kohsuke.github.GHEventPayload.setSender(GHUser)	Do not use this method. It was added due to incomplete understanding of Jackson binding.
org.kohsuke.github.GHEventPayload.Status.setCommit(GHCommit)	Do not use this method. It was added due to incomplete understanding of Jackson binding.
org.kohsuke.github.GHEventPayload.Status.setState(GHCommitState)	Do not use this method. It was added due to incomplete understanding of Jackson binding.
org.kohsuke.github.GHGist.getId()	Use GHGist.getGistId() instead.
org.kohsuke.github.GHHook.getHtmlUrl()	This object has no HTML URL.
org.kohsuke.github.GHIssue.getApiURL()	use GHObject.getUrl()
org.kohsuke.github.GHIssueComment.getUserName()
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.GHMilestone.wrap(GHRepository)
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.createRepository(String, String, String, GHTeam, boolean)	Use GHOrganization.createRepository(String) that uses a builder pattern to let you control every aspect.
org.kohsuke.github.GHOrganization.createTeam(String, Collection<GHRepository>)	Use GHOrganization.createTeam(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.createTeam(String, GHOrganization.Permission, GHRepository...)	https://developer.github.com/v3/teams/#create-team deprecates permission field use GHOrganization.createTeam(String)
org.kohsuke.github.GHOrganization.createTeam(String, GHRepository...)	Use GHOrganization.createTeam(String) that uses a builder pattern to let you control every aspect.
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.GHProject.wrap(GHRepository)
org.kohsuke.github.GHProject.wrap(GitHub)
org.kohsuke.github.GHProjectCard.wrap(GHProjectColumn)
org.kohsuke.github.GHProjectCard.wrap(GitHub)
org.kohsuke.github.GHProjectColumn.wrap(GHProject)
org.kohsuke.github.GHProjectColumn.wrap(GitHub)
org.kohsuke.github.GHPullRequest.createReview(String, GHPullRequestReviewState, List<GHPullRequestReviewComment>)	Use GHPullRequest.createReview()
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.draft(String, String, int)	You should be using GHPullRequestReviewBuilder.comment(String, String, int)
org.kohsuke.github.GHPullRequestReviewState.action()	This was an internal method accidentally exposed. Left here for compatibility.
org.kohsuke.github.GHReaction.delete()	this API is no longer supported by GitHub, keeping it as is for old versions of GitHub Enterprise
org.kohsuke.github.GHReaction.getHtmlUrl()
org.kohsuke.github.GHRelease.assets()	This should be the default behavior of GHRelease.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.
org.kohsuke.github.GHRelease.getAssets()	The behavior of this method will change in a future release. It will then provide cached assets as provided by GHRelease.assets(). Use GHRelease.listAssets() instead to fetch up-to-date information of assets.
org.kohsuke.github.GHRelease.setDraft(boolean)	Use GHRelease.update()
org.kohsuke.github.GHRelease.setOwner(GHRepository)	Do not use this method. It was added due to incomplete understanding of Jackson binding.
org.kohsuke.github.GHRepository.addCollaborators(Collection<GHUser>, GHOrganization.Permission)	#addCollaborators(Collection, GHOrganization.RolePermission)
org.kohsuke.github.GHRepository.addCollaborators(GHOrganization.Permission, GHUser...)	#addCollaborators(GHOrganization.RolePermission, GHUser)
org.kohsuke.github.GHRepository.createContent(byte[], String, String)
org.kohsuke.github.GHRepository.createContent(byte[], String, String, String)
org.kohsuke.github.GHRepository.createContent(String, String, String)
org.kohsuke.github.GHRepository.createContent(String, String, String, String)
org.kohsuke.github.GHRepository.createDeployStatus(int, GHDeploymentState)	Use getDeployment(deploymentId).createStatus(ghDeploymentState)
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.getRepoVariable(String)
org.kohsuke.github.GHRepository.getWatchers()	use GHRepository.getWatchersCount() instead
org.kohsuke.github.GHRepository.gitHttpTransportUrl()	Typo of GHRepository.getHttpTransportUrl()
org.kohsuke.github.GHRepository.listIssues(GHIssueState)	Use GHRepository.queryIssues()
org.kohsuke.github.GHRepository.listPullRequests(GHIssueState)	Use GHRepository.queryPullRequests()
org.kohsuke.github.GHRepositorySearchBuilder.fork(GHRepositorySearchBuilder.Fork)	use GHRepositorySearchBuilder.fork(GHFork) instead.
org.kohsuke.github.GHRepositorySearchBuilder.forks(String)	use GHRepositorySearchBuilder.fork(GHFork) instead.
org.kohsuke.github.GHRequestedAction.getHtmlUrl()	This object has no HTML URL.
org.kohsuke.github.GHTeam.add(GHRepository, GHOrganization.Permission)	use GHTeam.add(GHRepository, org.kohsuke.github.GHOrganization.RepositoryRole)
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.connectToEnterprise(String, String, String)	Use with caution. Login with password is not a preferred method.
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.getConnector()	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.
org.kohsuke.github.GitHub.getRepositoryById(String)	Do not use this method. It was added due to misunderstanding of the type of parameter. Use GitHub.getRepositoryById(long) instead
org.kohsuke.github.GitHub.getTeam(int)	Use GHOrganization.getTeam(long)
org.kohsuke.github.GitHub.lastRateLimit()	implement a RateLimitChecker and add it via GitHubBuilder.withRateLimitChecker(RateLimitChecker).
org.kohsuke.github.GitHub.rateLimit()	implement a RateLimitChecker and add it via GitHubBuilder.withRateLimitChecker(RateLimitChecker).
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.GitHubBuilder.fromEnvironment(String, 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.GitHubBuilder.withAbuseLimitHandler(AbuseLimitHandler)
org.kohsuke.github.GitHubBuilder.withConnector(HttpConnector)
org.kohsuke.github.internal.GitHubConnectorHttpConnectorAdapter.HttpURLConnectionGitHubConnectorResponse.toHttpURLConnection()
org.kohsuke.github.PagedIterable.asList()	Use PagedIterable.toList() instead.
org.kohsuke.github.PagedIterable.asSet()	Use PagedIterable.toSet() instead.
org.kohsuke.github.RateLimitHandler.onError(IOException, HttpURLConnection)

Deprecated Constructors

Constructor	Description
org.kohsuke.github.authorization.OrgAppInstallationAuthorizationProvider(String, AuthorizationProvider)	Replaced by AppInstallationAuthorizationProvider
org.kohsuke.github.extras.OkHttp3Connector(OkUrlFactory)
org.kohsuke.github.GHDeploymentStatusBuilder(GHRepository, int, GHDeploymentState)	Use GHDeployment.createStatus(GHDeploymentState)

Deprecated 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.