IScheduledEmailManagementDialogContextValue

Home > @gooddata/sdk-ui-dashboard > IScheduledEmailManagementDialogContextValue

IScheduledEmailManagementDialogContextValue interface

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Sub-context for the scheduled-email management dialog. The connector hydrates this from dashboard state.

Values already available on AutomationsContext (locale, currentUser, timezone, isWhiteLabeled, isExecutionTimestampMode, externalRecipient, features.*) are NOT duplicated here — consumers read those from useAutomationsContext().

Signature:

export interface IScheduledEmailManagementDialogContextValue

Properties

Property

Modifiers

Type

Description

automations

IAutomationMetadataObject[]

(ALPHA) Scheduled exports visible in the management dialog, scoped to the current dashboard context.

automationsInvalidationId?

number

(ALPHA) (Optional) Monotonic counter that increments whenever the automation list is invalidated. Consumers can use this as a cache-bust key for re-fetching.

dashboardId?

string

(ALPHA) (Optional) Id of the dashboard the management dialog is rendered on (mirrors alerting management ctx). Used to preselect the dashboard filter in the enhanced automations list.

dashboardTitle?

string

(ALPHA) (Optional) Title of the dashboard the management dialog is rendered on (mirrors alerting management ctx). Used as the label of the preselected dashboard filter in the enhanced automations list.

enableAccessibilityMode

boolean

(ALPHA) Whether accessibility mode is active (for aria/keyboard focus management).

isEmbedded

boolean

(ALPHA) Whether the dashboard is rendered in an embedded (iframe) context.

isLoading

boolean

(ALPHA) True while the automation list is still loading.

isScheduleEmailDialogOpen

boolean

(ALPHA) Whether the scheduled-email create/edit dialog is currently open (from store UI slice). Used by the management dialog tree's focus-return logic (refocus when the edit dialog closes).

maxAutomations

number

(ALPHA) Maximum number of automations allowed (derived connector-side from the max-automations entitlement, falling back to DEFAULT_MAX_AUTOMATIONS). Combined with the dialog's automations count to gate the create button.

unlimitedAutomations

boolean

(ALPHA) Whether the unlimited-automations entitlement is present. When true the max-automations limit is not enforced.

← IScheduledEmailDialogPropsIScheduledEmailManagementDialogProps →