Difference between revisions of "CloudUserInfo (Component)"

From Neos Wiki
Jump to navigation Jump to search
(Created page with "<languages></languages> <translate> <!--T:1--> {{stub}} {{Infobox Component |Image=CloudUserInfoComponent.png |Name=Cloud User Info }} <!--T:2--> == Fields == {{Table Compone...")
 
(Added more info)
Line 7: Line 7:
 
|Name=Cloud User Info
 
|Name=Cloud User Info
 
}}
 
}}
 +
The CloudUserInfo component can be used to retrieve information about a user from the Neos cloud, such as their name or profile picture, based on their user ID.
  
 
<!--T:2-->
 
<!--T:2-->
 
== Fields ==
 
== Fields ==
 
{{Table ComponentFields
 
{{Table ComponentFields
|UserId|String|
+
|UserId|String| The ID of the user that this component should display information about
|IsLoaded|Bool|
+
|IsLoaded|Bool| Whether or not the given user's information has been loaded
|Username|String|
+
|Username|String| The name of the given user
|RegistrationDate|DateTime|
+
|RegistrationDate|DateTime| The time that the given user registered their account
|IconURL|Uri|
+
|IconURL|Uri| A URL, pointing to the user's profile picture
|_loadedUserId|String|
+
|IsContact|Bool| Whether or not this user is one of your contacts
 +
|_loadedUserId|String| The user ID corresponding to the information this component is currently outputting. This is an internal value and shouldn't be edited manually.
 
}}
 
}}
  
 
<!--T:3-->
 
<!--T:3-->
 
== Usage ==
 
== Usage ==
 +
To get info about a user, type their user ID into the <code>UserId</code> field of the component.
 +
 +
You can get their user ID through multiple ways, for example using the [[UserID (LogiX node)|UserID LogiX node]].
  
 
<!--T:4-->
 
<!--T:4-->

Revision as of 14:27, 12 September 2022


This article or section is a Stub. You can help the Neos Wiki by expanding it.


Cloud User Info component as seen in the Scene Inspector

The CloudUserInfo component can be used to retrieve information about a user from the Neos cloud, such as their name or profile picture, based on their user ID.

Fields

Fields
Name Type Description
persistent Bool Determines whether or not this item will be saved to the server.
UpdateOrder Int Controls the order in which this component is updated
Enabled Bool Controls whether or not this component is enabled
UserId String The ID of the user that this component should display information about
IsLoaded Bool Whether or not the given user's information has been loaded
Username String The name of the given user
RegistrationDate DateTime The time that the given user registered their account
IconURL Uri A URL, pointing to the user's profile picture
IsContact Bool Whether or not this user is one of your contacts
_loadedUserId String The user ID corresponding to the information this component is currently outputting. This is an internal value and shouldn't be edited manually.

Usage

To get info about a user, type their user ID into the UserId field of the component.

You can get their user ID through multiple ways, for example using the UserID LogiX node.

Examples

Related Components