NamespaceSystemLibrary.Common.Episerver.Extensions SystemLibrary.Common.Episerver.dll

Contains application builder options that you can override if you want to

CmsAppBuilderOptions

public class CmsAppBuilderOptions : AppBuilderOptions

Inheritance

System.Object

SystemLibrary.Common.Web.Extensions.BaseOptions

SystemLibrary.Common.Web.Extensions.AppBuilderOptions

CmsAppBuilderOptions

Inherited Members

SystemLibrary.Common.Web.Extensions.AppBuilderOptions.UseHsts

SystemLibrary.Common.Web.Extensions.AppBuilderOptions.UseRouting

SystemLibrary.Common.Web.Extensions.AppBuilderOptions.UseAuthentication

SystemLibrary.Common.Web.Extensions.AppBuilderOptions.UseAuthorization

SystemLibrary.Common.Web.Extensions.AppBuilderOptions.UseStaticFiles

SystemLibrary.Common.Web.Extensions.AppBuilderOptions.StaticFilesMaxAgeSeconds

SystemLibrary.Common.Web.Extensions.AppBuilderOptions.StaticFilesServeUnknownFileTypes

SystemLibrary.Common.Web.Extensions.AppBuilderOptions.StaticFilesRequestPaths

SystemLibrary.Common.Web.Extensions.AppBuilderOptions.UseDeveloperPage

SystemLibrary.Common.Web.Extensions.BaseOptions.UseRazorPages

SystemLibrary.Common.Web.Extensions.BaseOptions.UseControllers

SystemLibrary.Common.Web.Extensions.BaseOptions.UseApiControllers

SystemLibrary.Common.Web.Extensions.BaseOptions.UseCookiePolicy

SystemLibrary.Common.Web.Extensions.BaseOptions.UseForwardedHeaders

SystemLibrary.Common.Web.Extensions.BaseOptions.UseHttpsRedirection

SystemLibrary.Common.Web.Extensions.BaseOptions.UseOutputCache

SystemLibrary.Common.Web.Extensions.BaseOptions.UseOutputCacheAfterAuthentication

SystemLibrary.Common.Web.Extensions.BaseOptions.UseGzipResponseCompression

SystemLibrary.Common.Web.Extensions.BaseOptions.UseBrotliResponseCompression

Examples

Arguments

X

Fields

If you want a custom login path like "SignIn", set this

public string CmsLoginPath

X

Field Value

Type	Description
System.String

Return a path of where to look for components view files.

Components that do not have a Controller nor a Component class defined, will use this path as the base path of where to look for views

Example: ~/Blocks/

public Func<Type, string> DefaultComponentPathPredicate

X

Field Value

Type	Description
Func<Type, System.String>

Disallow serving known application files:

- everything under the path ~/config

- everything under the path /bin/

- appSettings.json

- any .config filev

- any .dll file

- any .cs file

- any .cshtml file

- any .tsx file

- any .ts file

- any .mdf file

- any .sql file

- any .db file

Remarks

X

If set to True, this stops the pipeline and returns blank, even before StaticFileHandler, so if you need to host any of these file types register your own static file handler for those file types before or disable this one

public bool DisallowKnownAppFiles

X

Field Value

Type	Description
System.Boolean

Max usages per engine when environment is 'local'

public int ReactSsrMaxUsagesPerEngineLocal

X

Field Value

Type	Description
System.Int32

Max usages per engine before it resets when environment is not 'local'

public int ReactSsrMaxUsagesPerEngineNonLocal

X

Field Value

Type	Description
System.Int32

Enables loading of React Server Side through Node (V8 engine)

- does not load babel nor react, so your build must come with a React version and the already transpiled files for Node (basically "dist" folder)

Example might be:

~/static/dist/vendor-react.js

~/static/dist/vendor-others.js

~/static/dist/server-side-app.js

Where all these files are transpiled and minimized already before being loaded by the C# code

public string[] ReactSsrScriptsInOrder

X

Field Value

Type	Description
System.String[]

Enable the IErrorPage interface middleware

Implement your own ErrorPage.cs and a View, and inherit/implement IErrorPage interface

Set then the StatusCode on the ErrorPage.cs inside Epi UI to let that page respond to for instance any 404 in your whole application

This is never shown on path / nor if path starts with "/episerver"

If the request sends accept "application/json" the ErrorPage you've created is not invoked, but a hard-coded json error is returned

Remarks

X

You can set it to true to enable the parts in the comment that does not involve IErrorPage, even if you do not have a single IErrorPage implementation

public bool UseErrorPageResponse

X

Field Value

Type	Description
System.Boolean

public bool UseExceptionHandler

X

Field Value

Type	Description
System.Boolean

public bool UseMapContentAndControllers

X

Field Value

Type	Description
System.Boolean

Enables the reevaluate of the session

If session was created longer than 30 days ago, the cookie is deleted and user is redirected to root "/"

public bool UseRevalidateSessionMiddleware

X

Field Value

Type	Description
System.Boolean

Extension Methods

TExtensions.ReactServerSideRender<T>(T, Object, String, Boolean, String, String, String, Boolean, Boolean, Boolean)

}