Package org.kohsuke.github
Class GHAppInstallation
- java.lang.Object
-
- org.kohsuke.github.GHObject
-
- org.kohsuke.github.GHAppInstallation
-
public class GHAppInstallation extends GHObject
A Github App Installation.- Author:
- Paulo Miguel Almeida
- See Also:
GHApp#listInstallations()
,GHApp#getInstallationById(long)
,GHApp#getInstallationByOrganization(String)
,GHApp#getInstallationByRepository(String, String)
,GHApp#getInstallationByUser(String)
-
-
Field Summary
-
Fields inherited from class org.kohsuke.github.GHObject
responseHeaderFields
-
-
Constructor Summary
Constructors Constructor Description GHAppInstallation()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description GHAppCreateTokenBuilder
createToken()
Deprecated.GHAppCreateTokenBuilder
createToken(Map<String,GHPermissionType> permissions)
Deprecated.UsecreateToken()
instead.void
deleteInstallation()
Deprecated.String
getAccessTokenUrl()
Gets access token url.GHUser
getAccount()
Gets account.long
getAppId()
Gets app id.List<GHEvent>
getEvents()
Gets events.URL
getHtmlUrl()
Gets html url.Map<String,GHPermissionType>
getPermissions()
Gets permissions.String
getRepositoriesUrl()
Gets repositories url.GHRepositorySelection
getRepositorySelection()
Gets repository selection.GitHub
getRoot()
Gets root.String
getSingleFileName()
Gets single file name.long
getTargetId()
Gets target id.GHTargetType
getTargetType()
Gets target type.PagedSearchIterable<GHRepository>
listRepositories()
Deprecated.void
setAccessTokenUrl(String accessTokenUrl)
Deprecated.Do not use this method.void
setAccount(GHUser account)
Deprecated.Do not use this method.void
setAppId(long appId)
Deprecated.Do not use this method.void
setEvents(List<GHEvent> events)
Deprecated.Do not use this method.void
setPermissions(Map<String,GHPermissionType> permissions)
Deprecated.Do not use this method.void
setRepositoriesUrl(String repositoriesUrl)
Deprecated.Do not use this method.void
setRepositorySelection(GHRepositorySelection repositorySelection)
Deprecated.Do not use this method.void
setRoot(GitHub root)
Deprecated.Do not use this method.void
setSingleFileName(String singleFileName)
Deprecated.Do not use this method.void
setTargetId(long targetId)
Deprecated.Do not use this method.void
setTargetType(GHTargetType targetType)
Deprecated.Do not use this method.-
Methods inherited from class org.kohsuke.github.GHObject
getCreatedAt, getId, getNodeId, getResponseHeaderFields, getUpdatedAt, getUrl, setResponseHeaderFields, toString
-
-
-
-
Method Detail
-
getHtmlUrl
public URL getHtmlUrl()
Description copied from class:GHObject
Gets html url.- Specified by:
getHtmlUrl
in classGHObject
- Returns:
- URL of this object for humans, which renders some HTML.
-
getRoot
public GitHub getRoot()
Gets root.- Returns:
- the root
-
setRoot
@Deprecated public void setRoot(GitHub root)
Deprecated.Do not use this method. It was added due to incomplete understanding of Jackson binding.Sets root.- Parameters:
root
- the root
-
getAccount
public GHUser getAccount()
Gets account.- Returns:
- the account
-
setAccount
@Deprecated public void setAccount(GHUser account)
Deprecated.Do not use this method. It was added due to incomplete understanding of Jackson binding.Sets account.- Parameters:
account
- the account
-
getAccessTokenUrl
public String getAccessTokenUrl()
Gets access token url.- Returns:
- the access token url
-
setAccessTokenUrl
@Deprecated public void setAccessTokenUrl(String accessTokenUrl)
Deprecated.Do not use this method. It was added due to incomplete understanding of Jackson binding.Sets access token url.- Parameters:
accessTokenUrl
- the access token url
-
getRepositoriesUrl
public String getRepositoriesUrl()
Gets repositories url.- Returns:
- the repositories url
-
listRepositories
@Preview @Deprecated public PagedSearchIterable<GHRepository> listRepositories()
Deprecated.List repositories that this app installation can access.- Returns:
- the paged iterable
-
setRepositoriesUrl
@Deprecated public void setRepositoriesUrl(String repositoriesUrl)
Deprecated.Do not use this method. It was added due to incomplete understanding of Jackson binding.Sets repositories url.- Parameters:
repositoriesUrl
- the repositories url
-
getAppId
public long getAppId()
Gets app id.- Returns:
- the app id
-
setAppId
@Deprecated public void setAppId(long appId)
Deprecated.Do not use this method. It was added due to incomplete understanding of Jackson binding.Sets app id.- Parameters:
appId
- the app id
-
getTargetId
public long getTargetId()
Gets target id.- Returns:
- the target id
-
setTargetId
@Deprecated public void setTargetId(long targetId)
Deprecated.Do not use this method. It was added due to incomplete understanding of Jackson binding.Sets target id.- Parameters:
targetId
- the target id
-
getTargetType
public GHTargetType getTargetType()
Gets target type.- Returns:
- the target type
-
setTargetType
@Deprecated public void setTargetType(GHTargetType targetType)
Deprecated.Do not use this method. It was added due to incomplete understanding of Jackson binding.Sets target type.- Parameters:
targetType
- the target type
-
getPermissions
public Map<String,GHPermissionType> getPermissions()
Gets permissions.- Returns:
- the permissions
-
setPermissions
@Deprecated public void setPermissions(Map<String,GHPermissionType> permissions)
Deprecated.Do not use this method. It was added due to incomplete understanding of Jackson binding.Sets permissions.- Parameters:
permissions
- the permissions
-
setEvents
@Deprecated public void setEvents(List<GHEvent> events)
Deprecated.Do not use this method. It was added due to incomplete understanding of Jackson binding.Sets events.- Parameters:
events
- the events
-
getSingleFileName
public String getSingleFileName()
Gets single file name.- Returns:
- the single file name
-
setSingleFileName
@Deprecated public void setSingleFileName(String singleFileName)
Deprecated.Do not use this method. It was added due to incomplete understanding of Jackson binding.Sets single file name.- Parameters:
singleFileName
- the single file name
-
getRepositorySelection
public GHRepositorySelection getRepositorySelection()
Gets repository selection.- Returns:
- the repository selection
-
setRepositorySelection
@Deprecated public void setRepositorySelection(GHRepositorySelection repositorySelection)
Deprecated.Do not use this method. It was added due to incomplete understanding of Jackson binding.Sets repository selection.- Parameters:
repositorySelection
- the repository selection
-
deleteInstallation
@Preview @Deprecated public void deleteInstallation() throws IOException
Deprecated.Delete a Github App installationYou must use a JWT to access this endpoint.
- Throws:
IOException
- on error- See Also:
- Delete an installation
-
createToken
@Preview @Deprecated public GHAppCreateTokenBuilder createToken(Map<String,GHPermissionType> permissions)
Deprecated.UsecreateToken()
instead.Starts a builder that creates a new App Installation Token.You use the returned builder to set various properties, then call
GHAppCreateTokenBuilder.create()
to finally create an access token.- Parameters:
permissions
- map of permissions for the created token- Returns:
- a GHAppCreateTokenBuilder instance
-
createToken
@Preview @Deprecated public GHAppCreateTokenBuilder createToken()
Deprecated.Starts a builder that creates a new App Installation Token.You use the returned builder to set various properties, then call
GHAppCreateTokenBuilder.create()
to finally create an access token.- Returns:
- a GHAppCreateTokenBuilder instance
-
-