IAlertActionsContextValue
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
The alerting dialog’s mutators: the draft setter and every form change-handler.
Changes rarely: onGranularityChange is re-created when triggerIntervalDirty toggles or the supported measures load.
export interface IAlertActionsContextValue
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(measure: AlertMetric) => void | (BETA) Switches the condition to anomaly detection on the measure. | ||
(attribute: AlertAttribute | undefined, value: AttributeValue | undefined) => void | (BETA) Slices the condition by an attribute value; | ||
(measure: AlertMetric, comparisonOperator: IAlertComparisonOperator) => void | (BETA) Switches the condition to a comparison against a fixed threshold. | ||
(measure: AlertMetric | undefined, relativeOperator: [IAlertRelativeOperator, IAlertRelativeArithmeticOperator] | undefined, comparisonType: AlertMetricComparatorType, granularity?: DateAttributeGranularity) => void | (BETA) Sets the period a relative condition compares against (and its granularity when given). | ||
(destinationId: string) => void | (BETA) Selects the notification channel; recipients incompatible with it are dropped. | ||
(measure: AlertMetric | undefined, granularity: IAlertAnomalyDetectionGranularity) => void | (BETA) Sets the anomaly-detection granularity; derives the trigger interval unless the user edited it. | ||
(measure: AlertMetric) => void | (BETA) Selects the measure the condition targets; resets the comparison to the measure’s defaults. | ||
(recipients: IAutomationRecipient[]) => void | (BETA) Replaces the recipients with the complete updated array. | ||
(measure: AlertMetric, relativeOperator: IAlertRelativeOperator, arithmeticOperator: IAlertRelativeArithmeticOperator) => void | (BETA) Switches the condition to a relative (change / difference) comparison with the given operators. | ||
(sensitivity: IAlertAnomalyDetectionSensitivity) => void | (BETA) Sets the anomaly-detection sensitivity. | ||
(value: string) => void | (BETA) Sets the alert title and re-validates its length. | ||
(triggerInterval: IAlertTriggerInterval, dirty?: boolean) => void | (BETA) Sets the trigger interval. | ||
(triggerMode: IAlertTriggerMode) => void | (BETA) Sets when the alert fires: every evaluation or once per interval. | ||
Dispatch<SetStateAction<IAutomationMetadataObjectDefinition | undefined>> | (BETA) Replaces the draft; the change-handlers below are the preferred, field-scoped writes. |
Property details
IAlertActionsContextValue.onAnomalyDetectionChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Switches the condition to anomaly detection on the measure.
onAnomalyDetectionChange: (measure: AlertMetric) => void;
IAlertActionsContextValue.onAttributeChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Slices the condition by an attribute value; undefined clears the slice.
onAttributeChange: (attribute: AlertAttribute | undefined, value: AttributeValue | undefined) => void;
IAlertActionsContextValue.onComparisonOperatorChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Switches the condition to a comparison against a fixed threshold.
onComparisonOperatorChange: (measure: AlertMetric, comparisonOperator: IAlertComparisonOperator) => void;
IAlertActionsContextValue.onComparisonTypeChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Sets the period a relative condition compares against (and its granularity when given).
onComparisonTypeChange: (measure: AlertMetric | undefined, relativeOperator: [IAlertRelativeOperator, IAlertRelativeArithmeticOperator] | undefined, comparisonType: AlertMetricComparatorType, granularity?: DateAttributeGranularity) => void;
IAlertActionsContextValue.onDestinationChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Selects the notification channel; recipients incompatible with it are dropped.
onDestinationChange: (destinationId: string) => void;
IAlertActionsContextValue.onGranularityChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Sets the anomaly-detection granularity; derives the trigger interval unless the user edited it.
onGranularityChange: (measure: AlertMetric | undefined, granularity: IAlertAnomalyDetectionGranularity) => void;
IAlertActionsContextValue.onMeasureChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Selects the measure the condition targets; resets the comparison to the measure’s defaults.
onMeasureChange: (measure: AlertMetric) => void;
IAlertActionsContextValue.onRecipientsChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Replaces the recipients with the complete updated array.
onRecipientsChange: (recipients: IAutomationRecipient[]) => void;
IAlertActionsContextValue.onRelativeOperatorChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Switches the condition to a relative (change / difference) comparison with the given operators.
onRelativeOperatorChange: (measure: AlertMetric, relativeOperator: IAlertRelativeOperator, arithmeticOperator: IAlertRelativeArithmeticOperator) => void;
IAlertActionsContextValue.onSensitivityChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Sets the anomaly-detection sensitivity.
onSensitivityChange: (sensitivity: IAlertAnomalyDetectionSensitivity) => void;
IAlertActionsContextValue.onTitleChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Sets the alert title and re-validates its length.
onTitleChange: (value: string) => void;
IAlertActionsContextValue.onTriggerIntervalChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Sets the trigger interval. dirty defaults to true; the granularity handler passes false when it derives the interval.
onTriggerIntervalChange: (triggerInterval: IAlertTriggerInterval, dirty?: boolean) => void;
IAlertActionsContextValue.onTriggerModeChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Sets when the alert fires: every evaluation or once per interval.
onTriggerModeChange: (triggerMode: IAlertTriggerMode) => void;
IAlertActionsContextValue.setEditedAutomationpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Replaces the draft; the change-handlers below are the preferred, field-scoped writes.
setEditedAutomation: Dispatch<SetStateAction<IAutomationMetadataObjectDefinition | undefined>>;