m Removed irrelevant names and adjusted image |
Automated: update Categories |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 5: | Line 5: | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|UserId|String| The ID of the user that this component should display information about | |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 | |IsLoaded|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv1=true| Whether or not the given user's information has been loaded | ||
|Username|String| The name of the given user | |Username|String| The name of the given user | ||
|RegistrationDate|DateTime| The time that the given user registered their account | |RegistrationDate|DateTime| The time that the given user registered their account | ||
|OriginalRegistrationDate|DateTime| The time that the given user registered their account which they [[Migrations|migrated]] from. | |||
|IconURL|Uri| A URL, pointing to the user's profile picture | |IconURL|Uri| A URL, pointing to the user's profile picture | ||
|IsContact|Bool| Whether or not this user is one of your contacts (only works in [[userspace]]) | |IsContact|Bool| Whether or not this user is one of your contacts (only works in [[userspace]]) | ||
| Line 17: | Line 18: | ||
To get info about a user, type their user ID into the <code>UserId</code> field of the component. | 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 Protoflux node. | You can get their user ID through multiple ways, for example using the Protoflux node or Resonite's cloud API. | ||
<!--T:4--> | <!--T:4--> | ||
== Examples == | == Examples == | ||
Any item that populates an image with your profile icon and the default Profile Facet that is on your home dash tab with a new account. | |||
== Related Components == | == Related Components == | ||
[[Category: | [[Category:Components:Cloud:Indicators{{#translation:}}|Cloud User Info]] | ||
[[Category:Components{{#translation:}}|Cloud User Info]] | |||
Latest revision as of 20:24, 3 March 2024
The CloudUserInfo component can be used to retrieve information about a user from the Resonite cloud, such as their name or profile picture, based on their user ID.
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
|
raw output of 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 |
OriginalRegistrationDate
|
DateTime | The time that the given user registered their account which they migrated from. |
IconURL
|
Uri | A URL, pointing to the user's profile picture |
IsContact
|
Bool | Whether or not this user is one of your contacts (only works in userspace) |
_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 Protoflux node or Resonite's cloud API.
Examples
Any item that populates an image with your profile icon and the default Profile Facet that is on your home dash tab with a new account.