mirror of
https://github.com/noodlapp/noodl-docs.git
synced 2026-01-11 23:02:54 +01:00
Initial commit
Co-Authored-By: kotte <14197736+mrtamagotchi@users.noreply.github.com> Co-Authored-By: mikaeltellhed <2311083+mikaeltellhed@users.noreply.github.com> Co-Authored-By: Tore Knudsen <18231882+torekndsn@users.noreply.github.com> Co-Authored-By: Michael Cartner <32543275+michaelcartner@users.noreply.github.com>
This commit is contained in:
Eric Tuvesson
38
nodes/events/receive-event.md
Normal file
38
nodes/events/receive-event.md
Normal file
@@ -0,0 +1,38 @@
|
||||
---
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
title: Receive Event
|
||||
---
|
||||
|
||||
<##head##>
|
||||
|
||||
# Receive Event
|
||||
|
||||
This node is used to receive a signal triggered by a <span className="ndl-node">Send Event</span> node. To learn more about **Events** check out the [Events Guide](/docs/guides/business-logic/events).
|
||||
|
||||
<div className="ndl-image-with-background l">
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
The <span className="ndl-node">Send Event</span> node lets you specify a channel to broadcast to. All <span className="ndl-node">Receive Event</span> nodes set to that channel will be triggered simultaneously.
|
||||
<##head##>
|
||||
|
||||
## Inputs
|
||||
|
||||
| Data | Description |
|
||||
| ----------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| <span className="ndl-data">Enabled</span> | <##input:enabled##>This port is used to disable/enable this node.<##input##> If disabled the receiver node will not be activated when the corresponding [Send Event](/nodes/events/send-event) node is triggered. |
|
||||
| <span className="ndl-data">Consume</span> | <##input:consume##>This property specified if and how the event is consumed when captured by this receive event node.<##input##> |
|
||||
| <span className="ndl-data">Channel</span> | <##input:channelName##>Each **Receive Event** node must listen to a specific channel.<##input##> This means that when a [Send Event][/nodes/events/send-event] node of that channel is triggered all **Receive Event** nodes with the same channel will be triggered as well (depending on the propagation, please review the [Events guide](/docs/guides/business-logic/events) for more details). |
|
||||
|
||||
## Outputs
|
||||
|
||||
| Mixed | Description |
|
||||
| ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| <span className="ndl-data">Custom Outputs</span> | The **Receive Event** node will automatically get outputs from all [Send Event][0] nodes connected to the same channel. See the [Send Event][0] documentation for more details on adding ports for sending values with events. |
|
||||
|
||||
| Signal | Description |
|
||||
| -------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| <span className="ndl-signal">Received</span> | <##output:eventReceived##>This is a signal port, it is triggered when a signal is triggered in any **Send Event** node with the same channel as this **Receive Event** node.<##output##> |
|
||||
35
nodes/events/send-event.md
Normal file
35
nodes/events/send-event.md
Normal file
@@ -0,0 +1,35 @@
|
||||
---
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
title: Send Event
|
||||
---
|
||||
|
||||
<##head##>
|
||||
|
||||
# Send Event
|
||||
|
||||
This node sends a <span className="ndl-signal">signal</span> to another place in your app without having to connect the nodes directly. To learn more about **Events** check out the [Events Guide](/docs/guides/business-logic/events).
|
||||
|
||||
<div className="ndl-image-with-background l">
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
The <span className="ndl-node">Send Event</span> node lets you specify a channel to broadcast to. When this node is triggered with a <span className="ndl-signal">Send signal</span> all <span className="ndl-node">Receive Event</span> nodes set to that channel will be triggered.
|
||||
<##head##>
|
||||
|
||||
## Inputs
|
||||
|
||||
| Mixed | Description |
|
||||
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| **Custom Inputs** | **Send Event** nodes can have arbitrary input ports that will be passed on to the [Receive Event](/nodes/events/receive-event) nodes when the _Send_ signal is triggered. These ports can be added by inspecting the node and clicking the _Add port_ button. |
|
||||
|
||||
| Data | Description |
|
||||
| ---------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| <span className="ndl-data">Channel Name</span> | The channel name can be any identifier and is used on the [Receive Event](/nodes/events/receive-event) nodes to connect a sender and receiver node.<br/><br/>There may be multiple **Send Event** nodes with the same channel. In that case the receiving nodes listening to the channel will get a merged set of ports from all **Send Event** nodes. |
|
||||
| <span className="ndl-data">Send To</span> | <##input:propagation##>Controls what components the event will be sent to.<##input##><br/><br/>`Global`: Send to all components<br/>`Parent`: Send the event up the visual hierarchy to parent components.<br/>`Children`: Send the events to all children of this component, and their descendants.<br/>`Siblings`: Send the event to all siblings of this component in the visual hierarchy. |
|
||||
|
||||
| Signal | Description |
|
||||
| ---------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| <span className="ndl-signal">Send Event</span> | <##input:sendEvent##>Send a signal to this input to send the event.<##input##> This is a signal port and when triggered the corresponding [Receive Event](/nodes/events/receive-event) nodes will be triggered as well. |
|
||||
Reference in New Issue
Block a user