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

# IScheduledEmailDialogRecurrenceProps

- Package: [@gooddata/sdk-ui-dashboard](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/index.md)
- Kind: interface
- Stability: beta
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-ui-dashboard/src/presentation/automations/scheduledEmail/types.ts

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Props of the scheduled-export dialog's recurrence field.

**Signature:**

```typescript
export interface IScheduledEmailDialogRecurrenceProps 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [allowHourlyRecurrence](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogrecurrenceprops/index.md#ischeduledemaildialogrecurrencepropsallowhourlyrecurrence) |  | boolean | **_(BETA)_** Whether the hourly recurrence option is offered. |
| [closeDropdownsOnParentScroll](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogrecurrenceprops/index.md#ischeduledemaildialogrecurrencepropsclosedropdownsonparentscroll) |  | boolean | **_(BETA)_** Closes the recurrence dropdowns when the dialog body scrolls. |
| [cronDescription?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogrecurrenceprops/index.md#ischeduledemaildialogrecurrencepropscrondescription) |  | string | **_(BETA)_** _(Optional)_ Human-readable description of the cron expression, when the draft carries one. |
| [cronExpression](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogrecurrenceprops/index.md#ischeduledemaildialogrecurrencepropscronexpression) |  | string | **_(BETA)_** The draft's cron expression. |
| [dateFormat](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogrecurrenceprops/index.md#ischeduledemaildialogrecurrencepropsdateformat) |  | string | **_(BETA)_** Date format used by the first-run date picker. |
| [isWhiteLabeled](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogrecurrenceprops/index.md#ischeduledemaildialogrecurrencepropsiswhitelabeled) |  | boolean | **_(BETA)_** Hides GoodData-specific copy when white-labeled. |
| [locale](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogrecurrenceprops/index.md#ischeduledemaildialogrecurrencepropslocale) |  | string | **_(BETA)_** Locale of the recurrence editor. |
| [onChange](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogrecurrenceprops/index.md#ischeduledemaildialogrecurrencepropsonchange) |  | (cronExpression: string, startDate: Date \| null, isValid: boolean) => void | **_(BETA)_** Sets the cron expression and first run; `isValid` is the recurrence form's own verdict. |
| [onKeyDownSubmit](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogrecurrenceprops/index.md#ischeduledemaildialogrecurrencepropsonkeydownsubmit) |  | (event: KeyboardEvent) => void | **_(BETA)_** Key-down handler; the dialog submits on Enter through it. |
| [startDate](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogrecurrenceprops/index.md#ischeduledemaildialogrecurrencepropsstartdate) |  | Date | **_(BETA)_** First-run date the cron editor is anchored to. |
| [timezone](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogrecurrenceprops/index.md#ischeduledemaildialogrecurrencepropstimezone) |  | string | **_(BETA)_** Display-only timezone label shown in the occurrence description. |
| [weekStart](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledemaildialogrecurrenceprops/index.md#ischeduledemaildialogrecurrencepropsweekstart) |  | [WeekStart](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.weekstart/index.md) | **_(BETA)_** First day of the week in the date picker. |

## Property details

### IScheduledEmailDialogRecurrenceProps.allowHourlyRecurrence

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Whether the hourly recurrence option is offered.

**Signature:**

```typescript
allowHourlyRecurrence: boolean;
```

### IScheduledEmailDialogRecurrenceProps.closeDropdownsOnParentScroll

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Closes the recurrence dropdowns when the dialog body scrolls.

**Signature:**

```typescript
closeDropdownsOnParentScroll: boolean;
```

### IScheduledEmailDialogRecurrenceProps.cronDescription

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Human-readable description of the cron expression, when the draft carries one.

**Signature:**

```typescript
cronDescription?: string;
```

### IScheduledEmailDialogRecurrenceProps.cronExpression

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

The draft's cron expression.

**Signature:**

```typescript
cronExpression: string;
```

### IScheduledEmailDialogRecurrenceProps.dateFormat

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Date format used by the first-run date picker.

**Signature:**

```typescript
dateFormat: string;
```

### IScheduledEmailDialogRecurrenceProps.isWhiteLabeled

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Hides GoodData-specific copy when white-labeled.

**Signature:**

```typescript
isWhiteLabeled: boolean;
```

### IScheduledEmailDialogRecurrenceProps.locale

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Locale of the recurrence editor.

**Signature:**

```typescript
locale: string;
```

### IScheduledEmailDialogRecurrenceProps.onChange

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Sets the cron expression and first run; `isValid` is the recurrence form's own verdict.

**Signature:**

```typescript
onChange: (cronExpression: string, startDate: Date | null, isValid: boolean) => void;
```

### IScheduledEmailDialogRecurrenceProps.onKeyDownSubmit

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Key-down handler; the dialog submits on Enter through it.

**Signature:**

```typescript
onKeyDownSubmit: (event: KeyboardEvent) => void;
```

### IScheduledEmailDialogRecurrenceProps.startDate

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

First-run date the cron editor is anchored to.

**Signature:**

```typescript
startDate: Date;
```

### IScheduledEmailDialogRecurrenceProps.timezone

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Display-only timezone label shown in the occurrence description.

**Signature:**

```typescript
timezone: string;
```

### IScheduledEmailDialogRecurrenceProps.weekStart

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

First day of the week in the date picker.

**Signature:**

```typescript
weekStart: WeekStart;
```