XperienceCommunity.DataContext
0.0.0.1
See the version list below for details.
dotnet add package XperienceCommunity.DataContext --version 0.0.0.1
NuGet\Install-Package XperienceCommunity.DataContext -Version 0.0.0.1
<PackageReference Include="XperienceCommunity.DataContext" Version="0.0.0.1" />
paket add XperienceCommunity.DataContext --version 0.0.0.1
#r "nuget: XperienceCommunity.DataContext, 0.0.0.1"
// Install XperienceCommunity.DataContext as a Cake Addin #addin nuget:?package=XperienceCommunity.DataContext&version=0.0.0.1 // Install XperienceCommunity.DataContext as a Cake Tool #tool nuget:?package=XperienceCommunity.DataContext&version=0.0.0.1
XperienceCommunity.DataContext
Enhance your Kentico Xperience development with a fluent API for intuitive and efficient query building. This project abstracts the built-in ContentItemQueryBuilder, leveraging .NET 8 and integrated with Xperience By Kentico, to improve your local development and testing workflow.
Features
- Fluent API for query building with expressions.
- Built in caching.
- Built on .NET 8, ensuring modern development practices.
- Seamless integration with Xperience By Kentico.
Quick Start
- Prerequisites: Ensure you have .NET 8 and Kentico Xperience installed.
- Installation: Clone this repository to get started with local development.
Prerequisites
Before you begin, ensure you have met the following requirements:
- .NET 8: Make sure you have .NET 8 installed on your development machine. You can download it from here.
- Xperience By Kentico Project: You need an existing Xperience By Kentico project. If you're new to Xperience By Kentico, start here.
Installation
To integrate XperienceCommunity.DataContext into your Kentico Xperience project, follow these steps:
Add the Package:
- Currently, you need to clone the repository or reference the project directly, as it may not be available as a NuGet package yet.
Configure Services:
- In your
Startup.cs
or wherever you configure services, add the following line to register XperienceCommunity.DataContext services with dependency injection:
- In your
public void ConfigureServices(IServiceCollection services)
{
services.AddXperienceDataContext();
}
Injecting the IContentItemContext
into a Class
To leverage the IContentItemContext
in your classes, you need to inject it via dependency injection. The IContentItemContext
requires a class that implements the IContentItemFieldSource
interface. For instance, you might have a GenericContent
class designed for the Content Hub.
Example:
Assuming you have a GenericContent
class that implements IContentItemFieldSource
, you can inject the IContentItemContext<GenericContent>
into your classes as follows:
public class MyService
{
private readonly IContentItemContext<GenericContent> _contentItemContext;
public MyService(IContentItemContext<GenericContent> contentItemContext)
{
_contentItemContext = contentItemContext;
}
// Example method using the _contentItemContext
public async Task<GenericContent> GetContentItemAsync(Guid contentItemGUID)
{
return await _contentItemContext
.FirstOrDefaultAsync(x => x.SystemFields.ContentItemGUID == contentItemGUID);
}
}
This setup allows you to utilize the fluent API provided by IContentItemContext
to interact with content items in a type-safe manner, enhancing the development experience with Kentico Xperience.
Example Usage
Here's a quick example to show how you can use XperienceCommunity.DataContext in your project:
var result = await _context
.WithLinkedItems(1)
.FirstOrDefaultAsync(x => x.SystemFields.ContentItemGUID == selected.Identifier, HttpContext.RequestAborted);
This example demonstrates how to asynchronously retrieve the first content item that matches a given GUID, with a single level of linked items included, using the fluent API provided by XperienceCommunity.DataContext.
Built With
- Xperience By Kentico - Kentico Xperience
- NuGet - Dependency Management
Versioning
We use SemVer for versioning. For the versions available, see the tags on this repository.
Authors
- Brandon Henricks - Initial work - Brandon Henricks
License
This project is licensed under the MIT License - see the LICENSE.md file for details
Acknowledgments
- Mike Wills
- David Rector
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
-
net6.0
- CSharpFunctionalExtensions (>= 2.41.0)
-
net8.0
- CSharpFunctionalExtensions (>= 2.41.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.