> Documentation index: https://www.gooddata.ai/docs/gooddata-ui/llms.txt lists every page of these docs as Markdown.

# IPluggableApplicationMetaV1

- Package: [@gooddata/sdk-model](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/index.md)
- Kind: interface
- Stability: alpha
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-model/src/pluggableApplication/index.ts

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Pluggable application meta-information, v1.

**Signature:**

```typescript
export interface IPluggableApplicationMetaV1 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [apiVersion](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ipluggableapplicationmetav1/index.md#ipluggableapplicationmetav1apiversion) |  | "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](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ipluggableapplicationmetav1/index.md#ipluggableapplicationmetav1applicationscope) |  | [ApplicationScope](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.applicationscope/index.md) | **_(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](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ipluggableapplicationmetav1/index.md#ipluggableapplicationmetav1id) |  | 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?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ipluggableapplicationmetav1/index.md#ipluggableapplicationmetav1isenabled) |  | 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?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ipluggableapplicationmetav1/index.md#ipluggableapplicationmetav1localizedtitle) |  | [LocalizedTitle](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.localizedtitle/index.md) | **_(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. |
| [maintainer?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ipluggableapplicationmetav1/index.md#ipluggableapplicationmetav1maintainer) |  | string | **_(ALPHA)_** _(Optional)_ Maintainer of the application. The name of the team, person, email, or other information about the maintainer. |
| [menuOrder](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ipluggableapplicationmetav1/index.md#ipluggableapplicationmetav1menuorder) |  | 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?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ipluggableapplicationmetav1/index.md#ipluggableapplicationmetav1requiredentitlements) |  | [RequiredEntitlements](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.requiredentitlements/index.md) | **_(ALPHA)_** _(Optional)_ Entitlements and their values that must be set for the pluggable application to be accessible for the currently logged user. |
| [requiredOrganizationPermissions?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ipluggableapplicationmetav1/index.md#ipluggableapplicationmetav1requiredorganizationpermissions) |  | [RequiredOrganizationPermissions](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.requiredorganizationpermissions/index.md) | **_(ALPHA)_** _(Optional)_ Organization permissions that must be set for the pluggable application to be accessible for the currently logged user. |
| [requiredSettings?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ipluggableapplicationmetav1/index.md#ipluggableapplicationmetav1requiredsettings) |  | [RequiredSettings](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.requiredsettings/index.md) | **_(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?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ipluggableapplicationmetav1/index.md#ipluggableapplicationmetav1requiredworkspacepermissions) |  | [RequiredWorkspacePermissions](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.requiredworkspacepermissions/index.md) | **_(ALPHA)_** _(Optional)_ Workspace permissions and their values that must be set for the pluggable application to be accessible for the currently logged user. |
| [title](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ipluggableapplicationmetav1/index.md#ipluggableapplicationmetav1title) |  | string | **_(ALPHA)_** Title of the application. Used, for example, in Application Header, when the localized title variant is not provided. |

## Property details

### IPluggableApplicationMetaV1.apiVersion

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

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.

**Signature:**

```typescript
apiVersion: "1.0";
```

### IPluggableApplicationMetaV1.applicationScope

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

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.

**Signature:**

```typescript
applicationScope: ApplicationScope;
```

### IPluggableApplicationMetaV1.id

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

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.

**Signature:**

```typescript
id: string;
```

### IPluggableApplicationMetaV1.isEnabled

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

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.

**Signature:**

```typescript
isEnabled?: boolean;
```

### IPluggableApplicationMetaV1.localizedTitle

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

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.

**Signature:**

```typescript
localizedTitle?: LocalizedTitle;
```

### IPluggableApplicationMetaV1.maintainer

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Maintainer of the application. The name of the team, person, email, or other information about the maintainer.

**Signature:**

```typescript
maintainer?: string;
```

### IPluggableApplicationMetaV1.menuOrder

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

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.

**Signature:**

```typescript
menuOrder: number;
```

### IPluggableApplicationMetaV1.requiredEntitlements

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Entitlements and their values that must be set for the pluggable application to be accessible for the currently logged user.

**Signature:**

```typescript
requiredEntitlements?: RequiredEntitlements;
```

### IPluggableApplicationMetaV1.requiredOrganizationPermissions

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Organization permissions that must be set for the pluggable application to be accessible for the currently logged user.

**Signature:**

```typescript
requiredOrganizationPermissions?: RequiredOrganizationPermissions;
```

### IPluggableApplicationMetaV1.requiredSettings

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Settings (and feature flags) and their values that must be set for the pluggable application to be accessible for the currently logged user.

**Signature:**

```typescript
requiredSettings?: RequiredSettings;
```

### IPluggableApplicationMetaV1.requiredWorkspacePermissions

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Workspace permissions and their values that must be set for the pluggable application to be accessible for the currently logged user.

**Signature:**

```typescript
requiredWorkspacePermissions?: RequiredWorkspacePermissions;
```

### IPluggableApplicationMetaV1.title

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Title of the application.

Used, for example, in Application Header, when the localized title variant is not provided.

**Signature:**

```typescript
title: string;
```