remove bad category |
add info |
||
| Line 3: | Line 3: | ||
|Name=Feed Category Interface | |Name=Feed Category Interface | ||
}} | }} | ||
The '''FeedCategoryInterface''' component is used as a template type item in data feed mappers in the [[Data Feeds]] system. | |||
== | == Fields == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|HasData|Bool| | |HasData|Bool| {{Template:FeedItemInterface_HasData}} | ||
|ItemName|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv1=true| | |ItemName|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv1=true| {{Template:FeedItemInterface_ItemName}} | ||
|ItemKey|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv2=true| | |ItemKey|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv2=true| {{Template:FeedItemInterface_ItemKey}} | ||
|ItemDescription|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv3=true| | |ItemDescription|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv3=true| {{Template:FeedItemInterface_ItemDescription}} | ||
|HasDescription|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv4=true| | |HasDescription|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv4=true| {{Template:FeedItemInterface_HasDescription}} | ||
|DescriptionCleanup|Slot| | |DescriptionCleanup|Slot| {{Template:FeedItemInterface_DescriptionCleanup}} | ||
|ItemIcon|'''[[Type:IField`1|IField`1]]<[[Type:Uri|Uri]]>'''|TypeAdv6=true| | |ItemIcon|'''[[Type:IField`1|IField`1]]<[[Type:Uri|Uri]]>'''|TypeAdv6=true| {{Template:FeedItemInterface_ItemIcon}} | ||
|HasIcon|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv7=true| | |HasIcon|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv7=true| {{Template:FeedItemInterface_HasIcon}} | ||
|IconCleanup|Slot| | |IconCleanup|Slot| {{Template:FeedItemInterface_IconCleanup}} | ||
|View|'''[[Type:SyncRef`1|SyncRef`1]]<[[Type:IDataFeedView|IDataFeedView]]>'''|TypeAdv9=true| | |View|'''[[Type:SyncRef`1|SyncRef`1]]<[[Type:IDataFeedView|IDataFeedView]]>'''|TypeAdv9=true| {{Template:FeedItemInterface_View}} | ||
|ParentContainer|'''[[Component:FeedItemInterface|FeedItemInterface]]'''|TypeAdv10=true| | |ParentContainer|'''[[Component:FeedItemInterface|FeedItemInterface]]'''|TypeAdv10=true| {{Template:FeedItemInterface_ParentContainer}} | ||
|ChildContainer|Slot| | |ChildContainer|Slot| {{Template:FeedItemInterface_ChildContainer}} | ||
|NestedItems|{{RootFieldType|SyncList`1|[[Type:NestedItem|NestedItem]]}}|TypeAdv12=true| | |NestedItems|{{RootFieldType|SyncList`1|[[Type:NestedItem|NestedItem]]}}|TypeAdv12=true| {{Template:FeedItemInterface_NestedItems}} | ||
|EnabledState|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv13=true| | |EnabledState|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv13=true| {{Template:FeedItemInterface_EnabledState}} | ||
|Path|'''[[Type:SyncFieldList`1|SyncFieldList`1]]<[[Type:String|String]]>'''|TypeAdv14=true| | |Path|'''[[Type:SyncFieldList`1|SyncFieldList`1]]<[[Type:String|String]]>'''|TypeAdv14=true| A list of strings specifying this categories specific sub path. | ||
}} | }} | ||
== | == Usage == | ||
{{stub}} | |||
== Examples == | == Examples == | ||
== See Also == | == See Also == | ||
* [[Data Feeds]] | |||
[[Category:Components:Radiant UI:Data Feeds:Interfaces{{#translation:}}|Feed Category Interface]] | [[Category:Components:Radiant UI:Data Feeds:Interfaces{{#translation:}}|Feed Category Interface]] | ||
[[Category:Components{{#translation:}}|Feed Category Interface]] | [[Category:Components{{#translation:}}|Feed Category Interface]] | ||
Revision as of 18:50, 17 January 2025
Component image 
Feed Category Interface component as seen in the Scene Inspector
The FeedCategoryInterface component is used as a template type item in data feed mappers in the Data Feeds system.
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. Some components stop their functionality when this field is disabled, but some don't. |
HasData
|
Bool | The field to set when this interface is templated by a data feed for whether it has data or not. |
ItemName
|
IField`1<String> | The field to fill with the name of the interface item when it is templated via a data feed. For settings toggles, this would be the toggle name. |
ItemKey
|
IField`1<String> | The field to fill with the interfaces key if it is a dictionary type item. |
ItemDescription
|
IField`1<String> | The field to fill with the template description when template via a data feed. |
HasDescription
|
IField`1<Bool> | Whether the item when templated via a data feed has a description. |
DescriptionCleanup
|
Slot | If this interface doesn't have a description during templating via a data feed, then delete the slot specified. |
ItemIcon
|
IField`1<Uri> | The resource URL to fill with an image link/URI if the data feed item has an icon. |
HasIcon
|
IField`1<Bool> | Whether this template has an icon. This is set during duplication as a template via a data feed. |
IconCleanup
|
Slot | The slot to delete when this interface item doesn't have an icon when being duplicated as a template item by a data feed. |
View
|
SyncRef`1<IDataFeedView> | The data feed view that this template was instantiated by. Like a SingleFeedView. |
ParentContainer
|
FeedItemInterface | This template's parent container. If that template also has a parent and a child, then it recursively goes up the containers till it finds the root interface with a parent and a child interface, then instantiates that interfaces child interface and it's Nested items instead of just this interface. |
ChildContainer
|
Slot | This template's child template which it instanciates if it's part of a parent child structure of interfaces. |
NestedItems
|
list of NestedItem | A list of extra data feed items to instantiate the same as this one with the same arguments, except each one can be Nested under this item. |
EnabledState
|
IField`1<Bool> | The enabled state of this feed interface item UI element. |
Path
|
SyncFieldList`1<String> | A list of strings specifying this categories specific sub path. |
Usage
This article or section is a Stub. You can help the Resonite Wiki by expanding it.