new ArchActionSendNotification(coreSendNotificationActionViewModel)
The Architect Scripting class that represents the Send Notification action
Instances of this action should be created by calling ArchFactoryActions#addActionSendNotification
Parameters:
| Name | Type | Description |
|---|---|---|
coreSendNotificationActionViewModel |
Object | ( Internal ) an Architect core Send Notification action view model. |
Extends
Members
-
static, readonly displayTypeName :string
-
Returns the display type name string 'ArchActionSendNotification'.
-
static, readonly isArchActionSendNotification :boolean
-
Returns true indicating that this is an ArchActionSendNotification instance.
-
readonly body :ArchValueString
-
The notification body.
-
readonly emailFrom :ArchValueEmailAddress
-
The from address to use on the reply that is sent.
-
readonly emailNotificationStyle :ArchValueString
-
The notification style.
-
readonly notificationType :ArchValueString
-
The notification type.
-
readonly outputSuccess :ArchActionOutput
-
The success output for this action
- Inherited From:
-
readonly sendNotificationFailureOutputs :ArchNamedValueList
-
The contents of this named value list come from the Failure Outputs schema. It will contain two values: errorType and errorMessage. These values will be returned by the server if the action takes the Failure path.
-
readonly sendToUsers :ArchValueUserCollection
-
Get Users Collection.
-
readonly subject :ArchValueString
-
The subject of the notification.
Methods
-
setEmailNotificationStyle(newEmailNotificationStyle) → {string}
-
Sets the email notification style. The string values in
ArchEnums#EMAIL_STYLESlists valid operator values.Parameters:
Name Type Description newEmailNotificationStylestring the new value to use for the email notification style.
Returns:
string -
setNotificationType(newNotificationType) → {void}
-
Sets the Notification Type. The string values in
ArchEnums#SEND_NOTIFICATION_TYPESlists vaild operator values.Parameters:
Name Type Description newNotificationTypestring the new value to use for the notification type.
Returns:
void