com.atlassian.marketplace.client.model

Class Addon

java.lang.Object

com.atlassian.marketplace.client.model.AddonBase

com.atlassian.marketplace.client.model.Addon

All Implemented Interfaces:

Entity

public class Addon
extends AddonBase

Information about an add-on. Includes all the properties of AddonBase, but adds further details; to get these details, you will need to query the add-on individually with Addons.getByKey(java.lang.String, com.atlassian.marketplace.client.api.AddonQuery).

To construct a new instance of this class in order to create or update an add-on, use ModelBuilders.addon().

Since:

2.0.0

See Also:

Addons, AddonSummary

Constructor Summary

Constructors

Constructor and Description
Addon()

Method Summary

Methods

Modifier and Type	Method and Description
com.atlassian.fugue.Option<ImageInfo>	getBanner() The add-on banner image.
Iterable<AddonCategorySummary>	getCategories() Returns summaries of all logical categories that this add-on belongs to.
com.atlassian.fugue.Option<HtmlString>	getDescription() A description of the add-on that can be longer than AddonBase.getSummary() and can include some limited HTML markup.
AddonDistributionSummary	getDistribution() Summary information about the add-on's download/install counts.
com.atlassian.fugue.Option<URI>	getExternalLinkUri(AddonExternalLinkType type) Returns one of the optional vendor-specified external links for the add-on.
com.atlassian.fugue.Option<ImageInfo>	getLogo() The add-on logo.
AddonReviewsSummary	getReviews() Summary information about the add-on's reviews.
com.atlassian.fugue.Option<URI>	getSupportDetailsPageUri() The address of a Marketplace page that describes the add-on's support details.
com.atlassian.fugue.Option<VendorSummary>	getVendor() Summary information about the add-on's vendor.
com.atlassian.fugue.Option<AddonVersion>	getVersion() Details of one of the add-on's versions.
com.atlassian.fugue.Option<Boolean>	isEnableAtlassianAnswers() True if Marketplace should provide a link to an Atlassian Answers tag devoted to this add-on.

Methods inherited from class com.atlassian.marketplace.client.model.AddonBase

getAlternateUri, getCategoryIds, getCloudFreeUsers, getKey, getLinks, getName, getPricingDetailsPageUri, getPricingUri, getReviewDetailsPageUri, getSelfUri, getStatus, getSummary, getTagLine, getVendorId

Methods inherited from class java.lang.Object

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

Constructor Detail

Addon

public Addon()

Method Detail

getBanner

public com.atlassian.fugue.Option<ImageInfo> getBanner()

The add-on banner image. This is not displayed on Marketplace, but may appear in UPM.

See Also:

ModelBuilders.AddonBuilder.banner(com.atlassian.fugue.Option<com.atlassian.marketplace.client.api.ImageId>)

getLogo

public com.atlassian.fugue.Option<ImageInfo> getLogo()

Description copied from class: AddonBase

The add-on logo.

Specified by:

getLogo in class AddonBase

See Also:

ModelBuilders.AddonBuilder.logo(com.atlassian.fugue.Option<com.atlassian.marketplace.client.api.ImageId>)

getCategories

public Iterable<AddonCategorySummary> getCategories()

Description copied from class: AddonBase

Returns summaries of all logical categories that this add-on belongs to. These are assigned by the vendor.

Specified by:

getCategories in class AddonBase

See Also:

AddonVersionBase.getFunctionalCategories(), AddonBase.getCategoryIds()

getDistribution

public AddonDistributionSummary getDistribution()

Description copied from class: AddonBase

Summary information about the add-on's download/install counts.

Specified by:

getDistribution in class AddonBase

getReviews

public AddonReviewsSummary getReviews()

Description copied from class: AddonBase

Summary information about the add-on's reviews.

Specified by:

getReviews in class AddonBase

getVendor

public com.atlassian.fugue.Option<VendorSummary> getVendor()

Description copied from class: AddonBase

Summary information about the add-on's vendor.

Specified by:

getVendor in class AddonBase

See Also:

AddonBase.getVendorId()

getVersion

public com.atlassian.fugue.Option<AddonVersion> getVersion()

Details of one of the add-on's versions. This will be present if 1. you have requested it in an add-on query (see AddonQuery.Builder.withVersion(boolean)), in which case it will be the latest available version that matches whatever criteria you have specified; or 2. you have constructed it yourself because you are creating a new add-on (see ModelBuilders.AddonBuilder.version).

getSupportDetailsPageUri

public com.atlassian.fugue.Option<URI> getSupportDetailsPageUri()

The address of a Marketplace page that describes the add-on's support details.

getDescription

public com.atlassian.fugue.Option<HtmlString> getDescription()

A description of the add-on that can be longer than AddonBase.getSummary() and can include some limited HTML markup. This is no longer supported for new add-on listings, but may be present for older ones.

getExternalLinkUri

public com.atlassian.fugue.Option<URI> getExternalLinkUri(AddonExternalLinkType type)

Returns one of the optional vendor-specified external links for the add-on.

Parameters:

type - specifies which type of link to get

Returns:

the link URI, or Option.none() if there is no such link

isEnableAtlassianAnswers

public com.atlassian.fugue.Option<Boolean> isEnableAtlassianAnswers()

True if Marketplace should provide a link to an Atlassian Answers tag devoted to this add-on. Can be omitted for private add-ons.