com.atlassian.marketplace.client.model

Class AddonBase

java.lang.Object

com.atlassian.marketplace.client.model.AddonBase

All Implemented Interfaces:

Entity

Direct Known Subclasses:

Addon, AddonSummary

public abstract class AddonBase
extends Object
implements Entity

Properties that exist in both Addon and AddonSummary.

Since:

2.0.0

Constructor Summary

Constructors

Constructor and Description
AddonBase()

Method Summary

Methods

Modifier and Type	Method and Description
URI	getAlternateUri() The address of a Marketplace page that shows details of the add-on.
abstract Iterable<AddonCategorySummary>	getCategories() Returns summaries of all logical categories that this add-on belongs to.
Iterable<AddonCategoryId>	getCategoryIds() Same as getCategories(), but returns only the AddonCategoryId rather than the rest of the category description.
com.atlassian.fugue.Option<Integer>	getCloudFreeUsers() If there is an introductory free tier for this add-on, the maximum number of users allowed for free.
abstract AddonDistributionSummary	getDistribution() Summary information about the add-on's download/install counts.
String	getKey() The unique key of the add-on.
Links	getLinks() The top-level links for the resource.
abstract com.atlassian.fugue.Option<ImageInfo>	getLogo() The add-on logo.
String	getName() The name of the add-on.
com.atlassian.fugue.Option<URI>	getPricingDetailsPageUri() The address of a Marketplace page that shows details of the add-on's pricing.
com.atlassian.fugue.Option<URI>	getPricingUri(PricingType pricingType) Returns a resource URI for retrieving the add-on's current pricing.
com.atlassian.fugue.Option<URI>	getReviewDetailsPageUri() The address of a Marketplace page that shows details of the add-on's reviews.
abstract AddonReviewsSummary	getReviews() Summary information about the add-on's reviews.
URI	getSelfUri() The "self" link for the resource.
AddonStatus	getStatus() Indicates whether the add-on is public, private, or pending approval.
com.atlassian.fugue.Option<String>	getSummary() Summary of the add-on's functionality.
com.atlassian.fugue.Option<String>	getTagLine() A short phrase that summarizes what the add-on does.
abstract com.atlassian.fugue.Option<VendorSummary>	getVendor() Summary information about the add-on's vendor.
VendorId	getVendorId() A unique resource identifier for the add-on's vendor.

Methods inherited from class java.lang.Object

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

Constructor Detail

AddonBase

public AddonBase()

Method Detail

getLinks

public Links getLinks()

Description copied from interface: Entity

The top-level links for the resource.

Specified by:

getLinks in interface Entity

getSelfUri

public URI getSelfUri()

Description copied from interface: Entity

The "self" link for the resource. This is the canonical identifier for the entity in the API, and is used whenever linking to this resource from another one.

Specified by:

getSelfUri in interface Entity

getAlternateUri

public URI getAlternateUri()

The address of a Marketplace page that shows details of the add-on.

getVendorId

public VendorId getVendorId()

A unique resource identifier for the add-on's vendor.

See Also:

getVendor(), Vendors.getById(VendorId), ModelBuilders.AddonBuilder.vendor(VendorId)

getName

public String getName()

The name of the add-on.

See Also:

ModelBuilders.AddonBuilder.name(String)

getKey

public String getKey()

The unique key of the add-on.

See Also:

Addons.getByKey(java.lang.String, com.atlassian.marketplace.client.api.AddonQuery), ModelBuilders.AddonBuilder.key(String)

getStatus

public AddonStatus getStatus()

Indicates whether the add-on is public, private, or pending approval.

See Also:

ModelBuilders.AddonBuilder.status(AddonStatus)

getSummary

public com.atlassian.fugue.Option<String> getSummary()

Summary of the add-on's functionality. This is optional for private add-ons.

See Also:

ModelBuilders.AddonBuilder.summary(Option)

getTagLine

public com.atlassian.fugue.Option<String> getTagLine()

A short phrase that summarizes what the add-on does. This is optional for private add-ons.

See Also:

ModelBuilders.AddonBuilder.tagLine(Option)

getCloudFreeUsers

public com.atlassian.fugue.Option<Integer> getCloudFreeUsers()

If there is an introductory free tier for this add-on, the maximum number of users allowed for free.

getPricingUri

public com.atlassian.fugue.Option<URI> getPricingUri(PricingType pricingType)

Returns a resource URI for retrieving the add-on's current pricing. You can instead access pricing directly with Addons.getPricing(String, PricingType); use getPricingUri only if you need to pass the resource link to other code, for instance in order to get pricing asynchronously from the front end.

Parameters:

pricingType - specifies whether to query Cloud or Server pricing

Returns:

link to the pricing resource, if pricing is available for the specified hosting type; otherwise Option.none()

getPricingDetailsPageUri

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

The address of a Marketplace page that shows details of the add-on's pricing.

getReviewDetailsPageUri

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

The address of a Marketplace page that shows details of the add-on's reviews.

getCategoryIds

public Iterable<AddonCategoryId> getCategoryIds()

Same as getCategories(), but returns only the AddonCategoryId rather than the rest of the category description.

See Also:

ModelBuilders.AddonBuilder.categories(Iterable)

getCategories

public abstract Iterable<AddonCategorySummary> getCategories()

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

See Also:

AddonVersionBase.getFunctionalCategories(), getCategoryIds()

getDistribution

public abstract AddonDistributionSummary getDistribution()

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

getLogo

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

The add-on logo.

See Also:

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

getReviews

public abstract AddonReviewsSummary getReviews()

Summary information about the add-on's reviews.

getVendor

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

Summary information about the add-on's vendor.

See Also:

getVendorId()