Component:FeedItemInterface: Difference between revisions

From Resonite Wiki
Visual
Automated: create new component page
 
Automated: update Fields
 
(2 intermediate revisions by one other user not shown)
Line 3: Line 3:
|Name=Feed Item Interface
|Name=Feed Item Interface
}}
}}
{{stub}}
The '''FeedItemInterface''' component is used as a template type item in data feed mappers in the [[Data Feeds]] system.


== Usage ==
All Feed interface types extend from this class, and are listed in the [[:Category:Components:Radiant UI:Data Feeds:Interfaces| Interfaces category]].
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|ItemName|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv0=true|
|HasData|Bool| {{Template:FeedItemInterface_HasData}}
|ItemKey|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv1=true|
|ItemName|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv1=true| {{Template:FeedItemInterface_ItemName}}
|ItemDescription|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv2=true|
|ItemKey|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv2=true| {{Template:FeedItemInterface_ItemKey}}
|HasDescription|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv3=true|
|ItemDescription|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv3=true| {{Template:FeedItemInterface_ItemDescription}}
|DescriptionCleanup|Slot|
|HasDescription|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv4=true| {{Template:FeedItemInterface_HasDescription}}
|ItemIcon|'''[[Type:IField`1|IField`1]]<[[Type:Uri|Uri]]>'''|TypeAdv5=true|
|DescriptionCleanup|Slot| {{Template:FeedItemInterface_DescriptionCleanup}}
|HasIcon|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv6=true|
|ItemIcon|'''[[Type:IField`1|IField`1]]<[[Type:Uri|Uri]]>'''|TypeAdv6=true| {{Template:FeedItemInterface_ItemIcon}}
|IconCleanup|Slot|
|HasIcon|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv7=true| {{Template:FeedItemInterface_HasIcon}}
|View|'''[[Type:SyncRef`1|SyncRef`1]]<[[Type:IDataFeedView|IDataFeedView]]>'''|TypeAdv8=true|
|IconCleanup|Slot| {{Template:FeedItemInterface_IconCleanup}}
|ParentContainer|'''[[Component:FeedItemInterface|FeedItemInterface]]'''|TypeAdv9=true|
|View|'''[[Type:SyncRef`1|SyncRef`1]]<[[Type:IDataFeedView|IDataFeedView]]>'''|TypeAdv9=true| {{Template:FeedItemInterface_View}}
|ChildContainer|Slot|
|ParentContainer|'''[[Component:FeedItemInterface|FeedItemInterface]]'''|TypeAdv10=true| {{Template:FeedItemInterface_ParentContainer}}
|NestedItems|{{RootFieldType|SyncList`1|[[#NestedItem|NestedItem]]}}|TypeAdv11=true|
|ChildContainer|Slot| {{Template:FeedItemInterface_ChildContainer}}
|EnabledState|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv12=true|
|NestedItems|{{RootFieldType|SyncList`1|[[#NestedItem|NestedItem]]}}|TypeAdv12=true| {{Template:FeedItemInterface_NestedItems}}
|EnabledState|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv13=true| {{Template:FeedItemInterface_EnabledState}}
}}
 
== NestedItem ==
{{Table TypeFields
|Interface|'''[[Component:FeedItemInterface|FeedItemInterface]]'''|TypeAdv0=true| The template to instance when templated by a data feed as part of this Nested item.
|Container|Slot| Where to place this Nested item when it is generated.
|IgnoreParentContainer|bool| Whether to ignore instantiating the parent container of <code>Interface</code> when this is instanciated.
}}
}}


== Behavior ==
== Usage ==
{{stub}}


== Examples ==
== Examples ==


== See Also ==
== See Also ==
* [[Data Feeds]]


[[Category:Components:Radiant UI:Data Feeds:Interfaces{{#translation:}}|Feed Item Interface]]
[[Category:Components:Radiant UI:Data Feeds:Interfaces{{#translation:}}|Feed Item Interface]]
[[Category:Components{{#translation:}}|Feed Item Interface]]
[[Category:Components{{#translation:}}|Feed Item Interface]]
[[Category:Components With Nested Types{{#translation:}}|Feed Item Interface]]
[[Category:Components With Nested Types{{#translation:}}|Feed Item Interface]]
[[Category:ComponentStubs]]

Latest revision as of 22:29, 16 March 2025

Component image 
Feed Item Interface component as seen in the Scene Inspector

The FeedItemInterface component is used as a template type item in data feed mappers in the Data Feeds system.

All Feed interface types extend from this class, and are listed in the Interfaces category.

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. 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.

NestedItem

Fields
Name Type Description
Interface FeedItemInterface The template to instance when templated by a data feed as part of this Nested item.
Container Slot Where to place this Nested item when it is generated.
IgnoreParentContainer bool Whether to ignore instantiating the parent container of Interface when this is instanciated.

Usage

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


Examples

See Also

Retrieved from "https://wiki.resonite.com/index.php?title=Component:FeedItemInterface&oldid=97332"