mirror of
https://github.com/noodlapp/noodl-docs.git
synced 2026-01-11 14:52:54 +01:00
656e5fc8d2
* chore: Upgrade Docusaurus from v2 to v3 * chore: Update "Test build" GH workflow * fix: build All markdown is processed as MDX * fix: Broken links
43 lines
4.0 KiB
Markdown
43 lines
4.0 KiB
Markdown
---
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
title: Set User Properties node
|
|
---
|
|
|
|
{/*##head##*/}
|
|
|
|
# Set User Properties
|
|
|
|
This node is used to set properties on the currently logged in user.
|
|
|
|
<div className="ndl-image-with-background l">
|
|
|
|
|
|
|
|
</div>
|
|
|
|
A user needs to be logged in via either the <span className="ndl-node">Sign Up</span> node or the <span className="ndl-node">Log In</span> node. If you want to read user properties of the currently logged in user you can use the <span className="ndl-node">User</span> node.
|
|
{/*##head##*/}
|
|
|
|
## Inputs
|
|
|
|
| Data | Description |
|
|
| -------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| <span className="ndl-data">Email</span> | {/*##input:email##*/}This input is used to set the **Email** property.{/*##input##*/} |
|
|
| <span className="ndl-data">Your custom properties</span> | {/*##input:prop-\*##*/}A property of the **User** class. You can add additional properties to the **User** class in the Noodl Cloud Services dashboard. {/*##input##*/} These will show up as inputs on the **Set User Properties** node. |
|
|
|
|
| Signal | Description |
|
|
| -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| <span className="ndl-signal">Do</span> | {/*##input:do##*/}Send a signal to this input to store the properties in the user record in the Noodl Cloud Services. Once completed the **Success** or **Failure** action will be triggered.{/*##input##*/} |
|
|
|
|
## Outputs
|
|
|
|
| Signal | Description |
|
|
| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| <span className="ndl-signal">Success</span> | {/*##output:success##*/}This event will be triggered if the properties was succesfully stored.{/*##output##*/} |
|
|
| <span className="ndl-signal">Failure</span> | {/*##output:failure##*/}This event will be triggered if something went wrong while trying to store the properties on the **User** record in the Noodl Cloud Services. The error message can be found in the **Error** output.{/*##output##*/} |
|
|
|
|
| Data | Description |
|
|
| --------------------------------------- | ---------------------------------------------------------------------------------------------- |
|
|
| <span className="ndl-data">Error</span> | {/*##output:error##*/}This output will contain the error message if the action failed.{/*##output##*/} |
|