494 lines
19 KiB
XML
494 lines
19 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>xModels</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:xModels.Base.XBaseClass">
|
|
<summary>
|
|
a Base class which carry required things as a Father for it's childs ...
|
|
</summary>
|
|
</member>
|
|
<member name="F:xModels.Base.XBaseClass.LOG_TAG">
|
|
<summary>
|
|
LogTag which Specified for this class ...
|
|
</summary>
|
|
</member>
|
|
<member name="F:xModels.Base.XBaseClass.logger">
|
|
<summary>
|
|
logger instance ...
|
|
</summary>
|
|
</member>
|
|
<member name="M:xModels.Base.XBaseClass.GetLogMessage(System.String)">
|
|
<summary>
|
|
Extract Prepared Log MEssage ...
|
|
</summary>
|
|
<param name="message"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xModels.Base.XBaseClass.LogMessage(System.String,Microsoft.Extensions.Logging.LogLevel)">
|
|
<summary>
|
|
Logging specific Message ...
|
|
</summary>
|
|
<param name="message"></param>
|
|
<param name="logLevel"></param>
|
|
</member>
|
|
<member name="M:xModels.Base.XBaseClass.ConsoleMessage(System.String)">
|
|
<summary>
|
|
Logging specific Message to Console ...
|
|
</summary>
|
|
<param name="message"></param>
|
|
</member>
|
|
<member name="T:xModels.Base.XBaseDescriptor">
|
|
<summary>
|
|
Descriptors classes Map required data for creating Entities on Seeding time ...
|
|
this is a Base Descriptor class ...
|
|
</summary>
|
|
</member>
|
|
<member name="T:xModels.Base.XBaseDto">
|
|
<summary>
|
|
DTO - Data Transfer Objects is a kind of classes which Represent Entities ...
|
|
this is base Dto class ...
|
|
</summary>
|
|
</member>
|
|
<member name="T:xModels.Base.XBaseEntity`1">
|
|
<summary>
|
|
Base Entity Class
|
|
</summary>
|
|
<typeparam name="T"></typeparam>
|
|
</member>
|
|
<member name="P:xModels.Base.XBaseEntity`1.Id">
|
|
<summary>
|
|
Entity Id
|
|
</summary>
|
|
<value>entity unique id</value>
|
|
</member>
|
|
<member name="P:xModels.Base.XBaseEntity`1.Deleted">
|
|
<summary>
|
|
Provided Soft Delete Behaviour ...
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="T:xModels.Base.XBaseEntityDto`1">
|
|
<summary>
|
|
Base Entity Related Dto Class ...
|
|
</summary>
|
|
<typeparam name="TKey"></typeparam>
|
|
</member>
|
|
<member name="P:xModels.Base.XBaseEntityDto`1.Id">
|
|
<summary>
|
|
Entity Id
|
|
</summary>
|
|
<value>entity unique id</value>
|
|
</member>
|
|
<member name="P:xModels.Base.XBaseEntityDto`1.Deleted">
|
|
<summary>
|
|
Provided Soft Delete Behaviour ...
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="T:xModels.Base.XBaseGuidIDEntity">
|
|
<summary>
|
|
a BaseEntity Class which has Id of Guid type
|
|
</summary>
|
|
</member>
|
|
<member name="T:xModels.Base.XBaseIntIDEntity">
|
|
<summary>
|
|
a BaseEntity Class which has Id of int type
|
|
</summary>
|
|
</member>
|
|
<member name="T:xModels.Base.XBaseRangeRequest`1">
|
|
<summary>
|
|
Range Request Classes Carry a List of Objects
|
|
</summary>
|
|
<typeparam name="T"></typeparam>
|
|
</member>
|
|
<member name="T:xModels.Base.XBaseStringIDEntity">
|
|
<summary>
|
|
a BaseEntity Class which has Id of string type
|
|
</summary>
|
|
</member>
|
|
<member name="P:xModels.Dtos.XDeviceDto.Os">
|
|
<summary>
|
|
Operating System
|
|
</summary>
|
|
<value>device operating system identifier</value>
|
|
</member>
|
|
<member name="P:xModels.Dtos.XDeviceDto.OsVersion">
|
|
<summary>
|
|
Operating System Version
|
|
</summary>
|
|
<value>which version of operatin system is in use</value>
|
|
</member>
|
|
<member name="P:xModels.Dtos.XDeviceDto.Browser">
|
|
<summary>
|
|
Device Browser
|
|
</summary>
|
|
<value>the Browser identifier</value>
|
|
</member>
|
|
<member name="P:xModels.Dtos.XDeviceDto.UserAgent">
|
|
<summary>
|
|
Browser Engine Agent
|
|
</summary>
|
|
<value>browser engine Agent</value>
|
|
</member>
|
|
<member name="P:xModels.Dtos.XDeviceDto.DeviceType">
|
|
<summary>
|
|
Type of client Device
|
|
</summary>
|
|
<value>represent device type <see>XDeviceType</see></value>
|
|
</member>
|
|
<member name="T:xModels.Dtos.XObjectResponseResult`1">
|
|
<summary>
|
|
Some Requests Get Object Response Result of Data ...
|
|
</summary>
|
|
</member>
|
|
<member name="T:xModels.Dtos.XPersonDto">
|
|
<summary>
|
|
Since in Many Cases we have to Retrieve Specified User's Minimal
|
|
Infos for Handle Data Transfering, this Dto is Used ...
|
|
</summary>
|
|
</member>
|
|
<member name="T:xModels.Dtos.XQuery">
|
|
<summary>
|
|
Request a Page of Data Based on Query ...
|
|
this can used in every Data Providers ...
|
|
</summary>
|
|
</member>
|
|
<member name="P:xModels.Dtos.XQuery.Filter">
|
|
<summary>
|
|
an string for filtering results
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xModels.Dtos.XQuery.ContainsDetail">
|
|
<summary>
|
|
determines fully load object with it's relational fields or not
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xModels.Dtos.XQuery.SortBy">
|
|
<summary>
|
|
specifiy sorting of items
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="P:xModels.Dtos.XQuery.IsAscending">
|
|
<summary>
|
|
specify sorting direction
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xModels.Dtos.XQuery.Page">
|
|
<summary>
|
|
specify page number
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xModels.Dtos.XQuery.PageSize">
|
|
<summary>
|
|
specify page size
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="T:xModels.Dtos.XQueryResult`1">
|
|
<summary>
|
|
Result of a Requested Page of Data Based on Query ...
|
|
this can used in every Data Providers ...
|
|
</summary>
|
|
</member>
|
|
<member name="P:xModels.Dtos.XQueryResult`1.Items">
|
|
<summary>
|
|
a collection of items for a page ...
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xModels.Dtos.XQueryResult`1.Page">
|
|
<summary>
|
|
Current Page Number ...
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xModels.Dtos.XQueryResult`1.PageSize">
|
|
<summary>
|
|
Current Page Size ...
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xModels.Dtos.XQueryResult`1.TotalPages">
|
|
<summary>
|
|
Total Pages ...
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xModels.Dtos.XQueryResult`1.TotalFilteredPages">
|
|
<summary>
|
|
Total Filtered Items Pages Count ...
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xModels.Dtos.XQueryResult`1.TotalFilteredItems">
|
|
<summary>
|
|
Total Filtered Items ...
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="P:xModels.Dtos.XQueryResult`1.TotalItems">
|
|
<summary>
|
|
Total Exists Items ...
|
|
</summary>
|
|
<value></value>
|
|
</member>
|
|
<member name="T:xModels.Dtos.XValidateRevisionRequest">
|
|
<summary>
|
|
in some cases we have to validate a revision of request, this is a model
|
|
which used to request a revision validator ...
|
|
</summary>
|
|
</member>
|
|
<!-- Badly formed XML comment ignored for member "M:xModels.Extensions.DIExtensions.AddXStore``4(Microsoft.Extensions.DependencyInjection.IServiceCollection,``0,Microsoft.Extensions.DependencyInjection.ServiceLifetime)" -->
|
|
<member name="M:xModels.Extensions.XModelExtensions.IsSameAs(xModels.Dtos.XDeviceDto,xModels.Dtos.XDeviceDto)">
|
|
<summary>
|
|
Check to XDevice instance to be same or not
|
|
</summary>
|
|
<param name="source"></param>
|
|
<param name="dest"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:xModels.Interfaces.IXAuditable">
|
|
<summary>
|
|
Some times we need to wrap Entities by some logs or audits ...
|
|
this class provide Audit fields for an Auditable Entity ...
|
|
</summary>
|
|
</member>
|
|
<member name="M:xModels.Interfaces.IXBaseStore`2.GetAll">
|
|
<summary>
|
|
Retrieve all Exists Items ...
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xModels.Interfaces.IXBaseStore`2.Get(`1)">
|
|
<summary>
|
|
Retrieve specific Item by key ...
|
|
</summary>
|
|
<param name="key"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xModels.Interfaces.IXBaseStore`2.FindMany(System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}})">
|
|
<summary>
|
|
retrieve items based on specific condition ...
|
|
</summary>
|
|
<param name="condition"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xModels.Interfaces.IXBaseStore`2.FindOne(System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}})">
|
|
<summary>
|
|
retrieve item based on specific condition ...
|
|
</summary>
|
|
<param name="condition"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xModels.Interfaces.IXBaseStore`2.Add(`0)">
|
|
<summary>
|
|
add specific item to Store ...
|
|
</summary>
|
|
<param name="item"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xModels.Interfaces.IXBaseStore`2.AddMany(xModels.Base.XBaseRangeRequest{`0})">
|
|
<summary>
|
|
Add a Collection of Items on Store ...
|
|
</summary>
|
|
<param name="items"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xModels.Interfaces.IXBaseStore`2.Remove(`0)">
|
|
<summary>
|
|
Remove an item from store ...
|
|
</summary>
|
|
<param name="item"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xModels.Interfaces.IXBaseStore`2.RemoveByKey(`1)">
|
|
<summary>
|
|
remove an item by it's Key ...
|
|
</summary>
|
|
<param name="key"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xModels.Interfaces.IXBaseStore`2.RemoveMany(xModels.Base.XBaseRangeRequest{`0})">
|
|
<summary>
|
|
remove a collection of items at once ...
|
|
</summary>
|
|
<param name="items"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xModels.Interfaces.IXBaseStore`2.Update(`0,System.Collections.Generic.ICollection{System.String},System.Collections.Generic.ICollection{System.String},System.Collections.Generic.ICollection{System.Collections.Generic.KeyValuePair{System.String,System.Func{`0,System.Object}}},System.Boolean)">
|
|
<summary>
|
|
Update Exists Item in store ...
|
|
</summary>
|
|
<param name="item"></param>
|
|
<param name="propertyWhiteList"></param>
|
|
<param name="propertyBlackList"></param>
|
|
<param name="propertyValueProviders"></param>
|
|
<param name="updateWithNullOrEmptyValues"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xModels.Interfaces.IXBaseStore`2.UpdateMany(xModels.Base.XBaseRangeRequest{`0},System.Collections.Generic.ICollection{System.String},System.Collections.Generic.ICollection{System.String},System.Collections.Generic.ICollection{System.Collections.Generic.KeyValuePair{System.String,System.Func{`0,System.Object}}},System.Boolean)">
|
|
<summary>
|
|
Update a Collection of Exists Items ...
|
|
</summary>
|
|
<param name="items"></param>
|
|
<param name="propertyWhiteList"></param>
|
|
<param name="propertyBlackList"></param>
|
|
<param name="propertyValueProviders"></param>
|
|
<param name="updateWithNullOrEmptyValues"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xModels.Interfaces.IXBaseStore`2.IsExists(System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}})">
|
|
<summary>
|
|
retrieve item(s) exists based on specific condition ...
|
|
</summary>
|
|
<param name="condition"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xModels.Interfaces.IXBaseStore`2.IsExistsByKey(`1)">
|
|
<summary>
|
|
is exists an item by providing it's key ...
|
|
</summary>
|
|
<param name="key"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xModels.Interfaces.IXBaseStore`2.Count">
|
|
<summary>
|
|
Count Exists items ...
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="F:xModels.Providers.XBaseInMemoryStore`2.STORE">
|
|
<summary>
|
|
this is main store of items ...
|
|
</summary>
|
|
<typeparam name="T"></typeparam>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xModels.Providers.XBaseInMemoryStore`2.GetAll">
|
|
<summary>
|
|
Retrieve all Exists Items ...
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xModels.Providers.XBaseInMemoryStore`2.Get(`1)">
|
|
<summary>
|
|
Retrieve specific Item by key ...
|
|
</summary>
|
|
<param name="key"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xModels.Providers.XBaseInMemoryStore`2.FindMany(System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}})">
|
|
<summary>
|
|
retrieve items based on specific condition ...
|
|
</summary>
|
|
<param name="condition"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xModels.Providers.XBaseInMemoryStore`2.FindOne(System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}})">
|
|
<summary>
|
|
retrieve item based on specific condition ...
|
|
</summary>
|
|
<param name="condition"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xModels.Providers.XBaseInMemoryStore`2.Add(`0)">
|
|
<summary>
|
|
add specific item to Store ...
|
|
</summary>
|
|
<param name="item"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xModels.Providers.XBaseInMemoryStore`2.AddMany(xModels.Base.XBaseRangeRequest{`0})">
|
|
<summary>
|
|
Add a Collection of Items on Store ...
|
|
</summary>
|
|
<param name="items"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xModels.Providers.XBaseInMemoryStore`2.Remove(`0)">
|
|
<summary>
|
|
Remove an item from store ...
|
|
</summary>
|
|
<param name="item"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xModels.Providers.XBaseInMemoryStore`2.RemoveByKey(`1)">
|
|
<summary>
|
|
remove an item by it's Key ...
|
|
</summary>
|
|
<param name="key"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xModels.Providers.XBaseInMemoryStore`2.RemoveMany(xModels.Base.XBaseRangeRequest{`0})">
|
|
<summary>
|
|
remove a collection of items at once ...
|
|
</summary>
|
|
<param name="items"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xModels.Providers.XBaseInMemoryStore`2.Update(`0,System.Collections.Generic.ICollection{System.String},System.Collections.Generic.ICollection{System.String},System.Collections.Generic.ICollection{System.Collections.Generic.KeyValuePair{System.String,System.Func{`0,System.Object}}},System.Boolean)">
|
|
<summary>
|
|
Update Exists Item in store ...
|
|
</summary>
|
|
<param name="item"></param>
|
|
<param name="propertyWhiteList"></param>
|
|
<param name="propertyBlackList"></param>
|
|
<param name="propertyValueProviders"></param>
|
|
<param name="updateWithNullOrEmptyValues"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xModels.Providers.XBaseInMemoryStore`2.UpdateMany(xModels.Base.XBaseRangeRequest{`0},System.Collections.Generic.ICollection{System.String},System.Collections.Generic.ICollection{System.String},System.Collections.Generic.ICollection{System.Collections.Generic.KeyValuePair{System.String,System.Func{`0,System.Object}}},System.Boolean)">
|
|
<summary>
|
|
Update a Collection of Exists Items ...
|
|
</summary>
|
|
<param name="items"></param>
|
|
<param name="propertyWhiteList"></param>
|
|
<param name="propertyBlackList"></param>
|
|
<param name="propertyValueProviders"></param>
|
|
<param name="updateWithNullOrEmptyValues"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xModels.Providers.XBaseInMemoryStore`2.IsExists(System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}})">
|
|
<summary>
|
|
retrieve item(s) exists based on specific condition ...
|
|
</summary>
|
|
<param name="condition"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xModels.Providers.XBaseInMemoryStore`2.IsExistsByKey(`1)">
|
|
<summary>
|
|
is exists an item by providing it's key ...
|
|
</summary>
|
|
<param name="key"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xModels.Providers.XBaseInMemoryStore`2.Count">
|
|
<summary>
|
|
Count Exists items ...
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:xModels.Providers.XBaseInMemoryStore`2.SetKey(`0@,`1)">
|
|
<summary>
|
|
set Object Key ...
|
|
</summary>
|
|
<param name="item"></param>
|
|
<param name="id"></param>
|
|
</member>
|
|
<member name="M:xModels.Providers.XBaseInMemoryStore`2.GetKey(`0)">
|
|
<summary>
|
|
Get Object Key ...
|
|
</summary>
|
|
<param name="item"></param>
|
|
<returns></returns>
|
|
</member>
|
|
</members>
|
|
</doc>
|