AddonVersionBase (Atlassian Marketplace Client 3.0.2 API)

java.lang.Object
- com.atlassian.marketplace.client.model.AddonVersionBase

All Implemented Interfaces:

Entity

Direct Known Subclasses:

AddonVersion, AddonVersionSummary
```
public abstract class AddonVersionBase
extends Object
implements Entity
```
Properties that exist in both AddonVersion and AddonVersionSummary.

Since:

2.0.0

Constructor Summary

Constructors
Constructor and Description

AddonVersionBase()

Constructors
Constructor and Description
`AddonVersionBase()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`abstract io.atlassian.fugue.Option<ArtifactInfo>`	`getArtifactInfo()` Details about the installable file for this add-on, if it has one that is hosted by Marketplace.
`abstract io.atlassian.fugue.Option<URI>`	`getArtifactUri()` Shortcut for getting the download URI for the add-on's installable file, if any.
`Iterable<ConnectScope>`	`getConnectScopes()` List of Atlassian Connect scopes used by the version, if it is an Atlassian Connect add-on; otherwise an empty list.
`io.atlassian.fugue.Option<AddonVersionDataCenterStatus>`	`getDataCenterStatus()` Indicates the Data Center approval status
`io.atlassian.fugue.Option<URI>`	`getExternalLinkUri(AddonVersionExternalLinkType type)` Returns one of the optional vendor-specified external links for the add-on version.
`abstract Iterable<AddonCategorySummary>`	`getFunctionalCategories()` Returns summaries of all functional categories that this add-on version belongs to.
`Iterable<AddonCategoryId>`	`getFunctionalCategoryIds()` Same as `getFunctionalCategories()`, but returns only the `AddonCategoryId` rather than the rest of the category description.
`io.atlassian.fugue.Option<LicenseTypeId>`	`getLicenseTypeId()` The unique resource identifier for the software license type used by this version, if any.
`Links`	`getLinks()` The top-level links for the resource.
`io.atlassian.fugue.Option<String>`	`getName()` The version string, e.g.
`PaymentModel`	`getPaymentModel()` Indicates whether the version is free, paid via Atlassian, or paid via Vendor.
`org.joda.time.LocalDate`	`getReleaseDate()` The date on which this version was released.
`io.atlassian.fugue.Option<String>`	`getReleasedBy()` The name of the person who released this version.
`abstract io.atlassian.fugue.Option<URI>`	`getRemoteDescriptorUri()` Shortcut for getting the remote Atlassian Connect descriptor URI for the add-on, if any.
`URI`	`getSelfUri()` The "self" link for the resource.
`AddonVersionStatus`	`getStatus()` Indicates whether the version is public, private, or pending approval.
`boolean`	`isAutoUpdateAllowed()` True if automatic updates are allowed for the version.
`boolean`	`isBeta()` True if this is a beta version.
`boolean`	`isCloud()` True if this version is compatible with Cloud instances.
`boolean`	`isConnect()` True if this is an Atlassian Connect add-on.
`boolean`	`isDataCenterCompatible()` Deprecated.
`boolean`	`isDataCenterStatusCompatible()` True if this version is compatible with Data Center instances.
`boolean`	`isDeployable()` True if this version can be installed directly via the Plugin Manager.
`boolean`	`isServer()` True if this version is compatible with Server instances.
`boolean`	`isStatic()` True if this is a static add-on (Plugins 1, a deprecated add-on framework).
`boolean`	`isSupported()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AddonVersionBase
```
public AddonVersionBase()
```
- 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
  - getName
```
public io.atlassian.fugue.Option<String> getName()
```
    The version string, e.g. "1.0". This will always have a value in versions queried from Marketplace, but can usually be omitted when creating a new version.
    
    See Also:
    
    ModelBuilders.AddonVersionBuilder.name(String)
  - getPaymentModel
```
public PaymentModel getPaymentModel()
```
    Indicates whether the version is free, paid via Atlassian, or paid via Vendor.
    
    See Also:
    
    ModelBuilders.AddonVersionBuilder.paymentModel(PaymentModel)
  - getStatus
```
public AddonVersionStatus getStatus()
```
    Indicates whether the version is public, private, or pending approval.
    
    See Also:
    
    ModelBuilders.AddonVersionBuilder.status(AddonVersionStatus)
  - isBeta
```
public boolean isBeta()
```
    True if this is a beta version.
    
    See Also:
    
    ModelBuilders.AddonVersionBuilder.beta(boolean)
  - isStatic
```
public boolean isStatic()
```
    True if this is a static add-on (Plugins 1, a deprecated add-on framework).
  - isSupported
```
public boolean isSupported()
```
  - isDeployable
```
public boolean isDeployable()
```
    True if this version can be installed directly via the Plugin Manager.
  - getConnectScopes
```
public Iterable<ConnectScope> getConnectScopes()
```
    List of Atlassian Connect scopes used by the version, if it is an Atlassian Connect add-on; otherwise an empty list.
  - isServer
```
public boolean isServer()
```
    True if this version is compatible with Server instances.
  - isCloud
```
public boolean isCloud()
```
    True if this version is compatible with Cloud instances.
  - isAutoUpdateAllowed
```
public boolean isAutoUpdateAllowed()
```
    True if automatic updates are allowed for the version. This is always true for Atlassian Connect add-ons, and is enabled selectively by Atlassian for a small subset of other add-ons.
  - isConnect
```
public boolean isConnect()
```
    True if this is an Atlassian Connect add-on.
  - isDataCenterCompatible
```
@Deprecated
public boolean isDataCenterCompatible()
```
    Deprecated.
    
    True if this version is compatible with Data Center instances.
  - getDataCenterStatus
```
public io.atlassian.fugue.Option<AddonVersionDataCenterStatus> getDataCenterStatus()
```
    Indicates the Data Center approval status
    
    Since:
    
    2.1.0
  - isDataCenterStatusCompatible
```
public boolean isDataCenterStatusCompatible()
```
    True if this version is compatible with Data Center instances.
    
    Since:
    
    2.1.0
  - getLicenseTypeId
```
public io.atlassian.fugue.Option<LicenseTypeId> getLicenseTypeId()
```
    The unique resource identifier for the software license type used by this version, if any. This is required for public versions, optional for private versions.
    
    See Also:
    
    ModelBuilders.AddonVersionBuilder.licenseTypeId(Option)
  - getReleaseDate
```
public org.joda.time.LocalDate getReleaseDate()
```
    The date on which this version was released.
    
    See Also:
    
    ModelBuilders.AddonVersionBuilder.releaseDate(LocalDate)
  - getReleasedBy
```
public io.atlassian.fugue.Option<String> getReleasedBy()
```
    The name of the person who released this version.
    
    See Also:
    
    ModelBuilders.AddonVersionBuilder.releasedBy(Option)
  - getArtifactInfo
```
public abstract io.atlassian.fugue.Option<ArtifactInfo> getArtifactInfo()
```
    Details about the installable file for this add-on, if it has one that is hosted by Marketplace.
    
    See Also:
    
    ModelBuilders.AddonVersionBuilder.artifact(Option)
  - getArtifactUri
```
public abstract io.atlassian.fugue.Option<URI> getArtifactUri()
```
    Shortcut for getting the download URI for the add-on's installable file, if any.
    
    See Also:
    
    getArtifactInfo()
  - getRemoteDescriptorUri
```
public abstract io.atlassian.fugue.Option<URI> getRemoteDescriptorUri()
```
    Shortcut for getting the remote Atlassian Connect descriptor URI for the add-on, if any.
    
    See Also:
    
    getArtifactInfo()
  - getFunctionalCategoryIds
```
public Iterable<AddonCategoryId> getFunctionalCategoryIds()
```
    Same as getFunctionalCategories(), but returns only the AddonCategoryId rather than the rest of the category description.
  - getExternalLinkUri
```
public io.atlassian.fugue.Option<URI> getExternalLinkUri(AddonVersionExternalLinkType type)
```
    Returns one of the optional vendor-specified external links for the add-on version.
    
    Parameters:
    
    type - specifies which type of link to get
    
    Returns:
    
    the link URI, or Option.none() if there is no such link
  - getFunctionalCategories
```
public abstract Iterable<AddonCategorySummary> getFunctionalCategories()
```
    Returns summaries of all functional categories that this add-on version belongs to. A functional category - unlike the logical categories returned by AddonBase.getCategories() - describes a specific kind of feature integration based on the software structure of the add-on (for instance, the types of modules it provides); this is computed by Marketplace, not set by the vendor. Examples of functional categories include macros in Confluence and workflows in JIRA.

Class AddonVersionBase

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AddonVersionBase

Method Detail

getLinks

getSelfUri

getName

getPaymentModel

getStatus

isBeta

isStatic

isSupported

isDeployable

getConnectScopes

isServer

isCloud

isAutoUpdateAllowed

isConnect

isDataCenterCompatible

getDataCenterStatus

isDataCenterStatusCompatible

getLicenseTypeId

getReleaseDate

getReleasedBy

getArtifactInfo

getArtifactUri

getRemoteDescriptorUri

getFunctionalCategoryIds

getExternalLinkUri

getFunctionalCategories