Abp

This is the main class that is responsible to start entire ABP system. Prepares dependency injection and registers core components needed for startup. It must be instantiated and initialized (see ) first in an application.

Get the startup module of the application which depends on other used modules.

A list of plug in folders.

Gets IIocManager object used by this class.

Is this object disposed before?

Creates a new instance.

Startup module of the application which depends on other used modules. Should be derived from . An action to set options

Creates a new instance.

Startup module of the application which depends on other used modules. Should be derived from . An action to set options

Creates a new instance.

Startup module of the application which depends on other used modules. Should be derived from . An action to set options

Creates a new instance.

Startup module of the application which depends on other used modules. Should be derived from . IIocManager that is used to bootstrap the ABP system

Creates a new instance.

Startup module of the application which depends on other used modules. Should be derived from . IIocManager that is used to bootstrap the ABP system

Initializes the ABP system.

Disposes the ABP system.

Used to disable all interceptors added by ABP.

IIocManager that is used to bootstrap the ABP system. If set to null, uses global

List of plugin sources.

Used to define some constants for ABP.

Localization source name of ASP.NET Boilerplate framework.

Base exception type for those are thrown by Abp system for Abp specific exceptions.

Creates a new object.

Exception message

Creates a new object.

Exception message Inner exception

This exception is thrown if a problem on ABP initialization progress.

Constructor.

Constructor for serializing.

Constructor.

Exception message

Constructor.

Exception message Inner exception

Kernel (core) module of the ABP system. No need to depend on this, it's automatically the first module always.

This class can be used as a base class for services. It has some useful objects property-injected and has some basic methods most of services may need to.

Reference to the setting manager.

Reference to .

Gets current unit of work.

Reference to the localization manager.

Gets/sets name of the localization source that is used in this application service. It must be set in order to use and methods.

Gets localization source. It's valid if is set.

Reference to the logger to write logs.

Reference to the object to object mapper.

Constructor.

Gets localized string for given key name and current language.

Key name Localized string

Gets localized string for given key name and current language with formatting strings.

Key name Format arguments Localized string

Gets localized string for given key name and specified culture information.

Key name culture information Localized string

Gets localized string for given key name and current language with formatting strings.

Key name culture information Format arguments Localized string

Defines a feature of the application. A can be used in a multi-tenant application to enable or disable some application features depending on editions and tenants.

Gets/sets the arbitrary objects related to this object. Gets null if a given key does not exist. This is a shortcut for the dictionary.

Key

Arbitrary objects related to this object. These objects must be serializable.

Parent of this feature, if one exists. If set, this feature can be enabled only if the parent is enabled.

Unique name of the feature.

Display name of this feature. This can be used to show features on the UI.

A brief description for this feature. This can be used to show this feature's description on the UI.

Input type. This can be used to prepare an input for changing this feature's value. Default: .

Default value of this feature. This value is used if this feature's value is not defined for the current edition or tenant.

Feature's scope.

List of child features.

Creates a new feature.

Unique name of the feature Default value Display name of the feature A brief description for the feature Feature scope Input type

Adds a child feature.

Returns a newly created child feature

Default implementation for .

Reference to the current session.

Reference to the store used to get feature values.

Creates a new object.

Some extension methods for .

Gets the value of a feature by its name. This is the sync version of This is a shortcut for that uses . Note: This method should be used only if the TenantId can be obtained from the session.

instance Unique feature name Feature's current value

Gets the value of a feature by its name. This is the sync version of

instance Tenant's Id Unique feature name Feature's current value

Checks if a given feature is enabled. This should be used for boolean-value features. This is a shortcut for that uses . Note: This method should be used only if the TenantId can be obtained from the session.

instance Unique feature name True, if the current feature's value is "true".

Checks if a given feature is enabled. This should be used for boolean-value features.

instance Tenant's Id Unique feature name True, if the current feature's value is "true".

Used to check if one or all of the given features are enabled.

instance True, to require that all the given features are enabled. False, to require one or more. Names of the features

Used to check if one or all of the given features are enabled.

instance Tenant id True, to require that all the given features are enabled. False, to require one or more. Names of the features

Used to check if one or all of the given features are enabled.

instance True, to require that all the given features are enabled. False, to require one or more. Names of the features

Used to check if one or all of the given features are enabled.

instance Tenant id True, to require that all the given features are enabled. False, to require one or more. Names of the features

Checks if a given feature is enabled. Throws if not.

instance Unique feature name

Checks if a given feature is enabled. Throws if not.

instance Unique feature name

Checks if one or all of the given features are enabled. Throws if not.

instance True, to require that all the given features are enabled. False, to require one or more. Names of the features

Checks if one or all of the given features are enabled. Throws if not.

instance Tenant id True, to require that all the given features are enabled. False, to require one or more. Names of the features

Checks if one or all of the given features are enabled. Throws if not.

instance True, to require that all the given features are enabled. False, to require one or more. Names of the features

Checks if one or all of the given features are enabled. Throws if not.

instance Tenant id True, to require that all the given features are enabled. False, to require one or more. Names of the features

Internal implementation for .

Reference to the feature providers.

Initializes a new instance of the class.

Base for implementing .

Initializes a new instance of the class.

Creates a new feature.

Unique name of the feature Default value Display name of the feature A brief description for this feature Feature scope Input type

Gets a feature with a given name, or null if can not be found.

Unique name of the feature object or null

Remove feature with given name

Implementation of .

Initializes a new instance of the class.

Extension methods for .

Checks dependent features and returns true if dependencies are satisfied.

The feature dependency. The context.

Used to store s.

Adds all the child features of the current features, recursively.

Implements .

Creates a new object

IOC Manager Feature configuration

Initializes this

Gets a feature by its given name

Name of the feature

Gets all the features

This class should be inherited in order to provide s.

Used to set s.

Feature definition context

Scopes of a .

This can be enabled/disabled per edition.

This Feature can be enabled/disabled per tenant.

This can be enabled/disabled per tenant and edition.

This interface should be used to get the value of features

Gets the value of a feature by its name. This is a shortcut for that uses as tenantId. Note: This method should only be used if a TenantId can be obtained from the session.

Unique feature name Feature's current value

Gets the value of a feature for a tenant by the feature's name.

Tenant's Id Unique feature name Feature's current value

Unique feature name True, if the current feature's value is "true".

Checks if a given feature is enabled. This should be used for boolean-value features.

Tenant's Id Unique feature name True, if the current feature's value is "true".

Used to configure feature system.

Used to add/remove s.

Used in the method as context.

Creates a new feature.

Unique name of the feature Default value Display name of the feature A brief description for this feature Feature scope Input type

Gets a feature with a given name or null if it can not be found.

Unique name of the feature object or null

Remove feature with given name

Defines a feature dependency.

Checks dependent features and returns true if the dependencies are satisfied.

Used in the method.

Tenant id which requires the feature. Null for current tenant.

Gets the .

The ioc resolver.

Gets the .

The feature checker.

Feature manager.

Gets the by a specified name.

Unique name of the feature.

Gets the by a specified name or returns null if it can not be found.

The name.

Gets all s.

Defines a store to get a feature's value.

Gets the feature value or null.

The tenant id. The feature.

Null pattern (default) implementation of . It gets null for all feature values. can be used via property injection of .

Gets the singleton instance.

This attribute can be used on a class/method to declare that given class/method is available only if required feature(s) are enabled.

A list of features to be checked if they are enabled.

If this property is set to true, all of the must be enabled. If it's false, at least one of the must be enabled. Default: false.

Creates a new instance of class.

A list of features to be checked if they are enabled

Most simple implementation of . It checks one or more features if they are enabled.

A list of features to be checked if they are enabled.

If this property is set to true, all of the must be enabled. If it's false, at least one of the must be enabled. Default: false.

Initializes a new instance of the class.

The features.

Initializes a new instance of the class.

If this is set to true, all of the must be enabled. If it's false, at least one of the must be enabled. The features.

Defines extension methods for .

Searches and gets a by it's unique name. Throws exception if can not find.

Source object Unique name of the source

Searches all menu items (recursively) in the source and gets a by it's unique name. Returns null if can not find.

Source object Unique name of the source

Declares common interface for classes those have menu items.

List of menu items.

Manages navigation in the application.

All menus defined in the application.

Gets the main menu of the application. A shortcut of ["MainMenu"].

Provides infrastructure to set navigation.

Gets a reference to the menu manager.

Used to manage navigation for users.

Gets a menu specialized for given user.

Unique name of the menu The user, or null for anonymous users

Gets all menus specialized for given user.

User id or null for anonymous users

Represents a navigation menu for an application.

Unique name of the menu in the application. Required.

Display name of the menu. Required.

Can be used to store a custom object related to this menu. Optional.

Menu items (first level).

Creates a new object.

Unique name of the menu Display name of the menu Can be used to store a custom object related to this menu.

Adds a to .

to be added This object

Remove menu item with given name

Represents an item in a .

Unique name of the menu item in the application. Can be used to find this menu item later.

Display name of the menu item. Required.

The Display order of the menu. Optional.

Icon of the menu item if exists. Optional.

The URL to navigate when this menu item is selected. Optional.

A permission name. Only users that has this permission can see this menu item. Optional.

A permission dependency. Only users that can satisfy this permission dependency can see this menu item. Optional.

A feature dependency. Optional.

This can be set to true if only authenticated users should see this menu item.

Returns true if this menu item has no child .

Target of the menu item. Can be "_blank", "_self", "_parent", "_top" or a frame name.

Can be used to store a custom object related to this menu item. Optional.

Can be used to enable/disable a menu item.

Can be used to show/hide a menu item.

Sub items of this menu item. Optional.

This parameter is obsolete. Use instead!

Adds a to .

to be added This object

Remove notification with given name

Extension methods for .

Moves a menu item to top in the list.

List of menu items Name of the menu item to move

Moves a menu item to bottom in the list.

List of menu items Name of the menu item to move

Moves a menu item in the list after another menu item in the list.

List of menu items Name of the menu item to move Target menu item (to move before it)

Moves a menu item in the list before another menu item in the list.

List of menu items Name of the menu item to move Target menu item (to move after it)

This interface should be implemented by classes which change navigation of the application.

Used to set navigation.

Navigation context

Represents a menu shown to the user.

Unique name of the menu in the application.

Display name of the menu.

A custom object related to this menu item.

Menu items (first level).

Creates a new object.

Creates a new object from given .

Represents an item in a .

Unique name of the menu item in the application.

Icon of the menu item if exists.

Display name of the menu item.

The Display order of the menu. Optional.

The URL to navigate when this menu item is selected.

A custom object related to this menu item.

Target of the menu item. Can be "_blank", "_self", "_parent", "_top" or a frame name.

Can be used to enable/disable a menu item.

Can be used to show/hide a menu item.

Sub items of this menu item.

Creates a new object.

Creates a new object from given .

This class can be used as a base class for application services.

Gets current session information.

Reference to the permission manager.

Reference to the permission checker.

Reference to the feature manager.

Reference to the feature checker.

Gets the applied cross cutting concerns.

Constructor.

Checks if current user is granted for a permission.

Name of the permission

Checks if current user is granted for a permission.

Name of the permission

Checks if given feature is enabled for current tenant.

Name of the feature

Checks if given feature is enabled for current tenant.

Name of the feature

This is a common base class for CrudAppService and AsyncCrudAppService classes. Inherit either from CrudAppService or AsyncCrudAppService, not from this class.

Should apply sorting if needed.

The query. The input.

Should apply paging if needed.

The query. The input.

This method should create based on given input. It should filter query if needed, but should not do sorting or paging. Sorting should be done in and paging should be done in methods.

The input.

Maps to . It uses by default. It can be overrided for custom mapping.

Maps to to create a new entity. It uses by default. It can be overrided for custom mapping.

Maps to to update the entity. It uses by default. It can be overrided for custom mapping.

A shortcut of for most used primary key type ().

This class can be inherited for simple Dto objects those are used for entities implement interface.

Type of primary key

Last modification date of this entity.

Last modifier user of this entity.

This DTO can be used as a simple item for a combobox/list.

Value of the item.

Display text of the item.

Is selected?

Creates a new .

Value of the item Display text of the item

A shortcut of for most used primary key type ().

This class can be inherited for simple Dto objects those are used for entities implement interface.

Type of primary key

Creation date of this entity.

Creator user's id for this entity.

Constructor.

A shortcut of for most used primary key type ().

Creates a new object.

Id of the entity

Implements common properties for entity based DTOs.

Type of the primary key

Id of the entity.

Creates a new object.

Id of the entity

A shortcut of for most used primary key type ().

This class can be inherited for simple Dto objects those are used for entities implement interface.

Type of primary key

Is this entity deleted?

Deleter user's Id, if this entity is deleted,

Deletion time, if this entity is deleted,

A shortcut of for most used primary key type ().

Defines common properties for entity based DTOs.

Id of the entity.

This interface is defined to standardize to set "Total Count of Items" to a DTO for long type.

Total count of Items.

This interface is defined to standardize to set "Total Count of Items" to a DTO.

Total count of Items.

This interface is defined to standardize to request a limited result.

Max expected result count.

This interface is defined to standardize to return a list of items to clients.

Type of the items in the list

List of items.

This interface is defined to standardize to request a paged and sorted result.

This interface is defined to standardize to return a page of items to clients.

Type of the items in the list

This interface is defined to standardize to request a paged result.

Skip count (beginning of the page).

This interface is defined to standardize to request a sorted result.

Sorting information. Should include sorting field and optionally a direction (ASC or DESC) Can contain more than one field separated by comma (,).

Examples: "Name" "Name DESC" "Name ASC, Age DESC"

Simply implements .

Implements .

Type of the items in the list

List of items.

Creates a new object.

List of items

Can be used to send/receive Name/Value (or Key/Value) pairs.

Creates a new .

A object to get it's name and value

Can be used to send/receive Name/Value (or Key/Value) pairs.

Creates a new .

A object to get it's name and value

This DTO can be directly used (or inherited) to pass an nullable Id value to an application service method.

Type of the Id

A shortcut of for .

Simply implements .

Implements .

Type of the items in the list

Total count of Items.

Creates a new object.

Total count of Items List of items in current page

Simply implements .

This interface must be implemented by all application services to identify them by convention.

Default: true.

This attribute is used to apply audit logging for a single method or all methods of a class or interface.

This informations are collected for an method.

TenantId.

UserId.

ImpersonatorUserId.

ImpersonatorTenantId.

Service (class/interface) name.

Executed method name.

Calling parameters.

Return values.

Start time of the method execution.

Total duration of the method call.

IP address of the client.

Name (generally computer name) of the client.

Browser information if this method is called in a web request.

Optional custom data that can be filled and used.

Exception object, if an exception occurred during execution of the method.

Decides which properties of auditing class to be serialized

Extension methods for .

Should save audits to a persistent store.

Auditing store Audit informations

Default implementation of .

Used to disable auditing for a single method or all methods of a class or interface.

Provides an interface to provide audit informations in the upper layers.

Called to fill needed properties.

Audit info that is partially filled

Used to configure auditing.

Used to enable/disable auditing system. Default: true. Set false to completely disable it.

Set true to enable saving audit logs if current user is not logged in. Default: false.

List of selectors to select classes/interfaces which should be audited as default.

Ignored types for serialization on audit logging.

Used to decide whether to record return values. Default false.

List of selector functions to select classes/interfaces to be audited.

Removes a selector by name.

This interface should be implemented by vendors to make auditing working. Default implementation is .

Should save audits to a persistent store.

Audit informations

Implements to simply write audits to logs.

Singleton instance.

Used to allow a method to be accessed by any user. Suppress defined in the class containing that method.

This exception is thrown on an unauthorized request.

Severity of the exception. Default: Warn.

Creates a new object.

Exception message

Creates a new object.

Exception message Inner exception

This attribute is used on a method of an Application Service (A class that implements ) to make that method usable only by authorized users.

A list of permissions to authorize.

If this property is set to true, all of the must be granted. If it's false, at least one of the must be granted. Default: false.

Creates a new instance of class.

A list of permissions to authorize

This class is used to intercept methods to make authorization if the method defined .

This class is used to register interceptors on the Application Layer.

This is the main interface to define permissions for an application. Implement it to define permissions for your module.

This method is called once on application startup to allow to define permissions.

Permission definition context

Defines standard interface for authorization attributes.

A list of permissions to authorize.

If this property is set to true, all of the must be granted. If it's false, at least one of the must be granted. Default: false.

This class is used to permissions for users.

Checks if current user is granted for a permission.

Name of the permission

Checks if a user is granted for a permission.

User to check Name of the permission

This context is used on method.

Creates a new permission under this group.

Unique name of the permission Display name of the permission A brief description for this permission Which side can use this permission Depended feature(s) of this permission Custom Properties. Use this to add your own properties to permission. New created permission

Gets a permission with given name or null if can not find.

Unique name of the permission Permission object or null

Remove permission with given name

Defines interface to check a dependency.

Checks if permission dependency is satisfied.

Context.

Permission dependency context.

The user which requires permission. Can be null if no user.

Gets the .

The ioc resolver.

Gets the .

The feature checker.

Permission manager.

Gets object with given or throws exception if there is no permission with given .

Unique name of the permission

Gets object with given or returns null if there is no permission with given .

Unique name of the permission

Gets all permissions.

Can be passed false to disable tenancy filter.

Gets all permissions.

Multi-tenancy side to filter

Null (and default) implementation of .

Singleton instance.

Represents a permission. A permission is used to restrict functionalities of the application from unauthorized users.

Parent of this permission if one exists. If set, this permission can be granted only if parent is granted.

Unique name of the permission. This is the key name to grant permissions.

Display name of the permission. This can be used to show permission to the user.

A brief description for this permission.

Which side can use this permission.

Depended feature(s) of this permission.

Custom Properties. Use this to add your own properties to permission. You can use this with indexer like Permission["mykey"]=data; object mydata=Permission["mykey"];

Shortcut of Properties dictionary

List of child permissions. A child permission can be granted only if parent is granted.

Creates a new Permission.

Adds a child permission. A child permission can be granted only if parent is granted.

Returns newly created child permission

Extension methods for

Checks if current user is granted for a permission.

Permission checker Name of the permission

Checks if a user is granted for a permission.

Permission checker User to check Name of the permission

Checks if given user is granted for given permission.

Permission checker User True, to require all given permissions are granted. False, to require one or more. Name of the permissions

Checks if given user is granted for given permission.

Permission checker User True, to require all given permissions are granted. False, to require one or more. Name of the permissions

Checks if current user is granted for given permission.

Permission checker True, to require all given permissions are granted. False, to require one or more. Name of the permissions

Checks if current user is granted for given permission.

Permission checker True, to require all given permissions are granted. False, to require one or more. Name of the permissions

Authorizes current user for given permission or permissions, throws if not authorized. User it authorized if any of the are granted.

Permission checker Name of the permissions to authorize Throws authorization exception if

Authorizes current user for given permission or permissions, throws if not authorized. User it authorized if any of the are granted.

Permission checker If this is set to true, all of the must be granted. If it's false, at least one of the must be granted. Name of the permissions to authorize Throws authorization exception if

Authorizes current user for given permission or permissions, throws if not authorized. User it authorized if any of the are granted.

Permission checker Name of the permissions to authorize Throws authorization exception if

Authorizes current user for given permission or permissions, throws if not authorized.

Permission checker If this is set to true, all of the must be granted. If it's false, at least one of the must be granted. Name of the permissions to authorize Throws authorization exception if

Extension methods for .

Checks if permission dependency is satisfied.

The permission dependency Context.

Used to store and manipulate dictionary of permissions.

Adds all child permissions of current permissions recursively.

Adds a permission and it's all child permissions to dictionary.

Permission to be added

This class is used to get permissions out of the system. Normally, you should inject and use and use it. This class can be used in database migrations or in unit tests where Abp is not initialized.

Collects and gets all permissions in given providers. This method can be used to get permissions in database migrations or in unit tests where Abp is not initialized. Otherwise, use method.

Authorization providers List of permissions This method creates instances of by order and calls to build permission list. So, providers should not use dependency injection.

Permission manager.

Constructor.

Most simple implementation of . It checks one or more permissions if they are granted.

A list of permissions to be checked if they are granted.

If this property is set to true, all of the must be granted. If it's false, at least one of the must be granted. Default: false.

Initializes a new instance of the class.

The permissions.

Initializes a new instance of the class.

If this is set to true, all of the must be granted. If it's false, at least one of the must be granted. The permissions.

Base class that can be used to implement .

Reference to the setting manager.

Reference to .

Gets current unit of work.

Reference to the localization manager.

Gets/sets name of the localization source that is used in this application service. It must be set in order to use and methods.

Gets localization source. It's valid if is set.

Reference to the logger to write logs.

Constructor.

Gets localized string for given key name and current language.

Key name Localized string

Gets localized string for given key name and current language with formatting strings.

Key name Format arguments Localized string

Gets localized string for given key name and specified culture information.

Key name culture information Localized string

Gets localized string for given key name and current language with formatting strings.

Key name culture information Format arguments Localized string

Creates a new object.

Exception message Inner exception

Represents a background job info that is used to persist jobs.

Maximum length of . Value: 512.

Maximum length of . Value: 1 MB (1,048,576 bytes).

Default duration (as seconds) for the first wait on a failure. Default value: 60 (1 minutes).

Default timeout value (as seconds) for a job before it's abandoned (). Default value: 172,800 (2 days).

Default wait factor for execution failures. This amount is multiplated by last wait time to calculate next wait time. Default value: 2.0.

Type of the job. It's AssemblyQualifiedName of job type.

Job arguments as JSON string.

Try count of this job. A job is re-tried if it fails.

Next try time of this job.

Last try time of this job.

This is true if this job is continously failed and will not be executed again.

Priority of this job.

Initializes a new instance of the class.

Calculates next try time if a job fails. Returns null if it will not wait anymore and job should be abandoned.

Default implementation of .

Interval between polling jobs from . Default value: 5000 (5 seconds).

Initializes a new instance of the class.

Some extension methods for .

Enqueues a job to be executed.

Type of the job. Type of the arguments of job. Background job manager reference Job arguments. Job priority. Job delay (wait duration before first try).

Priority of a background job.

Low.

Below normal.

Normal (default).

Above normal.

High.

Defines interface of a background job.

Executes the job with the .

Job arguments.

Used to configure background job system.

Used to enable/disable background job execution.

Period in milliseconds.

Gets the ABP configuration object.

Defines interface of a job manager.

Enqueues a job to be executed.

Type of the job. Type of the arguments of job. Job arguments. Job priority. Job delay (wait duration before first try). Unique identifier of a background job.

Deletes a job with the specified jobId.

The Job Unique Identifier. True on a successfull state transition, false otherwise.

Defines interface to store/get background jobs.

Gets a BackgroundJobInfo based on the given jobId.

The Job Unique Identifier. The BackgroundJobInfo object.

Inserts a background job.

Job information.

Gets waiting jobs. It should get jobs based on these: Conditions: !IsAbandoned And NextTryTime <= Clock.Now. Order by: Priority DESC, TryCount ASC, NextTryTime ASC. Maximum result: .

Maximum result count.

Deletes a job.

Job information.

Updates a job.

Job information.

In memory implementation of . It's used if is not implemented by actual persistent store and job execution is enabled () for the application.

Initializes a new instance of the class.

Null pattern implementation of . It's used if is not implemented by actual persistent store and job execution is not enabled () for the application.

Extension methods for Collections.

Checks whatever given collection object is null or has no item.

Adds an item to the collection if it's not already in the collection.

Collection Item to check and add Type of the items in the collection Returns True if added, returns False if not.

Extension methods for Dictionary.

This method is used to try to get a value in a dictionary if it does exists.

Type of the value The collection object Key Value of the key (or default value if key not exists) True if key does exists in the dictionary

Gets a value from the dictionary with given key. Returns default value if can not find.

Dictionary to check and get Key to find the value Type of the key Type of the value Value if found, default if can not found.

Gets a value from the dictionary with given key. Returns default value if can not find.

Dictionary to check and get Key to find the value A factory method used to create the value if not found in the dictionary Type of the key Type of the value Value if found, default if can not found.

Gets a value from the dictionary with given key. Returns default value if can not find.

Dictionary to check and get Key to find the value A factory method used to create the value if not found in the dictionary Type of the key Type of the value Value if found, default if can not found.

Extension methods for .

Concatenates the members of a constructed collection of type System.String, using the specified separator between each member. This is a shortcut for string.Join(...)

A collection that contains the strings to concatenate. The string to use as a separator. separator is included in the returned string only if values has more than one element. A string that consists of the members of values delimited by the separator string. If values has no members, the method returns System.String.Empty.

Concatenates the members of a collection, using the specified separator between each member. This is a shortcut for string.Join(...)

A collection that contains the objects to concatenate. The string to use as a separator. separator is included in the returned string only if values has more than one element. The type of the members of values. A string that consists of the members of values delimited by the separator string. If values has no members, the method returns System.String.Empty.

Filters a by given predicate if given condition is true.

Enumerable to apply filtering A boolean value Predicate to filter the enumerable Filtered or not filtered enumerable based on

Filters a by given predicate if given condition is true.

Enumerable to apply filtering A boolean value Predicate to filter the enumerable Filtered or not filtered enumerable based on

Extension methods for .

Sort a list by a topological sorting, which consider their dependencies

The type of the members of values. A list of objects to sort Function to resolve the dependencies

The type of the members of values. Item to resolve Function to resolve the dependencies List with the sortet items Dictionary with the visited items

A shortcut for to use object as base type.

Extends to add restriction a specific base type.

Base Type of s in this list

Adds a type to list.

Type

Checks if a type exists in the list.

Type

Removes a type from list

A shortcut for to use object as base type.

Extends to add restriction a specific base type.

Base Type of s in this list

Gets the count.

The count.

Gets a value indicating whether this instance is read only.

true if this instance is read only; otherwise, false.

Gets or sets the at the specified index.

Index.

Creates a new object.

Extension methods for to get setting caches.

Gets application settings cache.

Gets tenant settings cache.

Gets user settings cache.

Implements default behavior for ISettingStore. Only method is implemented and it gets setting's value from application's configuration file if exists, or returns null if not.

Gets singleton instance.

Used to set/get custom configuration.

Dictionary of custom configuration.

Gets/sets a config value. Returns null if no config with given name.

Name of the config Value of the config

Constructor.

Gets a configuration value as a specific type.

Name of the config Type of the config Value of the configuration or null if not found

Used to set a string named configuration. If there is already a configuration with same , it's overwritten.

Unique name of the configuration Value of the configuration

Gets a configuration object with given name.

Unique name of the configuration Value of the configuration or null if not found

Gets a configuration object with given name.

Unique name of the configuration Default value of the object if can not found given configuration Value of the configuration or null if not found

Gets a configuration object with given name.

Type of the object Unique name of the configuration Default value of the object if can not found given configuration Value of the configuration or null if not found

Gets a configuration object with given name.

Type of the object Unique name of the configuration The function that will be called to create if given configuration is not found Value of the configuration or null if not found

This class is used to configure ABP and modules on startup.

Reference to the IocManager.

Used to set localization configuration.

Used to configure authorization.

Used to configure validation.

Used to configure settings.

Gets/sets default connection string used by ORM module. It can be name of a connection string in application's config file or can be full connection string.

Used to configure modules. Modules can write extension methods to to add module specific configurations.

Used to configure unit of work defaults.

Used to configure features.

Used to configure background job system.

Used to configure notification system.

Used to configure navigation.

Used to configure .

Used to configure auditing.

Used to configure multi-tenancy.

Private constructor for singleton pattern.

Extension methods for .

Used to replace a service type.

The configuration. Type. Implementation. Life style.

Used to replace a service type.

Type of the service. Type of the implementation. The configuration. Life style.

Used to replace a service type.

Type of the service. The configuration. Replace action.

Used to configure ABP and modules on startup.

Gets the IOC manager associated with this configuration.

Used to set localization configuration.

Used to configure navigation.

Used to configure .

Used to configure auditing.

Used to configure caching.

Used to configure multi-tenancy.

Used to configure authorization.

Used to configure validation.

Used to configure settings.

Gets/sets default connection string used by ORM module. It can be name of a connection string in application's config file or can be full connection string.

Used to configure modules. Modules can write extension methods to to add module specific configurations.

Used to configure unit of work defaults.

Used to configure features.

Used to configure background job system.

Used to configure notification system.

Used to configure embedded resources.

Used to configure entity history.

Used to replace a service type. Given should register an implementation for the .

The type to be replaced. Replace action.

Gets a configuration object.

Used to configure authorization system.

List of authorization providers.

Enables/Disables attribute based authentication and authorization. Default: true.

Used to configure .

True, to use . False, to create per . This is generally set to true. But, for unit tests, it can be set to false. Default: true.

Used for localization configurations.

Used to set languages available for this application.

List of localization sources.

Used to enable/disable localization system. Default: true.

If this is set to true, the given text (name) is returned if not found in the localization source. That prevent exceptions if given name is not defined in the localization sources. Also writes a warning log. Default: true.

It returns the given text by wrapping with [ and ] chars if not found in the localization source. This is considered only if is true. Default: true.

It returns the given text by converting string from 'PascalCase' to a 'Sentense case' if not found in the localization source. This is considered only if is true. Default: true.

Write (or not write) a warning log if given text can not found in the localization source. Default: true.

Defines a specialized list to store object.

Extensions for dictionay based localization sources.

Used to provide a way to configure modules. Create entension methods to this class to be used over object.

Gets the ABP configuration object.

Used to configure multi-tenancy.

Is multi-tenancy enabled? Default value: false.

Ignore feature check for host users Default value: false.

A list of contributors for tenant resolve process.

TenantId resolve key Default value: "Abp.TenantId"

Used to configure navigation.

List of navigation providers.

Used to configure setting system.

List of settings providers.

A list of method parameter validators.

Used for localization configurations.

A specialized list to store object.

Constructor.

Used to configure multi-tenancy.

Is multi-tenancy enabled? Default value: false.

Ignore feature check for host users Default value: false.

Defines interface to use a dictionary to make configurations.

Used to set a string named configuration. If there is already a configuration with same , it's overwritten.

Unique name of the configuration Value of the configuration Returns the passed

Gets a configuration object with given name.

Unique name of the configuration Value of the configuration or null if not found

Gets a configuration object with given name.

Type of the object Unique name of the configuration Value of the configuration or null if not found

Gets a configuration object with given name.

Unique name of the configuration Default value of the object if can not found given configuration Value of the configuration or null if not found

Gets a configuration object with given name.

Type of the object Unique name of the configuration Default value of the object if can not found given configuration Value of the configuration or null if not found

Gets a configuration object with given name.

Type of the object Unique name of the configuration The function that will be called to create if given configuration is not found Value of the configuration or null if not found

Defines setting definition manager.

Gets the object with given unique name. Throws exception if can not find the setting.

Unique name of the setting The object.

Gets a list of all setting definitions.

All settings.

This is the main interface that must be implemented to be able to load/change values of settings.

Gets current value of a setting. It gets the setting value, overwritten by application, current tenant and current user if exists.

Unique name of the setting Current value of the setting

Gets current value of a setting for the application level.

Unique name of the setting Current value of the setting for the application

Gets current value of a setting for the application level. If fallbackToDefault is false, it just gets value from application and returns null if application has not defined a value for the setting.

Unique name of the setting Current value of the setting for the application

Gets current value of a setting for a tenant level. It gets the setting value, overwritten by given tenant.

Unique name of the setting Tenant id Current value of the setting

Gets current value of a setting for a tenant level. It gets the setting value, overwritten by given tenant if fallbackToDefault is true. If fallbackToDefault is false, it just gets value from tenant and returns null if tenant has not defined a value for the setting.

Unique name of the setting Tenant id Current value of the setting

Gets current value of a setting for a user level. It gets the setting value, overwritten by given tenant and user.

Unique name of the setting Tenant id User id Current value of the setting for the user

Gets current value of a setting for a user level. It gets the setting value, overwritten by given tenant and user if fallbackToDefault is true. If fallbackToDefault is false, it just gets value from user and returns null if user has not defined a value for the setting.

Unique name of the setting Tenant id User id Current value of the setting for the user

Gets current value of a setting for a user level. It gets the setting value, overwritten by given tenant and user.

Unique name of the setting User Current value of the setting for the user

Gets current values of all settings. It gets all setting values, overwritten by application, current tenant (if exists) and the current user (if exists).

List of setting values

Gets current values of all settings. It gets default values of all settings then overwrites by given scopes.

One or more scope to overwrite List of setting values

Gets a list of all setting values specified for the application. It returns only settings those are explicitly set for the application. If a setting's default value is used, it's not included the result list. If you want to get current values of all settings, use method.

List of setting values

Gets a list of all setting values specified for a tenant. It returns only settings those are explicitly set for the tenant. If a setting's default value is used, it's not included the result list. If you want to get current values of all settings, use method.

Tenant to get settings List of setting values

Gets a list of all setting values specified for a user. It returns only settings those are explicitly set for the user. If a setting's value is not set for the user (for example if user uses the default value), it's not included the result list. If you want to get current values of all settings, use method.

User to get settings All settings of the user

Changes setting for the application level.

Unique name of the setting Value of the setting

Changes setting for a Tenant.

TenantId Unique name of the setting Value of the setting

Changes setting for a user.

UserId Unique name of the setting Value of the setting

This interface is used to get/set settings from/to a data source (database).

Gets a setting or null.

TenantId or null UserId or null Name of the setting Setting object

Deletes a setting.

Setting to be deleted

Adds a setting.

Setting to add

Update a setting.

Setting to add

Gets a list of setting.

TenantId or null UserId or null List of settings

Represents value of a setting.

Unique name of the setting.

Value of the setting.

Defines a setting. A setting is used to configure and change behavior of the application.

Unique name of the setting.

Display name of the setting. This can be used to show setting to the user.

A brief description for this setting.

Scopes of this setting. Default value: .

Is this setting inherited from parent scopes. Default: True.

Gets/sets group for this setting.

Default value of the setting.

Can clients see this setting and it's value. It maybe dangerous for some settings to be visible to clients (such as email server password). Default: false.

Client visibility definition for the setting.

Can be used to store a custom object related to this setting.

Creates a new object.

Unique name of the setting Default value of the setting Display name of the permission Group of this setting A brief description for this setting Scopes of this setting. Default value: . Can clients see this setting and it's value. Default: false Is this setting inherited from parent scopes. Default: True. Can be used to store a custom object related to this setting Client visibility definition for the setting. Default: invisible

A setting group is used to group some settings togehter. A group can be child of another group and can have child groups.

Unique name of the setting group.

Display name of the setting. This can be used to show setting to the user.

Gets parent of this group.

Gets a list of all children of this group.

Creates a new object.

Unique name of the setting group Display name of the setting

Adds a as child of this group.

Child to be added This child group to be able to add more child

Implements .

Constructor.

The context that is used in setting providers.

Represents a setting information.

TenantId for this setting. TenantId is null if this setting is not Tenant level.

UserId for this setting. UserId is null if this setting is not user level.

Unique name of the setting.

Value of the setting.

Creates a new object.

TenantId for this setting. TenantId is null if this setting is not Tenant level. UserId for this setting. UserId is null if this setting is not user level. Unique name of the setting Value of the setting

This class implements to manage setting values in the database.

Reference to the current Session.

Reference to the setting store.

Extension methods for .

Gets value of a setting in given type ().

Type of the setting to get Setting manager Unique name of the setting Value of the setting

Gets current value of a setting for the application level.

Setting manager Unique name of the setting Current value of the setting for the application

Gets current value of a setting for a tenant level. It gets the setting value, overwritten by given tenant.

Setting manager Unique name of the setting Tenant id Current value of the setting

Gets current value of a setting for a user level. It gets the setting value, overwritten by given tenant and user.

Setting manager Unique name of the setting Tenant id User id Current value of the setting for the user

Gets current value of a setting for a user level. It gets the setting value, overwritten by given tenant and user.

Setting manager Unique name of the setting User Current value of the setting for the user

Gets current value of a setting. It gets the setting value, overwritten by application and the current user if exists.

Setting manager Unique name of the setting Current value of the setting

Gets current value of a setting for the application level.

Setting manager Unique name of the setting Current value of the setting for the application

Gets current value of a setting for a tenant level. It gets the setting value, overwritten by given tenant.

Setting manager Unique name of the setting Tenant id Current value of the setting

Gets current value of a setting for a user level. It gets the setting value, overwritten by given tenant and user.

Setting manager Unique name of the setting Tenant id User id Current value of the setting for the user

Gets current value of a setting for a user level. It gets the setting value, overwritten by given tenant and user.

Setting manager Unique name of the setting Tenant id User id Current value of the setting for the user

Gets value of a setting.

Type of the setting to get Setting manager Unique name of the setting Value of the setting

Gets current value of a setting for the application level.

Type of the setting to get Setting manager Unique name of the setting Current value of the setting for the application

Gets current value of a setting for a tenant level. It gets the setting value, overwritten by given tenant.

Type of the setting to get Setting manager Unique name of the setting Tenant id Current value of the setting

Gets current value of a setting for a user level. It gets the setting value, overwritten by given tenant and user.

Type of the setting to get Setting manager Unique name of the setting Tenant id User id Current value of the setting for the user

Gets current value of a setting for a user level. It gets the setting value, overwritten by given tenant and user.

Type of the setting to get Setting manager Unique name of the setting User Current value of the setting for the user

Gets current values of all settings. It gets all setting values, overwritten by application and the current user if exists.

Setting manager List of setting values

Setting manager Tenant to get settings List of setting values

Setting manager User to get settings All settings of the user

Changes setting for the application level.

Setting manager Unique name of the setting Value of the setting

Changes setting for a Tenant.

Setting manager TenantId Unique name of the setting Value of the setting

Changes setting for a user.

Setting manager User Unique name of the setting Value of the setting

Inherit this class to define settings for a module/application.

Gets all setting definitions provided by this provider.

List of settings

Defines scope of a setting.

Represents a setting that can be configured/changed for the application level.

Represents a setting that can be configured/changed for each Tenant. This is reserved

Represents a setting that can be configured/changed for each User.

Represents a setting that can be configured/changed for all levels

Gets the active transaction or null if current UOW is not transactional.

Gets the active database connection.

This class is used to register basic dependency implementations such as and .

This class is used to pass configuration/options while registering classes in conventional way.

Install all implementations automatically or not. Default: true.

Creates a new object.

This class is used to pass needed objects on conventional registration process.

Gets the registering Assembly.

Reference to the IOC Container to register types.

Registration configuration.

Lifestyles of types used in dependency injection system.

Singleton object. Created a single object on first resolving and same instance is used for subsequent resolves.

Transient object. Created one object for every resolving.

This interface is used to register dependencies by conventions.

Implement this interface and register to method to be able to register classes by your own conventions.

Registers types of given assembly by convention.

Registration context

Used to pass needed objects on conventional registration process.

Gets the registering Assembly.

Reference to the IOC Container to register types.

Registration configuration.

This interface is used to wrap an object that is resolved from IOC container. It inherits , so resolved object can be easily released. In method, is called to dispose the object. This is non-generic version of interface.

This interface is used to wrap an object that is resolved from IOC container. It inherits , so resolved object can be easily released. In method, is called to dispose the object.

Type of the object

The resolved object.

This interface is used to directly perform dependency injection tasks.

Reference to the Castle Windsor Container.

Checks whether given type is registered before.

Type to check

Checks whether given type is registered before.

Type to check

Define interface for classes those are used to register dependencies.

Adds a dependency registrar for conventional registration.

dependency registrar

Registers types of given assembly by all conventional registrars. See method.

Assembly to register

Registers types of given assembly by all conventional registrars. See method.

Assembly to register Additional configuration

Registers a type as self registration.

Type of the class Lifestyle of the objects of this type

Registers a type as self registration.

Type of the class Lifestyle of the objects of this type

Registers a type with it's implementation.

Registering type The type that implements Lifestyle of the objects of this type

Registers a type with it's implementation.

Type of the class The type that implements Lifestyle of the objects of this type

Checks whether given type is registered before.

Type to check

Checks whether given type is registered before.

Type to check

Define interface for classes those are used to resolve dependencies.

Gets an object from IOC container. Returning object must be Released (see ) after usage.

Type of the object to get The object instance

Gets an object from IOC container. Returning object must be Released (see ) after usage.

Type of the object to cast Type of the object to resolve The object instance

Gets an object from IOC container. Returning object must be Released (see ) after usage.

Type of the object to get Constructor arguments The object instance

Gets an object from IOC container. Returning object must be Released (see ) after usage.

Type of the object to get The object instance

Gets an object from IOC container. Returning object must be Released (see ) after usage.

Type of the object to get Constructor arguments The object instance

Gets all implementations for given type. Returning objects must be Released (see ) after usage.

Type of the objects to resolve Object instances

Gets all implementations for given type. Returning objects must be Released (see ) after usage.

Type of the objects to resolve Constructor arguments Object instances

Gets all implementations for given type. Returning objects must be Released (see ) after usage.

Type of the objects to resolve Object instances

Gets all implementations for given type. Returning objects must be Released (see ) after usage.

Type of the objects to resolve Constructor arguments Object instances

Releases a pre-resolved object. See Resolve methods.

Object to be released

Checks whether given type is registered before.

Type to check

Checks whether given type is registered before.

Type to check

This class is used to directly perform dependency injection tasks.

The Singleton instance.

Singletone instance for Castle ProxyGenerator. From Castle.Core documentation it is highly recomended to use single instance of ProxyGenerator to avoid memoryleaks and performance issues Follow next links for more details: Castle.Core documentation, Article

Reference to the Castle Windsor Container.

List of all registered conventional registrars.

Creates a new object. Normally, you don't directly instantiate an . This may be useful for test purposes.

Adds a dependency registrar for conventional registration.

dependency registrar

Registers types of given assembly by all conventional registrars. See method.

Assembly to register

Registers types of given assembly by all conventional registrars. See method.

Assembly to register Additional configuration

Registers a type as self registration.

Type of the class Lifestyle of the objects of this type

Registers a type as self registration.

Type of the class Lifestyle of the objects of this type

Registers a type with it's implementation.

Registering type The type that implements Lifestyle of the objects of this type

Registers a type with it's implementation.

Type of the class The type that implements Lifestyle of the objects of this type

Checks whether given type is registered before.

Type to check

Checks whether given type is registered before.

Type to check

Gets an object from IOC container. Returning object must be Released (see ) after usage.

Type of the object to get The instance object

Gets an object from IOC container. Returning object must be Released (see ) after usage.

Type of the object to cast Type of the object to resolve The object instance

Gets an object from IOC container. Returning object must be Released (see ) after usage.

Type of the object to get Constructor arguments The instance object

Gets an object from IOC container. Returning object must be Released (see ) after usage.

Type of the object to get The instance object

Gets an object from IOC container. Returning object must be Released (see ) after usage.

Type of the object to get Constructor arguments The instance object

Releases a pre-resolved object. See Resolve methods.

Object to be released

Extension methods for interface.

Registers a type as self registration if it's not registered before.

Type of the class Registrar Lifestyle of the objects of this type True, if registered for given implementation.

Registers a type as self registration if it's not registered before.

Registrar Type of the class Lifestyle of the objects of this type True, if registered for given implementation.

Registers a type with it's implementation if it's not registered before.

Registering type The type that implements Registrar Lifestyle of the objects of this type True, if registered for given implementation.

Registers a type with it's implementation if it's not registered before.

Registrar Type of the class The type that implements Lifestyle of the objects of this type True, if registered for given implementation.

Extension methods to interface.

Gets an object that wraps resolved object to be Disposable.

Type of the object to get IIocResolver object The instance object wrapped by

Gets an object that wraps resolved object to be Disposable.

Type of the object to get IIocResolver object Type of the object to resolve. This type must be convertible . The instance object wrapped by

Gets an object that wraps resolved object to be Disposable.

IIocResolver object Type of the object to resolve. This type must be convertible to . The instance object wrapped by

Gets an object that wraps resolved object to be Disposable.

Type of the object to get IIocResolver object Constructor arguments The instance object wrapped by

Gets an object that wraps resolved object to be Disposable.

Type of the object to get IIocResolver object Type of the object to resolve. This type must be convertible . Constructor arguments The instance object wrapped by

Gets an object that wraps resolved object to be Disposable.

IIocResolver object Type of the object to resolve. This type must be convertible to . Constructor arguments The instance object wrapped by

Gets a object that starts a scope to resolved objects to be Disposable.

The instance object wrapped by

This method can be used to resolve and release an object automatically. You can use the object in .

Type of the object to use IIocResolver object An action that can use the resolved object

This method can be used to resolve and release an object automatically. You can use the object in and return a value.

Type of the service to use Return type IIocResolver object A function that can use the resolved object

This method starts a scope to resolve and release all objects automatically. You can use the scope in .

IIocResolver object An action that can use the resolved object

This interface is used to wrap a scope for batch resolvings in a single using statement. It inherits and , so resolved objects can be easily and batch manner released by IocResolver. In method, is called to dispose the object.

All classes implement this interface are automatically registered to dependency injection as singleton object.

All classes implement this interface are automatically registered to dependency injection as transient object.

Used to get a singleton of any class which can be resolved using . Important: Use classes by injecting wherever possible. This class is for cases that's not possible.

Gets the instance.

The instance.

This class can be used to provide an action when Dipose method is called.

Creates a new object.

Action to be executed when this object is disposed.

A shortcut of for most used primary key type ().

This class can be used to simplify implementing for aggregate roots.

Type of the primary key of the entity

Last modification date of this entity.

Last modifier user of this entity.

This class can be used to simplify implementing for aggregate roots.

Type of the primary key of the entity Type of the user

Reference to the creator user of this entity.

Reference to the last modifier user of this entity.

A shortcut of for most used primary key type ().

This class can be used to simplify implementing .

Type of the primary key of the entity

Last modification date of this entity.

Last modifier user of this entity.

This class can be used to simplify implementing .

Type of the primary key of the entity Type of the user

Reference to the creator user of this entity.

Reference to the last modifier user of this entity.

A shortcut of for most used primary key type ().

This class can be used to simplify implementing for aggregate roots.

Type of the primary key of the entity

Creation time of this entity.

Creator of this entity.

Constructor.

This class can be used to simplify implementing for aggregate roots.

Type of the primary key of the entity Type of the user

Reference to the creator user of this entity.

A shortcut of for most used primary key type ().

This class can be used to simplify implementing .

Type of the primary key of the entity

Creation time of this entity.

Creator of this entity.

Constructor.

This class can be used to simplify implementing .

Type of the primary key of the entity Type of the user

Reference to the creator user of this entity.

A shortcut of for most used primary key type ().

Implements to be a base class for full-audited aggregate roots.

Type of the primary key of the entity

Is this entity Deleted?

Which user deleted this entity?

Deletion time of this entity.

Implements to be a base class for full-audited aggregate roots.

Type of the primary key of the entity Type of the user

Is this entity Deleted?

Reference to the deleter user of this entity.

Which user deleted this entity?

Deletion time of this entity.

A shortcut of for most used primary key type ().

Implements to be a base class for full-audited entities.

Type of the primary key of the entity

Is this entity Deleted?

Which user deleted this entity?

Deletion time of this entity.

Implements to be a base class for full-audited entities.

Type of the primary key of the entity Type of the user

Is this entity Deleted?

Reference to the deleter user of this entity.

Which user deleted this entity?

Deletion time of this entity.

This interface is implemented by entities which must be audited. Related properties automatically set when saving/updating objects.

Adds navigation properties to interface for user.

Type of the user

This interface is implemented by entities that is wanted to store creation information (who and when created). Creation time and creator user are automatically set when saving to database.

Id of the creator user of this entity.

Adds navigation properties to interface for user.

Type of the user

Reference to the creator user of this entity.

This interface is implemented by entities which wanted to store deletion information (who and when deleted).

Which user deleted this entity?

Adds navigation properties to interface for user.

Type of the user

Reference to the deleter user of this entity.

This interface ads to for a fully audited entity.

Adds navigation properties to interface for user.

Type of the user

An entity can implement this interface if of this entity must be stored. is automatically set when saving to database.

Creation time of this entity.

An entity can implement this interface if of this entity must be stored. is automatically set when deleting .

Deletion time of this entity.

An entity can implement this interface if of this entity must be stored. is automatically set when updating .

The last modified time for this entity.

This interface is implemented by entities that is wanted to store modification information (who and when modified lastly). Properties are automatically set when updating the .

Last modifier user for this entity.

Adds navigation properties to interface for user.

Type of the user

Reference to the last modifier user of this entity.

A shortcut of for most used primary key type ().

Basic implementation of IEntity interface. An entity can inherit this class of directly implement to IEntity interface.

Type of the primary key of the entity

Unique identifier for this entity.

Checks if this entity is transient (it has not an Id).

True, if this entity is transient

Some useful extension methods for Entities.

Check if this Entity is null of marked as deleted.

Undeletes this entity by setting to false and properties to null.

Some helper methods for entities.

Gets primary key type of given entity type

Used to identify an entity. Can be used to store an entity and .

Entity Type.

Entity's Id.

Added for serialization purposes.

Initializes a new instance of the class.

Entity type. Id of the entity.

This exception is thrown if an entity excepted to be found but not found.

Type of the entity.

Id of the Entity.

Creates a new object.

Exception message

Creates a new object.

Exception message Inner exception

Type of the entity.

DbContext type that has DbSet property.

A shortcut of for most used primary key type ().

Defines interface for base entity type. All entities in the system must implement this interface.

Type of the primary key of the entity

Unique identifier for this entity.

Checks if this entity is transient (not persisted to database and it has not an ).

True, if this entity is transient

Defines a JSON formatted string property to extend an object/entity.

A JSON formatted string to extend the containing object. JSON data can contain properties with arbitrary values (like primitives or complex objects). Extension methods are available () to manipulate this data. General format:


            {
              "Property1" : ...
              "Property2" : ...
            }

Implement this interface for an entity which may optionally have TenantId.

TenantId of this entity.

Implement this interface for an entity which must have TenantId.

TenantId of this entity.

This interface is used to make an entity active/passive.

True: This entity is active. False: This entity is not active.

Used to standardize soft deleting entities. Soft-delete entities are not actually deleted, marked as IsDeleted = true in the database, but can not be retrieved to the application.

Used to mark an Entity as 'Deleted'.

This interface can be implemented by all Policy classes/interfaces to identify them by convention.

Base class to implement . It implements some methods in most simple way.

Type of the Entity for this repository Primary key of the entity

The multi tenancy side

Used to define auto-repository types for entities. This can be used for DbContext types.

This interface must be implemented by all repositories to identify them by convention. Implement generic version instead of this one.

A shortcut of for most used primary key type ().

Entity type

This interface is implemented by all repositories to ensure implementation of fixed methods.

Main Entity type this repository works on Primary key type of the entity

Used to get a IQueryable that is used to retrieve entities from entire table.

IQueryable to be used to select entities from database

Used to get a IQueryable that is used to retrieve entities from entire table. One or more

A list of include expressions. IQueryable to be used to select entities from database

Used to get all entities.

List of all entities

Used to get all entities.

List of all entities

Used to get all entities based on given .

A condition to filter entities List of all entities

Used to get all entities based on given .

A condition to filter entities List of all entities

Used to run a query over entire entities. attribute is not always necessary (as opposite to ) if finishes IQueryable with ToList, FirstOrDefault etc..

Type of return value of this method This method is used to query over entities Query result

Gets an entity with given primary key.

Primary key of the entity to get Entity

Gets an entity with given primary key.

Primary key of the entity to get Entity

Gets exactly one entity with given predicate. Throws exception if no entity or more than one entity.

Entity

Gets exactly one entity with given predicate. Throws exception if no entity or more than one entity.

Entity

Gets an entity with given primary key or null if not found.

Primary key of the entity to get Entity or null

Gets an entity with given primary key or null if not found.

Primary key of the entity to get Entity or null

Gets an entity with given given predicate or null if not found.

Predicate to filter entities

Gets an entity with given given predicate or null if not found.

Predicate to filter entities

Creates an entity with given primary key without database access.

Primary key of the entity to load Entity

Inserts a new entity.

Inserted entity

Inserts a new entity.

Inserted entity

Inserts a new entity and gets it's Id. It may require to save current unit of work to be able to retrieve id.

Entity Id of the entity

Inserts a new entity and gets it's Id. It may require to save current unit of work to be able to retrieve id.

Entity Id of the entity

Inserts or updates given entity depending on Id's value.

Entity

Inserts or updates given entity depending on Id's value.

Entity

Inserts or updates given entity depending on Id's value. Also returns Id of the entity. It may require to save current unit of work to be able to retrieve id.

Entity Id of the entity

Inserts or updates given entity depending on Id's value. Also returns Id of the entity. It may require to save current unit of work to be able to retrieve id.

Entity Id of the entity

Updates an existing entity.

Entity

Updates an existing entity.

Entity

Updates an existing entity.

Id of the entity Action that can be used to change values of the entity Updated entity

Updates an existing entity.

Id of the entity Action that can be used to change values of the entity Updated entity

Deletes an entity.

Entity to be deleted

Deletes an entity.

Entity to be deleted

Deletes an entity by primary key.

Primary key of the entity

Deletes an entity by primary key.

Primary key of the entity

Deletes many entities by function. Notice that: All entities fits to given predicate are retrieved and deleted. This may cause major performance problems if there are too many entities with given predicate.

A condition to filter entities

Gets count of all entities in this repository.

Count of entities

Gets count of all entities in this repository.

Count of entities

Gets count of all entities in this repository based on given .

A method to filter count Count of entities

Gets count of all entities in this repository based on given .

A method to filter count Count of entities

Gets count of all entities in this repository (use if expected return value is greather than .

Count of entities

Gets count of all entities in this repository (use if expected return value is greather than .

Count of entities

Gets count of all entities in this repository based on given (use this overload if expected return value is greather than ).

A method to filter count Count of entities

Gets count of all entities in this repository based on given (use this overload if expected return value is greather than ).

A method to filter count Count of entities

This class can be used as a base class for domain services.

This interface must be implemented by all domain services to identify them by convention.

Standard filters of ABP.

"SoftDelete". Soft delete filter. Prevents getting deleted data from database. See interface.

"MustHaveTenant". Tenant filter to prevent getting data that is not belong to current tenant.

"MayHaveTenant". Tenant filter to prevent getting data that is not belong to current tenant.

Standard parameters of ABP.

"tenantId".

"isDeleted".

Creates a new object.

Exception message

Creates a new object.

Exception message Inner exception

CallContext implementation of . This is the default implementation.

Default implementation of . Get connection string from , or "Default" connection string in config file, or single connection string in config file.

Initializes a new instance of the class.

This interface is used to work with active unit of work. This interface can not be injected. Use instead.

This event is raised when this UOW is successfully completed.

This event is raised when this UOW is failed.

This event is raised when this UOW is disposed.

Gets if this unit of work is transactional.

Gets data filter configurations for this unit of work.

A dictionary to use for custom operations on unitOfWork

Is this UOW disposed?

Saves all changes until now in this unit of work. This method may be called to apply changes whenever needed. Note that if this unit of work is transactional, saved changes are also rolled back if transaction is rolled back. No explicit call is needed to SaveChanges generally, since all changes saved at end of a unit of work automatically.

Disables one or more data filters. Does nothing for a filter if it's already disabled. Use this method in a using statement to re-enable filters if needed.

One or more filter names. for standard filters. A handle to take back the disable effect.

Enables one or more data filters. Does nothing for a filter if it's already enabled. Use this method in a using statement to re-disable filters if needed.

One or more filter names. for standard filters. A handle to take back the enable effect.

Checks if a filter is enabled or not.

Name of the filter. for standard filters.

Sets (overrides) value of a filter parameter.

Name of the filter Parameter's name Value of the parameter to be set

Sets/Changes Tenant's Id for this UOW.

The tenant id. A disposable object to restore old TenantId value when you dispose it

Sets/Changes Tenant's Id for this UOW.

The tenant id True to enable/disable based on given tenantId. Enables filter if tenantId is not null. Disables filter if tenantId is null. This value is true for method. A disposable object to restore old TenantId value when you dispose it

Gets Tenant Id for this UOW.

Used to get connection string when a database connection is needed.

Gets a connection string name (in config file) or a valid connection string.

Arguments that can be used while resolving connection string.

Used to get/set current .

Gets/sets current . Setting to null returns back to outer unit of work where possible.

This handle is used for innet unit of work scopes. A inner unit of work scope actually uses outer unit of work scope and has no effect on call. But if it's not called, an exception is thrown at end of the UOW to rollback the UOW.

Defines a unit of work. This interface is internally used by ABP. Use to start a new unit of work.

Unique id of this UOW.

Reference to the outer UOW if exists.

Begins the unit of work with given options.

Unit of work options

Used to complete a unit of work. This interface can not be injected or directly used. Use instead.

Completes this unit of work. It saves all changes and commit transaction if exists.

Used to get/set default options for a unit of work.

Scope option.

Should unit of works be transactional. Default: true.

A boolean value indicates that System.Transactions.TransactionScope is available for current application. Default: true.

Gets/sets a timeout value for unit of works.

Gets/sets isolation level of transaction. This is used if is true.

Gets list of all data filter configurations.

A list of selectors to determine conventional Unit Of Work classes.

Registers a data filter to unit of work system.

Name of the filter. Is filter enabled by default.

Overrides a data filter definition.

Name of the filter. Is filter enabled by default.

Unit of work manager. Used to begin and control a unit of work.

Gets currently active unit of work (or null if not exists).

Begins a new unit of work.

A handle to be able to complete the unit of work

Begins a new unit of work.

A handle to be able to complete the unit of work

Begins a new unit of work.

A handle to be able to complete the unit of work

Null implementation of unit of work. It's used if no component registered for . This ensures working ABP without a database.

This attribute is used to indicate that declaring method is atomic and should be considered as a unit of work. A method that has this attribute is intercepted, a database connection is opened and a transaction is started before call the method. At the end of method call, transaction is committed and all changes applied to the database if there is no exception, otherwise it's rolled back.

This attribute has no effect if there is already a unit of work before calling this method, if so, it uses the same transaction.

Scope option.

Is this UOW transactional? Uses default value if not supplied.

Timeout of UOW As milliseconds. Uses default value if not supplied.

If this UOW is transactional, this option indicated the isolation level of the transaction. Uses default value if not supplied.

Used to prevent starting a unit of work for the method. If there is already a started unit of work, this property is ignored. Default: false.

Creates a new UnitOfWorkAttribute object.

Creates a new object.

Is this unit of work will be transactional?

Creates a new object.

As milliseconds

Creates a new object.

Is this unit of work will be transactional? As milliseconds

Creates a new object. is automatically set to true.

Transaction isolation level

Creates a new object. is automatically set to true.

Transaction isolation level Transaction timeout as milliseconds

Creates a new object. is automatically set to true.

Transaction scope

Creates a new object.

Transaction scope Is this unit of work will be transactional?

Creates a new object. is automatically set to true.

Transaction scope Transaction timeout as milliseconds

Creates a new object. is automatically set to true.

Transaction scope Transaction isolation level

Creates a new object. is automatically set to true.

Transaction scope Transaction isolation level Transaction timeout as milliseconds

Creates a new object.

Transaction scope Transaction timeout as milliseconds

Base for all Unit Of Work classes.

Gets default UOW options.

Gets the connection string resolver.

Gets a value indicates that this unit of work is disposed or not.

Reference to current ABP session.

Is method called before?

Is this unit of work successfully completed.

A reference to the exception if this unit of work failed.

Constructor.

Can be implemented by derived classes to start UOW.

Should be implemented by derived classes to complete UOW.

Should be implemented by derived classes to dispose UOW.

Called to trigger event.

Exception that cause failure

Called to trigger event.

Used as event arguments on event.

Exception that caused failure.

Creates a new object.

Exception that caused failure

A helper class to simplify unit of work process.

Returns true if given method has UnitOfWorkAttribute attribute.

Method info to check

This interceptor is used to manage database connection and transactions.

Intercepts a method.

Method invocation arguments

Unit of work manager.

Unit of work options.

Scope option.

Is this UOW transactional? Uses default value if not supplied.

Timeout of UOW As milliseconds. Uses default value if not supplied.

If this UOW is transactional, this option indicated the isolation level of the transaction. Uses default value if not supplied.

This option should be set to if unit of work is used in an async scope.

Can be used to enable/disable some filters.

Creates a new object.

This class is used to register interceptor for needed classes for Unit Of Work mechanism.

Initializes the registerer.

IOC manager

Base class for value objects.

Base class for value objects. Recommended to use non-generic ValueObject class instead.

The type of the value object.

Maximum length of property. Value: 48.

Maximum length of property. Value: 192.

ChangeTime.

ChangeType.

Gets/sets change set id, used to group entity changes.

Gets/sets primary key of the entity.

FullName of the entity type.

TenantId.

PropertyChanges.

Maximum length of property.

Browser information if this entity is changed in a web request.

IP address of the client.

Name (generally computer name) of the client.

Creation time of this entity.

A JSON formatted string to extend the containing object.

ImpersonatorTenantId.

ImpersonatorUserId.

Reason for this change set.

TenantId.

UserId.

Entity changes grouped in this change set.

Maximum length of property. Value: 96.

Maximum length of and properties. Value: 512.

Maximum length of property. Value: 512.

EntityChangeId.

NewValue.

OriginalValue.

PropertyName.

Type of the JSON serialized and . It's the FullName of the type.

TenantId.

Defines some session information that can be useful for applications.

Gets current Reason or null.

Used to change for a limited scope.

Used to configure entity history.

Used to enable/disable entity history system. Default: true. Set false to completely disable it.

Set true to enable saving entity history if current user is not logged in. Default: false.

List of selectors to select classes/interfaces which should be tracked as default.

Ignored types for serialization on entity history tracking.

Removes a selector by name.

This interface should be implemented by vendors to make entity history working.

Should save entity change set to a persistent store.

Entity change set

Implements null object pattern for .

Singleton instance.

This attribute is used to set the description for a single method or all methods of a class or interface.

Used to pass data for an event when an entity () is changed (created, updated or deleted). See , and classes.

Entity type

Constructor.

Changed entity in this event

Used to trigger entity change events.

Used to pass data for an event when an entity () is being changed (creating, updating or deleting). See , and classes.

Entity type

Constructor.

Changing entity in this event

This type of event can be used to notify just after creation of an Entity.

Entity type

Constructor.

The entity which is created

This type of event is used to notify just before creation of an Entity.

Entity type

Constructor.

The entity which is being created

This type of event can be used to notify just after deletion of an Entity.

Entity type

Constructor.

The entity which is deleted

This type of event is used to notify just before deletion of an Entity.

Entity type

Constructor.

The entity which is being deleted

Used to pass data for an event that is related to with an object.

Entity type

Related entity with this event.

Constructor.

Related entity with this event

This type of event can be used to notify just after update of an Entity.

Entity type

Constructor.

The entity which is updated

This type of event is used to notify just before update of an Entity.

Entity type

Constructor.

The entity which is being updated

Used to trigger entity change events.

Null-object implementation of .

Gets single instance of class.

Implements EventBus as Singleton pattern.

Gets the default instance.

Reference to the Logger.

All registered handler factories. Key: Type of the event Value: List of handler factories

Creates a new instance. Instead of creating a new instace, you can use to use Global .

Installs event bus system and registers all handlers automatically.

Implements and provides a base for event data classes.

The time when the event occurred.

The object which triggers the event (optional).

Constructor.

This type of events are used to notify for exceptions handled by ABP infrastructure.

Constructor.

Exception object

This type of events can be used to notify for an exception.

Exception object.

Constructor.

Exception object

Defines an interface for factories those are responsible to create/get and release of event handlers.

Gets an event handler.

The event handler

Gets type of the handler (without creating an instance).

Releases an event handler.

Handle to be released

Used to unregister a on method.

This implementation is used to handle events by a single instance object.

This class always gets the same single instance of handler.

The event handler instance.

This implementation is used to handle events by a transient instance object.

This class always creates a new transient instance of handler.

Creates a new instance of the handler object.

The handler object

Disposes the handler object if it's . Does nothing if it's not.

Handler to be released

This implementation is used to get/release handlers using Ioc.

Type of the handler.

Creates a new instance of class.

Type of the handler

Resolves handler object from Ioc container.

Resolved handler object

Releases handler object using Ioc container.

Handler to be released

Defines an interface of a class that handles events asynchrounously of type .

Event type to handle

Handler handles the event by implementing this method.

Event data

Undirect base interface for all event handlers. Implement instead of this one.

Defines an interface of a class that handles events of type .

Event type to handle

Handler handles the event by implementing this method.

Event data

This event handler is an adapter to be able to use an action as implementation.

Event type

Action to handle the event.

Creates a new instance of .

Action to handle the event

Handles the event.

This event handler is an adapter to be able to use an action as implementation.

Event type

Function to handle the event.

Creates a new instance of .

Action to handle the event

Handles the event.

Defines interface of the event bus.

Registers to an event. Given action is called for all event occurrences.

Action to handle events Event type

Registers to an event. Given action is called for all event occurrences.

Action to handle events Event type

Registers to an event. Same (given) instance of the handler is used for all event occurrences.

Event type Object to handle the event

Registers to an event. Same (given) instance of the async handler is used for all event occurrences.

Event type Object to handle the event

Registers to an event. A new instance of object is created for every event occurrence.

Event type Type of the event handler

Registers to an event. Same (given) instance of the handler is used for all event occurrences.

Event type Object to handle the event

Registers to an event. Given factory is used to create/release handlers

Event type A factory to create/release handlers

Registers to an event.

Event type A factory to create/release handlers

Unregisters from an event.

Event type

Unregisters from an event.

Event type

Unregisters from an event.

Event type Handler object that is registered before

Unregisters from an event.

Event type Handler object that is registered before

Unregisters from an event.

Event type Handler object that is registered before

Unregisters from an event.

Event type Factory object that is registered before

Unregisters from an event.

Event type Factory object that is registered before

Unregisters all event handlers of given event type.

Event type

Unregisters all event handlers of given event type.

Event type

Triggers an event.

Event type Related data for the event

Triggers an event.

Event type The object which triggers the event Related data for the event

Triggers an event.

Event type Related data for the event

Triggers an event.

Event type The object which triggers the event Related data for the event

Triggers an event asynchronously.

Event type Related data for the event The task to handle async operation

Triggers an event asynchronously.

Event type The object which triggers the event Related data for the event The task to handle async operation

Triggers an event asynchronously.

Event type Related data for the event The task to handle async operation

Triggers an event asynchronously.

Event type The object which triggers the event Related data for the event The task to handle async operation

Defines interface for all Event data classes.

The time when the event occured.

The object which triggers the event (optional).

This interface must be implemented by event data classes that has a single generic argument and this argument will be used by inheritance. For example; Assume that Student inherits From Person. When trigger an EntityCreatedEventData{Student}, EntityCreatedEventData{Person} is also triggered if EntityCreatedEventData implements this interface.

Gets arguments to create this class since a new instance of this class is created.

Constructor arguments

An event bus that implements Null object pattern.

Gets single instance of class.

Extension methods for .

Checks a value is between a minimum and maximum value.

The value to be checked Minimum (inclusive) value Maximum (inclusive) value

Extension methods for .

Converts a DateTime to a Unix Timestamp

This DateTime

Converts a Unix Timestamp in to a DateTime

This Unix Timestamp

Gets the value of the End of the day (23:59)

Gets the First Date of the week for the specified date

this DateTime The Start Day of the Week (ie, Sunday/Monday) The First Date of the week

Returns all the days of a month.

The year. The month.

Determines the Nth instance of a Date's DayOfWeek in a month

11/29/2011 would return 5, because it is the 5th Tuesday of each month

Gets the total days in a month

The date time.

Takes any date and returns it's value as an Unspecified DateTime

Trims the milliseconds off of a datetime

Extension methods for .

Sets date range to given target.

Sets date range from given source.

Returns all the days of a datetime range.

The date range.

Returns all the days in a range.

The start. The end.

Extension methods for .

Check if a given value is weekend.

Check if a given value is weekday.

Finds the NTH week day of a month.

The day of week. The year. The month. The nth instance. Compensates for 4th and 5th DayOfWeek of Month

Finds the total number of instances of a specific DayOfWeek in a month.

The day of week. The year. The month.

Gets the total number of instances of a specific DayOfWeek in a month.

The day of week. The date in a month.

Extension methods for .

Raises given event safely with given arguments.

The event handler Source of the event

Raises given event safely with given arguments.

The event handler Source of the event Event argument

Raises given event safely with given arguments.

Type of the The event handler Source of the event Event argument

Extension methods for class.

Uses method to re-throws exception while preserving stack trace.

Exception to be re-thrown

Extension methods for all objects.

Used to simplify and beautify casting an object to a type.

Type to be casted Object to cast Casted object

Converts given object to a value or enum type using or method.

Object to be converted Type of the target object Converted object

Check if an item is in a list.

Item to check List of items Type of the items

Extension methods for String class.

Adds a char to end of given string if it does not ends with the char.

Adds a char to beginning of given string if it does not starts with the char.

Indicates whether this string is null or an System.String.Empty string.

indicates whether this string is null, empty, or consists only of white-space characters.

Gets a substring of a string from beginning of the string.

Thrown if is null Thrown if is bigger that string's length

Converts line endings in the string to .

Gets index of nth occurence of a char in a string.

source string to be searched Char to search in Count of the occurence

Removes first occurrence of the given postfixes from end of the given string. Ordering is important. If one of the postFixes is matched, others will not be tested.

The string. one or more postfix. Modified string or the same string if it has not any of given postfixes

Removes first occurrence of the given prefixes from beginning of the given string. Ordering is important. If one of the preFixes is matched, others will not be tested.

The string. one or more prefix. Modified string or the same string if it has not any of given prefixes

Gets a substring of a string from end of the string.

Thrown if is null Thrown if is bigger that string's length

Uses string.Split method to split given string by given separator.

Uses string.Split method to split given string by .

Converts PascalCase string to camelCase string.

String to convert Invariant culture camelCase of the string

Converts PascalCase string to camelCase string in specified culture.

String to convert An object that supplies culture-specific casing rules camelCase of the string

Converts given PascalCase/camelCase string to sentence (by splitting words by space). Example: "ThisIsSampleSentence" is converted to "This is a sample sentence".

String to convert. Invariant culture

Converts given PascalCase/camelCase string to sentence (by splitting words by space). Example: "ThisIsSampleSentence" is converted to "This is a sample sentence".

String to convert. An object that supplies culture-specific casing rules.

Converts string to enum value.

Type of enum String value to convert Returns enum object

Converts string to enum value.

Type of enum String value to convert Ignore case Returns enum object

Converts camelCase string to PascalCase string.

String to convert Invariant culture PascalCase of the string

Converts camelCase string to PascalCase string in specified culture.

String to convert An object that supplies culture-specific casing rules PascalCase of the string

Gets a substring of a string from beginning of the string if it exceeds maximum length.

Thrown if is null

Gets a substring of a string from beginning of the string if it exceeds maximum length. It adds a "..." postfix to end of the string if it's truncated. Returning string can not be longer than maxLength.

Thrown if is null

Gets a substring of a string from beginning of the string if it exceeds maximum length. It adds given to end of the string if it's truncated. Returning string can not be longer than maxLength.

Thrown if is null

Used to generate Ids.

Creates a GUID.

A helper class for Directory operations.

Creates a new directory if it does not exists.

Directory to create

A helper class for File operations.

Checks and deletes given file if it does exists.

Path of the file

Defines interface for objects those should be Initialized before using it. If the object resolved using dependency injection, method is automatically called just after creation of the object.

Interface to get a user identifier.

Tenant Id. Can be null for host users.

Id of the user.

Converts given object to JSON string.

Converts given object to JSON string using custom .

Returns deserialized string using default

Returns deserialized string using custom

Returns deserialized string using explicit and custom

Defines helper methods to work with JSON.

Serializes an object with a type information included. So, it can be deserialized using method later.

Deserializes an object serialized with methods.

The Predicate Operator

The "Or"

The "And"

See http://www.albahari.com/expressions for information and examples.

Start an expression

Create an expression with a stub expression true or false to use when the expression is not yet started.

Always true

Always false

AND

Extends the specified source Predicate with another Predicate and the specified PredicateOperator.

The type The source Predicate. The second Predicate. The Operator (can be "And" or "Or"). Expression{Func{T, bool}}

Extends the specified source Predicate with another Predicate and the specified PredicateOperator.

The type The source Predicate. The second Predicate. The Operator (can be "And" or "Or"). Expression{Func{T, bool}}

ExpressionStarter{T} which eliminates the default 1=0 or 1=1 stub expressions

The type

The actual Predicate. It can only be set by calling Start.

Determines if the predicate is started.

A default expression to use only when the expression is null

The default expression

Set the Expression predicate

The first expression

And

Show predicate string

Allows this object to be implicitely converted to an Expression{Func{T, bool}}.

Some useful extension methods for .

Used for paging. Can be used as an alternative to Skip(...).Take(...) chaining.

Used for paging with an object.

Queryable to apply paging An object implements interface

Filters a by given predicate if given condition is true.

Queryable to apply filtering A boolean value Predicate to filter the query Filtered or not filtered query based on

Filters a by given predicate if given condition is true.

Queryable to apply filtering A boolean value Predicate to filter the query Filtered or not filtered query based on

This interface is intended to be used by ABP.

This method is a temporary solution since CultureInfo.GetCultureInfo() does not exists in netstandard yet.

This class is used to build a localization source which works on memory based dictionaries to find strings.

Unique Name of the source.

Extends the source with given dictionary.

Dictionary to extend the source

Interface for a dictionary based localization source.

Gets the dictionary provider.

Extends the source with given dictionary.

Dictionary to extend the source

Represents a dictionary that is used to find a localized string.

Culture of the dictionary.

Gets/sets a string for this dictionary with given name (key).

Name to get/set

Gets a for given .

Name (key) to get localized string The localized string or null if not found in this dictionary

Gets a list of all strings in this dictionary.

List of all object

Used to get localization dictionaries () for a .

Provides localization dictionaries from JSON files embedded into an .

Creates a new object.

Assembly that contains embedded json files Namespace of the embedded json dictionary files Notice : Json folder name is different from Xml folder name. You must name it like this : Json**** and Xml****; Do not name : ****Json and ****Xml

Provides localization dictionaries from json files in a directory.

Creates a new .

Path of the dictionary that contains all related XML files

This class is used to build a localization dictionary from json.

Use static Build methods to create instance of this class.

Private constructor.

Culture of the dictionary

Builds an from given file.

Path of the file

Builds an from given json string.

Json string

Use it to serialize json file

Constructor

get or set the culture name; eg : en , en-us, zh-CN

Key value pairs

Represents a simple implementation of interface.

Creates a new object.

Culture of the dictionary

Provides localization dictionaries from XML files embedded into an .

Creates a new object.

Assembly that contains embedded xml files Namespace of the embedded xml dictionary files

Provides localization dictionaries from XML files in a directory.

Creates a new .

Path of the dictionary that contains all related XML files

This class is used to build a localization dictionary from XML.

Use static Build methods to create instance of this class.

Private constructor.

Culture of the dictionary

Builds an from given file.

Path of the file

Builds an from given xml string.

XML string

A class that gets the same string on every localization.

The fixed string. Whenever Localize methods called, this string is returned.

Needed for serialization.

Creates a new instance of .

The fixed string. Whenever Localize methods called, this string is returned.

Represents a string that can be localized when needed.

Localizes the string in current culture.

Localization context Localized string

Localizes the string in given culture.

Localization context culture Localized string

Localization context.

Gets the localization manager.

This interface is used to manage localization system.

Gets a localization source with name.

Unique name of the localization source The localization source

Gets all registered localization sources.

List of sources

Represents an available language for the application.

Code name of the language. It should be valid culture code. Ex: "en-US" for American English, "tr-TR" for Turkey Turkish.

Display name of the language in it's original language. Ex: "English" for English, "Türkçe" for Turkish.

An icon can be set to display on the UI.

Is this the default language?

Is this the language disabled?

Is this language Right To Left?

Creates a new object.

Code name of the language. It should be valid culture code. Ex: "en-US" for American English, "tr-TR" for Turkey Turkish. Display name of the language in it's original language. Ex: "English" for English, "Türkçe" for Turkish. An icon can be set to display on the UI Is this the default language? Is this the language disabled?

Represents a string that can be localized.

Unique name of the localization source.

Unique Name of the string to be localized.

Needed for serialization.

Unique Name of the string to be localized Unique name of the localization source

Localizes the string in current culture.

Localizable string instance Localization manager Localized string

Localizes the string in current culture.

Localizable string instance Localization manager culture Localized string

This class can be used to serialize to during serialization. It does not work for deserialization.

Implements .

Initializes a new instance of the class.

The localization manager.

This static class is used to simplify getting localized strings.

Gets a reference to the localization manager. Inject and use wherever it's possible, instead of this shortcut.

Gets a pre-registered localization source.

Gets a localized string in current language.

Name of the localization source Key name to get localized string Localized string

Gets a localized string in specified language.

Name of the localization source Key name to get localized string culture Localized string

Constructor.

Gets a localization source with name.

Unique name of the localization source The localization source

Gets all registered localization sources.

List of sources

Gets a localized string in current language.

Localized string

Gets a localized string in specified language.

Localized string

Gets a localized string in current language.

Localization manager instance Name of the localization source Key name to get localized string Localized string

Gets a localized string in specified language.

Localization manager instance Name of the localization source Key name to get localized string culture Localized string

Represents a localized string.

Culture info for this string.

Unique Name of the string.

Value for the .

Creates a localized string instance.

Culture info for this string Unique Name of the string Value for the

Singleton instance.

A Localization Source is used to obtain localized strings.

Unique Name of the source.

This method is called by ABP before first usage.

Gets localized string for given name in current language. Fallbacks to default language if not found in current culture.

Key name Localized string

Gets localized string for given name and specified culture. Fallbacks to default language if not found in given culture.

Key name culture information Localized string

Gets localized string for given name in current language. Returns null if not found.

Key name True: Fallbacks to default language if not found in current culture. Localized string

Gets localized string for given name and specified culture. Returns null if not found.

Key name culture information True: Fallbacks to default language if not found in current culture. Localized string

Gets all strings in current language.

True: Fallbacks to default language texts if not found in current culture.

Gets all strings in specified culture.

culture information True: Fallbacks to default language texts if not found in current culture.

Used to store a localization source extension information.

Source name.

Extension dictionaries.

Creates a new object.

Source name Extension dictionaries

Extension methods for .

Get a localized string by formatting string.

Localization source Key name Format arguments Formatted and localized string

Get a localized string in given language by formatting string.

Localization source Key name Culture Format arguments Formatted and localized string

Null object pattern for .

Singleton instance.

This class is used to simplify to create a localization source that uses resource a file.

Unique Name of the source.

Reference to the object related to this localization source.

Unique Name of the source Reference to the object related to this localization source

This method is called by ABP before first usage.

Gets all strings in current language.

Gets all strings in specified culture.

Interface to define a property (see ).

Log severity.

Extensions for .

This class can be used to write logs from somewhere where it's a hard to get a reference to the . Normally, use with property injection wherever it's possible.

A reference to the logger.

Indicates severity for log.

Debug.

Info.

Warn.

Error.

Fatal.

This class must be implemented by all module definition classes.

A module definition class is generally located in its own assembly and implements some action in module events on application startup and shutdown. It also defines depended modules.

Gets a reference to the IOC manager.

Gets a reference to the ABP configuration.

Gets or sets the logger.

This is the first event called on application startup. Codes can be placed here to run before dependency injection registrations.

This method is used to register dependencies for this module.

This method is called lastly on application startup.

This method is called when the application is being shutdown.

Checks if given type is an Abp module class.

Type to check

Finds direct depended modules of a module (excluding given module).

Used to store AbpModuleInfo objects as a dictionary.

Gets a reference to a module instance.

Module type Reference to the module instance

Sorts modules according to dependencies. If module A depends on module B, A comes after B in the returned List.

Sorted list

Used to store all needed information for a module.

The assembly which contains the module definition.

Type of the module.

Instance of the module.

Is this module loaded as a plugin.

All dependent modules of this module.

Creates a new AbpModuleInfo object.

This class is used to manage modules.

Used to define dependencies of an ABP module to other modules. It should be used for a class derived from .

Types of depended modules.

Used to define dependencies of an ABP module to other modules.

Types of depended modules

Default tenant id: 1.

Extension methods for multi-tenancy.

Gets multi-tenancy side () of an object that implements .

The object The entity to check TenantId or null for host

Used to declare multi tenancy side of an object.

Multitenancy side.

Initializes a new instance of the class.

Multitenancy side.

Represents sides in a multi tenancy application.

Tenant side.

Host (tenancy owner) side.

Used to represent a named type selector.

Name of the selector.

Predicate.

Creates new object.

Name Predicate

Add list of types to the list.

List of NamedTypeSelector items An arbitrary but unique name (can be later used to remove types from the list)

Can be used to store Name/Value (or Key/Value) pairs.

Creates a new .

Can be used to store Name/Value (or Key/Value) pairs.

Name.

Value.

Creates a new .

This class can be used as base to implement .

Constructor.

Configuration

Should implement this method to send email in derived classes.

Mail to be sent

Should implement this method to send email in derived classes.

Mail to be sent

Normalizes given email. Fills if it's not filled before. Sets encodings to UTF8 if they are not set before.

Mail to be normalized

Implementation of that reads settings from .

Creates a new .

Gets a setting value by checking. Throws if it's null or empty.

Name of the setting Value of the setting

Declares names of the settings defined by .

Abp.Net.Mail.DefaultFromAddress

Abp.Net.Mail.DefaultFromDisplayName

SMTP related email settings.

Abp.Net.Mail.Smtp.Host

Abp.Net.Mail.Smtp.Port

Abp.Net.Mail.Smtp.UserName

Abp.Net.Mail.Smtp.Password

Abp.Net.Mail.Smtp.Domain

Abp.Net.Mail.Smtp.EnableSsl

Abp.Net.Mail.Smtp.UseDefaultCredentials

Defines settings to send emails. for all available configurations.

This service can be used simply sending emails.

Sends an email.

Mail to be sent Should normalize email? If true, it sets sender address/name if it's not set before and makes mail encoding UTF-8.

Sends an email.

Mail to be sent Should normalize email? If true, it sets sender address/name if it's not set before and makes mail encoding UTF-8.

Defines configurations used while sending emails.

Default from address.

Default display name.

This class is an implementation of as similar to null pattern. It does not send emails but logs them.

Creates a new object.

Configuration

Used to send emails over SMTP.

Creates and configures new object to send emails.

An object that is ready to send emails.

Defines configurations to used by SmtpClient object.

SMTP Host name/IP.

SMTP Port.

User name to login to SMTP server.

Password to login to SMTP server.

Domain name to login to SMTP server.

Is SSL enabled?

Use default credentials?

Used to send emails over SMTP.

Creates a new .

Configuration

Implementation of that reads settings from .

SMTP Host name/IP.

SMTP Port.

User name to login to SMTP server.

Password to login to SMTP server.

Domain name to login to SMTP server.

Is SSL enabled?

Use default credentials?

Creates a new .

Setting manager

Used to distribute notifications to users.

Initializes a new instance of the class.

Used to configure notification system.

Notification providers.

A list of contributors for notification distribution process.

A list of contributors for notification notifying process.

Used as a context while defining notifications.

Gets the notification definition manager.

Used to manage notification definitions.

Adds the specified notification definition.

Gets a notification definition by name. Throws exception if there is no notification definition with given name.

Gets a notification definition by name. Returns null if there is no notification definition with given name.

Gets all notification definitions.

Checks if given notification () is available for given user.

Gets all available notification definitions for given user.

User.

Remove notification with given name

Used to distribute notifications to users.

Distributes given notification to users.

The notification id.

Used to publish notifications.

Publishes a new notification.

Unique notification name Notification data (optional) The entity identifier if this notification is related to an entity Notification severity Target user id(s). Used to send notification to specific user(s) (without checking the subscription). If this is null/empty, the notification is sent to subscribed users. Excluded user id(s). This can be set to exclude some users while publishing notifications to subscribed users. It's normally not set if is set. Target tenant id(s). Used to send notification to subscribed users of specific tenant(s). This should not be set if is set. can be passed to indicate all tenants. But this can only work in a single database approach (all tenants are stored in host database). If this is null, then it's automatically set to the current tenant on .

Used to store (persist) notifications.

Inserts a notification subscription.

Deletes a notification subscription.

Inserts a notification.

Gets a notification by Id, or returns null if not found.

Inserts a user notification.

Gets subscriptions for a notification.

Gets subscriptions for a notification for specified tenant(s).

Gets subscriptions for a user.

Checks if a user subscribed for a notification

Updates a user notification state.

Updates all notification states for a user.

Deletes a user notification.

Deletes all notifications of a user.

Gets notifications of a user.

User. State Skip count. Maximum result count. List notifications published after startDateTime List notifications published before startDateTime

Gets user notification count.

User. The state. List notifications published after startDateTime List notifications published before startDateTime

Gets a user notification.

Tenant Id Skip count.

Inserts notification for a tenant.

Deletes the notification.

The notification.

Used to manage subscriptions for notifications.

Subscribes to a notification for given user and notification informations.

User Name of the notification. entity identifier

Subscribes to all available notifications for given user. It does not subscribe entity related notifications.

User.

Unsubscribes from a notification.

User. Name of the notification. entity identifier

Gets all subscribtions for given notification (including all tenants). This only works for single database approach in a multitenant application!

Name of the notification. entity identifier

Gets all subscribtions for given notification.

Tenant id. Null for the host. Name of the notification. entity identifier

Gets subscribed notifications for a user.

User.

Checks if a user subscribed for a notification.

User. Name of the notification. entity identifier

Interface to send real time notifications to users.

This method tries to deliver real time notifications to specified users. If a user is not online, it should ignore him.

Used to manage user notifications.

Gets notifications for a user.

User. State Skip count. Maximum result count. List notifications published after startDateTime List notifications published before startDateTime

Gets user notification count.

User. State. List notifications published after startDateTime List notifications published before startDateTime

Gets a user notification by given id.

Tenant Id The user notification id.

Updates a user notification state.

Tenant Id. The user notification id. New state.

Updates all notification states for a user.

User. New state.

Deletes a user notification.

Tenant Id. The user notification id.

Deletes all notifications of a user.

User. State Delete notifications published after startDateTime Delete notifications published before startDateTime

Can be used to store a simple message as notification data.

The message.

Needed for serialization.

Initializes a new instance of the class.

The message.

Can be used to store a simple message as notification data.

The message.

Needed for serialization.

Used to store data for a notification. It can be directly used or can be derived.

Gets notification data type name. It returns the full class name by default.

Shortcut to set/get .

Can be used to add custom properties to this notification.

Createa a new NotificationData object.

Definition for a notification.

Unique name of the notification.

Related entity type with this notification (optional).

Display name of the notification. Optional.

Description for the notification. Optional.

A permission dependency. This notification will be available to a user if this dependency is satisfied. Optional.

A feature dependency. This notification will be available to a tenant if this feature is enabled. Optional.

Gets/sets arbitrary objects related to this object. Gets null if given key does not exists. This is a shortcut for dictionary.

Key

Arbitrary objects related to this object. These objects must be serializable.

Initializes a new instance of the class.

Unique name of the notification. Related entity type with this notification (optional). Display name of the notification. Description for the notification A permission dependency. This notification will be available to a user if this dependency is satisfied. A feature dependency. This notification will be available to a tenant if this feature is enabled.

Implements .

Extension methods for .

Gets all available notification definitions for given user.

Notification definition manager User

This background job distributes notifications to users.

Initializes a new instance of the class.

Arguments for .

Notification Id.

Initializes a new instance of the class.

Extension methods for , , .

Subscribes to a notification.

Notification subscription manager User. Name of the notification. entity identifier

Subscribes to all available notifications for given user. It does not subscribe entity related notifications.

Notification subscription manager User.

Unsubscribes from a notification.

Notification subscription manager User. Name of the notification. entity identifier

Gets all subscribtions for given notification. TODO: Can work only for single database approach!

Notification subscription manager Name of the notification. entity identifier

Gets all subscribtions for given notification.

Notification subscription manager Tenant id. Null for the host. Name of the notification. entity identifier

Gets subscribed notifications for a user.

Notification subscription manager User.

Checks if a user subscribed for a notification.

Notification subscription manager User. Name of the notification. entity identifier

Publishes a new notification.

Notification publisher Unique notification name Notification data (optional) The entity identifier if this notification is related to an entity Notification severity Target user id(s). Used to send notification to specific user(s). If this is null/empty, the notification is sent to all subscribed users

Gets notifications for a user.

User notificaiton manager User. State Skip count. Maximum result count.

Gets user notification count.

User notificaiton manager User. State.

Gets a user notification by given id.

User notificaiton manager Tenant Id The user notification id.

Updates a user notification state.

User notificaiton manager Tenant Id The user notification id. New state.

Updates all notification states for a user.

User notificaiton manager User. New state.

Deletes a user notification.

User notificaiton manager Tenant Id The user notification id.

Deletes all notifications of a user.

User notificaiton manager The user id.

Used to store a notification request. This notification is distributed to tenants and users by .

Indicates all tenant ids for property. Value: "0".

Maximum length of property. Value: 96.

Maximum length of property. Value: 1048576 (1 MB).

Maximum length of property. Value: 512.

Maximum length of property. Value: 250.

Maximum length of property. Value: 512.

Maximum length of property. Value: 96.

Maximum length of property. Value: 131072 (128 KB).

Unique notification name.

Notification data as JSON string.

Type of the JSON serialized . It's AssemblyQualifiedName of the type.

Gets/sets entity type name, if this is an entity level notification. It's FullName of the entity type.

AssemblyQualifiedName of the entity type.

Gets/sets primary key of the entity, if this is an entity level notification.

Notification severity.

Target users of the notification. If this is set, it overrides subscribed users. If this is null/empty, then notification is sent to all subscribed users.

Excluded users. This can be set to exclude some users while publishing notifications to subscribed users. It's not normally used if is not null.

Target tenants of the notification. Used to send notification to subscribed users of specific tenant(s). This is valid only if UserIds is null. If it's "0", then indicates to all tenants.

Initializes a new instance of the class.

This class should be implemented in order to define notifications.

Used to add/manipulate notification definitions.

Context

Implements .

Indicates all tenants.

Reference to ABP session.

Initializes a new instance of the class.

Pre-defined setting names for notification system.

A top-level switch to enable/disable receiving notifications for a user. "Abp.Notifications.ReceiveNotifications".

Notification severity.

Info.

Success.

Warn.

Error.

Fatal.

Represents a user subscription to a notification.

Tenant id of the subscribed user.

User Id.

Notification unique name.

Entity type.

Name of the entity type (including namespaces).

Entity Id.

Initializes a new instance of the class.

Used to store a notification subscription.

Tenant id of the subscribed user.

User Id.

Notification unique name.

Gets/sets entity type name, if this is an entity level notification. It's FullName of the entity type.

AssemblyQualifiedName of the entity type.

Gets/sets primary key of the entity, if this is an entity level notification.

Initializes a new instance of the class.

Extension methods for .

Converts to .

Implements .

Initializes a new instance of the class.

Null pattern implementation of .

Gets single instance of class.

Represents a published notification for a tenant/user.

Tenant Id.

Unique notification name.

Notification data.

Gets or sets the type of the entity.

Name of the entity type (including namespaces).

Entity id.

Severity.

Initializes a new instance of the class.

A notification distributed to it's related tenant.

Tenant id of the subscribed user.

Unique notification name.

Notification data as JSON string.

Type of the JSON serialized . It's AssemblyQualifiedName of the type.

Gets/sets entity type name, if this is an entity level notification. It's FullName of the entity type.

AssemblyQualifiedName of the entity type.

Gets/sets primary key of the entity, if this is an entity level notification.

Notification severity.

Extension methods for .

Converts to .

Represents a notification sent to a user.

TenantId.

User Id.

Current state of the user notification.

The notification.

Used to store a user notification.

Tenant Id.

User Id.

Notification Id.

Current state of the user notification.

Initializes a new instance of the class.

Extension methods for .

Converts to .

A class contains a and related .

User notification.

Notification.

Initializes a new instance of the class.

Extension methods for .

Converts to .

Implements .

Initializes a new instance of the class.

Represents state of a .

Notification is not read by user yet.

Notification is read by user.

Defines a simple interface to map objects.

Converts an object to another. Creates a new object of .

Type of the destination object Source object

Execute a mapping from the source object to the existing destination object

Source type Destination type Source object Destination object Returns the same object after mapping operation

Singleton instance.

A shortcut to use class. Also provides some useful methods.

Returns a random number within a specified range.

The inclusive lower bound of the random number returned. The exclusive upper bound of the random number returned. maxValue must be greater than or equal to minValue. A 32-bit signed integer greater than or equal to minValue and less than maxValue; that is, the range of return values includes minValue but not maxValue. If minValue equals maxValue, minValue is returned.

Returns a nonnegative random number less than the specified maximum.

The exclusive upper bound of the random number to be generated. maxValue must be greater than or equal to zero. A 32-bit signed integer greater than or equal to zero, and less than maxValue; that is, the range of return values ordinarily includes zero but not maxValue. However, if maxValue equals zero, maxValue is returned.

Returns a nonnegative random number.

A 32-bit signed integer greater than or equal to zero and less than .

Gets random of given objects.

Type of the objects List of object to select a random one

Generates a randomized list from given enumerable.

Type of items in the list items

Online clients.

Represents an online client connected to the application.

Unique connection Id for this client.

IP address of this client.

Tenant Id.

User Id.

Connection establishment time for this client.

Shortcut to set/get .

Can be used to add custom properties for this client.

Used to manage online clients those are connected to the application.

Adds a client.

The client.

Removes a client by connection id.

The connection id. True, if a client is removed

Tries to find a client by connection id. Returns null if not found.

connection id

Gets all online clients.

Gets all online clients by user id.

user identifier

Adds a client.

The client.

Removes a client by connection id.

The connection id. true if the client is removed, otherwise, false

Removes a client by connection id.

The connection id. true if the client is removed, otherwise, false

Gets a client by connection id.

The connection id. true if the client exists, otherwise, false

Determines if store contains client with connection id.

The connection id.

Gets all online clients.

Implements .

Unique connection Id for this client.

IP address of this client.

Tenant Id.

User Id.

Connection establishment time for this client.

Shortcut to set/get .

Can be used to add custom properties for this client.

Initializes a new instance of the class.

The connection identifier. The ip address. The tenant identifier. The user identifier.

Implements .

Online clients Store.

Initializes a new instance of the class.

Extension methods for .

Determines whether the specified user is online or not.

The online client manager. User.

Gets directory path of given assembly or returns null if can not find.

The assembly.

Extensions to .

Gets a single attribute for a member.

Type of the attribute The member that will be checked for the attribute Include inherited attributes Returns the attribute object if found. Returns null if not found.

This interface is used to get assemblies in the application. It may not return all assemblies, but those are related with modules.

Gets all assemblies.

List of assemblies

Returns dynamic proxy target object if this is a proxied object, otherwise returns the given object.

Defines helper methods for reflection.

Checks whether implements/inherits .

Type to check Generic type

Gets a list of attributes defined for a class member and it's declaring type including inherited attributes.

Inherit attribute from base classes MemberInfo

Gets a list of attributes defined for a class member and type including inherited attributes.

MemberInfo Type Inherit attribute from base classes

Gets a list of attributes defined for a class member and it's declaring type including inherited attributes.

Type of the attribute MemberInfo Inherit attribute from base classes

Gets a list of attributes defined for a class member and type including inherited attributes.

Type of the attribute MemberInfo Type Inherit attribute from base classes

Tries to gets an of attribute defined for a class member and it's declaring type including inherited attributes. Returns default value if it's not declared at all.

Type of the attribute MemberInfo Default value (null as default) Inherit attribute from base classes

Tries to gets an of attribute defined for a class member and it's declaring type including inherited attributes. Returns default value if it's not declared at all.

Type of the attribute MemberInfo Default value (null as default) Inherit attribute from base classes

Gets a property by it's full path from given object

Object to get value from Type of given object Full path of property

Gets value of a property by it's full path from given object

Object to get value from Type of given object Full path of property

Sets value of a property by it's full path on given object

Some simple type-checking methods used internally.

Implements by using .

Stores needed information of an embedded resource.

File name including extension.

Content of the resource file.

The assembly that contains the resource.

Provides infrastructure to use any type of resources (files) embedded into assemblies.

Used to get an embedded resource file. Can return null if resource is not found!

Full path of the resource The resource

Used to get the list of embedded resource file.

Full path of the resource The list of resource

A class to hold the Type information and Serialized payload for data stored in the cache.

Names of standard caches used in ABP.

Application settings cache: AbpApplicationSettingsCache.

Tenant settings cache: AbpTenantSettingsCache.

User settings cache: AbpUserSettingsCache.

Localization scripts cache: AbpLocalizationScripts.

Base class for caches. It's used to simplify implementing .

Constructor.

Extension methods for .

Base class for cache managers.

Constructor.

Used to create actual cache implementation.

Name of the cache Cache object

Extension methods for .

A registered cache configurator.

Name of the cache. It will be null if this configurator configures all caches.

Configuration action. Called just after the cache is created.

Used to configure caching system.

Gets the ABP configuration object.

List of all registered configurators.

Used to configure all caches.

An action to configure caches This action is called for each cache just after created.

Used to configure a specific cache.

Cache name An action to configure the cache. This action is called just after the cache is created.

Defines a cache that can be store and get items by keys.

Unique name of the cache.

Default sliding expire time of cache items. Default value: 60 minutes (1 hour). Can be changed by configuration.

Default absolute expire time of cache items. Default value: null (not used).

Gets an item from the cache. This method hides cache provider failures (and logs them), uses the factory method to get the object if cache provider fails.

Key Factory method to create cache item if not exists Cached item

Gets items from the cache. This method hides cache provider failures (and logs them), uses the factory method to get the object if cache provider fails.

Keys Factory method to create cache item if not exists Cached item

Gets an item from the cache. This method hides cache provider failures (and logs them), uses the factory method to get the object if cache provider fails.

Key Factory method to create cache item if not exists Cached item

Gets items from the cache. This method hides cache provider failures (and logs them), uses the factory method to get the object if cache provider fails.

Keys Factory method to create cache item if not exists Cached items

Gets an item from the cache or null if not found.

Key Cached item or null if not found

Gets items from the cache. For every key that is not found, a null value is returned.

Keys Cached items

Gets an item from the cache or null if not found.

Key Cached item or null if not found

Gets items from the cache. For every key that is not found, a null value is returned.

Keys Cached items

Saves/Overrides an item in the cache by a key. Use one of the expire times at most ( or ). If none of them is specified, then will be used if it's not null. Othewise, will be used.

Key Value Sliding expire time Absolute expire time

Saves/Overrides items in the cache by the pairs. Use one of the expire times at most ( or ). If none of them is specified, then will be used if it's not null. Othewise, will be used.

Pairs Sliding expire time Absolute expire time

Saves/Overrides an item in the cache by a key. Use one of the expire times at most ( or ). If none of them is specified, then will be used if it's not null. Othewise, will be used.

Key Value Sliding expire time Absolute expire time

Saves/Overrides items in the cache by the pairs. Use one of the expire times at most ( or ). If none of them is specified, then will be used if it's not null. Othewise, will be used.

Pairs Sliding expire time Absolute expire time

Removes a cache item by it's key (does nothing if given key does not exists in the cache).

Key

Removes cache items by their keys.

Keys

Removes a cache item by it's key (does nothing if given key does not exists in the cache).

Key

Removes cache items by their keys.

Keys

Clears all items in this cache.

An upper level container for objects. A cache manager should work as Singleton and track and manage objects.

Gets all caches.

List of caches

Gets a instance. It may create the cache if it does not already exists.

Unique and case sensitive name of the cache. The cache reference

An interface to work with cache in a typed manner. Use method to convert a to this interface.

Key type for cache items Value type for cache items

Unique name of the cache.

Default sliding expire time of cache items.

Gets the internal cache.

Gets an item from the cache.

Key Factory method to create cache item if not exists Cached item

Gets items from the cache.

Keys Factory method to create cache item if not exists Cached items

Gets an item from the cache.

Key Factory method to create cache item if not exists Cached item

Gets items from the cache.

Keys Factory method to create cache item if not exists Cached item

Gets an item from the cache or null if not found.

Key Cached item or null if not found

Gets items from the cache. For every key that is not found, a null value is returned.

Keys Cached items

Gets an item from the cache or null if not found.

Key Cached item or null if not found

Gets items from the cache. For every key that is not found, a null value is returned.

Keys Cached items

Saves/Overrides an item in the cache by a key.

Key Value Sliding expire time Absolute expire time

Saves/Overrides items in the cache by the pairs.

Pairs Sliding expire time Absolute expire time

Saves/Overrides an item in the cache by a key.

Key Value Sliding expire time Absolute expire time

Saves/Overrides items in the cache by the pairs.

Pairs Sliding expire time Absolute expire time

Removes a cache item by it's key (does nothing if given key does not exists in the cache).

Key

Removes cache items by their keys.

Keys

Removes a cache item by it's key (does nothing if given key does not exists in the cache).

Key

Removes cache items by their keys.

Keys

Clears all items in this cache.

Implements to work with .

Constructor.

Unique name of the cache

Implements to work with MemoryCache.

Constructor.

Extension methods for .

Implements to wrap a .

Creates a new object.

The actual internal cache

Used to get ABP-specific claim type names.

UserId. Default:

TenantId. Default: http://www.aspnetboilerplate.com/identity/claims/tenantId

ImpersonatorUserId. Default: http://www.aspnetboilerplate.com/identity/claims/impersonatorUserId

ImpersonatorTenantId Default: http://www.aspnetboilerplate.com/identity/claims/impersonatorTenantId

Can be used to simply encrypt/decrypt texts.

This constant string is used as a "salt" value for the PasswordDeriveBytes function calls. This size of the IV (in bytes) must = (keysize / 8). Default keysize is 256, so the IV must be 32 bytes long. Using a 16 character string here gives us 32 bytes when converted to a byte array.

Default password to encrypt/decrypt texts. It's recommented to set to another value for security. Default value: "gsKnGZ041HLL4IM8"

Default value: Encoding.ASCII.GetBytes("jkE49230Tf093b42")

Default value: Encoding.ASCII.GetBytes("hgt!16kl")

This constant is used to determine the keysize of the encryption algorithm.

This class is used to simplify serialization/deserialization operations. Uses .NET binary serialization.

Serializes an object and returns as a byte array.

object to be serialized bytes of object

Serializes an object into a stream.

object to be serialized Stream to serialize in bytes of object

Deserializes an object from given byte array.

The byte array that contains object deserialized object

Deserializes an object from given stream.

The stream that contains object deserialized object

Deserializes an object from given byte array. Difference from is that; this method can also deserialize types that are defined in dynamically loaded assemblies (like PlugIns).

The byte array that contains object deserialized object

Deserializes an object from given stream. Difference from is that; this method can also deserialize types that are defined in dynamically loaded assemblies (like PlugIns).

The stream that contains object deserialized object

This class is used in deserializing to allow deserializing objects that are defined in assemlies that are load in runtime (like PlugIns).

Extension methods for .

Gets current User's Id. Throws if is null.

Session object. Current User's Id.

Gets current Tenant's Id. Throws if is null.

Session object. Current Tenant's Id.

Creates from given session. Returns null if is null.

The session.

Implements to get session properties from current claims.

Defines some session information that can be useful for applications.

Gets current UserId or null. It can be null if no user logged in.

Gets current TenantId or null. This TenantId should be the TenantId of the . It can be null if given is a host user or no user logged in.

Gets current multi-tenancy side.

UserId of the impersonator. This is filled if a user is performing actions behalf of the .

TenantId of the impersonator. This is filled if a user with performing actions behalf of the .

Used to change and for a limited scope.

Implements null object pattern for .

Singleton instance.

This exception type is used to throws validation exceptions.

Detailed list of validation errors for this exception.

Exception severity. Default: Warn.

Constructor.

Constructor for serializing.

Constructor.

Exception message

Constructor.

Exception message Validation errors

Constructor.

Exception message Inner exception

List of validation results (errors). Add validation errors to this list.

Can be used to resolve dependencies on validation.

Validation context Localization source name Localization key

Can be added to a method to disable auto validation.

Can be added to a method to enable auto validation if validation is disabled for it's class.

Defines interface that must be implemented by classes those must be validated with custom rules. So, implementing class can define its own validation logic.

This method is used to validate the object.

Validation context.

Checks all properties for DataAnnotations attributes.

This interface is used to validate method parameters.

This class is used to validate a method call (invocation) for method arguments.

Creates a new instance.

Method to be validated List of arguments those are used to call the .

Validates the method invocation.

Validates given parameter for given value.

Parameter of the method to validate Value to validate

This interceptor is used intercept method calls for classes which's methods must be validated.

This interface is used to normalize inputs before method execution.

This method is called lastly before method execution (after validation if exists).

Gets/sets arbitrary objects related to this object. Gets null if given key does not exists.

Key

Arbitrary objects related to this object.

Implements by creating sequential Guids. This code is taken from https://github.com/jhtodd/SequentialGuid/blob/master/SequentialGuid/Classes/SequentialGuid.cs

Gets the singleton instance.

Prevents a default instance of the class from being created. Use .

Database type to generate GUIDs.

Describes the type of a sequential GUID value.

The GUID should be sequential when formatted using the method.

The sequential portion of the GUID should be located at the end of the Data4 block.

Represents the combined specification which indicates that the first specification can be satisifed by the given object whereas the second one cannot.

The type of the object to which the specification is applied.

Constructs a new instance of class.

The first specification. The second specification.

Gets the LINQ expression which represents the current specification.

The LINQ expression.

Represents the combined specification which indicates that both of the given specifications should be satisfied by the given object.

The type of the object to which the specification is applied.

Constructs a new instance of class.

The first specification. The second specification.

Gets the LINQ expression which represents the current specification.

The LINQ expression.

Represents the specification that can be satisfied by the given object in any circumstance.

The type of the object to which the specification is applied.

Gets the LINQ expression which represents the current specification.

The LINQ expression.

Represents the base class for composite specifications.

The type of the object to which the specification is applied.

Gets the first specification.

Gets the second specification.

Constructs a new instance of class.

The first specification. The second specification.

Represents the extender for Expression[Func[T, bool]] type. This is part of the solution which solves the expression parameter problem when going to Entity Framework. For more information about this solution please refer to http://blogs.msdn.com/b/meek/archive/2008/05/02/linq-to-entities-combining-predicates.aspx.

Combines two given expressions by using the AND semantics.

The type of the object. The first part of the expression. The second part of the expression. The combined expression.

Combines two given expressions by using the OR semantics.

The type of the object. The first part of the expression. The second part of the expression. The combined expression.

Represents the specification which is represented by the corresponding LINQ expression.

The type of the object to which the specification is applied.

Initializes a new instance of ExpressionSpecification<T> class.

The LINQ expression which represents the current specification.

Gets the LINQ expression which represents the current specification.

The LINQ expression.

Represents that the implemented classes are composite specifications.

The type of the object to which the specification is applied.

Gets the left side of the specification.

Gets the right side of the specification.

Represents that the implemented classes are specifications. For more information about the specification pattern, please refer to http://martinfowler.com/apsupp/spec.pdf.

The type of the object to which the specification is applied.

Returns a value which indicates whether the specification is satisfied by the given object.

The object to which the specification is applied. True if the specification is satisfied, otherwise false.

Gets the LINQ expression which represents the current specification.

The LINQ expression.

Represents that the implemented classes are specification parsers that parses the given specification to a domain specific criteria object, such as the ICriteria instance in NHibernate.

The type of the domain specific criteria.

Parses the given specification to a domain specific criteria object.

The type of the object to which the specification is applied. The specified specification instance. The instance of the domain specific criteria.

Represents the specification that can be satisfied by the given object in no circumstance.

The type of the object to which the specification is applied.

Gets the LINQ expression which represents the current specification.

The LINQ expression.

Represents the specification which indicates the semantics opposite to the given specification.

The type of the object to which the specification is applied.

Initializes a new instance of class.

The specification to be reversed.

Gets the LINQ expression which represents the current specification.

The LINQ expression.

Represents the combined specification which indicates that either of the given specification should be satisfied by the given object.

The type of the object to which the specification is applied.

Initializes a new instance of class.

The first specification. The second specification.

Gets the LINQ expression which represents the current specification.

The LINQ expression.

Represents the parameter rebinder used for rebinding the parameters for the given expressions. This is part of the solution which solves the expression parameter problem when going to Entity Framework. For more information about this solution please refer to http://blogs.msdn.com/b/meek/archive/2008/05/02/linq-to-entities-combining-predicates.aspx.

Represents the base class for specifications.

The type of the object to which the specification is applied.

Returns a value which indicates whether the specification is satisfied by the given object.

The object to which the specification is applied. True if the specification is satisfied, otherwise false.

Gets the LINQ expression which represents the current specification.

The LINQ expression.

Implicitly converts a specification to expression.

Combines the current specification instance with another specification instance and returns the combined specification which represents that both the current and the given specification must be satisfied by the given object.

The specification The specification instance with which the current specification is combined. The combined specification instance.

Combines the current specification instance with another specification instance and returns the combined specification which represents that either the current or the given specification should be satisfied by the given object.

The specification The specification instance with which the current specification is combined. The combined specification instance.

Combines the current specification instance with another specification instance and returns the combined specification which represents that the current specification should be satisfied by the given object but the specified specification should not.

The specification The specification instance with which the current specification is combined. The combined specification instance.

Reverses the current specification instance and returns a specification which represents the semantics opposite to the current specification.

The reversed specification instance.

This class is used to extract dynamic values from a formatted string. It works as reverse of

Say that str is "My name is Neo." and format is "My name is {name}.". Then Extract method gets "Neo" as "name".

Extracts dynamic values from a formatted string.

String including dynamic values Format of the string True, to search case-insensitive. format is splitted using this character when provided.

Checks if given fits to given . Also gets extracted values.

String including dynamic values Format of the string Array of extracted values if matched True, to search case-insensitive True, if matched.

Used as return value of method.

Is fully matched.

List of matched dynamic values.

Provides some helper methods to work with async methods.

Checks if given method is an async method.

A method to check

Checks if given method is an async method.

A method to check

Runs a async method synchronously.

A function that returns a result Result type Result of the async operation

Runs a async method synchronously.

An async action

Base class that can be used to implement .

Reference to the setting manager.

Reference to .

Gets current unit of work.

Reference to the localization manager.

Gets/sets name of the localization source that is used in this application service. It must be set in order to use and methods.

Gets localization source. It's valid if is set.

Reference to the logger to write logs.

Constructor.

Gets localized string for given key name and current language.

Key name Localized string

Gets localized string for given key name and current language with formatting strings.

Key name Format arguments Localized string

Gets localized string for given key name and specified culture information.

Key name culture information Localized string

Gets localized string for given key name and current language with formatting strings.

Key name culture information Format arguments Localized string

Implements .

Initializes a new instance of the class.

Interface for a worker (thread) that runs on background to perform some tasks.

Used to manage background workers.

Adds a new worker. Starts the worker immediately if has started.

The worker. It should be resolved from IOC.

Extends to add a periodic running Timer.

Initializes a new instance of the class.

A timer.

Handles the Elapsed event of the Timer.

Periodic works should be done by implementing this method.

Extension methods to make locking easier.

Executes given by locking given object.

Source object (to be locked) Action (to be executed)

Executes given by locking given object.

Type of the object (to be locked) Source object (to be locked) Action (to be executed)

Executes given and returns it's value by locking given object.

Return type Source object (to be locked) Function (to be executed) Return value of the

Executes given and returns it's value by locking given object.

Type of the object (to be locked) Return type Source object (to be locked) Function (to be executed) Return value of the

Interface to start/stop self threaded services.

Starts the service.

Sends stop command to the service. Service may return immediately and stop asynchronously. A client should then call method to ensure it's stopped.

Waits the service to stop.

Base implementation of .

A boolean value to control the running.

Some extension methods for .

Calls and then .

This class is copied from here: http://www.zpqrtbnk.net/posts/appdomains-threads-cultureinfos-and-paracetamol It's a workaround for application startup problem.

A roboust timer implementation that ensures no overlapping occurs. It waits exactly specified between ticks.

This event is raised periodically according to Period of Timer.

Task period of timer (as milliseconds).

Indicates whether timer raises Elapsed event on Start method of Timer for once. Default: False.

This timer is used to perfom the task at spesified intervals.

Indicates that whether timer is running or stopped.

Indicates that whether performing the task or _taskTimer is in sleep mode. This field is used to wait executing tasks when stopping Timer.

Creates a new Timer.

Task period of timer (as milliseconds) Indicates whether timer raises Elapsed event on Start method of Timer for once

Starts the timer.

Stops the timer.

Waits the service to stop.

This method is called by _taskTimer.

Not used argument

Used to perform some common date-time operations.

This object is used to perform all operations. Default value: .

Gets Now using current .

Returns true if multiple timezone is supported, returns false if not.

Normalizes given using current .

DateTime to be normalized. Normalized DateTime

A basic implementation of to store a date range.

Start time of the datetime range.

End time of the datetime range.

Gets the time span of the datetime range. When set, EndTime is recalculated

Creates a new object.

Creates a new object from the given and .

Start time of the datetime range End time of the datetime range

Creates a new object from the given and .

Start time of the datetime range The span of time to calculate the EndTime

Creates a new object from given the object.

IDateTimeRange object

Gets a date range representing yesterday.

Gets a date range representing today.

Gets a date range representing tomorrow.

Gets a date range representing the last month.

Gets a date range representing this month.

Gets a date range representing the next month.

Gets a date range representing the last year.

Gets a date range representing this year.

Gets a date range representing the next year.

Gets a date range representing the last 30 days (30x24 hours) including today.

Gets a date range representing the last 30 days excluding today.

Gets a date range representing the last 7 days (7x24 hours) including today.

Gets a date range representing the last 7 days excluding today.

Returns a that represents the current .

A that represents the current .

Defines interface to perform some common date-time operations.

Gets Now.

Gets kind.

Is that provider supports multiple time zone.

Normalizes given .

DateTime to be normalized. Normalized DateTime

Defines interface for a DateTime range.

Start time of the datetime range.

End time of the datetime range.

The time difference between the start and end times.

Defines interface for a DateTime range with timezone.

The Timezone of the datetime range

The StartTime with Offset

The EndTime with Offset

The StartTime in UTC

The EndTime in UTC

Implements to work with local times.

Interface for timezone converter

Converts given date to user's time zone. If timezone setting is not specified, returns given date.

Base date to convert TenantId of user UserId to convert date for

Converts given date to tenant's time zone. If timezone setting is not specified, returns given date.

Base date to convert TenantId to convert date for

Converts given date to application's time zone. If timezone setting is not specified, returns given date.

Base date to convert

Time zone converter class

Constructor

A helper class for timezone operations

Maps given windows timezone id to IANA timezone id

Maps given IANA timezone id to windows timezone id

Converts a date from one timezone to another

Converts a utc datetime to a local time based on a timezone

Converts a utc datetime in to a datetimeoffset

Converts a nullable date with a timezone to a nullable datetimeoffset

Converts a date with a timezone to a datetimeoffset

Implements to work with UTC times.

A basic implementation of to store a date range with a timezone. Default timezone is UTC

The Timezone of the datetime range

The StartTime with Offset

The EndTime with Offset

The StartTime in UTC

The EndTime in UTC

The current time based on the timezone

Gets a zoned date range representing yesterday.

Gets a zoned date range representing today.

Gets a zoned date range representing tomorrow.

Gets a zoned date range representing the last month.

Gets a zoned date range representing this month.

Gets a zoned date range representing the next month.

Gets a zoned date range representing the last year.

Gets a zoned date range representing this year.

Gets a zoned date range representing the next year.

Gets a zoned date range representing the last 30 days (30x24 hours) including today.

Gets a zoned date range representing the last 30 days excluding today.

Gets a zoned date range representing the last 7 days (7x24 hours) including today.

Gets a zoned date range representing the last 7 days excluding today.

Converts to .

Combobox value UI type.

Gets/sets arbitrary objects related to this object. Gets null if given key does not exists.

Key

Arbitrary objects related to this object.

This exception type is directly shown to the user.

Additional information about the exception.

An arbitrary error code.

Severity of the exception. Default: Warn.

Constructor.

Constructor for serializing.

Constructor.

Exception message

Constructor.

Exception message Exception severity

Constructor.

Error code Exception message

Constructor.

Exception message Additional information about the exception

Constructor.

Error code Exception message Additional information about the exception

Constructor.

Exception message Inner exception

Constructor.

Exception message Additional information about the exception Inner exception

Used to identify a user.

Tenant Id of the user. Can be null for host users in a multi tenant application.

Id of the user.

Initializes a new instance of the class.

Tenant Id of the user. Id of the user.

Parses given string and creates a new object.

Should be formatted one of the followings: - "userId@tenantId". Ex: "42@3" (for tenant users). - "userId". Ex: 1 (for host users)

Creates a string represents this instance. Formatted one of the followings: - "userId@tenantId". Ex: "42@3" (for tenant users). - "userId". Ex: 1 (for host users) Returning string can be used in method to re-create identical object.

Extension methods for and .

Creates a new object from any object implements .

User identifier.

This class is used to simulate a Disposable that does nothing.

A shortcut for to disable wrapping by default. It sets false to and properties.

Initializes a new instance of the class.

Used to determine how ABP should wrap response on the web layer.

Wrap result on success.

Wrap result on error.

Log errors. Default: true.

Initializes a new instance of the class.

Wrap result on success. Wrap result on error.

Extension methods for class.

Gets an attribute's value from an Xml node.

The Xml node Attribute name Value of the attribute