Addons (Atlassian Marketplace Client 2.0.0-m4 API)

```
public interface Addons
```
Starting point for all resources that return add-on information. Use MarketplaceClient.addons() to access this API.

Since:

2.0.0

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`claimAccessToken(String addonKey, String token)` Checks if the access token for the given add-on is valid for this application instance to use, and if so, marks it as claimed by this instance (based on the current hostname).
`Addon`	`createAddon(Addon addon)` Creates a new add-on listing.
`AddonVersion`	`createVersion(String addonKey, AddonVersion version)` Creates a new version for an existing add-on.
`Page<AddonSummary>`	`find(AddonQuery query)` Returns a list of add-ons.
`Page<AddonReference>`	`findBanners(AddonQuery query)` Similar to `find(com.atlassian.marketplace.client.api.AddonQuery)`, but further restricts the query to add-ons that have a banner image, and returns minimal `AddonReference` results, whose `AddonReference.getImage()` method will return the banner image.
`Page<AddonReference>`	`findRecommendations(String addonKey, AddonQuery query)` Returns add-ons that Marketplace considers similar to the specified add-on in some way, optionally constrained by compatibility or other `AddonQuery` properties.
`com.atlassian.fugue.Option<Addon>`	`getByKey(String addonKey, AddonQuery query)` Queries detail information for a single add-on.
`com.atlassian.fugue.Option<AddonPricing>`	`getPricing(String addonKey, PricingType pricingType)` Queries the current pricing (the prices that are publicly visible on the Marketplace site) for an add-on.
`com.atlassian.fugue.Option<AddonVersion>`	`getVersion(String addonKey, AddonVersionSpecifier version, AddonVersionsQuery query)` Queries one version of an add-on.
`Addon`	`updateAddon(Addon original, Addon updated)` Attempts to modify an existing add-on.
`AddonVersion`	`updateVersion(AddonVersion original, AddonVersion updated)` Attempts to modify an existing add-on version.

- Method Detail
  - getByKey
```
com.atlassian.fugue.Option<Addon> getByKey(String addonKey,
                                         AddonQuery query)
                                           throws MpacException
```
    Queries detail information for a single add-on.
    
    Parameters:
    addonKey - the add-on's unique key
    query - an AddonQuery which may contain criteria to limit the search, such as the compatible application version; use AddonQuery.any() if there are no additional criteria
    
    Returns:
    the add-on information, or Option.none() if there is no match
    
    Throws:
    
    MpacException - if the server was unavailable or returned an error
  - find
```
Page<AddonSummary> find(AddonQuery query)
                        throws MpacException
```
    Returns a list of add-ons.
    
    Parameters:
    query - an AddonQuery
    
    Returns:
    summary information for the available add-ons
    
    Throws:
    
    MpacException - if the server was unavailable or returned an error
  - createAddon
```
Addon createAddon(Addon addon)
                  throws MpacException
```
    Creates a new add-on listing. Assuming all properties are valid, if the add-on is private it will be created in a private state immediately; if it is public, it will be created in a "submitted" state and will not be visible until it has been approved by Atlassian.
    Use ModelBuilders.addon() to build a new Addon object. The add-on must include an initial version; to set this, use ModelBuilders.AddonBuilder.version(Option).
    
    Parameters:
    addon - the add-on to create
    
    Returns:
    an Addon representing the add-on in its initial state after being created
    
    Throws:
    
    MpacException - if the server was unavailable or returned an error
  - updateAddon
```
Addon updateAddon(Addon original,
                Addon updated)
                  throws MpacException
```
    Attempts to modify an existing add-on. You must have already queried the current state of the add-on with getByKey(String, com.atlassian.marketplace.client.api.AddonQuery); then, build another instance that includes any changes you want to make, using ModelBuilders.addon(Addon).
    
    Parameters:
    original - the existing add-on
    updated - a copy of the add-on that includes some changes
    
    Returns:
    the updated add-on (re-queried from the server) if successful
    
    Throws:
    
    MpacException - if the server was unavailable or returned an error
  - getVersion
```
com.atlassian.fugue.Option<AddonVersion> getVersion(String addonKey,
                                                  AddonVersionSpecifier version,
                                                  AddonVersionsQuery query)
                                                    throws MpacException
```
    Queries one version of an add-on.
    
    Parameters:
    addonKey - the add-on's unique key
    version - an AddonVersionSpecifier which designates either a specific version or the latest version
    query - an AddonVersionsQuery which may contain criteria to limit the search, such as the compatible application version; use AddonVersionsQuery.any() if there are no additional criteria
    
    Returns:
    the add-on version information, or Option.none() if there is no match
    
    Throws:
    
    MpacException - if the server was unavailable or returned an error
  - createVersion
```
AddonVersion createVersion(String addonKey,
                         AddonVersion version)
                           throws MpacException
```
    Creates a new version for an existing add-on. Assuming all properties are valid, if the version requires approval for any reason (such as being the first paid-via-Atlassian version of a formerly free add-on, or the first Cloud version of a Server add-on) it will be created in a "submitted" state pending Atlassian approval; otherwise it will be public or private as you specified.
    Use ModelBuilders.addonVersion() to build a new AddonVersion object.
    
    Parameters:
    addonKey - unique key of the existing add-on
    version - the add-on version to create
    
    Returns:
    an AddonVersion representing the version in its initial state after being created
    
    Throws:
    
    MpacException - if the server was unavailable or returned an error
  - updateVersion
```
AddonVersion updateVersion(AddonVersion original,
                         AddonVersion updated)
                           throws MpacException
```
    Attempts to modify an existing add-on version. You must have already queried the current state of the version with getVersion(String, AddonVersionSpecifier, AddonVersionsQuery); then, build another instance that includes any changes you want to make, using ModelBuilders.addonVersion(AddonVersion).
    
    Parameters:
    original - the existing add-on version
    updated - a copy of the version that includes some changes
    
    Returns:
    the updated version (re-queried from the server) if successful
    
    Throws:
    
    MpacException - if the server was unavailable or returned an error
  - getPricing
```
com.atlassian.fugue.Option<AddonPricing> getPricing(String addonKey,
                                                  PricingType pricingType)
                                                    throws MpacException
```
    Queries the current pricing (the prices that are publicly visible on the Marketplace site) for an add-on. Returns none() if the add-on is not paid via Atlassian, is not available for the given hosting model, or has not yet been approved.
    
    Parameters:
    addonKey - unique key of the add-on
    pricingType - specifies pricing for Cloud or Server
    
    Returns:
    the pricing, if available
    
    Throws:
    
    MpacException
  - findBanners
```
Page<AddonReference> findBanners(AddonQuery query)
                                 throws MpacException
```
    Similar to find(com.atlassian.marketplace.client.api.AddonQuery), but further restricts the query to add-ons that have a banner image, and returns minimal AddonReference results, whose AddonReference.getImage() method will return the banner image.
    
    Parameters:
    query - an AddonQuery
    
    Returns:
    a list of matching add-ons
    
    Throws:
    
    MpacException - if the server was unavailable or returned an error
  - findRecommendations
```
Page<AddonReference> findRecommendations(String addonKey,
                                       AddonQuery query)
                                         throws MpacException
```
    Returns add-ons that Marketplace considers similar to the specified add-on in some way, optionally constrained by compatibility or other AddonQuery properties.
    
    Parameters:
    addonKey - the add-on's unique key
    query - an AddonQuery which may contain criteria to limit the search, such as the compatible application version; use AddonQuery.any() if there are no additional criteria
    
    Returns:
    a list of recommended add-ons
    
    Throws:
    
    MpacException - if the server was unavailable or returned an error
  - claimAccessToken
```
boolean claimAccessToken(String addonKey,
                       String token)
                         throws MpacException
```
    Checks if the access token for the given add-on is valid for this application instance to use, and if so, marks it as claimed by this instance (based on the current hostname).
    
    Parameters:
    addonKey - the add-on's unique key
    token - the license token to check
    
    Returns:
    true if the token is valid for this add-on and can be used by this instance; false otherwise
    
    Throws:
    
    MpacException - if the server was unavailable or returned an error

Interface Addons

Method Summary

Method Detail

getByKey

find

createAddon

updateAddon

getVersion

createVersion

updateVersion

getPricing

findBanners

findRecommendations

claimAccessToken