Available translations
loading results
Announcement
An Announcement node is used to define the content and conditions with which messages are sent by Social Bots.
The Announcement node is used to configure the default text content of the message which will be sent by any Social Bots configured under the Trading Session.
The Announcement node can also optionally contain children nodes to define more specific announcement formula (content) and announcement conditions.
- An Announcement Formula child node contains the Javascript text string formula which defines the content of the message that will be sent.
- An Announcement Condition child node defines the condition when the message will be sent.
Warning: If the announcement formula child node is not configured, or; if there is an error evaluating the announcement formula or announcement condition then the default text configuration of the parent announcement node itself is sent instead.
Properties
-
textcontent of message to be sent when there is no formula.
-
onEnterdefine if message will be sent on node enter.
-
onExitdefine if message will be sent on node exit.
-
delaydefine the amount of delay before sending an announcement in milliseconds.
Initial Values
These are the Initial Values for Announcement configuration:
{
"text": "Type the message you wish to announce when there is no formula",
"onEnter": true,
"onExit": false
} Examples
This is a list of properties featured by the Announcement configuration. Expanding a property shows sample values for the property extracted from the current Workspace.
Announcement Menu
The Announcement node has the following Node Menu items:
The Configure menu item has the following properties:
- action: Configure
- actionFunction:
uiObject.configEditor.activate
- label: Configure
- iconPathOn: configuration
- iconPathOff: configuration
- actionProject: Foundations
The Add Announcement Formula menu item has the following properties:
- action: Add UI Object
- disableIfPropertyIsDefined: true
- propertyToCheckFor:
announcementFormula
- label: Add Announcement Formula
- relatedUiObject: Announcement Formula
- relatedUiObjectProject: Social-Bots
- actionFunction:
payload.executeAction
- actionProject: Visual-Scripting
The Add Announcement Condition menu item has the following properties:
- action: Add UI Object
- disableIfPropertyIsDefined: true
- propertyToCheckFor:
announcementCondition
- label: Add Announcement Condition
- relatedUiObject: Announcement Condition
- relatedUiObjectProject: Social-Bots
- actionFunction:
payload.executeAction
- actionProject: Visual-Scripting
The Delete menu item has the following properties:
- action: Delete UI Object
- actionProject: Visual-Scripting
- askConfirmation: true
- confirmationLabel: Confirm to Delete
- label: Delete
- iconPathOn: delete-entity
- iconPathOff: delete-entity
- actionFunction:
payload.executeAction
Tip: When a menu item is grayed out, it means that Announcement already has the required child type that the menu item may add, and only that child is allowed for that case.
Announcement Children
The Announcement node has the following childrenNodesProperties:
The Announcement Formula node property features the following properties:
- name:
announcementFormula
- type: node
- childType: Announcement Formula
- autoAdd: true
- project: Social-Bots
The Announcement Condition node property features the following properties:
- name:
announcementCondition
- type: node
- childType: Announcement Condition
- autoAdd: true
- project: Social-Bots
Announcement Attaching Rules
The following are the Node Attaching Rules that govern the attachment of Announcement with other nodes:
Compatible Types: