Data Sources Tutorials

using System.Linq;
using ToSic.Eav.DataSources;

public class Authors : Custom.DataSource.DataSource16
{
  public Authors(MyServices services) : base(services)
  {
    ProvideOut(() => {
      // Get the app data
      var appData = Kit.Data.GetAppSource();

      // Get the Content-Type Filter DataSource
      var contentTypeFilter = Kit.Data.GetSource<EntityTypeFilter>(attach: appData, parameters: new { TypeName = "Persons"});

      // Return all the items after filtering
      return contentTypeFilter.List;
    });
  }
}

using System.Linq;

public class KeepOdd : Custom.DataSource.DataSource16
{
  public KeepOdd(MyServices services) : base(services)
  {
    ProvideOut(() => {
      // Make sure we have an In stream - otherwise return an error
      var inStream = TryGetIn();
      if (inStream == null) return Error.TryGetInFailed();

      // Return only odd items
      return inStream.Where(e => e.EntityId % 2 == 1);
    });
  }
}

<div class="row">
  <div class="col-4">@Sys.Fancybox.PreviewWithLightbox(App.Path + "/data-sources/assets/use-in-visual-query.jpg", 200, 100, "float-right float-end", label: "Simple Query", figure: false)</div>
</div>
@{
  var queryOddAuthors = Kit.Data.GetQuery("DynamicDataSourceKeepOdd");
}
<h3>Data in the Query (@queryOddAuthors.List.Count())</h3>
<ul>
  @foreach (var item in AsList(queryOddAuthors)) {
    <li>
      <strong>@item.EntityTitle</strong> (ID: @item.EntityId)
    </li>
  }
</ul>

using System.Linq;
using ToSic.Eav.DataSource; // This namespace is for the [Configuration] attribute

public class WithConfig : Custom.DataSource.DataSource16
{
  public WithConfig(MyServices services) : base(services, "My.Magic")
  {
    ProvideOut(() => {
      var result = Enumerable.Range(1, AmountOfItems).Select(i => new {
        Title = "Hello from WithConfig #" + i,
        FavoriteColor,
      });
      return result;
    });
  }

  // This attribute [Configuration] creates a configuration "FavoriteColor"
  // In this example [Configuration] already knows about the fallback.
  // * The property getter calls Configuration.GetThis()
  // * GetThis() will automatically use the property name "FavoriteColor" to look up the config
  // * Calling an empty GetThis() will always return a string,
  //   so it's ideal for string-properties where the Fallback was specified before
  [Configuration(Fallback = "magenta")]
  public string FavoriteColor { get { return Configuration.GetThis(); } }

  // This attribute [Configuration] creates configuration "AmountOfItems"
  // * The property getter calls Configuration.GetThis()
  // * GetThis() will automatically use the property name "AmountOfItems" to look up the config
  //   and will use the default value of 1 if it was not specified
  [Configuration]
  public int AmountOfItems { get { return Configuration.GetThis(1); } }
}

<div class="row">
  <div class="col-4">@Sys.Fancybox.PreviewWithLightbox(App.Path + "/data-sources/assets/configure-in-visual-query1.jpg", 200, 100, "float-left", label: "Configured Query", figure: false)</div>
  <div class="col-4">@Sys.Fancybox.PreviewWithLightbox(App.Path + "/data-sources/assets/configure-in-visual-query2.jpg", 200, 100, "float-left", label: "Edit Configuration", figure: false)</div>
</div>
@{
  var queryWithConfig = Kit.Data.GetQuery("DynamicDataSourceWithConfig");
}
<h3>Data in the Query (@queryWithConfig.List.Count())</h3>
<ul>
  @foreach (var item in AsList(queryWithConfig)) {
    <li>
      <strong>@item.Title</strong> - Favorite Color: @item.FavoriteColor
    </li>
  }
</ul>

// This is necessary to use the [VisualQuery] Attribute
using ToSic.Eav.DataSource.VisualQuery;

// Configure some common aspects in Visual Query
// There are more, but they usually don't make sense on a Dynamic DataSource
[VisualQuery(
  // Give it a nice name and UI-Hint in visual query
  NiceName = "Customized DataSource",
  UiHint = "This demonstrates how to customize the visual query integration",
  // Customize the icon - see google material icons for more
  Icon = "opacity",
  // Customize the link on the (?) icon
  HelpLink = "https://2sxc.org",
  // Customize which Content Type to use when configuring this
  ConfigurationType = "WithConfigConfiguration"
)]
public class VisualQueryCustomized : Custom.DataSource.DataSource16
{
  public VisualQueryCustomized(MyServices services) : base(services)
  {
    // Trivial example, as this demo should focus on the VisualQuery
    ProvideOut(() => new {
      Title = "Hello from VisualQueryCustomized",
      TheAnswer = 42,
    });
  }
}

<div class="row">
  <div class="col-4">@Sys.Fancybox.PreviewWithLightbox(App.Path + "/data-sources/assets/visual-query-attribute.jpg", 200, 200, "float-left", label: "Customized with VisualQuery Attribute", figure: false)</div>
</div>