contentstack.csharp
2.10.0
dotnet add package contentstack.csharp --version 2.10.0
NuGet\Install-Package contentstack.csharp -Version 2.10.0
<PackageReference Include="contentstack.csharp" Version="2.10.0" />
paket add contentstack.csharp --version 2.10.0
#r "nuget: contentstack.csharp, 2.10.0"
// Install contentstack.csharp as a Cake Addin
#addin nuget:?package=contentstack.csharp&version=2.10.0
// Install contentstack.csharp as a Cake Tool
#tool nuget:?package=contentstack.csharp&version=2.10.0
Contentstack dotnet
.NET SDK for Contentstack's Content Delivery API
Getting Started
This guide will help you get started with our .NET SDK to build apps powered by Contentstack.
SDK Installation and Setup
To use the .NET SDK, download it from here
Open the terminal and install the contentstack module via ‘Package Manager’ command
PM> Install-Package contentstack.csharp
And via ‘.Net CLI’
dotnet add package contentstack.csharp
To use the module in your application, you need to first Add Namespace to your class
using Contentstack.Core; // ContentstackClient
using Contentstack.Core.Models; // Stack, Query, Entry, Asset, ContentType, ContentstackCollection
using Contentstack.Core.Configuration; // ContentstackOptions
Initialize SDK
You will need to specify the API key, Access token, and Environment Name of your stack to initialize the SDK:
ContentstackClient stack = new ContentstackClient("api_key", "delivery_token", "enviroment_name");
or:
var options = new ContentstackOptions()
{
ApiKey = "<api_key>",
DeliveryToken = "<delivery_token>"
Environment = "<environment>"
}
ContentstackClient stack = new ContentstackClient(options);
Once you have initialized the SDK, you can start getting content in your app.
Basic Queries
Get a Single Entry
To retrieve a single entry from a content type, use the code snippet given below:
Entry entry = client.ContentType("product").Entry("blta464e9fbd048668c");
entry.Fetch<Product>().ContinueWith((t) => {
if (!t.IsFaulted) {
Console.WriteLine("entry:" + t.Result);
}
});
Get Multiple Entries
To retrieve multiple entries of a particular content type, use the code snippet given below:
Query query = client.ContentType("product").Query();
query.Where("title", "welcome");
query.IncludeSchema();
query.IncludeCount();
query.ToJSON();
query.Find<Product>().ContinueWith((t) => {
if (!t.IsFaulted) {
ContentstackCollection<Product> result = t.Result;
Console.WriteLine("result" + result.items);
}
});
These were example of some of the basic queries of the SDK. For advanced queries, refer to our API reference documentation by visiting the link given below.
Note: Currently, the .NET SDK does not support multiple content types referencing in a single query. For more information on how to query entries and assets, refer the Queries section of our Content Delivery API documentation.
Paginating Responses
In a single instance, the Get Multiple Entries query will retrieve only the first 100 items of the specified content type. You can paginate and retrieve the rest of the items in batches using the skip and limit parameters in subsequent requests.
Query query = client.ContentType("product").Query();
query.Skip(20);
query.Limit(20);
query.Find<Product>().ContinueWith((t) => {
if (!t.IsFaulted) {
ContentstackCollection<Product> result = t.Result;
Console.WriteLine("result" + result);
}
});
API Reference
Go through our .NET SDK API Reference guide to know about the methods that can be used to query your content in Contentstack.
Example
To help you get started, we have created a sample application that is powered by Contentstack .NET SDK. Click on the link below to read the tutorial of the app.
Helpful Links
Product | Versions |
---|---|
.NET | net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows |
.NET Core | netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1 |
.NET Standard | netstandard2.0 netstandard2.1 |
.NET Framework | net461 net462 net463 net47 net471 net472 net48 net481 |
MonoAndroid | monoandroid |
MonoMac | monomac |
MonoTouch | monotouch |
Tizen | tizen40 tizen60 |
Xamarin.iOS | xamarinios |
Xamarin.Mac | xamarinmac |
Xamarin.TVOS | xamarintvos |
Xamarin.WatchOS | xamarinwatchos |
-
.NETFramework 4.7
- contentstack.utils (>= 1.0.1)
- Markdig (>= 0.31.0)
- Microsoft.Extensions.Options (>= 7.0.1)
- Newtonsoft.Json (>= 13.0.2)
-
.NETFramework 4.7.2
- contentstack.utils (>= 1.0.1)
- Markdig (>= 0.31.0)
- Microsoft.Extensions.Options (>= 7.0.1)
- Newtonsoft.Json (>= 13.0.2)
-
.NETStandard 2.0
- contentstack.utils (>= 1.0.1)
- Markdig (>= 0.31.0)
- Microsoft.Extensions.Options (>= 7.0.1)
- Newtonsoft.Json (>= 13.0.2)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on contentstack.csharp:
Package | Downloads |
---|---|
contentstack.aspnetcore
Main release |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
2.10.0 | 204 | 3/8/2023 |
2.9.0 | 7,850 | 9/9/2022 |
2.8.0 | 73,678 | 1/14/2022 |
2.7.0 | 2,329 | 12/8/2021 |
2.6.2 | 3,231 | 7/16/2021 |
2.6.1 | 4,380 | 4/9/2021 |
2.6.0 | 263 | 4/6/2021 |
2.5.0 | 3,243 | 12/5/2020 |
2.4.1-alpha | 226 | 11/11/2020 |
2.4.0 | 6,702 | 8/12/2020 |
2.3.0 | 953 | 6/22/2020 |
2.2.1 | 21,375 | 2/17/2020 |
2.2.0 | 495 | 11/15/2019 |
2.1.1 | 1,857 | 9/3/2019 |
2.1.0 | 556 | 7/29/2019 |
2.0.0 | 724 | 6/28/2019 |
1.1.0 | 13,487 | 4/12/2019 |
1.0.6 | 2,540 | 8/10/2018 |
1.0.5-alpha | 836 | 5/31/2018 |
1.0.4-alpha | 843 | 5/31/2018 |
1.0.3-alpha | 956 | 5/30/2018 |
1.0.2-alpha | 787 | 5/29/2018 |
1.0.1-alpha | 747 | 5/29/2018 |
1.0.0 | 1,092 | 6/1/2018 |
Reference in entry Live preview support added