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

# IScheduledExportActionsContextValue

- 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/state/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).
> 

The scheduled-export dialog's mutators: the draft setter, the form change-handlers, the attachment handlers and the "Time zone" section handlers.

Changes rarely.

**Signature:**

```typescript
export interface IScheduledExportActionsContextValue 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [applyCurrentScheduleTimezone](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledexportactionscontextvalue/index.md#ischeduledexportactionscontextvalueapplycurrentscheduletimezone) |  | () =&gt; void | **_(BETA)_** Repairs a stale schedule timezone with the currently effective one. |
| [onCsvRawSettingsChange](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledexportactionscontextvalue/index.md#ischeduledexportactionscontextvalueoncsvrawsettingschange) |  | (settings: [IExportDefinitionVisualizationObjectSettings](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iexportdefinitionvisualizationobjectsettings/index.md)) =&gt; void | **_(BETA)_** Sets the raw-CSV export settings (delimiter). |
| [onCsvSettingsChange](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledexportactionscontextvalue/index.md#ischeduledexportactionscontextvalueoncsvsettingschange) |  | (settings: [IExportDefinitionVisualizationObjectSettings](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iexportdefinitionvisualizationobjectsettings/index.md)) =&gt; void | **_(BETA)_** Sets the CSV export settings (delimiter). |
| [onDashboardAttachmentsChange](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledexportactionscontextvalue/index.md#ischeduledexportactionscontextvalueondashboardattachmentschange) |  | (formats: [DashboardAttachmentType](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.dashboardattachmenttype/index.md)[]) =&gt; void | **_(BETA)_** Replaces the dashboard export formats; new definitions inherit the current filters and timezone. |
| [onDestinationChange](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledexportactionscontextvalue/index.md#ischeduledexportactionscontextvalueondestinationchange) |  | (notificationChannelId: string) =&gt; void | **_(BETA)_** Selects the notification channel; recipients incompatible with it are dropped. |
| [onEvaluationModeChange](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledexportactionscontextvalue/index.md#ischeduledexportactionscontextvalueonevaluationmodechange) |  | (isShared: boolean) =&gt; void | **_(BETA)_** Switches between a shared and a per-recipient evaluation of the export. |
| [onMessageChange](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledexportactionscontextvalue/index.md#ischeduledexportactionscontextvalueonmessagechange) |  | (value: string, isValid: boolean) =&gt; void | **_(BETA)_** Sets the e-mail message; `isValid` is the message field's own verdict. |
| [onPdfSettingsChange](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledexportactionscontextvalue/index.md#ischeduledexportactionscontextvalueonpdfsettingschange) |  | (settings: [IExportDefinitionVisualizationObjectSettings](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iexportdefinitionvisualizationobjectsettings/index.md)) =&gt; void | **_(BETA)_** Sets the tabular-PDF export settings (page size, orientation, export info). |
| [onRecipientsChange](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledexportactionscontextvalue/index.md#ischeduledexportactionscontextvalueonrecipientschange) |  | (recipients: [IAutomationRecipient](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationrecipient/index.md)[]) =&gt; void | **_(BETA)_** Replaces the recipients with the complete updated array. |
| [onRecurrenceChange](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledexportactionscontextvalue/index.md#ischeduledexportactionscontextvalueonrecurrencechange) |  | (cronExpression: string, startDate: Date \| null, isValid: boolean) =&gt; void | **_(BETA)_** Sets the cron expression and first run; `isValid` is the recurrence form's own verdict. |
| [onScheduleTimezoneChange](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledexportactionscontextvalue/index.md#ischeduledexportactionscontextvalueonscheduletimezonechange) |  | (timezoneId: string \| undefined) =&gt; void | **_(BETA)_** Picks the export-content timezone; undefined selects the Default option. |
| [onSlidesTemplateIdChange](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledexportactionscontextvalue/index.md#ischeduledexportactionscontextvalueonslidestemplateidchange) |  | (templateId: string \| undefined, format: "PPTX" \| "PDF\_SLIDES" \| "PDF") =&gt; void | **_(BETA)_** Sets the slides template of one slides format; undefined restores the default template. |
| [onSubjectChange](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledexportactionscontextvalue/index.md#ischeduledexportactionscontextvalueonsubjectchange) |  | (value: string \| number, isValid: boolean) =&gt; void | **_(BETA)_** Sets the e-mail subject; `isValid` is the subject field's own verdict. |
| [onTitleChange](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledexportactionscontextvalue/index.md#ischeduledexportactionscontextvalueontitlechange) |  | (value: string) =&gt; void | **_(BETA)_** Sets the schedule title and re-validates its length. |
| [onWidgetAttachmentsChange](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledexportactionscontextvalue/index.md#ischeduledexportactionscontextvalueonwidgetattachmentschange) |  | (formats: [WidgetAttachmentType](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.widgetattachmenttype/index.md)[]) =&gt; void | **_(BETA)_** Replaces the widget export formats; throws when the dialog has no widget. |
| [onXlsxSettingsChange](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledexportactionscontextvalue/index.md#ischeduledexportactionscontextvalueonxlsxsettingschange) |  | (settings: [IExportDefinitionVisualizationObjectSettings](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iexportdefinitionvisualizationobjectsettings/index.md)) =&gt; void | **_(BETA)_** Sets the XLSX export settings (merge headers, export info). |
| [setEditedAutomation](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ischeduledexportactionscontextvalue/index.md#ischeduledexportactionscontextvalueseteditedautomation) |  | Dispatch&lt;SetStateAction&lt;[IAutomationMetadataObjectDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationmetadataobjectdefinition/index.md)&gt;&gt; | **_(BETA)_** Replaces the draft; the change-handlers below are the preferred, field-scoped writes. |

## Property details

### IScheduledExportActionsContextValue.applyCurrentScheduleTimezone

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

Repairs a stale schedule timezone with the currently effective one.

**Signature:**

```typescript
applyCurrentScheduleTimezone: () => void;
```

### IScheduledExportActionsContextValue.onCsvRawSettingsChange

> **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 raw-CSV export settings (delimiter).

**Signature:**

```typescript
onCsvRawSettingsChange: (settings: IExportDefinitionVisualizationObjectSettings) => void;
```

### IScheduledExportActionsContextValue.onCsvSettingsChange

> **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 CSV export settings (delimiter).

**Signature:**

```typescript
onCsvSettingsChange: (settings: IExportDefinitionVisualizationObjectSettings) => void;
```

### IScheduledExportActionsContextValue.onDashboardAttachmentsChange

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

Replaces the dashboard export formats; new definitions inherit the current filters and timezone.

**Signature:**

```typescript
onDashboardAttachmentsChange: (formats: DashboardAttachmentType[]) => void;
```

### IScheduledExportActionsContextValue.onDestinationChange

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

Selects the notification channel; recipients incompatible with it are dropped.

**Signature:**

```typescript
onDestinationChange: (notificationChannelId: string) => void;
```

### IScheduledExportActionsContextValue.onEvaluationModeChange

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

Switches between a shared and a per-recipient evaluation of the export.

**Signature:**

```typescript
onEvaluationModeChange: (isShared: boolean) => void;
```

### IScheduledExportActionsContextValue.onMessageChange

> **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 e-mail message; `isValid` is the message field's own verdict.

**Signature:**

```typescript
onMessageChange: (value: string, isValid: boolean) => void;
```

### IScheduledExportActionsContextValue.onPdfSettingsChange

> **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 tabular-PDF export settings (page size, orientation, export info).

**Signature:**

```typescript
onPdfSettingsChange: (settings: IExportDefinitionVisualizationObjectSettings) => void;
```

### IScheduledExportActionsContextValue.onRecipientsChange

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

Replaces the recipients with the complete updated array.

**Signature:**

```typescript
onRecipientsChange: (recipients: IAutomationRecipient[]) => void;
```

### IScheduledExportActionsContextValue.onRecurrenceChange

> **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
onRecurrenceChange: (cronExpression: string, startDate: Date | null, isValid: boolean) => void;
```

### IScheduledExportActionsContextValue.onScheduleTimezoneChange

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

Picks the export-content timezone; undefined selects the Default option.

**Signature:**

```typescript
onScheduleTimezoneChange: (timezoneId: string | undefined) => void;
```

### IScheduledExportActionsContextValue.onSlidesTemplateIdChange

> **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 slides template of one slides format; undefined restores the default template.

**Signature:**

```typescript
onSlidesTemplateIdChange: (templateId: string | undefined, format: "PPTX" | "PDF_SLIDES" | "PDF") => void;
```

### IScheduledExportActionsContextValue.onSubjectChange

> **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 e-mail subject; `isValid` is the subject field's own verdict.

**Signature:**

```typescript
onSubjectChange: (value: string | number, isValid: boolean) => void;
```

### IScheduledExportActionsContextValue.onTitleChange

> **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 schedule title and re-validates its length.

**Signature:**

```typescript
onTitleChange: (value: string) => void;
```

### IScheduledExportActionsContextValue.onWidgetAttachmentsChange

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

Replaces the widget export formats; throws when the dialog has no widget.

**Signature:**

```typescript
onWidgetAttachmentsChange: (formats: WidgetAttachmentType[]) => void;
```

### IScheduledExportActionsContextValue.onXlsxSettingsChange

> **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 XLSX export settings (merge headers, export info).

**Signature:**

```typescript
onXlsxSettingsChange: (settings: IExportDefinitionVisualizationObjectSettings) => void;
```

### IScheduledExportActionsContextValue.setEditedAutomation

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

Replaces the draft; the change-handlers below are the preferred, field-scoped writes.

**Signature:**

```typescript
setEditedAutomation: Dispatch<SetStateAction<IAutomationMetadataObjectDefinition>>;
```
