IPluggableApplicationMetaV1

Home > @gooddata/sdk-model > IPluggableApplicationMetaV1

IPluggableApplicationMetaV1 interface

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Pluggable application meta-information, v1.

Signature:

export interface IPluggableApplicationMetaV1 

Properties

Property	Modifiers	Type	Description
apiVersion		"1.0"	(ALPHA) The version of the application API. Explicit version is specified here as the applications list will be passed down the contract, for example, to shell application UI rendered, that can use 3rd party module for rendering. The local and remote registry manifest is versioned, but these types will not be passed down once the resulting list of the application is constructed from both of these manifests.
applicationScope		ApplicationScope	(ALPHA) Defines in which scope the application should be registered. The default UI uses this information to determine if the application is visible in the organization or workspace portal.
id		string	(ALPHA) Unique ID of the application. Used when the application is referenced by the remote registry override and in any other case when the application needs to be referenced.
isEnabled?		boolean	(ALPHA) (Optional) States if the application is enabled and should be allowed to load by the shell application. Used mainly by the remote registry override to disable the standard application.
localizedTitle?		LocalizedTitle	(ALPHA) (Optional) Optional localized titles map keyed by supported locale. It is used in the Application Header to display a localized name of the application. Each application has its own locale bundle, but it can't be used to store the localized name of the application. The application bundle is loaded and parsed only after the user clicks on the application link.
menuOrder		number	(ALPHA) Order of the application in the menu. Applications are sorted and rendered in the default UI according to this value, from smallest to the highest.
requiredEntitlements?		RequiredEntitlements	(ALPHA) (Optional) Entitlements and their values that must be set for the pluggable application to be accessible for the currently logged user.
requiredOrganizationPermissions?		RequiredOrganizationPermissions	(ALPHA) (Optional) Organization permissions that must be set for the pluggable application to be accessible for the currently logged user.
requiredSettings?		RequiredSettings	(ALPHA) (Optional) Settings (and feature flags) and their values that must be set for the pluggable application to be accessible for the currently logged user.
requiredWorkspacePermissions?		RequiredWorkspacePermissions	(ALPHA) (Optional) Workspace permissions and their values that must be set for the pluggable application to be accessible for the currently logged user.
title		string	(ALPHA) Title of the application. Used, for example, in Application Header, when the localized title variant is not provided.