README.md

Serenity.Net.Web assembly

Serenity namespace

signature	name	description
class	ScriptCulture	Culture options that are passed to the client side

Serenity.ComponentModel namespace

signature	name	description
class	EmailEditorAttribute	Email editor type with two inputs. Please prefer EmailAddressEditorAttribute which uses a single input.

Serenity.Data namespace

signature	name	description
static class	ForXmlHelper	Helper to generate T-SQL FOR XML RAW statements

Serenity.Extensions.DependencyInjection namespace

signature	name	description
static class	DynamicScriptServiceCollectionExtensions	Contains DI extension methods related to dynamic script services
static class	NodeScriptRunnerExtensions	Contains extensions for NodeScriptRunner

Serenity.Navigation namespace

signature	name	description
class	NavigationHelper	Contains helper methods for navigation models and items
class	NavigationLinkAttribute	A navigation item with a link

Serenity.Reporting namespace

signature	name	description
class	DefaultReportFactory	Default implementation for IReportFactory
class	DefaultReportRenderer	Default implementation for IReportRenderer
class	WKHtmlToPdf	HTML to PDF converter class using WKHTMLToPdf
class	WKHtmlToPdfConverter	Implementation for IWKHtmlToPdfConverter
class	WKHtmlToPdfSettings	Set of WKHTMLToPdf settings

Serenity.Services namespace

signature	name	description
class	AntiforgeryCookieResultFilterAttribute	Append the anti forgery token as CSRF-TOKEN cookie to the response, so that AJAX calls can read it client side and send as a header.
class	AuthorizeCreateAttribute	Authorizes access to a service method by reading one of InsertPermissionAttribute, ModifyPermissionAttribute or ReadPermissionAttribute from the target type, which is usually a Row class.
class	AuthorizeDeleteAttribute	Authorizes access to a service method by reading one of DeletePermissionAttribute, ModifyPermissionAttribute or ReadPermissionAttribute from the target type, which is usually a Row class.
class	AuthorizeListAttribute	Authorizes access to a service method by reading ReadPermissionAttribute. It also allows lookup mode access (as OrPermission) if the source type has ServiceLookupPermissionAttribute
class	AuthorizeUpdateAttribute	Authorizes access to a service method by reading one of UpdatePermissionAttribute, ModifyPermissionAttribute or ReadPermissionAttribute from the target type, which is usually a Row class.
static class	EndpointExtensions	Contains some extensions for service endpoints
class	FileUploadBehavior	Behavior class that handles FileUploadEditorAttribute and ImageUploadEditorAttribute.
class	HandleControllerExceptionAttribute	An exception filter attribute to handle controller exceptions and return as view.
class	HandleServiceExceptionAttribute	An exception filter attribute to handle service exceptions and return them to ServiceResponse objects
class	JsonRequestAttribute	An action filter for methods that accept JSON content via their "request" arguments.
class	MultipleFileUploadBehavior	Behavior class that handles MultipleFileUploadEditorAttribute and MultipleImageUploadEditorAttribute.
class	Result<TResponse>	An action result type containing a object
class	ResultWithStatus<TResponse>	An action result type containing a object with status code
class	ServiceAuthorizeAttribute	Authorizes access to a service action. Optionally checks the permission provided as the first argument. Use special permission key "?" to check for logged-in users, and "*" to allow anyone including anonymous access. This returns a service error instead of raising an exception like PageAuthorize attribute.
abstract class	ServiceEndpoint	Subclass of controller for service endpoints
class	ServiceEndpointActionModelConvention	Action model convention for ServiceEndpoint actions
class	ServiceEndpointModelBinderProvider	Provides model binding for service endpoints
class	ServiceEndpointNullModelBinder	Null model binder for interface arguments

Serenity.Web namespace

signature	name	description
class	AutoValidateAntiforgeryIgnoreBearerAttribute	An attribute that causes validation of antiforgery tokens for all unsafe HTTP methods. An antiforgery token is required for HTTP methods other than GET, HEAD, OPTIONS, and TRACE, and when there is no cookie header and authorization is Bearer, e.g. JWT etc.
class	ColumnsScript	Dynamic script type for columns (ColumnsScriptAttribute)
class	ColumnsScriptRegistration	Contains registration methods for ColumnsScript types
class	ConcatenatedScript	A dynamic script that is formed from concentanation of other scripts
class	ContentHashCache	Default IContentHashCache implementation
class	CssBundleManager	Default implementation for ICssBundleManager
class	CssBundlingOptions	Options for css bundling
class	CssMinifyOptions	Set of options for CSS minifying
class	CssMinifyResult	Result returned from a CSS minifier
abstract class	DataScript<TData>	Generic subclass of the DataScript
class	DataScript	Dynamic script that contains remote data
class	DataScriptRegistration	Contains helper methods for data script registration
class	DefaultFileWatcherFactory	Default implementation for IFileWatcherFactory
class	DefaultUploadFileResponder	Default implementation for upload file responder
class	DefaultUploadStorage	Default IUploadStorage implementation which uses a combined upload storage of two DiskUploadStorage instances.
class	DistinctValuesRegistration	Contains helper methods for distinct values scripts
class	DistinctValuesScript<TRow>	A dynamic script type for distinct values of a field
abstract class	DynamicScript	Base abstract implementation for IDynamicScript
class	DynamicScriptManager	Default implementation for IDynamicScriptManager
static class	ExcelContentResult	Excel content result helper methods
class	FileWatcher	Default file watcher implementation for physical file system
class	FormScript	Dynamic script type for forms (FormScriptAttribute)
class	FormScriptRegistration	Contains registration methods for FormScript types
static class	HtmlScriptExtensions	Contains Serenity related helper methods that can be used in Razor CSHTML files
class	HttpContextItemsAccessor	Default implementation for IHttpContextItemsAccessor using IHttpContextAccessor and its Items property.
class	HttpContextUserAccessor	Default implementation of IUserAccessor for HTTP context
static class	HttpRequestExtensions	Contains HTTP request related extensions
interface	ICacheSuffix	Abstraction to get cache suffix used while generating key for a cached dynamic script
interface	IContentHashCache	An abstraction for content hash cache, which contains hashes of web servable files.
interface	ICssBundleManager	Abstraction for css bundling manager
interface	ICssMinifier	Abstraction for Css minifier
interface	IDynamicScript	Dynamic script abstraction
interface	IDynamicScriptManager	Dynamic script manager abstraction
interface	IFileWatcher	File system watcher abstraction
interface	IFileWatcherFactory	An abstract factory to create file system watchers
interface	IGetScriptData	Provides access to the data object of a dynamic script
interface	INamedDynamicScript	A dynamic script with default registration name
interface	IScriptBundleManager	Abstraction for script bundling manager
interface	IScriptContent	Cached dynamic script content
interface	IScriptMinifier	Abstraction for script minifier
interface	IScriptName	Provides access to the registration name for a dynamic script
interface	IUploadFileResponder	Abstraction for reading a file via /upload/path, e.g. the Read action in the FilePage
static class	KnownMimeTypes	Contains set of known popular mime types
class	LocalTextScript	Local text dynamic script
abstract class	LookupScript	Dynamic script type for lookup scripts
class	LookupScriptRegistration	Contains helper methods for lookup script registration
class	NodeScriptRunner	Executes the script entries defined in a package.json file, capturing any output written to stdio.
class	NuglifyMinifier	Default implementation of IScriptMinifier and ICssMinifer interfaces with Nuglify library
class	PageAuthorizeAttribute	Authorizes access to a controller action. Optionally checks the permission provided as the first argument. Use special permission key "?" to check for logged-in users, and "*" to allow anyone including anonymous access.
abstract class	PropertyItemsScript	Abstract base class for ColumnsScript and FormScript
class	RecaptchaPropertyProcessor	Property processor to pass recaptcha site key to client side
static class	RecaptchaValidation	Recaptcha validation extensions. This was written for a very old version of Google Recaptcha and might not be working properly.
class	RegisteredScripts	A dynamic script type for registered scripts
class	RowLookupScript<TRow>	Generic lookup script type for rows
class	ScriptBundleManager	Default implementation for IScriptBundleManager
class	ScriptBundlingOptions	Options for script bundling
class	ScriptContent	Default implementation for IScriptContent
class	ScriptMinifyOptions	Set of options for script minifying
class	ScriptMinifyResult	Result returned from a script minifier
static class	ServiceCollectionConfigureExtensions	DI extension methods related to configuration and options
static class	TemplateHelper	Helper methods for CSHTML templating
class	TemplateScript	Dynamic script type for HTML templates
class	TemplateScriptRegistrar	Registrar for HTML templates (obsolete, please avoid such templates and specify templates directly in the Widget's getTemplate() method
static class	UploadServiceCollectionExtensions	DI extension methods related to upload services
static class	VirtualPathUtility	Extension methods providing partial compatibility with legacy VirtualPathUtility.
static class	WebTexts

Serenity.Web.Middleware namespace

signature	name	description
class	DynamicScriptMiddleware	Dynamic script middleware that handles "/DynJS.axd/" and "/DynamicData/" paths.

Serenity.Web.Providers namespace

signature	name	description
static class	SiteMembershipProvider	Used to be a membership provider but now only contains a SHA512 helper

SerenityIs.Administration namespace

signature	name	description
class	LocalTextDataScript	Local text data script to access local texts from an external app like mobile