Serenity.Extensions assembly

Serenity.Abstractions namespace

signature	name	description
interface	IElevationHandler	Interface for account elevation.

Serenity.ComponentModel namespace

signature	name	description
class	RowEditActionsColumnAttribute	Marks a property as the row edit actions column in a grid editor.

Serenity.Data namespace

signature	name	description
interface	IRolePermissionRow	Role permission row interface
interface	IUserPermissionRow	User permission row interface
interface	IUserRoleRow	User role row interface

Serenity.Extensions namespace

signature	name	description
abstract class	AccountPasswordActionsPageBase<TUserRow>	Base class for account password action pages, such as change password, set password, forgot password, and reset password.
abstract class	BasePermissionKeyLister	Base class for permission key listers that enumerate permission keys from a type source, including nested, assembly, and type-level permissions.
abstract class	BasePermissionService<TUserPermissionRow,TUserRoleRow>	Base permission service that provides common functionality for permission services.
abstract class	BasePermissionService	Base permission service that provides common functionality for permission services.
abstract class	BaseRolePermissionService<TRolePermissionRow>	Base permission service that provides common functionality for permission services.
class	BaseTranslationOptions	Options for the translation feature.
abstract class	BaseUserRetrieveService<TRow>	Base user retrieve service that provides common functionality for user retrieve services.
abstract class	BaseUserRetrieveService	Base user retrieve service that provides common functionality for user retrieve services.
static class	BasicProgressDialogTexts	Local text keys for the basic progress dialog.
static class	BulkServiceActionTexts	Local text keys for bulk service actions.
static class	ChangePasswordFormTexts	Local text keys for the change password form.
class	ChangePasswordRequest	The request model for a change password service.
static class	ChangePasswordValidationTexts	Local text keys for change password validation.
class	ClamAVSettings	Settings for ClamAV
class	ClamAVUploadScanner	Implementation of IUploadAVScanner which connects to ClamAV service
class	DefaultDBAttribute	Marks a migration to run on the default database.
class	DefaultElevationHandler	Default implementation of IElevationHandler
class	DeleteRowActionFormatterAttribute	An attribute that sets the formatter type to Serenity.Extensions.DeleteRowActionFormatter and its options.
static class	DialogUtilsTexts	Local text keys for dialog utilities.
class	EmailSender	Default implementation of IEmailSender that sends emails via SMTP, a pickup folder, or an email queue.
static class	EmailSenderExtensions	Extension methods for IEmailSender.
class	EnumSelectFormatterAttribute	An attribute that sets the formatter type to Serenity.Extensions.EnumSelectFormatter and its options.
class	EnvironmentSettings	Settings related to the environment the application runs in, such as the externally and internally accessible URLs of the web site.
class	ExcelImportRequest	The request model for an Excel import service.
class	ExcelImportResponse	The response model for an Excel import service.
static class	ExtensionsTexts
class	ExtensionsTypeSource	Base type source for apps using Serenity.Extensions assembly and its reference chain
static class	ForgotPasswordFormTexts	Local text keys for the forgot password form.
class	ForgotPasswordRequest	The request model for a forgot password service.
static class	GetNextNumberHelper	Helper for generating the next number in a sequence with a prefix.
class	GetNextNumberRequest	The request model for a get next number service.
class	GetNextNumberResponse	The response model for a get next number service.
interface	IEmailQueue	Abstraction for an email queue that stores messages to be sent later.
interface	IEmailSender	Abstraction for sending email messages.
interface	ITranslateTextHandler	Interface for handlers that translate texts.
abstract class	MembershipPageBase<TUserRow>	Base class for membership pages that provides common helpers for password hashing, salt generation, and user lookup.
class	MembershipSettings	Settings for membership.
abstract class	MigrationAttributeBase	Base attribute for migration attributes that validates the migration version format.
class	MigrationKeyAttribute	Marks a migration with a version key.
static class	MigrationUtils	Helper methods for FluentMigrator migrations, including table creation with identity keys and database type detection.
class	PasswordStrengthRules	The password strength rules.
class	PasswordStrengthRulesDataScript	This declares a dynamic script with key 'PasswordStrengthRules' that will be available from client side.
static class	PasswordStrengthValidationTexts	Local text keys for password strength validation.
class	PasswordStrengthValidator	Validates passwords against the configured password strength rules.
class	ReportTree	A tree of report categories and reports.
class	ResetPasswordEmailModel	The model for the reset password email.
static class	ResetPasswordFormTexts	Local text keys for the reset password form.
class	ResetPasswordOptions	A class that mirrors the ResetPasswordOptions script type.
class	ResetPasswordRequest	The request model for a reset password service.
class	ResetPasswordResponse	The response model for a reset password service.
class	SendResetPasswordResponse	The response model for a send reset password service.
static class	SetPasswordFormTexts	Local text keys for the set password form.
class	SingleLineTextFormatterAttribute	An attribute that sets the formatter type to Serenity.Extensions.SingleLineTextFormatter and its options.
class	SiteAbsoluteUrl	Default implementation for ISiteAbsoluteUrl
class	SmtpSettings	Settings for SMTP email sending.
class	StaticTextBlockAttribute	An attribute that sets the editor type to Serenity.Extensions.StaticTextBlock and its options.
class	TargetDBAttribute	Marks a migration to run only on the specified database type.
class	TranslateTextInput	A single text to be translated.
class	TranslateTextOutput	A single translated text.
class	TranslateTextRequest	The request model for translating one or more texts.
class	TranslateTextResponse	The response model for a text translation request.
class	TranslationItem	Represents a single translation entry in the translation grid.
class	TranslationListRequest	The request model for listing translations.
class	TranslationListResponse	The response model for a translation list request.
static class	TranslationTexts	Local text keys for the translation module.
class	TranslationUpdateRequest	The request model for updating user translations.
class	TranslationUpdateResponse	The response model for a translation update request.
class	UserPreferenceRetrieveRequest	The request model for retrieving a user preference.
class	UserPreferenceRetrieveResponse	The response model for retrieving a user preference.
class	UserPreferenceUpdateRequest	The request model for updating a user preference.

Serenity.Extensions.DependencyInjection namespace

signature	name	description
static class	ClamAVUploadServiceCollectionExtensions	DI extension methods related to ClamAVUploadScanner
static class	ElevationServiceCollectionExtensions	Contains extensions to register elevation services in Extensions
static class	EmailServiceCollectionExtensions	Contains extensions to register email services in Extensions
static class	PasswordStrengthServiceCollectionExtensions	Contains extensions to register password streng validator in Extensions
static class	ReportingServiceCollectionExtensions	Contains extensions to register reporting services in Extensions

Serenity.Extensions.Endpoints namespace

signature	name	description
class	UserPreferenceEndpoint	Service endpoint for managing user preferences.

Serenity.Extensions.Entities namespace

signature	name	description
abstract class	LoggingRow<TFields>	This is a sample base class for rows that does insert/update date and user audit logging automatically. It is recommended to create your own base class, if your auditing field names are different than these. You should implement IInsertLogRow and/or IUpdateLogRow interfaces. ILoggingRow is a combination of these two. There is also an optional IDeleteLogRow interface that supports auditing on delete but for it to work you need to also implement IIsActiveDeletedRow so that your rows aren't actually deleted.
class	LoggingRowFields	Fields for a LoggingRow.
class	UserPreferenceRow	Row for user preferences.

Serenity.Extensions.MVC namespace

signature	name	description
static class	ESM	Provides paths to ECMAScript module entry points.
static class	Views	Provides paths to view files.

Serenity.Extensions.Pages namespace

signature	name	description
class	ReportController	Controller for rendering and downloading reports.

Serenity.Extensions.Repositories namespace

signature	name	description
class	UserPreferenceRepository	Repository for managing user preferences.

Serenity.Reporting namespace

signature	name	description
class	DataReportExcelRenderer	Default implementation of IDataReportExcelRenderer that renders a data report to an Excel package.
class	DefaultReportRetrieveHandler	Default implementation for report retrieve handler
class	DefaultReportTreeFactory	Default implementation of IReportTreeFactory.
class	ExcelExporter	Default implementation of IExcelExporter that exports data to Excel.
static class	ExcelReportGenerator	Helper for generating Excel packages from report columns and data.
class	HtmlReportCallbackUrlBuilder	Default implementation for IHtmlReportRenderUrlBuilder
class	HtmlReportCallbackUrlInterceptor	Implementation for IReportCallbackInterceptor that uses callback report cookie to impersonate / transient grant permissions
class	HtmlReportPdfRenderer	Default implementation for IHtmlReportPdfRenderer
interface	IReportTreeFactory	Abstraction for a factory that builds report trees.
class	ReportRetrieveResult	Extending Serenity ReportRetrieveResponse class to add extra information

Serenity.Web namespace

signature	name	description
static class	ModulePageExtensions	Extension methods for creating module and grid pages from controllers.
class	ModulePageModel	The model for a module page.
class	ModulePageResult	The result of a module page action, which renders a module page view.
class	RequiresElevationAttribute	Used for critical methods that needs additional authentication. Like account link/unlinking.