org.kohsuke.github

Class GHApp

java.lang.Object

org.kohsuke.github.GHObject

org.kohsuke.github.GHApp

public class GHApp
extends GHObject

A Github App.

Author:

Paulo Miguel Almeida

See Also:

GitHub#getApp()

Field Summary

Fields inherited from class org.kohsuke.github.GHObject

created_at, id, responseHeaderFields, updated_at, url

Constructor Summary

Constructors

Constructor and Description
GHApp()

Method Summary

Modifier and Type	Method and Description
String	getDescription() Gets description.
List<GHEvent>	getEvents() Gets events.
String	getExternalUrl() Gets external url.
URL	getHtmlUrl() Gets html url.
GHAppInstallation	getInstallationById(long id) Deprecated.
GHAppInstallation	getInstallationByOrganization(String name) Deprecated.
GHAppInstallation	getInstallationByRepository(String ownerName, String repositoryName) Deprecated.
GHAppInstallation	getInstallationByUser(String name) Deprecated.
long	getInstallationsCount() Gets installations count.
String	getName() Gets name.
GHUser	getOwner() Gets owner.
Map<String,String>	getPermissions() Gets permissions.
PagedIterable<GHAppInstallation>	listInstallations() Deprecated.
void	setDescription(String description) Sets description.
void	setEvents(List<GHEvent> events) Sets events.
void	setExternalUrl(String externalUrl) Sets external url.
void	setInstallationsCount(long installationsCount) Sets installations count.
void	setName(String name) Sets name.
void	setOwner(GHUser owner) Sets owner.
void	setPermissions(Map<String,String> permissions) Sets permissions.

Methods inherited from class org.kohsuke.github.GHObject

getCreatedAt, getId, getResponseHeaderFields, getUpdatedAt, getUrl, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GHApp

public GHApp()

Method Detail

getOwner

public GHUser getOwner()

Gets owner.

Returns:

the owner

setOwner

public void setOwner(GHUser owner)

Sets owner.

Parameters:

owner - the owner

getName

public String getName()

Gets name.

Returns:

the name

setName

public void setName(String name)

Sets name.

Parameters:

name - the name

getDescription

public String getDescription()

Gets description.

Returns:

the description

setDescription

public void setDescription(String description)

Sets description.

Parameters:

description - the description

getExternalUrl

public String getExternalUrl()

Gets external url.

Returns:

the external url

setExternalUrl

public void setExternalUrl(String externalUrl)

Sets external url.

Parameters:

externalUrl - the external url

getEvents

public List<GHEvent> getEvents()

Gets events.

Returns:

the events

setEvents

public void setEvents(List<GHEvent> events)

Sets events.

Parameters:

events - the events

getInstallationsCount

public long getInstallationsCount()

Gets installations count.

Returns:

the installations count

setInstallationsCount

public void setInstallationsCount(long installationsCount)

Sets installations count.

Parameters:

installationsCount - the installations count

getHtmlUrl

public URL getHtmlUrl()

Description copied from class: GHObject

Gets html url.

Specified by:

getHtmlUrl in class GHObject

Returns:

URL of this object for humans, which renders some HTML.

getPermissions

public Map<String,String> getPermissions()

Gets permissions.

Returns:

the permissions

setPermissions

public void setPermissions(Map<String,String> permissions)

Sets permissions.

Parameters:

permissions - the permissions

listInstallations

@Preview
 @Deprecated
public PagedIterable<GHAppInstallation> listInstallations()

Deprecated.

Obtains all the installations associated with this app.

You must use a JWT to access this endpoint.

Returns:

a list of App installations

See Also:

List installations

getInstallationById

@Preview
 @Deprecated
public GHAppInstallation getInstallationById(long id)
                                                            throws IOException

Deprecated.

Obtain an installation associated with this app.

You must use a JWT to access this endpoint.

Parameters:

id - Installation Id

Returns:

a GHAppInstallation

Throws:

IOException - on error

See Also:

Get an installation

getInstallationByOrganization

@Preview
 @Deprecated
public GHAppInstallation getInstallationByOrganization(String name)
                                                                      throws IOException

Deprecated.

Obtain an organization installation associated with this app.

You must use a JWT to access this endpoint.

Parameters:

name - Organization name

Returns:

a GHAppInstallation

Throws:

IOException - on error

See Also:

Get an organization installation

getInstallationByRepository

@Preview
 @Deprecated
public GHAppInstallation getInstallationByRepository(String ownerName,
                                                                           String repositoryName)
                                                                    throws IOException

Deprecated.

Obtain an repository installation associated with this app.

You must use a JWT to access this endpoint.

Parameters:

ownerName - Organization or user name

repositoryName - Repository name

Returns:

a GHAppInstallation

Throws:

IOException - on error

See Also:

Get a repository installation

getInstallationByUser

@Preview
 @Deprecated
public GHAppInstallation getInstallationByUser(String name)
                                                              throws IOException

Deprecated.

Obtain a user installation associated with this app.

You must use a JWT to access this endpoint.

Parameters:

name - user name

Returns:

a GHAppInstallation

Throws:

IOException - on error

See Also:

Get a user installation