Data.Connect.Descriptor

This module provides the data types to let you write your own typesafe Atlassian Connect descriptor and it comes with Aeson bindings so that you can easily convert into json: the format that the Atlassian Connect framework expects.

Atlassian Connect is a framework for writing Add-on's that can run inside the Atlassian Cloud products. You can find more information from the Atlassian Connect documentation https://developer.atlassian.com/static/connect/docs/guides/introduction.html.

The plugin descriptor is defined by the Plugin class. The end result of using this Haskell Module should be for you to end up with a valid Plugin. To turn your plugin into JSON that the Atlassian marketplace can accept just use the encode function from the Aeson library. For example, here in an example Atlassian Connect Descriptor:

pluginToJsonString :: Plugin -> ByteString
pluginToJsonString = encode

exampleDescriptor :: Plugin
exampleDescriptor = (pluginDescriptor (PluginKey "my-example-connect") baseURL (Authentication Jwt))
    { pluginName = Just . Name $ "My Example Connect Addon"
    , pluginDescription = Just "This is an example connect descriptor."
    , vendor = Just $ Vendor (Name "Awesome Devs") (toURI "http://awesome-devs.com")
    , lifecycle = Just defaultLifecycle
    , modules = Just exampleModules
    , enableLicensing = Just False
    , links = HM.fromList
        [ ("documentation", toURI "http://awesome-devs.com/docs")
        , ("source", toURI "http://bitbucket.org/awesome-devs/connect-addon")
        ]
    , scopes = Just [Read, Admin]
    }

exampleModules :: Modules
exampleModules = Modules exampleJIRAModules emptyConfluenceModules

exampleJIRAModules :: JIRAModules
exampleJIRAModules = emptyJIRAModules
    { jmWebPanels = Just
        [ WebPanel
            { wpKey = "test-web-panel"
            , wpName = simpleText "Test Web Panel"
            , wpTooltip = Just $ simpleText "This is a test web panel..."
            , wpLocation = "some-location-in-jira"
            , wpUrl = "/panel/location/for"
            , wpConditions = [staticJiraCondition UserIsAdminJiraCondition]
            , wpWeight = Nothing
            , wpLayout = Nothing
            , wpParams = noParams
            }
        ]
    , jmGeneralPages = Just
        [ JIRAPage
            { jiraPageKey = "test-general-page"
            , jiraPageName = simpleText "Test General Page"
            , jiraPageLocation = Just "some-other-location-in-jira"
            , jiraPageWeight = Just 1234
            , jiraPageUrl = "/panel/general-page"
            , jiraPageIcon = Just IconDetails
                { iconUrl = "/static/path/to/icon.png"
                , iconWidth = Just 20
                , iconHeight = Just 40
                }
            , jiraPageConditions = [staticJiraCondition UserHasIssueHistoryJiraCondition]
            , jiraPageParams = noParams
            }
        ]
    , jmWebhooks = Just
        [ Webhook
            { webhookEvent = JiraIssueDeleted
            , webhookUrl = "/webhook/handle-deletion"
            }
        ]
    }

You can use this library to make your own. This library will experience change whenever the Atlassian Connect descriptor changes. There are likely to be many breaking changes but we will keep track of them using the standard Haskell version structure.

Atlassian Connect Add-on Descriptor

data Plugin

A Plugin is the end result of an Atlassian Connect descriptor. It is what you should provide to the Atlassian Marketplace in order to register your plugin and it is what your Atlassian Cloud customers will download to install your Add-on via the Atlassian UPM (Universal Plugin Manager). Only a very small number of fields are strictly required to generate a valid Atlassian Connect plugin descriptor. Everything that is optional is marked by a maybe type.

Even though we provide documentation here you shoucd check the Atlassian Connect Descriptor documentation if you want to get accurate information on the contents of a plugin: https://developer.atlassian.com/static/connect/docs/modules/

Constructors

Plugin

Fields

• pluginKey :: PluginKey

  Plugin keys are required. The important detail about this key is that it should be unique across the Atlassian Marketplace. For example, a good key might be com.yourcompanyorpersonalname.youraddonname because it would be unique in the marketplace.

• pluginBaseUrl :: URI

  Every plugin must specify a base url where all other relative URI's in the plugin will call to in production. This is the url that the Atlassian Marketplace will query for your descriptor and the url that your customers will come in on. This is especially important for load balanced applications and will also likely be different in your staging and production environments.

• authentication :: Authentication

  The authentication type that you plugin requires. See Authentication for more details.

• pluginName :: Maybe (Name Plugin)

  While your add-on does not require a name it is strongly recommended as this is the human readable name that will appear in the UPM amongst other places.

• pluginDescription :: Maybe Text

  You should give your add-on a description. This description will appear in multiple locations on the Atlassian Marketplace and UPM and will be used to explain what your add-on does.

• vendor :: Maybe Vendor

  You are the Vendor. Put your details here!

• lifecycle :: Maybe Lifecycle

  Atlassian Connect addon's have a lifecycle. Register your handlers for the Lifecycle events here so that you can tell, for example, when your addon is installed or enabled.

• modules :: Maybe Modules

  The modules that your Atlassian Connect add-on provides to the Cloud application. Look at the Modules documentaiton for more information.

• apiVersion :: Maybe Text

  Required if you wish to provide new versions of your addon to a subset of beta customers.

• enableLicensing :: Maybe Bool

  If you are giving away a free add-on then you can set this to false, otherwise set it to true.

• links :: HashMap Text URI

  A collection of custom links that you wish to publish with your add-on. Like documentation or bug-tracking links.

• scopes :: Maybe [ProductScope]

  The scopes that your add-on requires. See ProductScope for more information.

• apiMigrations :: Maybe ApiMigrations

  The Migrations that this app has opted into.

Instances

Show Plugin

Defined in Data.Connect.Descriptor

Methods

showsPrec :: Int -> Plugin -> ShowS

show :: Plugin -> String

showList :: [Plugin] -> ShowS

Generic Plugin

Defined in Data.Connect.Descriptor

Associated Types

type Rep Plugin :: Type -> Type

Methods

from :: Plugin -> Rep Plugin x

to :: Rep Plugin x -> Plugin

ToJSON Plugin

Defined in Data.Connect.Descriptor

Methods

toJSON :: Plugin -> Value

toEncoding :: Plugin -> Encoding

toJSONList :: [Plugin] -> Value

toEncodingList :: [Plugin] -> Encoding

ToJSON (Name Plugin)

Defined in Data.Connect.Descriptor

Methods

toJSON :: Name Plugin -> Value

toEncoding :: Name Plugin -> Encoding

toJSONList :: [Name Plugin] -> Value

toEncodingList :: [Name Plugin] -> Encoding

type Rep Plugin

Defined in Data.Connect.Descriptor

type Rep Plugin = D1 (MetaData "Plugin" "Data.Connect.Descriptor" "atlassian-connect-descriptor-0.4.10.0-9IB5n7ayoT45x7ylOmuoxH" False) (C1 (MetaCons "Plugin" PrefixI True) (((S1 (MetaSel (Just "pluginKey") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PluginKey) :*: (S1 (MetaSel (Just "pluginBaseUrl") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 URI) :*: S1 (MetaSel (Just "authentication") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Authentication))) :*: (S1 (MetaSel (Just "pluginName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Name Plugin))) :*: (S1 (MetaSel (Just "pluginDescription") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "vendor") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Vendor))))) :*: ((S1 (MetaSel (Just "lifecycle") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Lifecycle)) :*: (S1 (MetaSel (Just "modules") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Modules)) :*: S1 (MetaSel (Just "apiVersion") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "enableLicensing") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "links") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (HashMap Text URI))) :*: (S1 (MetaSel (Just "scopes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [ProductScope])) :*: S1 (MetaSel (Just "apiMigrations") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe ApiMigrations)))))))

pluginDescriptor

Arguments

:: PluginKey

The key for your add-on.

-> URI

The base url for your add-on.

-> Authentication

The authentication that your add-on requires.

-> Plugin

A bare-bones Atlassian Connect descriptor.

A helper method to generate a bare-bones Atlassian Connect add-on by providing only the absolutely required fields. You can then use Haskell record syntax to update the plugin with more details. For example:

(pluginDescriptor (PluginKey . pack $ "com.company.mycoolplugin") (fromJust . parseURI $ "http://mycoolplugin.company.com") (Authentication Jwt))
   { pluginName = Just . Name . pack $ "My Cool Plugin"
   , pluginDescription = Just . pack $ "Chil and be cool, you have a plugin descriptor."
   }

Basic Types

data Key t a

This data type represents a Key for a particular data type.

Constructors

Key t

Instances

Eq t => Eq (Key t a)

Defined in Data.Connect.BaseTypes

Methods

(==) :: Key t a -> Key t a -> Bool

(/=) :: Key t a -> Key t a -> Bool

Show t => Show (Key t a)

Defined in Data.Connect.BaseTypes

Methods

showsPrec :: Int -> Key t a -> ShowS

show :: Key t a -> String

showList :: [Key t a] -> ShowS

Generic (Key t a)

Defined in Data.Connect.BaseTypes

Associated Types

type Rep (Key t a) :: Type -> Type

Methods

from :: Key t a -> Rep (Key t a) x

to :: Rep (Key t a) x -> Key t a

type Rep (Key t a)

Defined in Data.Connect.BaseTypes

type Rep (Key t a) = D1 (MetaData "Key" "Data.Connect.BaseTypes" "atlassian-connect-descriptor-0.4.10.0-9IB5n7ayoT45x7ylOmuoxH" False) (C1 (MetaCons "Key" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 t)))

data PluginKey

This data type represents an Atlassian Connect Add-on key.

Constructors

PluginKey Text

Instances

Eq PluginKey

Defined in Data.Connect.BaseTypes

Methods

(==) :: PluginKey -> PluginKey -> Bool

(/=) :: PluginKey -> PluginKey -> Bool

Show PluginKey

Defined in Data.Connect.BaseTypes

Methods

showsPrec :: Int -> PluginKey -> ShowS

show :: PluginKey -> String

showList :: [PluginKey] -> ShowS

Generic PluginKey

Defined in Data.Connect.BaseTypes

Associated Types

type Rep PluginKey :: Type -> Type

Methods

from :: PluginKey -> Rep PluginKey x

to :: Rep PluginKey x -> PluginKey

ToJSON PluginKey

Defined in Data.Connect.BaseTypes

Methods

toJSON :: PluginKey -> Value

toEncoding :: PluginKey -> Encoding

toJSONList :: [PluginKey] -> Value

toEncodingList :: [PluginKey] -> Encoding

ToJSON (Name PluginKey)

Defined in Data.Connect.BaseTypes

Methods

toJSON :: Name PluginKey -> Value

toEncoding :: Name PluginKey -> Encoding

toJSONList :: [Name PluginKey] -> Value

toEncodingList :: [Name PluginKey] -> Encoding

type Rep PluginKey

Defined in Data.Connect.BaseTypes

type Rep PluginKey = D1 (MetaData "PluginKey" "Data.Connect.BaseTypes" "atlassian-connect-descriptor-0.4.10.0-9IB5n7ayoT45x7ylOmuoxH" False) (C1 (MetaCons "PluginKey" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

newtype Timeout

Represents a timeout in seconds.

Constructors

Timeout Second

Instances

Enum Timeout

Defined in Data.Connect.BaseTypes

Methods

succ :: Timeout -> Timeout

pred :: Timeout -> Timeout

toEnum :: Int -> Timeout

fromEnum :: Timeout -> Int

enumFrom :: Timeout -> [Timeout]

enumFromThen :: Timeout -> Timeout -> [Timeout]

enumFromTo :: Timeout -> Timeout -> [Timeout]

enumFromThenTo :: Timeout -> Timeout -> Timeout -> [Timeout]

Eq Timeout

Defined in Data.Connect.BaseTypes

Methods

(==) :: Timeout -> Timeout -> Bool

(/=) :: Timeout -> Timeout -> Bool

Integral Timeout

Defined in Data.Connect.BaseTypes

Methods

quot :: Timeout -> Timeout -> Timeout

rem :: Timeout -> Timeout -> Timeout

div :: Timeout -> Timeout -> Timeout

mod :: Timeout -> Timeout -> Timeout

quotRem :: Timeout -> Timeout -> (Timeout, Timeout)

divMod :: Timeout -> Timeout -> (Timeout, Timeout)

toInteger :: Timeout -> Integer

Num Timeout

Defined in Data.Connect.BaseTypes

Methods

(+) :: Timeout -> Timeout -> Timeout

(-) :: Timeout -> Timeout -> Timeout

(*) :: Timeout -> Timeout -> Timeout

negate :: Timeout -> Timeout

abs :: Timeout -> Timeout

signum :: Timeout -> Timeout

fromInteger :: Integer -> Timeout

Ord Timeout

Defined in Data.Connect.BaseTypes

Methods

compare :: Timeout -> Timeout -> Ordering

(<) :: Timeout -> Timeout -> Bool

(<=) :: Timeout -> Timeout -> Bool

(>) :: Timeout -> Timeout -> Bool

(>=) :: Timeout -> Timeout -> Bool

max :: Timeout -> Timeout -> Timeout

min :: Timeout -> Timeout -> Timeout

Real Timeout

Defined in Data.Connect.BaseTypes

Methods

toRational :: Timeout -> Rational

Show Timeout

Defined in Data.Connect.BaseTypes

Methods

showsPrec :: Int -> Timeout -> ShowS

show :: Timeout -> String

showList :: [Timeout] -> ShowS

data Vendor

Represents the Vendor of the add-on; which will be you. Put your details in this structure.

Constructors

Vendor

Fields

• vendorName :: Name Vendor

  Your name as a Vendor. Might be your personal name or your business name.

• vendorUrl :: URI

  A URL to a website that represents you as a vendor.

Instances

Eq Vendor

Defined in Data.Connect.BaseTypes

Methods

(==) :: Vendor -> Vendor -> Bool

(/=) :: Vendor -> Vendor -> Bool

Show Vendor

Defined in Data.Connect.BaseTypes

Methods

showsPrec :: Int -> Vendor -> ShowS

show :: Vendor -> String

showList :: [Vendor] -> ShowS

Generic Vendor

Defined in Data.Connect.BaseTypes

Associated Types

type Rep Vendor :: Type -> Type

Methods

from :: Vendor -> Rep Vendor x

to :: Rep Vendor x -> Vendor

ToJSON Vendor

Defined in Data.Connect.BaseTypes

Methods

toJSON :: Vendor -> Value

toEncoding :: Vendor -> Encoding

toJSONList :: [Vendor] -> Value

toEncodingList :: [Vendor] -> Encoding

ToJSON (Name Vendor)

Defined in Data.Connect.BaseTypes

Methods

toJSON :: Name Vendor -> Value

toEncoding :: Name Vendor -> Encoding

toJSONList :: [Name Vendor] -> Value

toEncodingList :: [Name Vendor] -> Encoding

type Rep Vendor

Defined in Data.Connect.BaseTypes

type Rep Vendor = D1 (MetaData "Vendor" "Data.Connect.BaseTypes" "atlassian-connect-descriptor-0.4.10.0-9IB5n7ayoT45x7ylOmuoxH" False) (C1 (MetaCons "Vendor" PrefixI True) (S1 (MetaSel (Just "vendorName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Name Vendor)) :*: S1 (MetaSel (Just "vendorUrl") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 URI)))

data Authentication

If your Atlassian Connect addon wants to perform any server side communication with the host product then you will need to use authentication. Otherwise you should specify that you don't need authentication.

Constructors

Authentication

Fields

• authType :: AuthType

  The authentication type that you wish to use.

Instances

Eq Authentication

Defined in Data.Connect.BaseTypes

Methods

(==) :: Authentication -> Authentication -> Bool

(/=) :: Authentication -> Authentication -> Bool

Show Authentication

Defined in Data.Connect.BaseTypes

Methods

showsPrec :: Int -> Authentication -> ShowS

show :: Authentication -> String

showList :: [Authentication] -> ShowS

Generic Authentication

Defined in Data.Connect.BaseTypes

Associated Types

type Rep Authentication :: Type -> Type

Methods

from :: Authentication -> Rep Authentication x

to :: Rep Authentication x -> Authentication

ToJSON Authentication

Defined in Data.Connect.BaseTypes

Methods

toJSON :: Authentication -> Value

toEncoding :: Authentication -> Encoding

toJSONList :: [Authentication] -> Value

toEncodingList :: [Authentication] -> Encoding

type Rep Authentication

Defined in Data.Connect.BaseTypes

type Rep Authentication = D1 (MetaData "Authentication" "Data.Connect.BaseTypes" "atlassian-connect-descriptor-0.4.10.0-9IB5n7ayoT45x7ylOmuoxH" False) (C1 (MetaCons "Authentication" PrefixI True) (S1 (MetaSel (Just "authType") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 AuthType)))

data AuthType

The authentication type that you wish to use in your Add-on.

Constructors

Jwt

If you need to communicate with the host product then you will want to request JWT authentication.

None

If you do not need to communicate the host product then you should request None for authentication.

Instances

Eq AuthType

Defined in Data.Connect.BaseTypes

Methods

(==) :: AuthType -> AuthType -> Bool

(/=) :: AuthType -> AuthType -> Bool

Show AuthType

Defined in Data.Connect.BaseTypes

Methods

showsPrec :: Int -> AuthType -> ShowS

show :: AuthType -> String

showList :: [AuthType] -> ShowS

Generic AuthType

Defined in Data.Connect.BaseTypes

Associated Types

type Rep AuthType :: Type -> Type

Methods

from :: AuthType -> Rep AuthType x

to :: Rep AuthType x -> AuthType

ToJSON AuthType

Defined in Data.Connect.BaseTypes

Methods

toJSON :: AuthType -> Value

toEncoding :: AuthType -> Encoding

toJSONList :: [AuthType] -> Value

toEncodingList :: [AuthType] -> Encoding

type Rep AuthType

Defined in Data.Connect.BaseTypes

type Rep AuthType = D1 (MetaData "AuthType" "Data.Connect.BaseTypes" "atlassian-connect-descriptor-0.4.10.0-9IB5n7ayoT45x7ylOmuoxH" False) (C1 (MetaCons "Jwt" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "None" PrefixI False) (U1 :: Type -> Type))

data IconDetails

Represents an arbitrary icon. Potentially for an Atlassian Connect module or for the entire add-on itself.

Constructors

IconDetails

Fields

• iconUrl :: Text

  The URI to the icon.

• iconWidth :: Maybe Integer

  The width of the icon.

• iconHeight :: Maybe Integer

  The height of the icon.

Instances

Show IconDetails

Defined in Data.Connect.BaseTypes

Methods

showsPrec :: Int -> IconDetails -> ShowS

show :: IconDetails -> String

showList :: [IconDetails] -> ShowS

Generic IconDetails

Defined in Data.Connect.BaseTypes

Associated Types

type Rep IconDetails :: Type -> Type

Methods

from :: IconDetails -> Rep IconDetails x

to :: Rep IconDetails x -> IconDetails

ToJSON IconDetails

Defined in Data.Connect.BaseTypes

Methods

toJSON :: IconDetails -> Value

toEncoding :: IconDetails -> Encoding

toJSONList :: [IconDetails] -> Value

toEncodingList :: [IconDetails] -> Encoding

type Rep IconDetails

Defined in Data.Connect.BaseTypes

type Rep IconDetails = D1 (MetaData "IconDetails" "Data.Connect.BaseTypes" "atlassian-connect-descriptor-0.4.10.0-9IB5n7ayoT45x7ylOmuoxH" False) (C1 (MetaCons "IconDetails" PrefixI True) (S1 (MetaSel (Just "iconUrl") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: (S1 (MetaSel (Just "iconWidth") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Integer)) :*: S1 (MetaSel (Just "iconHeight") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Integer)))))

data Name a

Atlassian Connect descriptors contain many names: module names, add-on names, vendor names etc. We want to make sure that these names don't get put in places that they do not belong. Or, if they do get moved around, they get moved around specifically. We are just adding type saefty to names.

Constructors

Name Text

Instances

Eq (Name a)

Defined in Data.Connect.BaseTypes

Methods

(==) :: Name a -> Name a -> Bool

(/=) :: Name a -> Name a -> Bool

Show (Name a)

Defined in Data.Connect.BaseTypes

Methods

showsPrec :: Int -> Name a -> ShowS

show :: Name a -> String

showList :: [Name a] -> ShowS

Generic (Name a)

Defined in Data.Connect.BaseTypes

Associated Types

type Rep (Name a) :: Type -> Type

Methods

from :: Name a -> Rep (Name a) x

to :: Rep (Name a) x -> Name a

ToJSON (Name Vendor)

Defined in Data.Connect.BaseTypes

Methods

toJSON :: Name Vendor -> Value

toEncoding :: Name Vendor -> Encoding

toJSONList :: [Name Vendor] -> Value

toEncodingList :: [Name Vendor] -> Encoding

ToJSON (Name PluginKey)

Defined in Data.Connect.BaseTypes

Methods

toJSON :: Name PluginKey -> Value

toEncoding :: Name PluginKey -> Encoding

toJSONList :: [Name PluginKey] -> Value

toEncodingList :: [Name PluginKey] -> Encoding

ToJSON (Name Plugin)

Defined in Data.Connect.Descriptor

Methods

toJSON :: Name Plugin -> Value

toEncoding :: Name Plugin -> Encoding

toJSONList :: [Name Plugin] -> Value

toEncodingList :: [Name Plugin] -> Encoding

type Rep (Name a)

Defined in Data.Connect.BaseTypes

type Rep (Name a) = D1 (MetaData "Name" "Data.Connect.BaseTypes" "atlassian-connect-descriptor-0.4.10.0-9IB5n7ayoT45x7ylOmuoxH" False) (C1 (MetaCons "Name" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

data I18nText

Represents a standard text type in the descriptor than may be Internationalised in the future. However, currently there is no I18n support: http://goo.gl/9vJEsW

Constructors

I18nText

Fields

• dValue :: Text

  The raw text value that will show.

• dI18n :: Maybe Text

  The potential i18n key that will be used when we eventually have I18n support: http://goo.gl/9vJEsW

Instances

Show I18nText

Defined in Data.Connect.BaseTypes

Methods

showsPrec :: Int -> I18nText -> ShowS

show :: I18nText -> String

showList :: [I18nText] -> ShowS

Generic I18nText

Defined in Data.Connect.BaseTypes

Associated Types

type Rep I18nText :: Type -> Type

Methods

from :: I18nText -> Rep I18nText x

to :: Rep I18nText x -> I18nText

ToJSON I18nText

Defined in Data.Connect.BaseTypes

Methods

toJSON :: I18nText -> Value

toEncoding :: I18nText -> Encoding

toJSONList :: [I18nText] -> Value

toEncodingList :: [I18nText] -> Encoding

type Rep I18nText

Defined in Data.Connect.BaseTypes

type Rep I18nText = D1 (MetaData "I18nText" "Data.Connect.BaseTypes" "atlassian-connect-descriptor-0.4.10.0-9IB5n7ayoT45x7ylOmuoxH" False) (C1 (MetaCons "I18nText" PrefixI True) (S1 (MetaSel (Just "dValue") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: S1 (MetaSel (Just "dI18n") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))))

simpleText :: Text -> I18nText

Since there is currently no I18n support (http://goo.gl/9vJEsW) we have this helper method to quickly create an I18nText from a standard Text object.

data URLBean

This represents a URL wrapped as an object instead of as a plain text element.

Constructors

URLBean

Fields

• ubUrl :: Text

  The raw URL.

Instances

Show URLBean

Defined in Data.Connect.BaseTypes

Methods

showsPrec :: Int -> URLBean -> ShowS

show :: URLBean -> String

showList :: [URLBean] -> ShowS

Generic URLBean

Defined in Data.Connect.BaseTypes

Associated Types

type Rep URLBean :: Type -> Type

Methods

from :: URLBean -> Rep URLBean x

to :: Rep URLBean x -> URLBean

ToJSON URLBean

Defined in Data.Connect.BaseTypes

Methods

toJSON :: URLBean -> Value

toEncoding :: URLBean -> Encoding

toJSONList :: [URLBean] -> Value

toEncodingList :: [URLBean] -> Encoding

type Rep URLBean

Defined in Data.Connect.BaseTypes

type Rep URLBean = D1 (MetaData "URLBean" "Data.Connect.BaseTypes" "atlassian-connect-descriptor-0.4.10.0-9IB5n7ayoT45x7ylOmuoxH" False) (C1 (MetaCons "URLBean" PrefixI True) (S1 (MetaSel (Just "ubUrl") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

toUrl :: Text -> URLBean

Wrap a regular Text based URL inside a URLBean.

data Length

A basic length type for HTML elements. Useful for WebPanels and other modules that may require length specifications.

Constructors

Pixels Integer

Specify a length in pixels

Percentage Integer

Specify a length as a percentage in the range [0-100].

Instances

Show Length

Defined in Data.Connect.BaseTypes

Methods

showsPrec :: Int -> Length -> ShowS

show :: Length -> String

showList :: [Length] -> ShowS

Generic Length

Defined in Data.Connect.BaseTypes

Associated Types

type Rep Length :: Type -> Type

Methods

from :: Length -> Rep Length x

to :: Rep Length x -> Length

ToJSON Length

Defined in Data.Connect.BaseTypes

Methods

toJSON :: Length -> Value

toEncoding :: Length -> Encoding

toJSONList :: [Length] -> Value

toEncodingList :: [Length] -> Encoding

type Rep Length

Defined in Data.Connect.BaseTypes

type Rep Length = D1 (MetaData "Length" "Data.Connect.BaseTypes" "atlassian-connect-descriptor-0.4.10.0-9IB5n7ayoT45x7ylOmuoxH" False) (C1 (MetaCons "Pixels" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Integer)) :+: C1 (MetaCons "Percentage" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Integer)))

type Weight = Integer

Represents the weight of an element in a menu.

type ModuleParams = HashMap Text Text

The standard representation for module parameters.

noParams :: ModuleParams

No parameters. A useful helper when you don't want to pass any parameters to a module.

Migrations

data ApiMigrations

Constructors

ApiMigrations

Fields

• migrationGdpr :: Bool

Instances

Show ApiMigrations

Defined in Data.Connect.Descriptor

Methods

showsPrec :: Int -> ApiMigrations -> ShowS

show :: ApiMigrations -> String

showList :: [ApiMigrations] -> ShowS

Generic ApiMigrations

Defined in Data.Connect.Descriptor

Associated Types

type Rep ApiMigrations :: Type -> Type

Methods

from :: ApiMigrations -> Rep ApiMigrations x

to :: Rep ApiMigrations x -> ApiMigrations

ToJSON ApiMigrations

Defined in Data.Connect.Descriptor

Methods

toJSON :: ApiMigrations -> Value

toEncoding :: ApiMigrations -> Encoding

toJSONList :: [ApiMigrations] -> Value

toEncodingList :: [ApiMigrations] -> Encoding

type Rep ApiMigrations

Defined in Data.Connect.Descriptor

type Rep ApiMigrations = D1 (MetaData "ApiMigrations" "Data.Connect.Descriptor" "atlassian-connect-descriptor-0.4.10.0-9IB5n7ayoT45x7ylOmuoxH" False) (C1 (MetaCons "ApiMigrations" PrefixI True) (S1 (MetaSel (Just "migrationGdpr") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)))

Lifecycle

data Lifecycle

Every Atlassian Connect add-on can be installed, uninstalled, enabled and disabled. These are known as Lifecycle events. These events will fire on each and every Cloud instance that your add-on is installed on. You can request in your Atlassian Connect add-on descriptor to be alerted of lifecycle events. When the event fires, if you have requested it, you will be given the details of the event in a JSON blob by the host application.

The lifecycle events are documented fully in the Atlassian Connect documentation: https://developer.atlassian.com/static/connect/docs/modules/lifecycle.html

It is important to note that the installed event is particularily important to any Atlassian Connect add-on that needs to use Jwt auth tokens because the installed handler will come with the shared secret for your add-on on that particular instance.

Constructors

Lifecycle

Fields

• installed :: Maybe URI

  Potential relative URI to call every time an add-on is installed on an instance.

• uninstalled :: Maybe URI

  Potential relative URI to call every time an add-on is uninstalled on an instance.

• enabled :: Maybe URI

  Potential relative URI to call every time an add-on is enabled on an instance.

• disabled :: Maybe URI

  Potential relative URI to call every time an add-on is disabled on an instance.

Instances

Show Lifecycle

Defined in Data.Connect.Lifecycle

Methods

showsPrec :: Int -> Lifecycle -> ShowS

show :: Lifecycle -> String

showList :: [Lifecycle] -> ShowS

Generic Lifecycle

Defined in Data.Connect.Lifecycle

Associated Types

type Rep Lifecycle :: Type -> Type

Methods

from :: Lifecycle -> Rep Lifecycle x

to :: Rep Lifecycle x -> Lifecycle

ToJSON Lifecycle

Defined in Data.Connect.Lifecycle

Methods

toJSON :: Lifecycle -> Value

toEncoding :: Lifecycle -> Encoding

toJSONList :: [Lifecycle] -> Value

toEncodingList :: [Lifecycle] -> Encoding

type Rep Lifecycle

Defined in Data.Connect.Lifecycle

type Rep Lifecycle = D1 (MetaData "Lifecycle" "Data.Connect.Lifecycle" "atlassian-connect-descriptor-0.4.10.0-9IB5n7ayoT45x7ylOmuoxH" False) (C1 (MetaCons "Lifecycle" PrefixI True) ((S1 (MetaSel (Just "installed") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe URI)) :*: S1 (MetaSel (Just "uninstalled") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe URI))) :*: (S1 (MetaSel (Just "enabled") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe URI)) :*: S1 (MetaSel (Just "disabled") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe URI)))))

emptyLifecycle :: Lifecycle

The empty Lifecycle allowing you to specify exactly which events you wish to handle with Haskell record syntax.

defaultLifecycle :: Lifecycle

The default Lifecycle where installed goes to /installed and so on and so forth for every lifecycle event. You can choose to disclude certain events by Nothing them out.

Add-on Modules

data Modules

Modules are perhaps the most important part of your Atlassian Connect descriptor. They specify which parts of the host application you wish to inject content into. They provide your entry point into the host application.

Atlassian Connect provides a large set of pre-defined entry points into the host application. Some of which are common to every application and some of which are unique to the particular application that you are targeting:

• To see the JIRA modules: https://developer.atlassian.com/static/connect/docs/modules/jira/index.html
• To see the Confluence modules: https://developer.atlassian.com/static/connect/docs/modules/confluence/index.html

Note: One important point about modules: they must all have a key and that key must be unique inside the same Atlassian Connect addon.

Constructors

Modules

Fields

• jiraModules :: JIRAModules

  All of the JIRA Modules that you wish to define.

• confluenceModules :: ConfluenceModules

  All of the Confluence modules that you wish to define.

Instances

Show Modules

Defined in Data.Connect.Modules

Methods

showsPrec :: Int -> Modules -> ShowS

show :: Modules -> String

showList :: [Modules] -> ShowS

Generic Modules

Defined in Data.Connect.Modules

Associated Types

type Rep Modules :: Type -> Type

Methods

from :: Modules -> Rep Modules x

to :: Rep Modules x -> Modules

ToJSON Modules

Defined in Data.Connect.Modules

Methods

toJSON :: Modules -> Value

toEncoding :: Modules -> Encoding

toJSONList :: [Modules] -> Value

toEncodingList :: [Modules] -> Encoding

type Rep Modules

Defined in Data.Connect.Modules

type Rep Modules = D1 (MetaData "Modules" "Data.Connect.Modules" "atlassian-connect-descriptor-0.4.10.0-9IB5n7ayoT45x7ylOmuoxH" False) (C1 (MetaCons "Modules" PrefixI True) (S1 (MetaSel (Just "jiraModules") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JIRAModules) :*: S1 (MetaSel (Just "confluenceModules") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ConfluenceModules)))

data JIRAModules

A collection of all of the JIRA Modules that you can define. For more documentation on which Modules are supported the Atlassian Connect framework please see Modules. You can also find more documentation on each of the modules.

Constructors

JIRAModules

Fields

• jmWebSections :: Maybe [JIRAWebSection]
• jmWebItems :: Maybe [WebItem]
• jmWebPanels :: Maybe [WebPanel]
• jmGeneralPages :: Maybe [JIRAPage]
• jmAdminPages :: Maybe [JIRAPage]
• jmConfigurePage :: Maybe JIRAPage
• jmJiraSearchRequestViews :: Maybe [JIRASearchRequestView]
• jmJiraProfileTabPanels :: Maybe [JIRAGenericTabPanel]
• jmJiraVersionTabPanels :: Maybe [JIRAGenericTabPanel]
• jmJiraProjectTabPanels :: Maybe [JIRAGenericTabPanel]
• jmJiraProjectAdminTabPanels :: Maybe [JIRAProjectAdminTabPanel]
• jmJiraIssueTabPanels :: Maybe [JIRAGenericTabPanel]
• jmJiraComponentTabPanels :: Maybe [JIRAGenericTabPanel]
• jmJiraIssueContents :: Maybe [JIRAIssueContent]
• jmJiraIssueGlances :: Maybe [JIRAIssueGlance]
• jmJiraReports :: Maybe [JIRAReport]
• jmWebhooks :: Maybe [Webhook]
• jmJiraWorkflowPostFunctions :: Maybe [JIRAWorkflowPostFunction]
• jmJiraEntityProperties :: Maybe [JIRAEntityProperties]

Instances

Show JIRAModules

Defined in Data.Connect.Modules

Methods

showsPrec :: Int -> JIRAModules -> ShowS

show :: JIRAModules -> String

showList :: [JIRAModules] -> ShowS

Generic JIRAModules

Defined in Data.Connect.Modules

Associated Types

type Rep JIRAModules :: Type -> Type

Methods

from :: JIRAModules -> Rep JIRAModules x

to :: Rep JIRAModules x -> JIRAModules

ToJSON JIRAModules

Defined in Data.Connect.Modules

Methods

toJSON :: JIRAModules -> Value

toEncoding :: JIRAModules -> Encoding

toJSONList :: [JIRAModules] -> Value

toEncodingList :: [JIRAModules] -> Encoding

type Rep JIRAModules

Defined in Data.Connect.Modules

type Rep JIRAModules = D1 (MetaData "JIRAModules" "Data.Connect.Modules" "atlassian-connect-descriptor-0.4.10.0-9IB5n7ayoT45x7ylOmuoxH" False) (C1 (MetaCons "JIRAModules" PrefixI True) ((((S1 (MetaSel (Just "jmWebSections") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [JIRAWebSection])) :*: S1 (MetaSel (Just "jmWebItems") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [WebItem]))) :*: (S1 (MetaSel (Just "jmWebPanels") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [WebPanel])) :*: S1 (MetaSel (Just "jmGeneralPages") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [JIRAPage])))) :*: ((S1 (MetaSel (Just "jmAdminPages") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [JIRAPage])) :*: S1 (MetaSel (Just "jmConfigurePage") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe JIRAPage))) :*: (S1 (MetaSel (Just "jmJiraSearchRequestViews") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [JIRASearchRequestView])) :*: (S1 (MetaSel (Just "jmJiraProfileTabPanels") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [JIRAGenericTabPanel])) :*: S1 (MetaSel (Just "jmJiraVersionTabPanels") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [JIRAGenericTabPanel])))))) :*: (((S1 (MetaSel (Just "jmJiraProjectTabPanels") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [JIRAGenericTabPanel])) :*: S1 (MetaSel (Just "jmJiraProjectAdminTabPanels") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [JIRAProjectAdminTabPanel]))) :*: (S1 (MetaSel (Just "jmJiraIssueTabPanels") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [JIRAGenericTabPanel])) :*: (S1 (MetaSel (Just "jmJiraComponentTabPanels") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [JIRAGenericTabPanel])) :*: S1 (MetaSel (Just "jmJiraIssueContents") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [JIRAIssueContent]))))) :*: ((S1 (MetaSel (Just "jmJiraIssueGlances") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [JIRAIssueGlance])) :*: S1 (MetaSel (Just "jmJiraReports") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [JIRAReport]))) :*: (S1 (MetaSel (Just "jmWebhooks") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [Webhook])) :*: (S1 (MetaSel (Just "jmJiraWorkflowPostFunctions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [JIRAWorkflowPostFunction])) :*: S1 (MetaSel (Just "jmJiraEntityProperties") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [JIRAEntityProperties]))))))))

emptyJIRAModules :: JIRAModules

Empty JIRA Modules; useful when you only want to define a few modules via Haskell record syntax.

data ConfluenceModules

A collection of all of the Confluence Modules that you can define. For more documentation on which Modules are supported the Atlassian Connect framework please see Modules. You can also find more documentation on each of the modules.

Constructors

ConfluenceModules

Fields

• confluenceWebPanels :: Maybe [WebPanel]
• confluenceWebItems :: Maybe [WebItem]

Instances

Show ConfluenceModules

Defined in Data.Connect.Modules

Methods

showsPrec :: Int -> ConfluenceModules -> ShowS

show :: ConfluenceModules -> String

showList :: [ConfluenceModules] -> ShowS

Generic ConfluenceModules

Defined in Data.Connect.Modules

Associated Types

type Rep ConfluenceModules :: Type -> Type

Methods

from :: ConfluenceModules -> Rep ConfluenceModules x

to :: Rep ConfluenceModules x -> ConfluenceModules

ToJSON ConfluenceModules

Defined in Data.Connect.Modules

Methods

toJSON :: ConfluenceModules -> Value

toEncoding :: ConfluenceModules -> Encoding

toJSONList :: [ConfluenceModules] -> Value

toEncodingList :: [ConfluenceModules] -> Encoding

type Rep ConfluenceModules

Defined in Data.Connect.Modules

type Rep ConfluenceModules = D1 (MetaData "ConfluenceModules" "Data.Connect.Modules" "atlassian-connect-descriptor-0.4.10.0-9IB5n7ayoT45x7ylOmuoxH" False) (C1 (MetaCons "ConfluenceModules" PrefixI True) (S1 (MetaSel (Just "confluenceWebPanels") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [WebPanel])) :*: S1 (MetaSel (Just "confluenceWebItems") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [WebItem]))))

emptyConfluenceModules :: ConfluenceModules

Empty Confluence Modules; useful when you only want to define a few modules via Haskell record syntax.

Web Sections, Items and Panels

data JIRAWebSection

A JIRAWebSection represents a location in the host application that you can add WebItems to. In this way you can give your add-on sections to inject content into.

For more information read the Atlassian Connect documentation: https://developer.atlassian.com/static/connect/docs/modules/jira/web-section.html

Constructors

JIRAWebSection

Fields

• jwsKey :: Text

  The add-on unique key for this module.

• jwsName :: I18nText

  The name of this section, likely to appear in the User Interface.

• jwsLocation :: Text

  The location in the application interface where the web section should appear.

• jwsTooltip :: Maybe I18nText

  The internationalised text to be used in the link's tooltip.

• jwsConditions :: [Condition]

  The conditions under which to show this web section.

• jwsWeight :: Maybe Weight

  The higher the weight the lower down the menu it will appear.

• jwsParams :: ModuleParams

  Optional parameters to pass to the web section.

Instances

Show JIRAWebSection

Defined in Data.Connect.Modules

Methods

showsPrec :: Int -> JIRAWebSection -> ShowS

show :: JIRAWebSection -> String

showList :: [JIRAWebSection] -> ShowS

Generic JIRAWebSection

Defined in Data.Connect.Modules

Associated Types

type Rep JIRAWebSection :: Type -> Type

Methods

from :: JIRAWebSection -> Rep JIRAWebSection x

to :: Rep JIRAWebSection x -> JIRAWebSection

ToJSON JIRAWebSection

Defined in Data.Connect.Modules

Methods

toJSON :: JIRAWebSection -> Value

toEncoding :: JIRAWebSection -> Encoding

toJSONList :: [JIRAWebSection] -> Value

toEncodingList :: [JIRAWebSection] -> Encoding

type Rep JIRAWebSection

Defined in Data.Connect.Modules

type Rep JIRAWebSection = D1 (MetaData "JIRAWebSection" "Data.Connect.Modules" "atlassian-connect-descriptor-0.4.10.0-9IB5n7ayoT45x7ylOmuoxH" False) (C1 (MetaCons "JIRAWebSection" PrefixI True) ((S1 (MetaSel (Just "jwsKey") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: (S1 (MetaSel (Just "jwsName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 I18nText) :*: S1 (MetaSel (Just "jwsLocation") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text))) :*: ((S1 (MetaSel (Just "jwsTooltip") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe I18nText)) :*: S1 (MetaSel (Just "jwsConditions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Condition])) :*: (S1 (MetaSel (Just "jwsWeight") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Weight)) :*: S1 (MetaSel (Just "jwsParams") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ModuleParams)))))

data WebItem

A WebItem is a like that can be placed in one of an Atlassian Products many menus. Currently the WebItem has the same structure for both JIRA and Confluence. You can read their documentation here:

• JIRA Web Items: https://developer.atlassian.com/static/connect/docs/modules/jira/web-item.html
• Confluence Web Items: https://developer.atlassian.com/static/connect/docs/modules/confluence/web-item.html

Web items are very useful for providing links to your Atlassian Connect pages. See GeneralPage or AdminPage for more information.

Constructors

WebItem

Fields

• wiKey :: Text

  The add-on unique key for this module.

• wiName :: I18nText

  The name of this web item. It will appear as the text of the link.

• wiLocation :: Text

  Where in the product UI this web item will appear.

• wiUrl :: Text

  The URL to direct the user to. May be relative to the host Product or the Addon depending on the context.

• wiTooltip :: Maybe I18nText

  An optional tooltip for the link.

• wiIcon :: Maybe IconDetails

  An optional icon to display with the link text or as the link

• wiWeight :: Maybe Weight

  The higher the weight the lower down in the location menu this web item will appear.

• wiTarget :: Maybe Target

  Determines the way the link is opened. In the page, in a dialog or in an inline dialog.

• wiStyleClasses :: [Text]

  Specifies custom styles for the web item target page

• wiContext :: Maybe WebItemContext

  Determines if the url is relative to the page, product or connect addon.

• wiConditions :: [Condition]

  Determines the conditions under which to show this link.

• wiParams :: ModuleParams

  Optional parameters that you can pass to the web item.

Instances

Show WebItem

Defined in Data.Connect.Modules

Methods

showsPrec :: Int -> WebItem -> ShowS

show :: WebItem -> String

showList :: [WebItem] -> ShowS

Generic WebItem

Defined in Data.Connect.Modules

Associated Types

type Rep WebItem :: Type -> Type

Methods

from :: WebItem -> Rep WebItem x

to :: Rep WebItem x -> WebItem

ToJSON WebItem

Defined in Data.Connect.Modules

Methods

toJSON :: WebItem -> Value

toEncoding :: WebItem -> Encoding

toJSONList :: [WebItem] -> Value

toEncodingList :: [WebItem] -> Encoding

type Rep WebItem

Defined in Data.Connect.Modules

type Rep WebItem = D1 (MetaData "WebItem" "Data.Connect.Modules" "atlassian-connect-descriptor-0.4.10.0-9IB5n7ayoT45x7ylOmuoxH" False) (C1 (MetaCons "WebItem" PrefixI True) (((S1 (MetaSel (Just "wiKey") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: (S1 (MetaSel (Just "wiName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 I18nText) :*: S1 (MetaSel (Just "wiLocation") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text))) :*: (S1 (MetaSel (Just "wiUrl") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: (S1 (MetaSel (Just "wiTooltip") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe I18nText)) :*: S1 (MetaSel (Just "wiIcon") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe IconDetails))))) :*: ((S1 (MetaSel (Just "wiWeight") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Weight)) :*: (S1 (MetaSel (Just "wiTarget") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Target)) :*: S1 (MetaSel (Just "wiStyleClasses") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Text]))) :*: (S1 (MetaSel (Just "wiContext") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe WebItemContext)) :*: (S1 (MetaSel (Just "wiConditions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Condition]) :*: S1 (MetaSel (Just "wiParams") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ModuleParams))))))

data WebItemContext

Wether to open the url relative to the current page, the current addon or the current product. This lets you control where Atlassian Connect web items point to.

Constructors

PageContext

AddonContext

ProductContext

Instances

Show WebItemContext

Defined in Data.Connect.Modules

Methods

showsPrec :: Int -> WebItemContext -> ShowS

show :: WebItemContext -> String

showList :: [WebItemContext] -> ShowS

Generic WebItemContext

Defined in Data.Connect.Modules

Associated Types

type Rep WebItemContext :: Type -> Type

Methods

from :: WebItemContext -> Rep WebItemContext x

to :: Rep WebItemContext x -> WebItemContext

ToJSON WebItemContext

Defined in Data.Connect.Modules

Methods

toJSON :: WebItemContext -> Value

toEncoding :: WebItemContext -> Encoding

toJSONList :: [WebItemContext] -> Value

toEncodingList :: [WebItemContext] -> Encoding

type Rep WebItemContext

Defined in Data.Connect.Modules

type Rep WebItemContext = D1 (MetaData "WebItemContext" "Data.Connect.Modules" "atlassian-connect-descriptor-0.4.10.0-9IB5n7ayoT45x7ylOmuoxH" False) (C1 (MetaCons "PageContext" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "AddonContext" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "ProductContext" PrefixI False) (U1 :: Type -> Type)))

data WebPanel

A WebPanel is an injectable segment of the host application that you can place content inside. Currently the WebPanel has the same structure for both JIRA and Confluence but, potentially, that could change in the future. You can read their Atlassian Connect documentation here:

• JIRA Web panels: https://developer.atlassian.com/static/connect/docs/modules/jira/web-panel.html
• Confluence Web panels: https://developer.atlassian.com/static/connect/docs/modules/confluence/web-panel.html

Here is what an example Hello World web panel might look like:

helloWorldWebPanel = WebPanel
   { wpKey = "hello-world"
   , wpName = Name "Hello world!"
   , wpUrl = "/panel/show-hello-world"
   , wpLocation = "atl.jira.view.issue.right.context"
   , wpConditions = [staticJiraCondition UserIsLoggedInJiraCondition]
   }
   where
      toURI = fromJust . parseRelativeReference

WebPanels are a great way to inject your add-on's content into the host application.

Constructors

WebPanel

Fields

• wpKey :: Text

  The add-on unique key for this module.

• wpName :: I18nText

  The name of this panel, likely to appear in the User Interface.

• wpUrl :: Text

  The relative URI that the host product will hit to get HTML content.

• wpLocation :: Text

  The location that this content should be injected in the host product.

• wpConditions :: [Condition]

  The Conditions that need to be met for this module to be displayed.

• wpTooltip :: Maybe I18nText

  A tooltip that explains what this is for.

• wpWeight :: Maybe Weight

  Web panels can be ordered and a higher weight makes you appear lower down the page.

• wpLayout :: Maybe WebPanelLayout

  You can specify the dimensions of this panel. This will only be considered in certain locations.

• wpParams :: ModuleParams

  You can pass parameters to the web panel.

Instances

Show WebPanel

Defined in Data.Connect.Modules

Methods

showsPrec :: Int -> WebPanel -> ShowS

show :: WebPanel -> String

showList :: [WebPanel] -> ShowS

Generic WebPanel

Defined in Data.Connect.Modules

Associated Types

type Rep WebPanel :: Type -> Type

Methods

from :: WebPanel -> Rep WebPanel x

to :: Rep WebPanel x -> WebPanel

ToJSON WebPanel

Defined in Data.Connect.Modules

Methods

toJSON :: WebPanel -> Value

toEncoding :: WebPanel -> Encoding

toJSONList :: [WebPanel] -> Value

toEncodingList :: [WebPanel] -> Encoding

type Rep WebPanel

Defined in Data.Connect.Modules

type Rep WebPanel = D1 (MetaData "WebPanel" "Data.Connect.Modules" "atlassian-connect-descriptor-0.4.10.0-9IB5n7ayoT45x7ylOmuoxH" False) (C1 (MetaCons "WebPanel" PrefixI True) (((S1 (MetaSel (Just "wpKey") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: S1 (MetaSel (Just "wpName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 I18nText)) :*: (S1 (MetaSel (Just "wpUrl") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: S1 (MetaSel (Just "wpLocation") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text))) :*: ((S1 (MetaSel (Just "wpConditions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Condition]) :*: S1 (MetaSel (Just "wpTooltip") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe I18nText))) :*: (S1 (MetaSel (Just "wpWeight") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Weight)) :*: (S1 (MetaSel (Just "wpLayout") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe WebPanelLayout)) :*: S1 (MetaSel (Just "wpParams") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ModuleParams))))))

data WebPanelLayout

A WebPanelLayout allows you to specify the dimensions of your Web Panel if that is required.

Constructors

WebPanelLayout

Fields

• wplWidth :: Length
• wplHeight :: Length

Instances

Show WebPanelLayout

Defined in Data.Connect.Modules

Methods

showsPrec :: Int -> WebPanelLayout -> ShowS

show :: WebPanelLayout -> String

showList :: [WebPanelLayout] -> ShowS

Generic WebPanelLayout

Defined in Data.Connect.Modules

Associated Types

type Rep WebPanelLayout :: Type -> Type

Methods

from :: WebPanelLayout -> Rep WebPanelLayout x

to :: Rep WebPanelLayout x -> WebPanelLayout

ToJSON WebPanelLayout

Defined in Data.Connect.Modules

Methods

toJSON :: WebPanelLayout -> Value

toEncoding :: WebPanelLayout -> Encoding

toJSONList :: [WebPanelLayout] -> Value

toEncodingList :: [WebPanelLayout] -> Encoding

type Rep WebPanelLayout

Defined in Data.Connect.Modules

type Rep WebPanelLayout = D1 (MetaData "WebPanelLayout" "Data.Connect.Modules" "atlassian-connect-descriptor-0.4.10.0-9IB5n7ayoT45x7ylOmuoxH" False) (C1 (MetaCons "WebPanelLayout" PrefixI True) (S1 (MetaSel (Just "wplWidth") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Length) :*: S1 (MetaSel (Just "wplHeight") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Length)))

JIRA Pages

data JIRAPage

A JIRAPage is gives you a location in the host product that you addon can present content and behave just like any other host product page. The main types of pages in JIRA are:

• General pages: for just getting a geniric chunk of realestate to display your content.
• Admin pages: for getting a page in the admin seciton of JIRA to display your content.
• Configuration page: Every Atlassian Connect plugin can have a configuration page to configure the plugin when installed.

This is very useful for pages like Configuration screens or Statistics pages where you really want the user to be immersed in working with your add-on inside the host product.

General pages, like Web Panels, are common to JIRA and Confluence and share the same json format. However they have separate documentation:

• JIRA General Page: https://developer.atlassian.com/static/connect/docs/modules/jira/general-page.html
• Confluence General Page: https://developer.atlassian.com/static/connect/docs/modules/confluence/general-page.html

Even though, at this point in time, the documentation looks identical. You can find the Admin page and Configure page documentation in the official Atlassian Connect documentation too.

Constructors

JIRAPage

Fields

• jiraPageKey :: Text

  The add-on unique key for this module.

• jiraPageName :: I18nText

  The name of this JIRA page. Likely to be used in the page title.

• jiraPageUrl :: Text

  The relative URI that the host product will hit to get the HTML content for the page.

• jiraPageLocation :: Maybe Text

  The location for this General Page to display; see the docs for your options.

• jiraPageWeight :: Maybe Weight

  Determines the order that this item appears in any menu or list. Lower numbers mean that it will appear higher in the list.

• jiraPageIcon :: Maybe IconDetails

  The optional icon to use for this JIRA page.

• jiraPageConditions :: [Condition]

  The Conditions that need to be met for this page to be displayed.

• jiraPageParams :: ModuleParams

  Optional parameters for the page.

Instances

Show JIRAPage

Defined in Data.Connect.Modules

Methods

showsPrec :: Int -> JIRAPage -> ShowS

show :: JIRAPage -> String

showList :: [JIRAPage] -> ShowS

Generic JIRAPage

Defined in Data.Connect.Modules

Associated Types

type Rep JIRAPage :: Type -> Type

Methods

from :: JIRAPage -> Rep JIRAPage x

to :: Rep JIRAPage x -> JIRAPage

ToJSON JIRAPage

Defined in Data.Connect.Modules

Methods

toJSON :: JIRAPage -> Value

toEncoding :: JIRAPage -> Encoding

toJSONList :: [JIRAPage] -> Value

toEncodingList :: [JIRAPage] -> Encoding

type Rep JIRAPage

Defined in Data.Connect.Modules

type Rep JIRAPage = D1 (MetaData "JIRAPage" "Data.Connect.Modules" "atlassian-connect-descriptor-0.4.10.0-9IB5n7ayoT45x7ylOmuoxH" False) (C1 (MetaCons "JIRAPage" PrefixI True) (((S1 (MetaSel (Just "jiraPageKey") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: S1 (MetaSel (Just "jiraPageName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 I18nText)) :*: (S1 (MetaSel (Just "jiraPageUrl") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: S1 (MetaSel (Just "jiraPageLocation") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "jiraPageWeight") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Weight)) :*: S1 (MetaSel (Just "jiraPageIcon") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe IconDetails))) :*: (S1 (MetaSel (Just "jiraPageConditions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Condition]) :*: S1 (MetaSel (Just "jiraPageParams") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ModuleParams)))))

JIRA Tab Panels

data JIRAGenericTabPanel

JIRA has the concept of a TabPanel which is a panel where you can inject content along with a WebItem that is automatically created for you so that you can navigate to the tab panel in question. Tab panels often have a common format and this JIRAGenericTabPanel encapsulates that common format and allows you to apply it to many different scenarios.

Constructors

JIRAGenericTabPanel

Fields

• jtpKey :: Text

  The add-on unique key for this module.

• jtpName :: I18nText

  The user facing name of this panel. Likely to appear as the name of the link to the tab panel.

• jtpUrl :: Text

  The URL to your addon where you will provide the content for the panel.

• jtpConditions :: [Condition]

  The conditions under which this tapb panel should be displayed.

• jtpWeight :: Maybe Weight

  The higher the weight the lower down in the list of tabs the link to this tab panel will be displayed.

• jtpParams :: ModuleParams

  Optional parameters for the tab panel.

Instances

Show JIRAGenericTabPanel

Defined in Data.Connect.Modules

Methods

showsPrec :: Int -> JIRAGenericTabPanel -> ShowS

show :: JIRAGenericTabPanel -> String

showList :: [JIRAGenericTabPanel] -> ShowS

Generic JIRAGenericTabPanel

Defined in Data.Connect.Modules

Associated Types

type Rep JIRAGenericTabPanel :: Type -> Type

Methods

from :: JIRAGenericTabPanel -> Rep JIRAGenericTabPanel x

to :: Rep JIRAGenericTabPanel x -> JIRAGenericTabPanel

ToJSON JIRAGenericTabPanel

Defined in Data.Connect.Modules

Methods

toJSON :: JIRAGenericTabPanel -> Value

toEncoding :: JIRAGenericTabPanel -> Encoding

toJSONList :: [JIRAGenericTabPanel] -> Value

toEncodingList :: [JIRAGenericTabPanel] -> Encoding

type Rep JIRAGenericTabPanel

Defined in Data.Connect.Modules

type Rep JIRAGenericTabPanel = D1 (MetaData "JIRAGenericTabPanel" "Data.Connect.Modules" "atlassian-connect-descriptor-0.4.10.0-9IB5n7ayoT45x7ylOmuoxH" False) (C1 (MetaCons "JIRAGenericTabPanel" PrefixI True) ((S1 (MetaSel (Just "jtpKey") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: (S1 (MetaSel (Just "jtpName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 I18nText) :*: S1 (MetaSel (Just "jtpUrl") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text))) :*: (S1 (MetaSel (Just "jtpConditions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Condition]) :*: (S1 (MetaSel (Just "jtpWeight") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Weight)) :*: S1 (MetaSel (Just "jtpParams") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ModuleParams)))))

data JIRAProjectAdminTabPanel

A JIRAProjectAdminTabPanel is useful for when you want to add a page to the administration screens of a project. This module will create a web item in the sidebar of every project for you and provide a web panel in the JIRA Project Admin section.

Constructors

JIRAProjectAdminTabPanel

Fields

• jpatpKey :: Text

  The add-on unique key for this module.

• jpatpName :: I18nText

  The user facing name of this panel. Likely to appear as the name of the link to the tab panel.

• jpatpUrl :: Text

  The URL to your addon where you will provide the content for the panel.

• jpatpLocation :: Text

  The location in JIRA Admin that you wish the link to this panel to appear.

• jpatpConditions :: [Condition]

  The conditions under which this panel should be displayed. UserIsAdminCondition is redundant.

• jpatpWeight :: Maybe Weight

  The higher the weight the lower down in the list of tabs the link to this tab panel will be displayed.

• jpatpParams :: ModuleParams

  Optional parameters for the tab panel.

Instances

Show JIRAProjectAdminTabPanel

Defined in Data.Connect.Modules

Methods

showsPrec :: Int -> JIRAProjectAdminTabPanel -> ShowS

show :: JIRAProjectAdminTabPanel -> String

showList :: [JIRAProjectAdminTabPanel] -> ShowS

Generic JIRAProjectAdminTabPanel

Defined in Data.Connect.Modules

Associated Types

type Rep JIRAProjectAdminTabPanel :: Type -> Type

Methods

from :: JIRAProjectAdminTabPanel -> Rep JIRAProjectAdminTabPanel x

to :: Rep JIRAProjectAdminTabPanel x -> JIRAProjectAdminTabPanel

ToJSON JIRAProjectAdminTabPanel

Defined in Data.Connect.Modules

Methods

toJSON :: JIRAProjectAdminTabPanel -> Value

toEncoding :: JIRAProjectAdminTabPanel -> Encoding

toJSONList :: [JIRAProjectAdminTabPanel] -> Value

toEncodingList :: [JIRAProjectAdminTabPanel] -> Encoding

type Rep JIRAProjectAdminTabPanel

Defined in Data.Connect.Modules

type Rep JIRAProjectAdminTabPanel = D1 (MetaData "JIRAProjectAdminTabPanel" "Data.Connect.Modules" "atlassian-connect-descriptor-0.4.10.0-9IB5n7ayoT45x7ylOmuoxH" False) (C1 (MetaCons "JIRAProjectAdminTabPanel" PrefixI True) ((S1 (MetaSel (Just "jpatpKey") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: (S1 (MetaSel (Just "jpatpName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 I18nText) :*: S1 (MetaSel (Just "jpatpUrl") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text))) :*: ((S1 (MetaSel (Just "jpatpLocation") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: S1 (MetaSel (Just "jpatpConditions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Condition])) :*: (S1 (MetaSel (Just "jpatpWeight") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Weight)) :*: S1 (MetaSel (Just "jpatpParams") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ModuleParams)))))

JIRA Specific Modules

data JIRASearchRequestView

A Search Request View allows you to render a custom representation of a search result. Rendering a custom XML format is a common example.

For more information read the Atlassian Connect documentation: https://developer.atlassian.com/static/connect/docs/modules/jira/search-request-view.html

Constructors

JIRASearchRequestView

Fields

• jsrvKey :: Text

  The add-on unique key for this module.

• jsrvName :: I18nText

  The name of this Search Request View. Will appear in the Export menu.

• jsrvUrl :: Text

  This URL will render the search results.

• jsrvDescription :: Maybe I18nText

  The description of this view.

• jsrvWeight :: Maybe Weight

  A higher weight puts the link further down the export menu.

• jsrvConditions :: [Condition]

  The conditions under which this option should show.

• jsrvParams :: ModuleParams

  The optional parameters to this search request view.

Instances

Show JIRASearchRequestView

Defined in Data.Connect.Modules

Methods

showsPrec :: Int -> JIRASearchRequestView -> ShowS

show :: JIRASearchRequestView -> String

showList :: [JIRASearchRequestView] -> ShowS

Generic JIRASearchRequestView

Defined in Data.Connect.Modules

Associated Types

type Rep JIRASearchRequestView :: Type -> Type

Methods

from :: JIRASearchRequestView -> Rep JIRASearchRequestView x

to :: Rep JIRASearchRequestView x -> JIRASearchRequestView

ToJSON JIRASearchRequestView

Defined in Data.Connect.Modules

Methods

toJSON :: JIRASearchRequestView -> Value

toEncoding :: JIRASearchRequestView -> Encoding

toJSONList :: [JIRASearchRequestView] -> Value

toEncodingList :: [JIRASearchRequestView] -> Encoding

type Rep JIRASearchRequestView

Defined in Data.Connect.Modules

type Rep JIRASearchRequestView = D1 (MetaData "JIRASearchRequestView" "Data.Connect.Modules" "atlassian-connect-descriptor-0.4.10.0-9IB5n7ayoT45x7ylOmuoxH" False) (C1 (MetaCons "JIRASearchRequestView" PrefixI True) ((S1 (MetaSel (Just "jsrvKey") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: (S1 (MetaSel (Just "jsrvName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 I18nText) :*: S1 (MetaSel (Just "jsrvUrl") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text))) :*: ((S1 (MetaSel (Just "jsrvDescription") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe I18nText)) :*: S1 (MetaSel (Just "jsrvWeight") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Weight))) :*: (S1 (MetaSel (Just "jsrvConditions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Condition]) :*: S1 (MetaSel (Just "jsrvParams") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ModuleParams)))))

data JIRAIssueContent

This module adds a content button to the context area of the new Jira issue view. Content can have an icon, tooltip, and target.

Constructors

JIRAIssueContent

Fields

• jicKey :: Text

  The add-on unique key for this module.

• jicName :: I18nText

  The name of this JIRA Issue Content.

• jicTooltip :: I18nText

  The tooltip for this JIRA Issue Content.

• jicIcon :: IconDetails

  The icon for this JIRA Issue Content.

• jicTarget :: JIRAIssueContentTarget

  Specifies the target action when clicking on the content.

• jicConditions :: [Condition]

  The conditions under which the content could be shown.

• jicContentPresentConditions :: [Condition]

  The conditions under which the content will always be shown.

Instances

Show JIRAIssueContent

Defined in Data.Connect.Modules

Methods

showsPrec :: Int -> JIRAIssueContent -> ShowS

show :: JIRAIssueContent -> String

showList :: [JIRAIssueContent] -> ShowS

Generic JIRAIssueContent

Defined in Data.Connect.Modules

Associated Types

type Rep JIRAIssueContent :: Type -> Type

Methods

from :: JIRAIssueContent -> Rep JIRAIssueContent x

to :: Rep JIRAIssueContent x -> JIRAIssueContent

ToJSON JIRAIssueContent

Defined in Data.Connect.Modules

Methods

toJSON :: JIRAIssueContent -> Value

toEncoding :: JIRAIssueContent -> Encoding

toJSONList :: [JIRAIssueContent] -> Value

toEncodingList :: [JIRAIssueContent] -> Encoding

type Rep JIRAIssueContent

Defined in Data.Connect.Modules

type Rep JIRAIssueContent = D1 (MetaData "JIRAIssueContent" "Data.Connect.Modules" "atlassian-connect-descriptor-0.4.10.0-9IB5n7ayoT45x7ylOmuoxH" False) (C1 (MetaCons "JIRAIssueContent" PrefixI True) ((S1 (MetaSel (Just "jicKey") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: (S1 (MetaSel (Just "jicName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 I18nText) :*: S1 (MetaSel (Just "jicTooltip") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 I18nText))) :*: ((S1 (MetaSel (Just "jicIcon") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 IconDetails) :*: S1 (MetaSel (Just "jicTarget") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JIRAIssueContentTarget)) :*: (S1 (MetaSel (Just "jicConditions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Condition]) :*: S1 (MetaSel (Just "jicContentPresentConditions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Condition])))))

data JIRAIssueContentTarget

Constructors

JIRAIssueContentTargetWebPanel

Fields

• jictwpUrl :: Text

  The url to the content that will be loaded in the glance iframe.

Instances

Show JIRAIssueContentTarget

Defined in Data.Connect.Modules

Methods

showsPrec :: Int -> JIRAIssueContentTarget -> ShowS

show :: JIRAIssueContentTarget -> String

showList :: [JIRAIssueContentTarget] -> ShowS

ToJSON JIRAIssueContentTarget

Defined in Data.Connect.Modules

Methods

toJSON :: JIRAIssueContentTarget -> Value

toEncoding :: JIRAIssueContentTarget -> Encoding

toJSONList :: [JIRAIssueContentTarget] -> Value

toEncodingList :: [JIRAIssueContentTarget] -> Encoding

data JIRAIssueGlance

This module adds a glance to the context area of the new Jira issue view. Glances can have an icon, content, and status.

Constructors

JIRAIssueGlance

Fields

• jigKey :: Text

  The add-on unique key for this module.

• jigName :: I18nText

  The name of this JIRA Glance.

• jigContent :: JIRAIssueGlanceContent

  This content becomes the label next to the icon. It's handy for communicating a small amount of information.

• jigIcon :: IconDetails

  Specifies an icon to display at the left of the glance view control. The icon resource provided in this field should be 24x24 pixels or larger, preferably in .SVG format.

• jigTarget :: JIRAIssueGlanceTarget

  Specifies the target action when clicking on the glance.

• jigConditions :: [Condition]

  The conditions under which the glance will be shown.

Instances

Show JIRAIssueGlance

Defined in Data.Connect.Modules

Methods

showsPrec :: Int -> JIRAIssueGlance -> ShowS

show :: JIRAIssueGlance -> String

showList :: [JIRAIssueGlance] -> ShowS

Generic JIRAIssueGlance

Defined in Data.Connect.Modules

Associated Types

type Rep JIRAIssueGlance :: Type -> Type

Methods

from :: JIRAIssueGlance -> Rep JIRAIssueGlance x

to :: Rep JIRAIssueGlance x -> JIRAIssueGlance

ToJSON JIRAIssueGlance

Defined in Data.Connect.Modules

Methods

toJSON :: JIRAIssueGlance -> Value

toEncoding :: JIRAIssueGlance -> Encoding

toJSONList :: [JIRAIssueGlance] -> Value

toEncodingList :: [JIRAIssueGlance] -> Encoding

type Rep JIRAIssueGlance

Defined in Data.Connect.Modules

type Rep JIRAIssueGlance = D1 (MetaData "JIRAIssueGlance" "Data.Connect.Modules" "atlassian-connect-descriptor-0.4.10.0-9IB5n7ayoT45x7ylOmuoxH" False) (C1 (MetaCons "JIRAIssueGlance" PrefixI True) ((S1 (MetaSel (Just "jigKey") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: (S1 (MetaSel (Just "jigName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 I18nText) :*: S1 (MetaSel (Just "jigContent") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JIRAIssueGlanceContent))) :*: (S1 (MetaSel (Just "jigIcon") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 IconDetails) :*: (S1 (MetaSel (Just "jigTarget") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JIRAIssueGlanceTarget) :*: S1 (MetaSel (Just "jigConditions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Condition])))))

data JIRAIssueGlanceContent

Constructors

JIRAIssueGlanceContentLabel

Fields

• jigclLabel :: I18nText

Instances

Show JIRAIssueGlanceContent

Defined in Data.Connect.Modules

Methods

showsPrec :: Int -> JIRAIssueGlanceContent -> ShowS

show :: JIRAIssueGlanceContent -> String

showList :: [JIRAIssueGlanceContent] -> ShowS

ToJSON JIRAIssueGlanceContent

Defined in Data.Connect.Modules

Methods

toJSON :: JIRAIssueGlanceContent -> Value

toEncoding :: JIRAIssueGlanceContent -> Encoding

toJSONList :: [JIRAIssueGlanceContent] -> Value

toEncodingList :: [JIRAIssueGlanceContent] -> Encoding

data JIRAIssueGlanceTarget

Constructors

JIRAIssueGlanceTargetWebPanel

Fields

• jigtwpUrl :: Text

  The url to the content that will be loaded in the glance iframe.

Instances

Show JIRAIssueGlanceTarget

Defined in Data.Connect.Modules

Methods

showsPrec :: Int -> JIRAIssueGlanceTarget -> ShowS

show :: JIRAIssueGlanceTarget -> String

showList :: [JIRAIssueGlanceTarget] -> ShowS

ToJSON JIRAIssueGlanceTarget

Defined in Data.Connect.Modules

Methods

toJSON :: JIRAIssueGlanceTarget -> Value

toEncoding :: JIRAIssueGlanceTarget -> Encoding

toJSONList :: [JIRAIssueGlanceTarget] -> Value

toEncodingList :: [JIRAIssueGlanceTarget] -> Encoding

data JIRAReport

A JIRAReport will provide a report on the JIRA issues in the project. It allows you to write custom reporting for JIRA.

For more information read the Atlassian Connect documentation: https://developer.atlassian.com/static/connect/docs/modules/jira/report.html

Constructors

JIRAReport

Fields

• jrKey :: Text

  The add-on unique key for this module.

• jrName :: I18nText

  The user facing name of this report.

• jrUrl :: Text

  The URL that will render the report back to the user.

• jrDescription :: I18nText

  The required user facing description of this report.

• jrReportCategory :: Maybe JIRAReportCategory

  The category that this report should be placed inside.

• jrWeight :: Maybe Weight

  A higher weight will push this report further down the list of reports.

• jrThumbnailUrl :: Maybe Text

  A thumbnail that gives a gist of what this report is supposed to accomplish.

Instances

Show JIRAReport

Defined in Data.Connect.Modules

Methods

showsPrec :: Int -> JIRAReport -> ShowS

show :: JIRAReport -> String

showList :: [JIRAReport] -> ShowS

Generic JIRAReport

Defined in Data.Connect.Modules

Associated Types

type Rep JIRAReport :: Type -> Type

Methods

from :: JIRAReport -> Rep JIRAReport x

to :: Rep JIRAReport x -> JIRAReport

ToJSON JIRAReport

Defined in Data.Connect.Modules

Methods

toJSON :: JIRAReport -> Value

toEncoding :: JIRAReport -> Encoding

toJSONList :: [JIRAReport] -> Value

toEncodingList :: [JIRAReport] -> Encoding

type Rep JIRAReport

Defined in Data.Connect.Modules

type Rep JIRAReport = D1 (MetaData "JIRAReport" "Data.Connect.Modules" "atlassian-connect-descriptor-0.4.10.0-9IB5n7ayoT45x7ylOmuoxH" False) (C1 (MetaCons "JIRAReport" PrefixI True) ((S1 (MetaSel (Just "jrKey") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: (S1 (MetaSel (Just "jrName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 I18nText) :*: S1 (MetaSel (Just "jrUrl") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text))) :*: ((S1 (MetaSel (Just "jrDescription") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 I18nText) :*: S1 (MetaSel (Just "jrReportCategory") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe JIRAReportCategory))) :*: (S1 (MetaSel (Just "jrWeight") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Weight)) :*: S1 (MetaSel (Just "jrThumbnailUrl") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))))))

data JIRAReportCategory

The report category for a JIRAReport. Useful in organising the different types of reports.

Constructors

AgileRC

This report is visible to agile customers.

IssueAnalysisRC

This report does issue analysis.

ForecastManagementRC

This report considers future of the project state.

OtherRC

Any report that does not fit into the other categories goes here.

Instances

Show JIRAReportCategory

Defined in Data.Connect.Modules

Methods

showsPrec :: Int -> JIRAReportCategory -> ShowS

show :: JIRAReportCategory -> String

showList :: [JIRAReportCategory] -> ShowS

ToJSON JIRAReportCategory

Defined in Data.Connect.Modules

Methods

toJSON :: JIRAReportCategory -> Value

toEncoding :: JIRAReportCategory -> Encoding

toJSONList :: [JIRAReportCategory] -> Value

toEncodingList :: [JIRAReportCategory] -> Encoding

data Target

A Target represents the location that a link will be opened into.

Constructors

TargetPage

Open the link into the current page.

TargetDialog (Maybe DialogOptions)

Open the link into a dialog on the page with the given options.

TargetInlineDialog (Maybe InlineDialogOptions)

Open the link into an inline dialog with the given options.

Instances

Show Target

Defined in Data.Connect.Modules

Methods

showsPrec :: Int -> Target -> ShowS

show :: Target -> String

showList :: [Target] -> ShowS

ToJSON Target

Defined in Data.Connect.Modules

Methods

toJSON :: Target -> Value

toEncoding :: Target -> Encoding

toJSONList :: [Target] -> Value

toEncodingList :: [Target] -> Encoding

data JIRAWorkflowPostFunction

A JIRAWorkflowPostFunction carries out any additional processing required after a JIRA workflow transition is executed.

For more information read the Atlassian Connect documentation: https://developer.atlassian.com/static/connect/docs/modules/jira/workflow-post-function.html

Or you could read the JIRA documentation on Workflow Post Functions to learn more: https://confluence.atlassian.com/display/Cloud/Advanced+Workflow+Configuration#AdvancedWorkflowConfiguration-postfunctions

Constructors

JIRAWorkflowPostFunction

Fields

• jwpfKey :: Text

  The add-on unique key for this module.

• jwpfName :: I18nText

  The user facing name of this workflow post function.

• jwpfTriggered :: URLBean

  The add-on URL to hit when the post function is triggered. The URL will be POST'ed to and you should read the Atlassian Connect docs for more details.

• jwpfDescription :: Maybe I18nText

  The user facing description of this post function.

• jwpfCreate :: Maybe URLBean

  The add-on URL to the configuration page for the post function when it is created.

• jwpfEdit :: Maybe URLBean

  The add-on URL to the configuration edit page of the post function.

• jwpfView :: Maybe URLBean

  The add-on URL to the view page for the read-only view of the configuration.

Instances

Show JIRAWorkflowPostFunction

Defined in Data.Connect.Modules

Methods

showsPrec :: Int -> JIRAWorkflowPostFunction -> ShowS

show :: JIRAWorkflowPostFunction -> String

showList :: [JIRAWorkflowPostFunction] -> ShowS

Generic JIRAWorkflowPostFunction

Defined in Data.Connect.Modules

Associated Types

type Rep JIRAWorkflowPostFunction :: Type -> Type

Methods

from :: JIRAWorkflowPostFunction -> Rep JIRAWorkflowPostFunction x

to :: Rep JIRAWorkflowPostFunction x -> JIRAWorkflowPostFunction

ToJSON JIRAWorkflowPostFunction

Defined in Data.Connect.Modules

Methods

toJSON :: JIRAWorkflowPostFunction -> Value

toEncoding :: JIRAWorkflowPostFunction -> Encoding

toJSONList :: [JIRAWorkflowPostFunction] -> Value

toEncodingList :: [JIRAWorkflowPostFunction] -> Encoding

type Rep JIRAWorkflowPostFunction

Defined in Data.Connect.Modules

type Rep JIRAWorkflowPostFunction = D1 (MetaData "JIRAWorkflowPostFunction" "Data.Connect.Modules" "atlassian-connect-descriptor-0.4.10.0-9IB5n7ayoT45x7ylOmuoxH" False) (C1 (MetaCons "JIRAWorkflowPostFunction" PrefixI True) ((S1 (MetaSel (Just "jwpfKey") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: (S1 (MetaSel (Just "jwpfName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 I18nText) :*: S1 (MetaSel (Just "jwpfTriggered") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 URLBean))) :*: ((S1 (MetaSel (Just "jwpfDescription") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe I18nText)) :*: S1 (MetaSel (Just "jwpfCreate") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe URLBean))) :*: (S1 (MetaSel (Just "jwpfEdit") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe URLBean)) :*: S1 (MetaSel (Just "jwpfView") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe URLBean))))))

data DialogOptions

Options for a dialog that a link may be opened into.

Constructors

DialogOptions

Fields

• doHeight :: Maybe Integer

  The height of the dialog on the page.

• doWidth :: Maybe Integer

  The width of the dialog on the page.

• doChrome :: Maybe Bool

  Whether the dialog should contain the AUI header and buttons. Default is true

Instances

Show DialogOptions

Defined in Data.Connect.Modules

Methods

showsPrec :: Int -> DialogOptions -> ShowS

show :: DialogOptions -> String

showList :: [DialogOptions] -> ShowS

Generic DialogOptions

Defined in Data.Connect.Modules

Associated Types

type Rep DialogOptions :: Type -> Type

Methods

from :: DialogOptions -> Rep DialogOptions x

to :: Rep DialogOptions x -> DialogOptions

ToJSON DialogOptions

Defined in Data.Connect.Modules

Methods

toJSON :: DialogOptions -> Value

toEncoding :: DialogOptions -> Encoding

toJSONList :: [DialogOptions] -> Value

toEncodingList :: [DialogOptions] -> Encoding

type Rep DialogOptions

Defined in Data.Connect.Modules

type Rep DialogOptions = D1 (MetaData "DialogOptions" "Data.Connect.Modules" "atlassian-connect-descriptor-0.4.10.0-9IB5n7ayoT45x7ylOmuoxH" False) (C1 (MetaCons "DialogOptions" PrefixI True) (S1 (MetaSel (Just "doHeight") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Integer)) :*: (S1 (MetaSel (Just "doWidth") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Integer)) :*: S1 (MetaSel (Just "doChrome") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool)))))

data InlineDialogOptions

Options for an inline dialog that a link may be opened into.

Constructors

InlineDialogOptions

Fields

• idoWidth :: Maybe Text

  Sets how wide the inline-dialog is in pixels

• idoOnTop :: Maybe Bool

  Determines if the dialog should be shown above the trigger or not

• idoIsRelativeToMouse :: Maybe Bool

  Determines if the dialog should be shown relative to where the mouse is at the time of the event trigger

• idoShowDelay :: Maybe Integer

  Determines how long in milliseconds after a show trigger is fired until the dialog is shown

• idoOnHover :: Maybe Bool

  Determines whether the inline-Dialog will show on a mouseOver or mouseClick of the trigger

• idoOffsetX :: Maybe Text

  Sets an offset distance of the inline-dialog from the trigger element along the x-axis in pixels

• idoOffsetY :: Maybe Text

  Sets an offset distance of the inline-dialog from the trigger element along the y-axis in pixels

• idoPersistent :: Maybe Bool

  This option, ignores the closeOthers option

• idoCloseOthers :: Maybe Bool

  Cetermines if all other dialogs on the screen are closed when this one is opened

Instances

Show InlineDialogOptions

Defined in Data.Connect.Modules

Methods

showsPrec :: Int -> InlineDialogOptions -> ShowS

show :: InlineDialogOptions -> String

showList :: [InlineDialogOptions] -> ShowS

Generic InlineDialogOptions

Defined in Data.Connect.Modules

Associated Types

type Rep InlineDialogOptions :: Type -> Type

Methods

from :: InlineDialogOptions -> Rep InlineDialogOptions x

to :: Rep InlineDialogOptions x -> InlineDialogOptions

ToJSON InlineDialogOptions

Defined in Data.Connect.Modules

Methods

toJSON :: InlineDialogOptions -> Value

toEncoding :: InlineDialogOptions -> Encoding

toJSONList :: [InlineDialogOptions] -> Value

toEncodingList :: [InlineDialogOptions] -> Encoding

type Rep InlineDialogOptions

Defined in Data.Connect.Modules

type Rep InlineDialogOptions = D1 (MetaData "InlineDialogOptions" "Data.Connect.Modules" "atlassian-connect-descriptor-0.4.10.0-9IB5n7ayoT45x7ylOmuoxH" False) (C1 (MetaCons "InlineDialogOptions" PrefixI True) (((S1 (MetaSel (Just "idoWidth") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "idoOnTop") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool))) :*: (S1 (MetaSel (Just "idoIsRelativeToMouse") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "idoShowDelay") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Integer)))) :*: ((S1 (MetaSel (Just "idoOnHover") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "idoOffsetX") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "idoOffsetY") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "idoPersistent") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "idoCloseOthers") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool)))))))

data JIRAEntityProperties

JIRAEntityProperties are used to set Key / Value pair information on JIRA Issues that can be searched via JQL and are indexed by JIRA. The can also be accessed directly via rest api so they allow you to store data in client-only Atlassian Connect plugins. Very handy!

The data stored as entity properties is in the JSON data format so multiple values can be stored against the one property.

For more information read the JIRA Documentation on the topic: https://developer.atlassian.com/display/JIRADEV/JIRA+Entity+Properties+Overview

Or read the Atlassian Connect documentation on the topic: https://developer.atlassian.com/static/connect/docs/modules/jira/entity-property.html

Constructors

JIRAEntityProperties

Fields

• jepKey :: Text

  The add-on unique key for this module.

• jepName :: I18nText

  The user facing name of this entity property.

• jepEntityType :: Maybe EntityType

  The entity type that you want to attach this property to. Issue by default.

• jepKeyConfigurations :: [KeyConfiguration]

  The list of key configurations that you wish to define.

Instances

Show JIRAEntityProperties

Defined in Data.Connect.Modules

Methods

showsPrec :: Int -> JIRAEntityProperties -> ShowS

show :: JIRAEntityProperties -> String

showList :: [JIRAEntityProperties] -> ShowS

Generic JIRAEntityProperties

Defined in Data.Connect.Modules

Associated Types

type Rep JIRAEntityProperties :: Type -> Type

Methods

from :: JIRAEntityProperties -> Rep JIRAEntityProperties x

to :: Rep JIRAEntityProperties x -> JIRAEntityProperties

ToJSON JIRAEntityProperties

Defined in Data.Connect.Modules

Methods

toJSON :: JIRAEntityProperties -> Value

toEncoding :: JIRAEntityProperties -> Encoding

toJSONList :: [JIRAEntityProperties] -> Value

toEncodingList :: [JIRAEntityProperties] -> Encoding

type Rep JIRAEntityProperties

Defined in Data.Connect.Modules

type Rep JIRAEntityProperties = D1 (MetaData "JIRAEntityProperties" "Data.Connect.Modules" "atlassian-connect-descriptor-0.4.10.0-9IB5n7ayoT45x7ylOmuoxH" False) (C1 (MetaCons "JIRAEntityProperties" PrefixI True) ((S1 (MetaSel (Just "jepKey") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: S1 (MetaSel (Just "jepName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 I18nText)) :*: (S1 (MetaSel (Just "jepEntityType") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe EntityType)) :*: S1 (MetaSel (Just "jepKeyConfigurations") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [KeyConfiguration]))))

data EntityType

An EntityType represents the type of entity that the JIRA Entity Property should be attatched to. By default entity types are attatched to issues.

Constructors

IssueEntityType

Instances

Show EntityType

Defined in Data.Connect.Modules

Methods

showsPrec :: Int -> EntityType -> ShowS

show :: EntityType -> String

showList :: [EntityType] -> ShowS

ToJSON EntityType

Defined in Data.Connect.Modules

Methods

toJSON :: EntityType -> Value

toEncoding :: EntityType -> Encoding

toJSONList :: [EntityType] -> Value

toEncodingList :: [EntityType] -> Encoding

data KeyConfiguration

A KeyConfiguration is the key for this particular property and the JSON flattened paths to the elements that should be extracted from this property. For more information see the Atlassian Connect documentation: https://developer.atlassian.com/static/connect/docs/modules/fragment/index-key-configuration.html

Constructors

KeyConfiguration

Fields

• kcPropertyKey :: Text

  The name of the JIRA Entity Property

• kcExtractions :: [Extraction]

  All of the data extractions from the property that should be indexed.

Instances

Show KeyConfiguration

Defined in Data.Connect.Modules

Methods

showsPrec :: Int -> KeyConfiguration -> ShowS

show :: KeyConfiguration -> String

showList :: [KeyConfiguration] -> ShowS

Generic KeyConfiguration

Defined in Data.Connect.Modules

Associated Types

type Rep KeyConfiguration :: Type -> Type

Methods

from :: KeyConfiguration -> Rep KeyConfiguration x

to :: Rep KeyConfiguration x -> KeyConfiguration

ToJSON KeyConfiguration

Defined in Data.Connect.Modules

Methods

toJSON :: KeyConfiguration -> Value

toEncoding :: KeyConfiguration -> Encoding

toJSONList :: [KeyConfiguration] -> Value

toEncodingList :: [KeyConfiguration] -> Encoding

type Rep KeyConfiguration

Defined in Data.Connect.Modules

type Rep KeyConfiguration = D1 (MetaData "KeyConfiguration" "Data.Connect.Modules" "atlassian-connect-descriptor-0.4.10.0-9IB5n7ayoT45x7ylOmuoxH" False) (C1 (MetaCons "KeyConfiguration" PrefixI True) (S1 (MetaSel (Just "kcPropertyKey") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: S1 (MetaSel (Just "kcExtractions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Extraction])))

data Extraction

An Extraction represents a snippet of data that should be extracted from a KeyConfiguration such that it is Indexed by JIRA and capable of being searched in JQL.

Constructors

Extraction

Fields

• extractionObjectName :: Text

  The json path to the data in the json data stored in this property.

• extractionType :: ExtractionType

  The type of data contained in this extraction. Arrays are automatically handled.

• extractionAlias :: Maybe Text

  The alias for this extraction to use in JQL queries.

Instances

Show Extraction

Defined in Data.Connect.Modules

Methods

showsPrec :: Int -> Extraction -> ShowS

show :: Extraction -> String

showList :: [Extraction] -> ShowS

Generic Extraction

Defined in Data.Connect.Modules

Associated Types

type Rep Extraction :: Type -> Type

Methods

from :: Extraction -> Rep Extraction x

to :: Rep Extraction x -> Extraction

ToJSON Extraction

Defined in Data.Connect.Modules

Methods

toJSON :: Extraction -> Value

toEncoding :: Extraction -> Encoding

toJSONList :: [Extraction] -> Value

toEncodingList :: [Extraction] -> Encoding

type Rep Extraction

Defined in Data.Connect.Modules

type Rep Extraction = D1 (MetaData "Extraction" "Data.Connect.Modules" "atlassian-connect-descriptor-0.4.10.0-9IB5n7ayoT45x7ylOmuoxH" False) (C1 (MetaCons "Extraction" PrefixI True) (S1 (MetaSel (Just "extractionObjectName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: (S1 (MetaSel (Just "extractionType") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ExtractionType) :*: S1 (MetaSel (Just "extractionAlias") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)))))

data ExtractionType

The style in which the data should be extracted and indexed. For example, you may want the data to be treated as a Date or as a Number.

Constructors

ExtractionTypeNumber

Index the data as a numeric type.

ExtractionTypeText

Index the data as a text based type, with words.

ExtractionTypeString

Index the data as an exact string.

ExtractionTypeDate

Index the data as a Date.

ExtractionTypeUser

Index the data as Atlassian Account IDs.

Instances

Show ExtractionType

Defined in Data.Connect.Modules

Methods

showsPrec :: Int -> ExtractionType -> ShowS

show :: ExtractionType -> String

showList :: [ExtractionType] -> ShowS

ToJSON ExtractionType

Defined in Data.Connect.Modules

Methods

toJSON :: ExtractionType -> Value

toEncoding :: ExtractionType -> Encoding

toJSONList :: [ExtractionType] -> Value

toEncodingList :: [ExtractionType] -> Encoding

Webhooks

data Webhook

When users of the host application perform updates your Atlassian Connect add-on will not be alerted unless it listens to the WebhookEvents coming from that application. Webhooks are the way to close the issue recency loop in the Atlassian products. It is important to note that Webhooks are 'best effort' and that there is no guarantee that the webhook will make it to your Atlassian Connect application.

The Atlassian connect webhook documentation explains this in more detail: https://developer.atlassian.com/static/connect/docs/modules/jira/webhook.html

Constructors

Webhook

Fields

• webhookEvent :: WebhookEvent

  The event that you want your Atlassian Connect add-on to watch.

• webhookUrl :: Text

  The relative URI that you wish to handle the webhook response.

Instances

Show Webhook

Defined in Data.Connect.Webhooks

Methods

showsPrec :: Int -> Webhook -> ShowS

show :: Webhook -> String

showList :: [Webhook] -> ShowS

Generic Webhook

Defined in Data.Connect.Webhooks

Associated Types

type Rep Webhook :: Type -> Type

Methods

from :: Webhook -> Rep Webhook x

to :: Rep Webhook x -> Webhook

ToJSON Webhook

Defined in Data.Connect.Webhooks

Methods

toJSON :: Webhook -> Value

toEncoding :: Webhook -> Encoding

toJSONList :: [Webhook] -> Value

toEncodingList :: [Webhook] -> Encoding

type Rep Webhook

Defined in Data.Connect.Webhooks

type Rep Webhook = D1 (MetaData "Webhook" "Data.Connect.Webhooks" "atlassian-connect-descriptor-0.4.10.0-9IB5n7ayoT45x7ylOmuoxH" False) (C1 (MetaCons "Webhook" PrefixI True) (S1 (MetaSel (Just "webhookEvent") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 WebhookEvent) :*: S1 (MetaSel (Just "webhookUrl") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

data WebhookEvent

The webhook event that you wish to watch from your Atlassian Connect add-on.

Constructors

ConnectAddonDisabled

ConnectAddonEnabled

JiraWebhookPostFunction

JiraIssueCreated

JiraIssueDeleted

JiraIssueUpdated

JiraWorklogUpdated

JiraVersionCreated

JiraVersionDeleted

JiraVersionMerged

JiraVersionUpdated

JiraVersionMoved

JiraVersionReleased

JiraVersionUnreleased

JiraProjectCreated

JiraProjectUpdated

JiraProjectDeleted

JiraPluginEnabled

JiraPluginsUpgraded

JiraRemoteIssueLinkAggregateClearedEvent

JiraRemoteWorkflowPostFunction

JiraUserCreated

JiraUserDeleted

JiraUserUpdated

ConfluenceAttachmentCreated

ConfluenceAttachmentRemoved

ConfluenceAttachmentUpdated

ConfluenceAttachmentViewed

ConfluenceBlogCreated

ConfluenceBlogRemoved

ConfluenceBlogRestored

ConfluenceBlogTrashed

ConfluenceBlogUpdated

ConfluenceBlogViewed

ConfluenceCacheStatisticsChanged

ConfluenceCommentCreated

ConfluenceCommentRemoved

ConfluenceCommentUpdated

ConfluenceContentPermissionsUpdated

ConfluenceLabelAdded

ConfluenceLabelCreated

ConfluenceLabelDeleted

ConfluenceLabelRemoved

ConfluenceLogin

ConfluenceLoginFailed

ConfluenceLogout

ConfluencePageChildrenReordered

ConfluencePageCreated

ConfluencePageMoved

ConfluencePageRemoved

ConfluencePageRestored

ConfluencePageTrashed

ConfluencePageUpdated

ConfluencePageViewed

ConfluenceSearchPerformed

ConfluenceSpaceCreated

ConfluenceSpaceLogoUpdated

ConfluenceSpacePermissionsUpdated

ConfluenceSpaceRemoved

ConfluenceSpaceUpdated

ConfluenceStatusCleared

ConfluenceStatusCreated

ConfluenceStatusRemoved

ConfluenceUserCreated

ConfluenceUserDeactivated

ConfluenceUserFollowed

ConfluenceUserReactivated

ConfluenceUserRemoved

ConfluenceGroupCreated

ConfluenceGroupRemoved

Instances

Show WebhookEvent

Defined in Data.Connect.Webhooks

Methods

showsPrec :: Int -> WebhookEvent -> ShowS

show :: WebhookEvent -> String

showList :: [WebhookEvent] -> ShowS

ToJSON WebhookEvent

Defined in Data.Connect.Webhooks

Methods

toJSON :: WebhookEvent -> Value

toEncoding :: WebhookEvent -> Encoding

toJSONList :: [WebhookEvent] -> Value

toEncodingList :: [WebhookEvent] -> Encoding

Module Conditions

data Condition

A Condition can be placed on an Atlassian Connect Module to cause it to display or not based on the result it returns. For example, you can choose not to show a WebPanel if the user viewing the page is not logged in. Conditions are very useful in curating when your modules will appear to your users.

The Atlassian Connect documentation describes conditions fully: https://developer.atlassian.com/static/connect/docs/concepts/conditions.html

Constructors

SingleCondition

A single condition based on a source.

Fields

• conditionSource :: ConditionSource

  The source of this condition.

• conditionInverted :: Bool

  If you should invert the condition. For example, only show if user is NOT logged in.

• conditionParams :: HashMap String String

  Extra parameters to pass with the condition to give it context.

CompositeCondition

A condition that is the composition of one or more conditions. The ConditionType decides the way in which the conditions are composed

Fields

• subConditions :: [Condition]

  The conditions that will be merged together.

• conditionType :: ConditionType

  The way in which the conditions will be merged together.

Instances

Show Condition

Defined in Data.Connect.Conditions

Methods

showsPrec :: Int -> Condition -> ShowS

show :: Condition -> String

showList :: [Condition] -> ShowS

ToJSON Condition

Defined in Data.Connect.Conditions

Methods

toJSON :: Condition -> Value

toEncoding :: Condition -> Encoding

toJSONList :: [Condition] -> Value

toEncodingList :: [Condition] -> Encoding

data ConditionType

Composite Conditions can be joined together to behave as a single condition. The way that you can join them together is decided by the condition type.

Constructors

AndCondition

The boolean intersection of the conditions.

OrCondition

The boolean union of the conditions.

Instances

Eq ConditionType

Defined in Data.Connect.Conditions

Methods

(==) :: ConditionType -> ConditionType -> Bool

(/=) :: ConditionType -> ConditionType -> Bool

Show ConditionType

Defined in Data.Connect.Conditions

Methods

showsPrec :: Int -> ConditionType -> ShowS

show :: ConditionType -> String

showList :: [ConditionType] -> ShowS

ToJSON ConditionType

Defined in Data.Connect.Conditions

Methods

toJSON :: ConditionType -> Value

toEncoding :: ConditionType -> Encoding

toJSONList :: [ConditionType] -> Value

toEncodingList :: [ConditionType] -> Encoding

data ConditionSource

Conditions can be specified by the Host application or by the Atlassian Connect add-on itself. This means that the source of the condition needs to be specified and that is what you can use this data type to do.

Constructors

StaticJIRACondition JIRACondition

A static JIRA condition.

StaticConfluenceCondition ConfluenceCondition

A static Confluence condition.

RemoteCondition

A remote condition defined by your Atlassian Connect application.

Fields

• remoteConditionPath :: String

  The relative URI that you should hit in your Atlassian Connect application to get the condition result. This URI, when hit, should return a JSON response in the format:

  { "shouldDisplay": <true|false> }

Instances

Eq ConditionSource

Defined in Data.Connect.Conditions

Methods

(==) :: ConditionSource -> ConditionSource -> Bool

(/=) :: ConditionSource -> ConditionSource -> Bool

Show ConditionSource

Defined in Data.Connect.Conditions

Methods

showsPrec :: Int -> ConditionSource -> ShowS

show :: ConditionSource -> String

showList :: [ConditionSource] -> ShowS

ToJSON ConditionSource

Defined in Data.Connect.Conditions

Methods

toJSON :: ConditionSource -> Value

toEncoding :: ConditionSource -> Encoding

toJSONList :: [ConditionSource] -> Value

toEncodingList :: [ConditionSource] -> Encoding

remoteCondition :: String -> Condition

Given a URI that defines a remote condition convert it into a regular Condition.

data JIRACondition

The conditions that have been provided by JIRA. Please see the single condition documentation for more details: https://developer.atlassian.com/static/connect/docs/modules/fragment/single-condition.html

Constructors

CanAttachFileToIssueJiraCondition

CanManageAttachmentsJiraCondition

EntityPropertyEqualToJiraCondition

FeatureFlagJiraCondition

HasIssuePermissionJiraCondition

HasProjectPermissionJiraCondition

Returns true if there is a selected project and the user has project admin to it.

HasSelectedProjectPermissionJiraCondition

HasSubTasksAvaliableJiraCondition

HasVotedForIssueJiraCondition

IsAdminModeJiraCondition

IsIssueAssignedToCurrentUserJiraCondition

IsIssueEditableJiraCondition

IsIssueReportedByCurrentUserJiraCondition

IsIssueUnresolvedJiraCondition

IsSubTaskJiraCondition

IsWatchingIssueJiraCondition

LinkingEnabledJiraCondition

SubTasksEnabledJiraCondition

TimeTrackingEnabledJiraCondition

UserHasIssueHistoryJiraCondition

UserIsAdminJiraCondition

UserIsLoggedInJiraCondition

UserIsProjectAdminJiraCondition

UserIsSysadminJiraCondition

UserIsTheLoggedInUserJiraCondition

VotingEnabledJiraCondition

WatchingEnabledJiraCondition

Instances

Eq JIRACondition

Defined in Data.Connect.Conditions

Methods

(==) :: JIRACondition -> JIRACondition -> Bool

(/=) :: JIRACondition -> JIRACondition -> Bool

Show JIRACondition

Defined in Data.Connect.Conditions

Methods

showsPrec :: Int -> JIRACondition -> ShowS

show :: JIRACondition -> String

showList :: [JIRACondition] -> ShowS

Generic JIRACondition

Defined in Data.Connect.Conditions

Associated Types

type Rep JIRACondition :: Type -> Type

Methods

from :: JIRACondition -> Rep JIRACondition x

to :: Rep JIRACondition x -> JIRACondition

ToJSON JIRACondition

Defined in Data.Connect.Conditions

Methods

toJSON :: JIRACondition -> Value

toEncoding :: JIRACondition -> Encoding

toJSONList :: [JIRACondition] -> Value

toEncodingList :: [JIRACondition] -> Encoding

type Rep JIRACondition

Defined in Data.Connect.Conditions

type Rep JIRACondition = D1 (MetaData "JIRACondition" "Data.Connect.Conditions" "atlassian-connect-descriptor-0.4.10.0-9IB5n7ayoT45x7ylOmuoxH" False) ((((C1 (MetaCons "CanAttachFileToIssueJiraCondition" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "CanManageAttachmentsJiraCondition" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "EntityPropertyEqualToJiraCondition" PrefixI False) (U1 :: Type -> Type))) :+: (C1 (MetaCons "FeatureFlagJiraCondition" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "HasIssuePermissionJiraCondition" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "HasProjectPermissionJiraCondition" PrefixI False) (U1 :: Type -> Type)))) :+: ((C1 (MetaCons "HasSelectedProjectPermissionJiraCondition" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "HasSubTasksAvaliableJiraCondition" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "HasVotedForIssueJiraCondition" PrefixI False) (U1 :: Type -> Type))) :+: ((C1 (MetaCons "IsAdminModeJiraCondition" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "IsIssueAssignedToCurrentUserJiraCondition" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "IsIssueEditableJiraCondition" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "IsIssueReportedByCurrentUserJiraCondition" PrefixI False) (U1 :: Type -> Type))))) :+: (((C1 (MetaCons "IsIssueUnresolvedJiraCondition" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "IsSubTaskJiraCondition" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "IsWatchingIssueJiraCondition" PrefixI False) (U1 :: Type -> Type))) :+: ((C1 (MetaCons "LinkingEnabledJiraCondition" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "SubTasksEnabledJiraCondition" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "TimeTrackingEnabledJiraCondition" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "UserHasIssueHistoryJiraCondition" PrefixI False) (U1 :: Type -> Type)))) :+: ((C1 (MetaCons "UserIsAdminJiraCondition" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "UserIsLoggedInJiraCondition" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "UserIsProjectAdminJiraCondition" PrefixI False) (U1 :: Type -> Type))) :+: ((C1 (MetaCons "UserIsSysadminJiraCondition" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "UserIsTheLoggedInUserJiraCondition" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "VotingEnabledJiraCondition" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "WatchingEnabledJiraCondition" PrefixI False) (U1 :: Type -> Type))))))

staticJiraCondition :: JIRACondition -> Condition

Turn a standard JIRA Condition into a regular Condition.

data ConfluenceCondition

The conditions that have been provided by Confluence. Please see the single condition documentation for more details: https://developer.atlassian.com/static/connect/docs/modules/fragment/single-condition.html

Constructors

ActiveThemeConfluenceCondition

CanEditSpaceStylesConfluenceCondition

CanSignupConfluenceCondition

ContentHasAnyPermissionsSetConfluenceCondition

CreateContentConfluenceCondition

EmailAddressPublicConfluenceCondition

FavouritePageConfluenceCondition

FavouriteSpaceConfluenceCondition

FeatureFlagConfluenceCondition

FollowingTargetUserConfluenceCondition

HasAttachmentConfluenceCondition

HasBlogPostConfluenceCondition

HasPageConfluenceCondition

HasSpaceConfluenceCondition

HasTemplateConfluenceCondition

LatestVersionConfluenceCondition

NotPersonalSpaceConfluenceCondition

PrintableVersionConfluenceCondition

ShowingPageAttachmentsConfluenceCondition

SpaceFunctionPermissionConfluenceCondition

SpaceSidebarConfluenceCondition

TargetUserCanSetStatusConfluenceCondition

TargetUserHasPersonalBlogConfluenceCondition

TargetUserHasPersonalSpaceConfluenceCondition

ThreadedCommentsConfluenceCondition

TinyUrlSupportedConfluenceCondition

UserCanCreatePersonalSpaceConfluenceCondition

UserCanUpdateUserStatusConfluenceCondition

UserCanUseConfluenceConfluenceCondition

UserFavouritingTargetUserPersonalSpaceConfluenceCondition

UserHasPersonalBlogConfluenceCondition

UserHasPersonalSpaceConfluenceCondition

UserIsAdminConfluenceCondition

UserIsConfluenceAdministratorConfluenceCondition

UserIsLoggedInConfluenceCondition

UserIsSysadminConfluenceCondition

UserLoggedInEditableConfluenceCondition

UserWatchingPageConfluenceCondition

UserWatchingSpaceConfluenceCondition

UserWatchingSpaceForContentTypeConfluenceCondition

ViewingContentConfluenceCondition

ViewingOwnProfileConfluenceCondition

Instances

Eq ConfluenceCondition

Defined in Data.Connect.Conditions

Methods

(==) :: ConfluenceCondition -> ConfluenceCondition -> Bool

(/=) :: ConfluenceCondition -> ConfluenceCondition -> Bool

Show ConfluenceCondition

Defined in Data.Connect.Conditions

Methods

showsPrec :: Int -> ConfluenceCondition -> ShowS

show :: ConfluenceCondition -> String

showList :: [ConfluenceCondition] -> ShowS

Generic ConfluenceCondition

Defined in Data.Connect.Conditions

Associated Types

type Rep ConfluenceCondition :: Type -> Type

Methods

from :: ConfluenceCondition -> Rep ConfluenceCondition x

to :: Rep ConfluenceCondition x -> ConfluenceCondition

ToJSON ConfluenceCondition

Defined in Data.Connect.Conditions

Methods

toJSON :: ConfluenceCondition -> Value

toEncoding :: ConfluenceCondition -> Encoding

toJSONList :: [ConfluenceCondition] -> Value

toEncodingList :: [ConfluenceCondition] -> Encoding

type Rep ConfluenceCondition

Defined in Data.Connect.Conditions

type Rep ConfluenceCondition = D1 (MetaData "ConfluenceCondition" "Data.Connect.Conditions" "atlassian-connect-descriptor-0.4.10.0-9IB5n7ayoT45x7ylOmuoxH" False) (((((C1 (MetaCons "ActiveThemeConfluenceCondition" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "CanEditSpaceStylesConfluenceCondition" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "CanSignupConfluenceCondition" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "ContentHasAnyPermissionsSetConfluenceCondition" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "CreateContentConfluenceCondition" PrefixI False) (U1 :: Type -> Type)))) :+: ((C1 (MetaCons "EmailAddressPublicConfluenceCondition" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "FavouritePageConfluenceCondition" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "FavouriteSpaceConfluenceCondition" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "FeatureFlagConfluenceCondition" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "FollowingTargetUserConfluenceCondition" PrefixI False) (U1 :: Type -> Type))))) :+: (((C1 (MetaCons "HasAttachmentConfluenceCondition" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "HasBlogPostConfluenceCondition" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "HasPageConfluenceCondition" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "HasSpaceConfluenceCondition" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "HasTemplateConfluenceCondition" PrefixI False) (U1 :: Type -> Type)))) :+: ((C1 (MetaCons "LatestVersionConfluenceCondition" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "NotPersonalSpaceConfluenceCondition" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "PrintableVersionConfluenceCondition" PrefixI False) (U1 :: Type -> Type))) :+: (C1 (MetaCons "ShowingPageAttachmentsConfluenceCondition" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "SpaceFunctionPermissionConfluenceCondition" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "SpaceSidebarConfluenceCondition" PrefixI False) (U1 :: Type -> Type)))))) :+: ((((C1 (MetaCons "TargetUserCanSetStatusConfluenceCondition" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "TargetUserHasPersonalBlogConfluenceCondition" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "TargetUserHasPersonalSpaceConfluenceCondition" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "ThreadedCommentsConfluenceCondition" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "TinyUrlSupportedConfluenceCondition" PrefixI False) (U1 :: Type -> Type)))) :+: ((C1 (MetaCons "UserCanCreatePersonalSpaceConfluenceCondition" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "UserCanUpdateUserStatusConfluenceCondition" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "UserCanUseConfluenceConfluenceCondition" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "UserFavouritingTargetUserPersonalSpaceConfluenceCondition" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "UserHasPersonalBlogConfluenceCondition" PrefixI False) (U1 :: Type -> Type))))) :+: (((C1 (MetaCons "UserHasPersonalSpaceConfluenceCondition" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "UserIsAdminConfluenceCondition" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "UserIsConfluenceAdministratorConfluenceCondition" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "UserIsLoggedInConfluenceCondition" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "UserIsSysadminConfluenceCondition" PrefixI False) (U1 :: Type -> Type)))) :+: ((C1 (MetaCons "UserLoggedInEditableConfluenceCondition" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "UserWatchingPageConfluenceCondition" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "UserWatchingSpaceConfluenceCondition" PrefixI False) (U1 :: Type -> Type))) :+: (C1 (MetaCons "UserWatchingSpaceForContentTypeConfluenceCondition" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "ViewingContentConfluenceCondition" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "ViewingOwnProfileConfluenceCondition" PrefixI False) (U1 :: Type -> Type)))))))

staticConfluenceCondition :: ConfluenceCondition -> Condition

Turn a standard Confluence Condition into a regular Condition.

invertCondition :: Condition -> Condition

Invert the given condition.

Scopes (Permissions)

data ProductScope

Scopes are an Atlassian Connect concept that declare how much access your addon requires to any give Cloud instance. These scopes can be thought of as permissions are are well documented: https://developer.atlassian.com/static/connect/docs/scopes/scopes.html

It is important to note that these scopes only give you restricted access to certain REST resources. You can not query any REST url as you would with an Atlassian Server plugin. The restricted set of REST resources per application can be found in the Atlassian Connect documentation.

Constructors

Read

The read scope means that you can pull data from the Cloud application.

Write

The write scope gives you the same access as a regular user of the Atlassian connect application.

Delete

The delete scope is required if you want to perform potentially destructive operations on data.

ProjectAdmin

A JIRA specific scope. Lets your add-on administer a project in JIRA.

SpaceAdmin

A Confluence specific scope. Lets your add-on administer a space in Confluence.

Admin

Gives your Atlassian Connect add-on administrative rights to the Cloud instance. (But NOT system administrator permission. Happily you cannot request that level of access.)

ActAsUser

Add-ons with this scope can access resources and perform actions in JIRA and Confluence on behalf of users.

Instances

Eq ProductScope

Defined in Data.Connect.Scopes

Methods

(==) :: ProductScope -> ProductScope -> Bool

(/=) :: ProductScope -> ProductScope -> Bool

Show ProductScope

Defined in Data.Connect.Scopes

Methods

showsPrec :: Int -> ProductScope -> ShowS

show :: ProductScope -> String

showList :: [ProductScope] -> ShowS

Generic ProductScope

Defined in Data.Connect.Scopes

Associated Types

type Rep ProductScope :: Type -> Type

Methods

from :: ProductScope -> Rep ProductScope x

to :: Rep ProductScope x -> ProductScope

ToJSON ProductScope

Defined in Data.Connect.Scopes

Methods

toJSON :: ProductScope -> Value

toEncoding :: ProductScope -> Encoding

toJSONList :: [ProductScope] -> Value

toEncodingList :: [ProductScope] -> Encoding

FromJSON ProductScope

Defined in Data.Connect.Scopes

Methods

parseJSON :: Value -> Parser ProductScope

parseJSONList :: Value -> Parser [ProductScope]

type Rep ProductScope

Defined in Data.Connect.Scopes

type Rep ProductScope = D1 (MetaData "ProductScope" "Data.Connect.Scopes" "atlassian-connect-descriptor-0.4.10.0-9IB5n7ayoT45x7ylOmuoxH" False) ((C1 (MetaCons "Read" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "Write" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Delete" PrefixI False) (U1 :: Type -> Type))) :+: ((C1 (MetaCons "ProjectAdmin" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "SpaceAdmin" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "Admin" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "ActAsUser" PrefixI False) (U1 :: Type -> Type))))