---
title: "settings | Eidos Docs"
description: "SDK signatures, permissions and behavior for settings."
source: "https://docs.eidos.space/plugins/api/settings/"
lang: "en"
---

# settings

Keys and defaults come from manifest.settings. Views receive get only. Ordinary actions can also set and reset values. File hooks receive a resolved settings snapshot instead of this interface.

Usage guide: [services](https://docs.eidos.space/plugins/services/). [API index](https://docs.eidos.space/plugins/api/).

Signatures, parameters and return types are generated from the SDK. Optional members are not available in every host and context.

## PluginSettings

[Source](https://github.com/mayneyao/eidos/blob/dev/packages/plugin-sdk/src/index.ts#L701)

### PluginSettings.get

Supported hosts: Lite Mobile

Read a declared setting.

```ts
get(key: string): Promise<SettingValue>;
```

| Parameter | Type   | Required |
| --------- | ------ | -------- |
| key       | string | Yes      |

Returns: `Promise<SettingValue>`.

### PluginSettings.set

Supported hosts: Lite Mobile

Set a declared setting from an ordinary action context.

```ts
set(key: string, value: SettingValue): Promise<void>;
```

| Parameter | Type         | Required |
| --------- | ------------ | -------- |
| key       | string       | Yes      |
| value     | SettingValue | Yes      |

Returns: `Promise<void>`.

### PluginSettings.reset

Supported hosts: Lite Mobile

Reset a setting to its declared default.

```ts
reset(key: string): Promise<void>;
```

| Parameter | Type   | Required |
| --------- | ------ | -------- |
| key       | string | Yes      |

Returns: `Promise<void>`.

Related types: [SettingValue](https://docs.eidos.space/plugins/api/types/#settingvalue).
