Class SitecoreLayoutClientBuilderExtensions

Namespace

Sitecore.AspNetCore.SDK.LayoutService.Client.Extensions

Assembly

Sitecore.AspNetCore.SDK.LayoutService.Client.dll

Extension methods to support configuration of layout service services.

public static class SitecoreLayoutClientBuilderExtensions

Inheritance

object

SitecoreLayoutClientBuilderExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

AddGraphQLHandler(ISitecoreLayoutClientBuilder, string, string, string)

Registers a graphQl handler to handle requests, it uses already configured GraphQL client.

public static ILayoutRequestHandlerBuilder<GraphQLLayoutServiceHandler> AddGraphQLHandler(this ISitecoreLayoutClientBuilder builder, string name, string siteName, string defaultLanguage = "en")

Parameters

builder ISitecoreLayoutClientBuilder

The ISitecoreLayoutClientBuilder being configured.

name string

The name used to identify the handler.

siteName string

The siteName used to identify the handler.

defaultLanguage string

Default language for GraphQL requests.

Returns

ILayoutRequestHandlerBuilder<GraphQLLayoutServiceHandler>

The ILayoutRequestHandlerBuilder<THandler> so that additional calls can be chained.

AddGraphQLHandler(ISitecoreLayoutClientBuilder, string, string, string, Uri, string)

Registers a graphQl handler to handle requests.

public static ILayoutRequestHandlerBuilder<GraphQLLayoutServiceHandler> AddGraphQLHandler(this ISitecoreLayoutClientBuilder builder, string name, string siteName, string apiKey, Uri uri, string defaultLanguage = "en")

Parameters

builder ISitecoreLayoutClientBuilder

The ISitecoreLayoutClientBuilder being configured.

name string

The name used to identify the handler.

siteName string

The siteName used to identify the handler.

apiKey string

The apiKey to access graphQL endpoint.

uri Uri

GraphQL endpoint uri.

defaultLanguage string

Default language for GraphQL requests.

Returns

ILayoutRequestHandlerBuilder<GraphQLLayoutServiceHandler>

The ILayoutRequestHandlerBuilder<THandler> so that additional calls can be chained.

AddGraphQLWithContextHandler(ISitecoreLayoutClientBuilder, string, string, Uri?, string?, string)

Registers a graphQl handler to handle requests.

public static ILayoutRequestHandlerBuilder<GraphQLLayoutServiceHandler> AddGraphQLWithContextHandler(this ISitecoreLayoutClientBuilder builder, string name, string contextId, Uri? uri = null, string? siteName = null, string defaultLanguage = "en")

Parameters

builder ISitecoreLayoutClientBuilder

The ISitecoreLayoutClientBuilder being configured.

name string

The name used to identify the handler.

contextId string

The context identifier to access graphQl endpoint.

uri Uri

GraphQL endpoint uri.

siteName string

The siteName used to identify the handler.

defaultLanguage string

Default language for GraphQL requests.

Returns

ILayoutRequestHandlerBuilder<GraphQLLayoutServiceHandler>

The ILayoutRequestHandlerBuilder<THandler> so that additional calls can be chained.

AddHandler<THandler>(ISitecoreLayoutClientBuilder, string, Func<IServiceProvider, THandler>?)

Registers a handler of type THandler to handle requests.

public static ILayoutRequestHandlerBuilder<THandler> AddHandler<THandler>(this ISitecoreLayoutClientBuilder builder, string name, Func<IServiceProvider, THandler>? factory = null) where THandler : ILayoutRequestHandler

Parameters

builder ISitecoreLayoutClientBuilder

The ISitecoreLayoutClientBuilder being configured.

name string

The name used to identify the handler.

factory Func<IServiceProvider, THandler>

Optional factory to control the instantiation of the client.

Returns

ILayoutRequestHandlerBuilder<THandler>

The ILayoutRequestHandlerBuilder<THandler> so that additional calls can be chained.

Type Parameters

THandler

The type of service to be registered for this name.

AddHttpHandler(ISitecoreLayoutClientBuilder, string, Action<IServiceProvider, HttpClient>)

Registers an HTTP request handler for the Sitecore layout service client.

public static ILayoutRequestHandlerBuilder<HttpLayoutRequestHandler> AddHttpHandler(this ISitecoreLayoutClientBuilder builder, string handlerName, Action<IServiceProvider, HttpClient> configure)

Parameters

builder ISitecoreLayoutClientBuilder

The ISitecoreLayoutClientBuilder to configure.

handlerName string

The name of the request handler being registered.

configure Action<IServiceProvider, HttpClient>

An action to configure the HttpClient.

Returns

ILayoutRequestHandlerBuilder<HttpLayoutRequestHandler>

The ILayoutRequestHandlerBuilder<THandler> so that additional calls can be chained.

AddHttpHandler(ISitecoreLayoutClientBuilder, string, Action<HttpClient>)

Registers an HTTP request handler for the Sitecore layout service client.

public static ILayoutRequestHandlerBuilder<HttpLayoutRequestHandler> AddHttpHandler(this ISitecoreLayoutClientBuilder builder, string handlerName, Action<HttpClient> configure)

Parameters

builder ISitecoreLayoutClientBuilder

The ISitecoreLayoutClientBuilder to configure.

handlerName string

The name of the request handler being registered.

configure Action<HttpClient>

An action to configure the HttpClient.

Returns

ILayoutRequestHandlerBuilder<HttpLayoutRequestHandler>

The ILayoutRequestHandlerBuilder<THandler> so that additional calls can be chained.

AddHttpHandler(ISitecoreLayoutClientBuilder, string, Func<IServiceProvider, HttpClient>)

Registers an HTTP request handler for the Sitecore layout service client.

public static ILayoutRequestHandlerBuilder<HttpLayoutRequestHandler> AddHttpHandler(this ISitecoreLayoutClientBuilder builder, string handlerName, Func<IServiceProvider, HttpClient> resolveClient)

Parameters

builder ISitecoreLayoutClientBuilder

The ISitecoreLayoutClientBuilder to configure.

handlerName string

The name of the request handler being registered.

resolveClient Func<IServiceProvider, HttpClient>

A function to resolve the HttpClient to be used. Be aware, that the underlying HttpMessageHandler associated to the HttpClient will be reused across multiple sessions. To prevent data, leaking among sessions, make sure Cookies are not cached. See for reference https://docs.microsoft.com/en-us/aspnet/core/fundamentals/http-requests?view=aspnetcore-3.1#cookies .

Returns

ILayoutRequestHandlerBuilder<HttpLayoutRequestHandler>

The ILayoutRequestHandlerBuilder<THandler> so that additional calls can be chained.

AddHttpHandler(ISitecoreLayoutClientBuilder, string, Func<IServiceProvider, HttpClient>, string[])

Registers an HTTP request handler for the Sitecore layout service client.

public static ILayoutRequestHandlerBuilder<HttpLayoutRequestHandler> AddHttpHandler(this ISitecoreLayoutClientBuilder builder, string handlerName, Func<IServiceProvider, HttpClient> resolveClient, string[] nonValidatedHeaders)

Parameters

builder ISitecoreLayoutClientBuilder

The ISitecoreLayoutClientBuilder to configure.

handlerName string

The name of the request handler being registered.

resolveClient Func<IServiceProvider, HttpClient>

A function to resolve the HttpClient to be used. Be aware, that the underlying HttpMessageHandler associated to the HttpClient will be reused across multiple sessions. To prevent data, leaking among sessions, make sure Cookies are not cached. See for reference https://docs.microsoft.com/en-us/aspnet/core/fundamentals/http-requests?view=aspnetcore-3.1#cookies .

nonValidatedHeaders string[]

The list of headers which should not be validated.

Returns

ILayoutRequestHandlerBuilder<HttpLayoutRequestHandler>

The ILayoutRequestHandlerBuilder<THandler> so that additional calls can be chained.

AddHttpHandler(ISitecoreLayoutClientBuilder, string, string)

Registers an HTTP request handler for the Sitecore layout service client.

public static ILayoutRequestHandlerBuilder<HttpLayoutRequestHandler> AddHttpHandler(this ISitecoreLayoutClientBuilder builder, string handlerName, string uri)

Parameters

builder ISitecoreLayoutClientBuilder

The ISitecoreLayoutClientBuilder to configure.

handlerName string

The name of the request handler being registered.

uri string

The Uri used for the BaseAddress.

Returns

ILayoutRequestHandlerBuilder<HttpLayoutRequestHandler>

The ILayoutRequestHandlerBuilder<THandler> so that additional calls can be chained.

AddHttpHandler(ISitecoreLayoutClientBuilder, string, Uri)

Registers an HTTP request handler for the Sitecore layout service client.

public static ILayoutRequestHandlerBuilder<HttpLayoutRequestHandler> AddHttpHandler(this ISitecoreLayoutClientBuilder builder, string handlerName, Uri uri)

Parameters

builder ISitecoreLayoutClientBuilder

The ISitecoreLayoutClientBuilder to configure.

handlerName string

The name of the request handler being registered.

uri Uri

The Uri used for the BaseAddress.

Returns

ILayoutRequestHandlerBuilder<HttpLayoutRequestHandler>

The ILayoutRequestHandlerBuilder<THandler> so that additional calls can be chained.

WithDefaultRequestOptions(ISitecoreLayoutClientBuilder, Action<SitecoreLayoutRequest>)

Registers the default layout service request options for all handlers.

public static ISitecoreLayoutClientBuilder WithDefaultRequestOptions(this ISitecoreLayoutClientBuilder builder, Action<SitecoreLayoutRequest> configureRequest)

Parameters

builder ISitecoreLayoutClientBuilder

The ISitecoreLayoutClientBuilder being configured.

configureRequest Action<SitecoreLayoutRequest>

The SitecoreLayoutRequest request options configuration.

Returns

ISitecoreLayoutClientBuilder

The configured ISitecoreLayoutClientBuilder.