@ExperimentalApi @Immutable public final class RemoteProject extends Object
Normally this will represent a project coming from one of the JIRA servers that we have an app link with. However, because it can be useful to create a list with both local and remote projects, one can construct an instance of this class that represents a local project.
This class is considered experimental while RemoteProjectService is still being developed.
Modifier and Type | Class and Description |
---|---|
static class |
RemoteProject.Builder |
Constructor and Description |
---|
RemoteProject(long id,
String key,
String name,
String description,
RemoteUser leadUser,
String url,
com.atlassian.applinks.api.ApplicationLink applicationLink,
RemoteAvatar avatar) |
Modifier and Type | Method and Description |
---|---|
static RemoteProject |
from(com.atlassian.applinks.api.ApplicationLink applicationLink,
JSONObject jsonObject) |
static RemoteProject |
from(Project project)
Build a Network project instance from a local Project.
|
com.atlassian.applinks.api.ApplicationLink |
getApplicationLink()
Returns the AppLink for the server that this remote project lives on.
|
RemoteAvatar |
getAvatar() |
String |
getBrowseProjectUrl()
Returns the URL for the "Browse Project" page of this project.
|
String |
getDescription()
Returns the description for the underlying project, or null if the description was not supplied in the JSON response.
|
long |
getId() |
String |
getKey() |
RemoteUser |
getLeadUser()
Returns the Project Lead for this project.
|
String |
getName() |
String |
getServerBaseUrl()
Returns the Base URL for the server that this project lives on.
|
String |
getUrl()
Returns the configured "URL" value for this project.
|
public RemoteProject(long id, String key, String name, String description, RemoteUser leadUser, String url, com.atlassian.applinks.api.ApplicationLink applicationLink, RemoteAvatar avatar)
public long getId()
@Nullable public String getDescription()
An empty String is returned if the project has a blank description. A null return value indicates that the description was not returned over the wire, and should be treated as an "unknown" value.
@Nullable public RemoteUser getLeadUser()
In the REST API for JIRA 6.1, this value is returned when getting a single project, but not when getting all projects, so this value can sometimes be null even if the underlying project has a lead. Developers should treat a null value as "unknown".
@Nullable public String getUrl()
In the REST API for JIRA 6.1, this value is returned when getting a single project, but not when getting all projects, so this value can sometimes be null even if the underlying project has a URL specified. Consumers should treat a null value as "unknown".
@Nullable public com.atlassian.applinks.api.ApplicationLink getApplicationLink()
Will return null if the project is representing a local project on this server.
@Nonnull public RemoteAvatar getAvatar()
@Nonnull public String getBrowseProjectUrl()
@Nonnull public String getServerBaseUrl()
@Nonnull public static RemoteProject from(Project project)
project
- the local project@Nonnull public static RemoteProject from(com.atlassian.applinks.api.ApplicationLink applicationLink, JSONObject jsonObject) throws JSONException
JSONException
Copyright © 2002-2024 Atlassian. All Rights Reserved.