PINGWorks.SitecoreExperienceEdge.Common
1.3.0
dotnet add package PINGWorks.SitecoreExperienceEdge.Common --version 1.3.0
NuGet\Install-Package PINGWorks.SitecoreExperienceEdge.Common -Version 1.3.0
<PackageReference Include="PINGWorks.SitecoreExperienceEdge.Common" Version="1.3.0" />
<PackageVersion Include="PINGWorks.SitecoreExperienceEdge.Common" Version="1.3.0" />
<PackageReference Include="PINGWorks.SitecoreExperienceEdge.Common" />
paket add PINGWorks.SitecoreExperienceEdge.Common --version 1.3.0
#r "nuget: PINGWorks.SitecoreExperienceEdge.Common, 1.3.0"
#:package PINGWorks.SitecoreExperienceEdge.Common@1.3.0
#addin nuget:?package=PINGWorks.SitecoreExperienceEdge.Common&version=1.3.0
#tool nuget:?package=PINGWorks.SitecoreExperienceEdge.Common&version=1.3.0
PINGWorks.SitecoreExperienceEdge.Common
This library provides shared utility classes to PINGWorks.SitecoreExperienceEdge.* libraries. It is a
transient dependency of other PINGWorks.SitecoreExperienceEdge.* libraries.
Getting started
You should not install this library directly. Instead, install an SDK library that provides service interfaces to access Sitecore Experience Edge's APIs, such as:
- PINGWorks.SitecoreExperienceEdge.AdminSDK for managing SitecoreAI configuration
- PINGWorks.SitecoreExperienceEdge.ContentSDK for accessing SitecoreAI content
- PINGWorks.SitecoreExperienceEdge.EventsSDK for recording SitecoreAI analytics
Cross-cutting HttpClient defaults
Every AddSitecore*Sdk(…) call routes through AddSitecoreEECommon() (it's the shared setup
hook). That call uses ConfigureHttpClientDefaults to apply two cross-cutting defaults to
every named/typed HttpClient registered against the container — including any HttpClients
the host app registers itself for its own services:
| Default | Build | Notes |
|---|---|---|
AddStandardResilienceHandler() |
All builds | Microsoft's standard pipeline (retry, timeout, circuit breaker, concurrency limit). |
AddHttpMessageHandler<DebugLogger>() |
DEBUG only | Writes request URL + headers + body and response status + body to Console.Out. Stripped from Release. |
AddSitecoreEECommon is idempotent — calling it from multiple SDK registrations applies the
defaults exactly once.
Customizing the resilience options for a specific client
Use the standard ASP.NET options-with-name pattern. The HttpClient name for a typed-client registration is the unqualified type name of the service interface:
// Increase the per-attempt timeout for ISitecoreAdminSdk only:
services.Configure<HttpStandardResilienceOptions>( nameof( ISitecoreAdminSdk ), opts =>
{
opts.AttemptTimeout.Timeout = TimeSpan.FromSeconds( 60 );
opts.TotalRequestTimeout.Timeout = TimeSpan.FromMinutes( 5 );
} );
For the named OAuth-token client (registered by AgentSDK / AdminSDK / PagesSDK / PublishingSDK
/ SitesSDK), use the constant DefaultTokenProvider.HttpClientName as the options name.
Opting out entirely
There is no built-in opt-out. If your app already configures resilience on its own HttpClients
and the duplicate handler would interfere, raise an issue — we can add a ConfigureSitecoreEE
overload that takes a bool applyResilienceToAll flag.
Known Issues
None.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. 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 was computed. 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. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
| .NET Core | netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
| .NET Standard | netstandard2.1 is compatible. |
| MonoAndroid | monoandroid was computed. |
| MonoMac | monomac was computed. |
| MonoTouch | monotouch was computed. |
| Tizen | tizen60 was computed. |
| Xamarin.iOS | xamarinios was computed. |
| Xamarin.Mac | xamarinmac was computed. |
| Xamarin.TVOS | xamarintvos was computed. |
| Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.1
- Microsoft.AspNetCore.Http.Abstractions (>= 2.3.9)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.5)
- Microsoft.Extensions.Http (>= 10.0.5)
- Microsoft.Extensions.Http.Resilience (>= 10.4.0)
- System.Net.Http.Json (>= 10.0.5)
NuGet packages (10)
Showing the top 5 NuGet packages that depend on PINGWorks.SitecoreExperienceEdge.Common:
| Package | Downloads |
|---|---|
|
PINGWorks.SitecoreExperienceEdge.AdminSDK
PING Works' .NET SDK for working with Sitecore's Experience Edge Admin API. |
|
|
PINGWorks.SitecoreExperienceEdge.ContentSDK
PING Works' .NET SDK for working with Sitecore's Experience Edge Content API. |
|
|
PINGWorks.SitecoreExperienceEdge.EventsSDK
PING Works' .NET SDK for working with Sitecore's Experience Edge Events API. |
|
|
PINGWorks.SitecoreAI.SitesSDK
PING Works' .NET SDK for working with SitecoreAI's Sites API. |
|
|
PINGWorks.SitecoreExperienceEdge.PublishingSDK
PING Works' .NET SDK for working with Sitecore's Experience Edge Publishing API. |
GitHub repositories
This package is not used by any popular GitHub repositories.
v1.3.0
✔️ Add CancellationToken support
🐛 Update PATCH requests expression parser
v1.2.1
✔️ Export the JsonSerializerOptions configured for use with Sitecore
v1.2.0
✔️ Move DefaultTokenProvider to common library from AdminSDK as it will be used in other SDKs
v1.1.0
Initial public release