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

# IWorkspaceCustomApplicationSettingsService

- Package: [@gooddata/sdk-backend-spi](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/index.md)
- Kind: interface
- Stability: alpha
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-backend-spi/src/workspace/customApplicationSettings/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).
> 

Service that manages the settings that applications store in a workspace.

**Signature:**

```typescript
export interface IWorkspaceCustomApplicationSettingsService 
```

## Methods

| Method | Description |
| --- | --- |
| [createSetting(applicationName, content, id)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacecustomapplicationsettingsservice/index.md#iworkspacecustomapplicationsettingsservicecreatesetting) | **_(ALPHA)_** Creates a setting. |
| [deleteSetting(id)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacecustomapplicationsettingsservice/index.md#iworkspacecustomapplicationsettingsservicedeletesetting) | **_(ALPHA)_** Deletes a setting. |
| [getSetting(id)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacecustomapplicationsettingsservice/index.md#iworkspacecustomapplicationsettingsservicegetsetting) | **_(ALPHA)_** Returns one setting. |
| [getSettings(applicationName)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacecustomapplicationsettingsservice/index.md#iworkspacecustomapplicationsettingsservicegetsettings) | **_(ALPHA)_** Returns the settings stored in the workspace. |

## Method details

### IWorkspaceCustomApplicationSettingsService.createSetting()

> **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).
> 

Creates a setting.

**Signature:**

```typescript
createSetting(applicationName: string, content: object, id?: string): Promise<ICustomApplicationSetting>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| applicationName | string | name of the application that owns the setting |
| content | object | content of the setting |
| id | string | _(Optional)_ identifier of the setting; when not set, the backend generates one |

**Returns:**

Promise&lt;[ICustomApplicationSetting](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.icustomapplicationsetting/index.md)&gt;

### IWorkspaceCustomApplicationSettingsService.deleteSetting()

> **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).
> 

Deletes a setting.

**Signature:**

```typescript
deleteSetting(id: string): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| id | string | identifier of the setting |

**Returns:**

Promise&lt;void&gt;

### IWorkspaceCustomApplicationSettingsService.getSetting()

> **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).
> 

Returns one setting.

**Signature:**

```typescript
getSetting(id: string): Promise<ICustomApplicationSetting>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| id | string | identifier of the setting |

**Returns:**

Promise&lt;[ICustomApplicationSetting](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.icustomapplicationsetting/index.md)&gt;

### IWorkspaceCustomApplicationSettingsService.getSettings()

> **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).
> 

Returns the settings stored in the workspace.

**Signature:**

```typescript
getSettings(applicationName?: string): Promise<ICustomApplicationSetting[]>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| applicationName | string | _(Optional)_ when set, returns only the settings of this application |

**Returns:**

Promise&lt;[ICustomApplicationSetting](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.icustomapplicationsetting/index.md)[]&gt;