Deprecated API

Contents

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

Deprecated Interfaces

Interface and Description
org.kohsuke.github.Reactable

Deprecated Classes

Class and Description
org.kohsuke.github.GHCommit.GHAuthor Use GitUser instead.
org.kohsuke.github.GHCommitSearchBuilder
org.kohsuke.github.GHCompare.User use GitUser instead.
org.kohsuke.github.GHIssue.Label use GHLabel
org.kohsuke.github.GHPullRequestCommitDetail.Authorship Use GitUser
org.kohsuke.github.GHReaction
org.kohsuke.github.extras.OkHttp3Connector

Deprecated Enums

Enum and Description
org.kohsuke.github.EnforcementLevel

Deprecated Fields

Field and 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()

Deprecated Methods

Method and Description
org.kohsuke.github.GHPullRequestReviewState.action() This was an internal method accidentally exposed. Left here for compatibility.
org.kohsuke.github.GitHub.connect(String, String, String) Either OAuth token or password is sufficient, so there's no point in passing both. Use GitHub.connectUsingPassword(String, String) or 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.GHAppCreateTokenBuilder.create()
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.GHPullRequestReviewComment.createReaction(ReactionContent)
org.kohsuke.github.GHIssueComment.createReaction(ReactionContent)
org.kohsuke.github.GHCommitComment.createReaction(ReactionContent)
org.kohsuke.github.GHIssue.createReaction(ReactionContent)
org.kohsuke.github.Reactable.createReaction(ReactionContent)
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.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.createRepository(String, String, String, String, boolean) Use GHOrganization.createRepository(String) that uses a builder pattern to let you control every aspect.
org.kohsuke.github.GHPullRequest.createReview(String, GHPullRequestReviewState, GHPullRequestReviewComment...) Use GHPullRequest.createReview()
org.kohsuke.github.GHPullRequest.createReview(String, GHPullRequestReviewState, List<GHPullRequestReviewComment>) Use GHPullRequest.createReview()
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, Collection)
org.kohsuke.github.GHOrganization.createTeam(String, GHOrganization.Permission, GHRepository...) https://developer.github.com/v3/teams/#create-team deprecates permission field use GHOrganization.createTeam(String, GHRepository...)
org.kohsuke.github.GHAppInstallation.createToken()
org.kohsuke.github.GHAppInstallation.createToken(Map<String, GHPermissionType>) Use GHAppInstallation.createToken() instead.
org.kohsuke.github.GHAppInstallation.deleteInstallation()
org.kohsuke.github.GHBranchProtection.disableSignedCommits()
org.kohsuke.github.GHPullRequestReviewComment.draft(String, String, int) You should be using GHPullRequestReviewBuilder.comment(String, String, int)
org.kohsuke.github.GHBranchProtection.enabledSignedCommits()
org.kohsuke.github.GHBranch.enableProtection()
org.kohsuke.github.GHBranch.enableProtection(EnforcementLevel, Collection<String>)
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.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.GitHub.getApp()
org.kohsuke.github.GHContent.getContent() Use GHContent.read()
org.kohsuke.github.GHRepositoryStatistics.getContributorStats(boolean)
org.kohsuke.github.GHRepository.getDeploymentStatuses(int) Use getDeployment(id).listStatuses()
org.kohsuke.github.GHMyself.getEmails() Use GHMyself.getEmails2()
org.kohsuke.github.GHContent.getEncodedContent() Use GHContent.read()
org.kohsuke.github.GHPerson.getGravatarId() No longer available in the v3 API.
org.kohsuke.github.GHAsset.getHtmlUrl() This object has no HTML URL.
org.kohsuke.github.GHDeploymentStatus.getHtmlUrl() This object has no HTML URL.
org.kohsuke.github.GHDeployment.getHtmlUrl() This object has no HTML URL.
org.kohsuke.github.GHReaction.getHtmlUrl()
org.kohsuke.github.GHAuthorization.getHtmlUrl() This object has no HTML URL.
org.kohsuke.github.GHCheckRun.getHtmlUrl() This object has no HTML URL.
org.kohsuke.github.GHThread.getHtmlUrl() This object has no HTML URL.
org.kohsuke.github.GHRequestedAction.getHtmlUrl() This object has no HTML URL.
org.kohsuke.github.GHHook.getHtmlUrl() This object has no HTML URL.
org.kohsuke.github.GHCommitStatus.getHtmlUrl() This object has no HTML URL.
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.GHPullRequest.getIssueUpdatedAt()
org.kohsuke.github.GHRepository.getMasterBranch() Renamed to GHRepository.getDefaultBranch()
org.kohsuke.github.GHOrganization.getMembers() use GHOrganization.listMembers()
org.kohsuke.github.GHRepository.getMilestones() Use GHRepository.listMilestones(GHIssueState)
org.kohsuke.github.GHRepository.getNetworkCount() This no longer exists in the official API documentation. Use GHRepository.getForks()
org.kohsuke.github.GHRepository.getPostCommitHooks() Use GHRepository.getHooks() and GHRepository.createHook(String, Map, Collection, boolean)
org.kohsuke.github.GHBranch.getProtectionUrl()
org.kohsuke.github.GHRepository.getReleases() use GHRepository.listReleases()
org.kohsuke.github.GHBranchProtection.getRequiredSignatures()
org.kohsuke.github.GHObject.getResponseHeaderFields()
org.kohsuke.github.GHIssueComment.getUserName()
org.kohsuke.github.GHRepository.gitHttpTransportUrl() Typo of GHRepository.getHttpTransportUrl()
org.kohsuke.github.GHBranch.isProtected()
org.kohsuke.github.GHPerson.iterateRepositories(int) Use GHPerson.listRepositories()
org.kohsuke.github.GHMyself.listAllRepositories() Use GHMyself.listRepositories()
org.kohsuke.github.GHApp.listInstallations()
org.kohsuke.github.GHRepository.listPullRequests(GHIssueState) Use GHRepository.queryPullRequests()
org.kohsuke.github.GHPullRequestReviewComment.listReactions()
org.kohsuke.github.GHIssueComment.listReactions()
org.kohsuke.github.GHCommitComment.listReactions()
org.kohsuke.github.GHIssue.listReactions()
org.kohsuke.github.Reactable.listReactions()
org.kohsuke.github.GHAppCreateTokenBuilder.permissions(Map<String, GHPermissionType>)
org.kohsuke.github.GHAppCreateTokenBuilder.repositoryIds(List<Long>)
org.kohsuke.github.GitHub.searchCommits()
org.kohsuke.github.GHRelease.setDraft(boolean) Use GHRelease.update()
org.kohsuke.github.GHTreeBuilder.shaEntry(String, String, boolean) use GHTreeBuilder.add(String, String, boolean) or GHTreeBuilder.add(String, byte[], boolean) instead.
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.GHTreeBuilder.textEntry(String, String, boolean) use GHTreeBuilder.add(String, String, boolean) or GHTreeBuilder.add(String, byte[], boolean) instead.

Deprecated Constructors

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

Deprecated Enum Constants

Enum Constant and 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.