---
title: LifecycleSettingsResult
slug: data-platform/connect-platform/app-sdk-api-reference-classes-lifecyclesettingsresult
docTags: 
createdAt: 2026-08-05T20:06:36.174Z
---

[OCP App SDK](docId\:gxEU_0AA37IEZJK-uoVcT)

***

[OCP App SDK](docId\:gxEU_0AA37IEZJK-uoVcT) / LifecycleSettingsResult

# Class: LifecycleSettingsResult

Defined in: [src/app/lib/LifecycleSettingsResult.ts:16](https://github.com/ZaiusInc/app-sdk/blob/8c7209817facb226c91abb960e6d54a7692b9aa2/src/app/lib/LifecycleSettingsResult.ts#L16)

Used to compose a response to the onSettingsForm lifecycle request

## Extends

- [`` `FormResult` ``](docId:-r0C81fTwTqoXjXByTdja)

## Constructors

### Constructor

:::BlockQuote
**new LifecycleSettingsResult**(): `LifecycleSettingsResult`
:::

### Returns

`LifecycleSettingsResult`

### Inherited from

[`` `FormResult` ``](docId:-r0C81fTwTqoXjXByTdja).[`` `constructor` ``](<./#function Object() \{ \[native code] }>)

## Properties

### errors

:::BlockQuote
`protected` **errors**: `object` = `{}`
:::

Defined in: [src/app/lib/FormResult.ts:4](https://github.com/ZaiusInc/app-sdk/blob/8c7209817facb226c91abb960e6d54a7692b9aa2/src/app/lib/FormResult.ts#L4)

### Index Signature

\[`field`: `string`]: `string`\[]

### Inherited from

[`` `FormResult` ``](docId:-r0C81fTwTqoXjXByTdja).[`` `errors` ``](docId\:GWRZD0rP4MVXA78SMqQul)

***

### toasts

:::BlockQuote
`protected` **toasts**: `object`\[] = `[]`
:::

Defined in: [src/app/lib/FormResult.ts:5](https://github.com/ZaiusInc/app-sdk/blob/8c7209817facb226c91abb960e6d54a7692b9aa2/src/app/lib/FormResult.ts#L5)

### intent

:::BlockQuote
**intent**: [`` `Intent` ``](docId:_9hudfE1-ZW7RrTE5XYot)
:::

### message

:::BlockQuote
**message**: `string`
:::

### Inherited from

[`` `FormResult` ``](docId:-r0C81fTwTqoXjXByTdja).[`` `toasts` ``](docId\:GWRZD0rP4MVXA78SMqQul)

## Methods

### addError()

:::BlockQuote
**addError**(`field`, `error`): `this`
:::

Defined in: [src/app/lib/LifecycleSettingsResult.ts:25](https://github.com/ZaiusInc/app-sdk/blob/8c7209817facb226c91abb960e6d54a7692b9aa2/src/app/lib/LifecycleSettingsResult.ts#L25)

Add an error to display to the user for a particular form field (implicitly scoped to the submitted section)

### Parameters

### field

`string`

key to display the error under, as defined in the form schema

### error

`string`

message to display to the user

### Returns

`this`

***

### addToast()

:::BlockQuote
**addToast**(`intent`, `message`): `this`
:::

Defined in: [src/app/lib/FormResult.ts:13](https://github.com/ZaiusInc/app-sdk/blob/8c7209817facb226c91abb960e6d54a7692b9aa2/src/app/lib/FormResult.ts#L13)

Display a toast to user, such as, "Successfully authenticated with `<Integration>`" or
"Authentication failed, please check your credentials and try again."

### Parameters

### intent

[`` `Intent` ``](docId:_9hudfE1-ZW7RrTE5XYot)

one of the supported intents that will affect how the toast is displayed

### message

`string`

to display in the toast

### Returns

`this`

### Inherited from

[`` `FormResult` ``](docId:-r0C81fTwTqoXjXByTdja).[`` `addToast` ``](docId\:GWRZD0rP4MVXA78SMqQul)

***

### redirect()

:::BlockQuote
**redirect**(`url`): `this`
:::

Defined in: [src/app/lib/LifecycleSettingsResult.ts:34](https://github.com/ZaiusInc/app-sdk/blob/8c7209817facb226c91abb960e6d54a7692b9aa2/src/app/lib/LifecycleSettingsResult.ts#L34)

Redirect the user to another page, such as for an OAuth flow. Calling this method will override any value
previously set by [redirectToSettings](docId\:g5OsLnkbu9bF299fT_m6q).

### Parameters

### url

`string`

the destination URL for the redirect (location header)

### Returns

`this`

***

### redirectToSettings()

:::BlockQuote
**redirectToSettings**(`section`): `this`
:::

Defined in: [src/app/lib/LifecycleSettingsResult.ts:45](https://github.com/ZaiusInc/app-sdk/blob/8c7209817facb226c91abb960e6d54a7692b9aa2/src/app/lib/LifecycleSettingsResult.ts#L45)

Redirect the user to a particular section of the settings form. Calling this method will override any value
previously set by [redirect](docId\:g5OsLnkbu9bF299fT_m6q).

### Parameters

### section

`string`

to open

### Returns

`this`