Index
All Classes and Interfaces|All Packages|Serialized Form
A
- Application - Interface in com.atlassian.application.api
-
Represents an Application (e.g.
- APPLICATION - Enum constant in enum class com.atlassian.application.api.ApplicationPlugin.PluginType
-
A plugin that provides fundamental features for the application.
- ApplicationAccess - Interface in com.atlassian.application.api
-
Represents the access control to a
Application(e.g. - ApplicationAccess.AccessError - Enum Class in com.atlassian.application.api
-
Represents the different types of access error.
- ApplicationKey - Class in com.atlassian.application.api
-
Represents the identifier to an Application.
- ApplicationManager - Interface in com.atlassian.application.api
-
Interface into the
Applications (e.g. - ApplicationPlugin - Interface in com.atlassian.application.api
-
Representation of a plugin in an
Application. - ApplicationPlugin.PluginType - Enum Class in com.atlassian.application.api
-
An enumeration holding the different types of plugins.
B
- buildZonedDate() - Method in interface com.atlassian.application.api.Application
-
Return the build date of the application.
C
- canUserAccessApplication(UserKey) - Method in interface com.atlassian.application.api.ApplicationAccess
-
Returns
trueif the user actually able to use the associatedApplication. - clearConfiguration() - Method in interface com.atlassian.application.api.Application
-
Clear (remove) application's configuration.
- com.atlassian.application.api - package com.atlassian.application.api
-
The
atlassian-applicationis a library for accessing information about Applications (e.g.
E
- equals(Object) - Method in class com.atlassian.application.api.ApplicationKey
- EXPIRED - Enum constant in enum class com.atlassian.application.api.ApplicationAccess.AccessError
-
The
Applicationis licensed but that license is now out of date.
G
- getAccess() - Method in interface com.atlassian.application.api.Application
-
Return the
ApplicationAccessassociated with the application. - getAccess(ApplicationKey) - Method in interface com.atlassian.application.api.ApplicationManager
-
Get the
ApplicationAccessassociated with the passed application, orOption.none()if there is noApplicationinstalled with the passed key. - getAccessError(UserKey) - Method in interface com.atlassian.application.api.ApplicationAccess
-
Returns the most important reason why the passed user cannot access the
Application. - getActiveUserCount() - Method in interface com.atlassian.application.api.ApplicationAccess
-
Returns the number of users who are currently able to access the associated
Application. - getApplication(ApplicationKey) - Method in interface com.atlassian.application.api.ApplicationManager
-
Return the installed
Applicationwith the passed key. - getApplication(ApplicationKey, Class<A>) - Method in interface com.atlassian.application.api.ApplicationManager
-
Return the installed
Applicationassociated with the passedApplicationKeyif it is of the correct type. - getApplicationKey() - Method in interface com.atlassian.application.api.ApplicationAccess
-
Get the
ApplicationKeyof theApplicationwhose access control is managed by this instance. - getApplicationPlugins() - Method in interface com.atlassian.application.api.PluginApplication
-
Return all the application plugins in the application.
- getApplications() - Method in interface com.atlassian.application.api.ApplicationManager
-
Return all the
Applications installed on the platform. - getConfigurationURI() - Method in interface com.atlassian.application.api.Application
-
Get the relative URI for the configuration of the application.
- getDefaultGroup() - Method in interface com.atlassian.application.api.Application
-
Get the default user group defined for the application.
- getDefinitionModuleKey() - Method in interface com.atlassian.application.api.PluginApplication
-
Return the module key for the module in the Primary plugin that defines the application.
- getDescription() - Method in interface com.atlassian.application.api.Application
-
Get the description of the application.
- getKey() - Method in interface com.atlassian.application.api.Application
-
Return the
ApplicationKeyassociated with the application. - getLicense() - Method in interface com.atlassian.application.api.Application
-
Return the license associated with the application.
- getManagementPage() - Method in interface com.atlassian.application.api.ApplicationAccess
-
Returns a relative URI to a screen where administrators can manage application access.
- getMaximumUserCount() - Method in interface com.atlassian.application.api.ApplicationAccess
-
Return the maximum number of users that can be given access to the
Application. - getName() - Method in interface com.atlassian.application.api.Application
-
Get the name of the application.
- getPlatform() - Method in interface com.atlassian.application.api.ApplicationManager
-
Return the
PlatformApplicationthat represents the Platform. - getPluginKey() - Method in interface com.atlassian.application.api.ApplicationPlugin
-
The key of the plugin.
- getPlugins() - Method in interface com.atlassian.application.api.PluginApplication
-
Get the primary, application and utility plugins associated with the application.
- getPostInstallURI() - Method in interface com.atlassian.application.api.Application
-
Get the relative URI to show after the application is installed.
- getPostUpdateURI() - Method in interface com.atlassian.application.api.Application
-
Get the relative URI to show after the application is updated.
- getPrimaryPlugin() - Method in interface com.atlassian.application.api.PluginApplication
-
Get the primary plugin associated in the application.
- getProductHelpCloudSpaceURI() - Method in interface com.atlassian.application.api.Application
-
Returns relative URI to use as target space for product user helplinks in cloud.
- getProductHelpServerSpaceURI() - Method in interface com.atlassian.application.api.Application
-
Returns relative URI to use as target space for product user helplinks.
- getType() - Method in interface com.atlassian.application.api.ApplicationPlugin
-
Return the type of this plugin.
- getUserCountDescription(Option<Integer>) - Method in interface com.atlassian.application.api.Application
-
Returns the internationalised description for the passed number of users.
- getUtilityPlugins() - Method in interface com.atlassian.application.api.PluginApplication
-
Return all the utility plugins in the application.
- getVersion() - Method in interface com.atlassian.application.api.Application
-
Get the version of the application.
H
- hashCode() - Method in class com.atlassian.application.api.ApplicationKey
I
- isValid(String) - Static method in class com.atlassian.application.api.ApplicationKey
-
Indicate if the passed key is valid.
N
- NO_ACCESS - Enum constant in enum class com.atlassian.application.api.ApplicationAccess.AccessError
-
The
Applicationis licensed but the user does not have access.
P
- PlatformApplication - Interface in com.atlassian.application.api
-
The
Applicationprovided by the platform directly. - PluginApplication - Interface in com.atlassian.application.api
-
A
Applicationprovided by a set of plugins. - PRIMARY - Enum constant in enum class com.atlassian.application.api.ApplicationPlugin.PluginType
-
A plugin that defines the application.
T
- toString() - Method in class com.atlassian.application.api.ApplicationKey
U
- UNLICENSED - Enum constant in enum class com.atlassian.application.api.ApplicationAccess.AccessError
-
The
Applicationis not licensed. - USERS_EXCEEDED - Enum constant in enum class com.atlassian.application.api.ApplicationAccess.AccessError
-
The
Applicationis licensed but too many users are allowed access. - UTILITY - Enum constant in enum class com.atlassian.application.api.ApplicationPlugin.PluginType
-
A plugin that provides functionality for the primary and application plugins.
V
- value() - Method in class com.atlassian.application.api.ApplicationKey
-
Return the
Stringkey used to create the ApplicationKey. - valueOf(String) - Static method in enum class com.atlassian.application.api.ApplicationAccess.AccessError
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in class com.atlassian.application.api.ApplicationKey
-
Create a new
ApplicationKey. - valueOf(String) - Static method in enum class com.atlassian.application.api.ApplicationPlugin.PluginType
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.atlassian.application.api.ApplicationAccess.AccessError
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.atlassian.application.api.ApplicationPlugin.PluginType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- VERSION_MISMATCH - Enum constant in enum class com.atlassian.application.api.ApplicationAccess.AccessError
-
The
Applicationis too new for the license.
All Classes and Interfaces|All Packages|Serialized Form