IAutomationDialogRecipientsProps
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Members shared by both automation dialogs’ recipients regions.
export interface IAutomationDialogRecipientsProps
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
boolean | (BETA) (Optional) Allows removing the last recipient. | ||
boolean | (BETA) (Optional) Allows recipients that are not workspace users. | ||
boolean | (BETA) (Optional) Restricts the selection to the logged-in user. | ||
string | (BETA) (Optional) When set, the only addable recipient is this external address. | ||
(BETA) (Optional) The logged-in user as a recipient candidate. | |||
number | (BETA) (Optional) Maximum number of recipients. | ||
string | (BETA) (Optional) Id of the automation’s currently selected notification channel. | ||
INotificationChannelIdentifier[] | INotificationChannelMetadataObject[] | (BETA) (Optional) Notification channels, used to derive channel-specific recipient constraints. | ||
(recipients: IAutomationRecipient[]) => void | (BETA) Replaces the selection with the complete updated array. | ||
(BETA) Currently selected recipients. |
Property details
IAutomationDialogRecipientsProps.allowEmptySelectionpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Allows removing the last recipient.
allowEmptySelection?: boolean;
IAutomationDialogRecipientsProps.allowExternalRecipientspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Allows recipients that are not workspace users.
allowExternalRecipients?: boolean;
IAutomationDialogRecipientsProps.allowOnlyLoggedUserRecipientspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Restricts the selection to the logged-in user.
allowOnlyLoggedUserRecipients?: boolean;
IAutomationDialogRecipientsProps.externalRecipientOverridepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
When set, the only addable recipient is this external address.
externalRecipientOverride?: string;
IAutomationDialogRecipientsProps.loggedUserpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
The logged-in user as a recipient candidate.
loggedUser?: IAutomationRecipient;
IAutomationDialogRecipientsProps.maxRecipientspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Maximum number of recipients.
maxRecipients?: number;
IAutomationDialogRecipientsProps.notificationChannelIdpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Id of the automation’s currently selected notification channel.
notificationChannelId?: string;
IAutomationDialogRecipientsProps.notificationChannelspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Notification channels, used to derive channel-specific recipient constraints.
notificationChannels?: INotificationChannelIdentifier[] | INotificationChannelMetadataObject[];
IAutomationDialogRecipientsProps.onChangepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Replaces the selection with the complete updated array.
onChange: (recipients: IAutomationRecipient[]) => void;
IAutomationDialogRecipientsProps.valuepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Currently selected recipients.
value: IAutomationRecipient[];