Files
xSaherElmAiApi/bin/Debug/net10.0/xCommons.xml
T

1294 lines
55 KiB
XML

<?xml version="1.0"?>
<doc>
<assembly>
<name>xCommons</name>
</assembly>
<members>
<member name="T:xCommons.Configurations.XAppConfiguration">
<summary>
represent an xBackend Application
</summary>
</member>
<member name="T:xCommons.Constants.XDeviceType">
<summary>
a collection of available Client Devices
</summary>
</member>
<member name="T:xCommons.Controllers.XBaseApiController">
<summary>
Base Api Controller
</summary>
</member>
<member name="T:xCommons.Controllers.XBaseApiV1Controller">
<summary>
Base Api V1 Controller
</summary>
</member>
<member name="T:xCommons.Controllers.XBaseController">
<summary>
Base Controller
</summary>
</member>
<member name="M:xCommons.Controllers.XBaseController.Hi">
<summary>
Check the Controller Up and Running
</summary>
<returns>string message</returns>
</member>
<member name="M:xCommons.Controllers.XBaseController.PassRequireXPowered">
<summary>
Check Controller ByPass XPowered Filter
</summary>
<returns>string message</returns>
</member>
<member name="M:xCommons.Controllers.XBaseController.GetExceptionActionResult(System.Exception)">
<summary>
Convert an Exception to Propper Error Result
</summary>
<param name="ex"></param>
<returns></returns>
</member>
<member name="M:xCommons.Controllers.XBaseController.GetExceptionResult(System.Exception)">
<summary>
Return Structured Exception
</summary>
<param name="ex"></param>
<returns></returns>
</member>
<member name="M:xCommons.Controllers.XBaseController.GetControllerName">
<summary>
Retrieve ControllerName
</summary>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CertificateExtensions.GetCertificate(Microsoft.Extensions.Configuration.IConfiguration,System.String)">
<summary>
Retrieve Specific Certificate From app Settings
</summary>
<param name="configuration"></param>
<param name="name"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.ToString(System.Xml.XmlNode,System.Int32)">
<summary>
Conert XMLNode to String ...
</summary>
<param name="node"></param>
<param name="indentation"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.JSONToDictionary(System.String)">
<summary>
Converts a Json String to Dictionary of String Mappings
</summary>
<param name="source">Json String</param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.ToDictionary``1(``0)">
<summary>
Convert properties of specific Class instance to Dictionary ...
</summary>
<param name="source">class instance</param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.RunTask(System.Threading.Tasks.Task)">
<summary>
run specific task and retrieve result ...
</summary>
<param name="source"></param>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.RunTask``1(System.Threading.Tasks.Task{``0})">
<summary>
run specific task and retrieve result ...
</summary>
<param name="source"></param>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.ToJSON(System.String)">
<summary>
Convert XML String to Json Object ...
</summary>
<param name="source"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.ToJSON``1(``0)">
<summary>
Convert object to Json ...
</summary>
<param name="value"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.ToJSON``1(``0,System.Boolean)">
<summary>
Convert to Json With Support of Camel Casing
</summary>
<param name="value"></param>
<param name="camelCase"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.ToDynamicObject(System.String)">
<summary>
Map to Dynamic Object ...
</summary>
<param name="source"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.ToDynamicObject(System.Object)">
<summary>
Map to Dynamic Object ...
</summary>
<param name="source"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.FromDynamicObject``1(System.Object)">
<summary>
Parse From Dynamic Object ...
</summary>
<param name="source"></param>
<typeparam name="T"></typeparam>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.ConvertTo``1(System.Object)">
<summary>
Convert Type of Object to Safe Type
</summary>
<param name="source"></param>
<typeparam name="T"></typeparam>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.MapConvert``1(``0)">
<summary>
Convert an Instance to another Instance
using AutoMapper dynamic Convertion
</summary>
<param name="source"></param>
<typeparam name="T"></typeparam>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.MapConvert``2(``1)">
<summary>
Convert Using Auto Mapper ...
</summary>
<param name="source"></param>
<typeparam name="T"></typeparam>
<typeparam name="E"></typeparam>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.MapConvert``2(System.Collections.Generic.IEnumerable{``1})">
<summary>
Convert Using Auto Mapper ...
</summary>
<param name="source"></param>
<typeparam name="T"></typeparam>
<typeparam name="E"></typeparam>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.MapConvert``2(System.Collections.Generic.ICollection{``1})">
<summary>
Convert Using Auto Mapper ...
</summary>
<param name="source"></param>
<typeparam name="T"></typeparam>
<typeparam name="E"></typeparam>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.MapConvert``2(System.Collections.Generic.IList{``1})">
<summary>
Convert Using Auto Mapper ...
</summary>
<param name="source"></param>
<typeparam name="T"></typeparam>
<typeparam name="E"></typeparam>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.MapConvert``3(System.Collections.Generic.IDictionary{``0,``2})">
<summary>
Convert Using Auto Mapper ...
</summary>
<param name="source"></param>
<typeparam name="TKey"></typeparam>
<typeparam name="TDest"></typeparam>
<typeparam name="TSource"></typeparam>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.ToStatic``1(System.Object)">
<summary>
Convert a Type to Static Type
</summary>
<param name="source"></param>
<typeparam name="T"></typeparam>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.FromJSON``1(System.String)">
<summary>
Convert From Json String ...
</summary>
<param name="value"></param>
<typeparam name="T"></typeparam>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.FromJSON(System.String,System.Type)">
<summary>
Convert From Json String ...
</summary>
<param name="value"></param>
<param name="type"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.FindTokens(Newtonsoft.Json.Linq.JToken,System.String)">
<summary>
Search a Json String for Specific Node ...
</summary>
<param name="containerToken"></param>
<param name="name"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.ToMd5Bytes(System.String)">
<summary>
Convert to MD5 Bytes ...
</summary>
<param name="source"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.ToMd5String(System.String)">
<summary>
Convert to MD5 String ...
</summary>
<param name="source"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.IsMD5String(System.String)">
<summary>
Check a String is MD5 String or not ...
</summary>
<param name="source"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.ToBytes(System.String)">
<summary>
Convert an string to Byte array Representation ...
</summary>
<param name="source"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.FromBytes(System.Byte[])">
<summary>
Converts Byte Array to String Value ...
</summary>
<param name="source"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.IsNull(System.Object)">
<summary>
Check object is Null ...
</summary>
<param name="source"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.HasChild``1(System.Collections.Generic.IList{``0})">
<summary>
Check collection Has Childs ...
</summary>
<param name="source"></param>
<typeparam name="T"></typeparam>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.HasChild``1(System.Collections.Generic.ICollection{``0})">
<summary>
Check collection Has Childs ...
</summary>
<param name="source"></param>
<typeparam name="T"></typeparam>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.HasChild``1(System.Collections.Generic.IEnumerable{``0})">
<summary>
Check collection Has Childs ...
</summary>
<param name="source"></param>
<typeparam name="T"></typeparam>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.SelectAsync``2(System.Collections.Generic.IEnumerable{``0},System.Func{``0,System.Threading.Tasks.Task{``1}})">
<summary>
Select Async ...
</summary>
<param name="source"></param>
<param name="method"></param>
<typeparam name="TSource"></typeparam>
<typeparam name="TResult"></typeparam>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.ToAsyncEnumerable``1(System.Collections.Generic.IEnumerable{``0},System.Threading.CancellationToken)">
<summary>
Converts an Enumerable to Async Enumerable ...
</summary>
<param name="source"></param>
<param name="cancellationToken"></param>
<typeparam name="T"></typeparam>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.ToModelAsyncEnumerable``1(System.IO.Stream,System.Threading.CancellationToken)">
<summary>
Converts an Stream to Model AsyncEnumerator ...
</summary>
<param name="source"></param>
<param name="cancellationToken"></param>
<typeparam name="T"></typeparam>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.ToStringAsyncEnumerable(System.IO.Stream,System.Threading.CancellationToken)">
<summary>
Converts an Stream to String AsyncEnumerator ...
using Read Line of Stream Reader ...S
</summary>
<param name="source"></param>
<param name="cancellationToken"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.WriteModelToStream``1(System.IO.Stream,``0,System.Threading.CancellationToken)">
<summary>
Write a Model to Stream ...
</summary>
<param name="source">an Stream to Write ...</param>
<param name="model">a Model instance to Write ...</param>
<param name="cancellationToken"></param>
<typeparam name="T"></typeparam>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.WriteJsonToStream(System.IO.Stream,System.String,System.Threading.CancellationToken)">
<summary>
Write a Json String to Stream ...
</summary>
<param name="source">an Stream to Write ...</param>
<param name="json">json string to write ...</param>
<param name="cancellationToken"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.ReadModelFromStream``1(System.IO.Stream,System.Threading.CancellationToken)">
<summary>
Read a Json Model From Stream ...
</summary>
<param name="source"></param>
<param name="cancellationToken"></param>
<typeparam name="T"></typeparam>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.ReadJsonFromStream(System.IO.Stream,System.Threading.CancellationToken)">
<summary>
Reading Json String From Stream ...
</summary>
<param name="source">an Stream to Write ...</param>
<param name="cancellationToken"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.Update``1(System.Collections.Generic.IList{``0},``0,``0)">
<summary>
Update a Collection item ...
</summary>
<param name="source"></param>
<param name="sourceItem"></param>
<param name="updateWith"></param>
<typeparam name="T"></typeparam>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.Update``1(System.Collections.Generic.ICollection{``0},``0,``0)">
<summary>
Update a Collection item ...
</summary>
<param name="source"></param>
<param name="sourceItem"></param>
<param name="updateWith"></param>
<typeparam name="T"></typeparam>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.Update``1(System.Collections.Generic.IEnumerable{``0},``0,``0)">
<summary>
Update a Collection item ...
</summary>
<param name="source"></param>
<param name="sourceItem"></param>
<param name="updateWith"></param>
<typeparam name="T"></typeparam>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.GetNthItems``1(System.Collections.Generic.IList{``0},System.Int32,System.Boolean)">
<summary>
Select and Retrieve Nth Childs of given List ...
</summary>
<param name="source"></param>
<param name="n"></param>
<param name="throwException"></param>
<typeparam name="T"></typeparam>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.GetNthItems``1(System.Collections.Generic.ICollection{``0},System.Int32,System.Boolean)">
<summary>
Select and Retrieve Nth Childs of given List ...
</summary>
<param name="source"></param>
<param name="n"></param>
<param name="throwException"></param>
<typeparam name="T"></typeparam>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.GetNthItems``1(System.Collections.Generic.IEnumerable{``0},System.Int32,System.Boolean)">
<summary>
Select and Retrieve Nth Childs of given List ...
</summary>
<param name="source"></param>
<param name="n"></param>
<param name="throwException"></param>
<typeparam name="T"></typeparam>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.IsNullOrEmpty(System.String)">
<summary>
Check an string is Null or Empty ...
</summary>
<param name="sourse"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.GetStringValue(System.Enum)">
<summary>
Get string Value Attribute of an Enum ...
</summary>
<param name="source"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.GetDigits(System.String)">
<summary>
Extracts digit's of an string ...
</summary>
<param name="source"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.IsDigits(System.String)">
<summary>
Check an string is contains only digits ...
</summary>
<param name="source"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.ToNormalString(System.String)">
<summary>
Convert to normal string, Trim and ToLower ...
</summary>
<param name="source"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.Capitalize(System.String)">
<summary>
Capitalize an string ...
</summary>
<param name="source"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.SummarizeContent(System.String,System.Int32,System.String)">
<summary>
Summarize a Text ...
</summary>
<param name="source"></param>
<param name="maxAllowedLength"></param>
<param name="endsWith"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.IsValidMobileNumber(System.String)">
<summary>
Check an string is a Valid Representation of PhoneNumber ...
</summary>
<param name="source"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.IsValidEmail(System.String)">
<summary>
Check an string is Valid Representation of Email Address ...
</summary>
<param name="source"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.IsValidUrl(System.String)">
<summary>
Check an string is Valid Representation of URL Address ...
</summary>
<param name="url"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.NormalizeUrl(System.String)">
<summary>
check a URL has / at the end, if not add one ...
</summary>
<param name="url"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.IsGuid(System.String)">
<summary>
Check an string is GUID or not ...
</summary>
<param name="source"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.IsDefaultGuid(System.String)">
<summary>
Check Specific Guid string is Default Guid or not ...
</summary>
<param name="guid"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.IsDefaultGuid(System.Guid)">
<summary>
Check Specific Guid is Default Guid or not ...
</summary>
<param name="guid"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.ParseListString``1(System.String,System.Nullable{System.Char})">
<summary>
Parse an String to related Enumerable Items ...
</summary>
<param name="source"></param>
<param name="separator"></param>
<typeparam name="T"></typeparam>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.ParseListGuid(System.String,System.Nullable{System.Char})">
<summary>
Converts a List String Representation to GUid List ...
</summary>
<param name="list"></param>
<param name="separator"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.ToListString``1(System.Collections.Generic.IEnumerable{``0},System.Nullable{System.Char})">
<summary>
Convert a List to List String ...
</summary>
<param name="source"></param>
<param name="separator"></param>
<typeparam name="T"></typeparam>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.Default``1(``0)">
<summary>
get default value of a Type
</summary>
<param name="source"></param>
<typeparam name="T"></typeparam>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.IsNullOrDefault``1(``0)">
<summary>
Check if an object is Null or Default Value
</summary>
<param name="source"></param>
<typeparam name="T"></typeparam>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.ISODateString(System.Int64)">
<summary>
convert a timestamp to ISO String representation ...
</summary>
<param name="timestamp"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.ToTimestamp(System.DateTime)">
<summary>
Converts a DateTime to Unix Like Long ...
</summary>
<param name="source"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.FromTimestamp(System.Int64)">
<summary>
convert timestamp to DateTime ...
</summary>
<param name="timestamp"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.IsExPired(System.DateTime)">
<summary>
Check a Date Time is Expired or not
</summary>
<param name="source"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.IsImageKind(xCommons.Constants.XFileType)">
<summary>
Determines a File Type is Image Kind or not
</summary>
<param name="source"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.ToUrlEncoded(System.String)">
<summary>
Encode String as Url
</summary>
<param name="source"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.ToUrlDecoded(System.String)">
<summary>
Decode Url String
</summary>
<param name="source"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.ToHttpParamString(System.Object,System.Globalization.CultureInfo)">
<summary>
Convert an Object to string for use in HttpParams
</summary>
<param name="value"></param>
<param name="cultureInfo"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.AsHttpParamString(System.Object)">
<summary>
ReShape an Object as HttpParam String
</summary>
<param name="value"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.CommonExtensions.GenerateDateTimeOffset(System.String)">
<summary>
Calculating Date Difference Provider String
and Generate Date based on UTC Time in Milliseconds like unix Date ...
</summary>
<param name="offsetProvider"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.DIExtensions.GetRegisteredService``1(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
<summary>
Inject Specific Registered Service from IServiceCollection
</summary>
<param name="source"></param>
<typeparam name="T"></typeparam>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.DIExtensions.AddXAppConfiguration(Microsoft.Extensions.DependencyInjection.IServiceCollection,Microsoft.Extensions.Configuration.IConfiguration)">
<summary>
Register App Configuration as a Service
</summary>
<param name="services"></param>
<param name="configuration"></param>
</member>
<member name="M:xCommons.Extensions.DIExtensions.AddXSwaggerGenOptions(Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenOptions,System.String,System.Boolean,System.Boolean,System.Boolean)">
<summary>
Add Required OperationFilters and Authorization Fields to Swagger Options
</summary>
<param name="source"></param>
<param name="xmlFilePath"></param>
<param name="addRequiredXPoweredFilter"></param>
<param name="addXTokenAuthorization"></param>
<param name="addDefaultValueFilter"></param>
</member>
<member name="M:xCommons.Extensions.DIExtensions.AddXSwagger(Microsoft.Extensions.DependencyInjection.IServiceCollection,Microsoft.Extensions.Configuration.IConfiguration,Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenOptions,System.String,System.Boolean,System.Boolean,System.Boolean)">
<summary>
Register Swagger
</summary>
<param name="source"></param>
<param name="configuration"></param>
<param name="settings"></param>
<param name="xmlFilePath"></param>
<param name="addRequiredXPoweredFilter"></param>
<param name="addXTokenAuthorization"></param>
<param name="addDefaultValueFilter"></param>
</member>
<member name="M:xCommons.Extensions.DIExtensions.UseXSwagger(Microsoft.AspNetCore.Builder.IApplicationBuilder,Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIOptions)">
<summary>
Use Sagger
</summary>
<param name="source"></param>
<param name="options"></param>
</member>
<member name="M:xCommons.Extensions.DIExtensions.AddXCors(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Add Cross Origin Resource Sharings
</summary>
<param name="source"></param>
<param name="allowedOrigins"></param>
</member>
<member name="M:xCommons.Extensions.DIExtensions.UseXCors(Microsoft.AspNetCore.Builder.IApplicationBuilder)">
<summary>
Use X Registered Cross Origin Resource Sharings
</summary>
<param name="sources"></param>
</member>
<member name="M:xCommons.Extensions.DIExtensions.AddXApiV1Versioning(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
<summary>
Register Api V1 Versioning ...
</summary>
<param name="services"></param>
</member>
<member name="T:xCommons.Extensions.ExceptionExtensions">
<summary>
this is an extension pack for Exceptions
</summary>
</member>
<member name="M:xCommons.Extensions.ExceptionExtensions.IsXError(System.String)">
<summary>
determines an string contains an XError content or not
</summary>
<param name="source"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.ExceptionExtensions.ToXError(System.String)">
<summary>
deserialize an string to to XError class instance
</summary>
<param name="source"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.ExceptionExtensions.ToException(xExceptions.Models.XError)">
<summary>
Convert an XError instance to an Exception
</summary>
<param name="source"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.ExceptionExtensions.FromException(System.Exception)">
<summary>
Convert an Exception to corresponding XError Object
</summary>
<param name="source"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.ExceptionExtensions.AddContentToError(xExceptions.Constants.XException,System.String)">
<summary>
Add Content to Contentable XException member and return XError Object
</summary>
<param name="exception"></param>
<param name="value"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.ExceptionExtensions.AddContentToException(xExceptions.Constants.XException,System.String)">
<summary>
Add Content to Contentable XException member and return Exception Object
</summary>
<param name="exception"></param>
<param name="value"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.ExceptionExtensions.Throw(xExceptions.Constants.XException,System.String)">
<summary>
Throw Specific Exception ...
</summary>
<param name="source"></param>
<param name="content"></param>
</member>
<member name="M:xCommons.Extensions.IConfigurationExtensions.GetXAppConfiguration(Microsoft.Extensions.Configuration.IConfiguration)">
<summary>
Retrieve AppConfiguration from Configurations
</summary>
<param name="source"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.IConfigurationExtensions.GetXSwaggerConfiguration(Microsoft.Extensions.Configuration.IConfiguration)">
<summary>
Retrieve Swagger Configurations
</summary>
<param name="source"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.IConfigurationExtensions.ToObject(Microsoft.Extensions.Configuration.IConfigurationSection)">
<summary>
Converts a ConfigurationSection to object Representation ...
</summary>
<param name="section"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.IConfigurationExtensions.ToJSON(Microsoft.Extensions.Configuration.IConfigurationSection)">
<summary>
Converts a ConfigurationSection to Json Representation ...
</summary>
<param name="section"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.IConfigurationExtensions.GetSectionAsObject(Microsoft.Extensions.Configuration.IConfiguration,System.String)">
<summary>
Get a Configuration Section as Object ...
</summary>
<param name="source"></param>
<param name="section"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.IConfigurationExtensions.GetSectionAsJson(Microsoft.Extensions.Configuration.IConfiguration,System.String)">
<summary>
Retrieve a Configuration Section as Json String ...
</summary>
<param name="source"></param>
<param name="section"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.ModelExtensions.GetDefaultBindingFlag">
<summary>
Retrieve a Binding Flag for Retrieve all Instance Members including
Priate and Public ...
</summary>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.ModelExtensions.UpdateData``2(``0,``1,System.Collections.Generic.ICollection{System.String},System.Collections.Generic.ICollection{System.String},System.Collections.Generic.ICollection{System.Collections.Generic.KeyValuePair{System.String,System.Func{``1,System.Object}}},System.Boolean,System.Boolean)">
<summary>
Update an Instance of a Typed Object with Data Provided by another Instance of Typed Object
</summary>
<param name="source"></param>
<param name="updateWith"></param>
<param name="propertyWhiteList"></param>
<param name="propertyBlackList"></param>
<param name="propertyValueProviders"></param>
<param name="updateWithNullOrEmptyValues"></param>
<param name="throwExceptionOnFails"></param>
<typeparam name="T"></typeparam>
<typeparam name="D"></typeparam>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.ModelExtensions.HasProperty``1(``0,System.String,System.Reflection.BindingFlags)">
<summary>
Check a Class is Contains a Property or not ...
</summary>
<typeparam name="T"></typeparam>
<param name="source"></param>
<param name="property"></param>
<param name="bindingAttr"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.ModelExtensions.HasField``1(``0,System.String,System.Reflection.BindingFlags)">
<summary>
Check a Class is Contains a field or not ...
</summary>
<typeparam name="T"></typeparam>
<param name="source"></param>
<param name="field"></param>
<param name="bindingAttr"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.ModelExtensions.HasMethod``1(``0,System.String,System.Reflection.BindingFlags)">
<summary>
Check a Class is Contains a Method or not ...
</summary>
<typeparam name="T"></typeparam>
<param name="source"></param>
<param name="method"></param>
<param name="bindingAttr"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.ModelExtensions.GetPropertiesNames``1(``0,System.Reflection.BindingFlags)">
<summary>
Retrieve a Class Properties Names ...
</summary>
<typeparam name="T"></typeparam>
<param name="source"></param>
<param name="bindingAttr"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.ModelExtensions.GetFieldsNames``1(``0,System.Reflection.BindingFlags)">
<summary>
Retrieve a Class Fields Names ...
</summary>
<typeparam name="T"></typeparam>
<param name="source"></param>
<param name="bindingAttr"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.ModelExtensions.GetMethodsNames``1(``0,System.Reflection.BindingFlags)">
<summary>
Retrieve a Class Methods Names ...
</summary>
<typeparam name="T"></typeparam>
<param name="source"></param>
<param name="bindingAttr"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.ModelExtensions.GetMembersNames``1(``0,System.Reflection.BindingFlags)">
<summary>
Retrieve a Class Members Names ...
</summary>
<typeparam name="T"></typeparam>
<param name="source"></param>
<param name="bindingAttr"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.ModelExtensions.GetProperty``2(``0,System.String,System.Reflection.BindingFlags)">
<summary>
Get a Class Property Value using Generic Concept ...
</summary>
<typeparam name="T"></typeparam>
<typeparam name="TProp"></typeparam>
<param name="source"></param>
<param name="property"></param>
<param name="bindingAttr"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.ModelExtensions.GetField``2(``0,System.String,System.Reflection.BindingFlags)">
<summary>
Get a Class Field Value using Generic Concept ...
</summary>
<typeparam name="T"></typeparam>
<typeparam name="TField"></typeparam>
<param name="source"></param>
<param name="field"></param>
<param name="bindingAttr"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.ModelExtensions.SetProperty``2(``0,System.String,``1,System.Reflection.BindingFlags)">
<summary>
Set a Class Property Value using Generic Concept ...
</summary>
<typeparam name="T"></typeparam>
<typeparam name="TProp"></typeparam>
<param name="source"></param>
<param name="property"></param>
<param name="value"></param>
<param name="bindingAttr"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.ModelExtensions.SetField``2(``0,System.String,``1,System.Reflection.BindingFlags)">
<summary>
Set a Class Field Value using Generic Concept ...
</summary>
<typeparam name="T"></typeparam>
<typeparam name="TField"></typeparam>
<param name="source"></param>
<param name="field"></param>
<param name="value"></param>
<param name="bindingAttr"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.ModelExtensions.IsSameContent``2(``0,``1,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,``1,System.Boolean}}},System.Boolean)">
<summary>
Check two Instance of Typed Object Values are Same or not
</summary>
<param name="source"></param>
<param name="dest"></param>
<param name="propertyWhiteList"></param>
<param name="propertyBlackList"></param>
<param name="throwExceptionOnFails"></param>
<param name="propertyValueCheckers"></param>
/// <typeparam name="T"></typeparam>
<typeparam name="D"></typeparam>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.ModelExtensions.IsCollectionType(System.Type)">
<summary>
Check specific type is Collection Type or not
</summary>
<param name="source"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.ModelExtensions.GetPropValues``1(``0)">
<summary>
Retrieve a Property Value in Generic
</summary>
<param name="item"></param>
<typeparam name="T"></typeparam>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.ModelExtensions.PropValuesContains``1(``0,System.String)">
<summary>
Check a Property Value Contains specific value
</summary>
<param name="item"></param>
<param name="value"></param>
<typeparam name="T"></typeparam>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.ModelExtensions.GetDefaultColumnsMap``1(``0)">
<summary>
Generate Default Column Map
</summary>
<param name="item"></param>
<typeparam name="T"></typeparam>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.ModelExtensions.GetPropValuesDictionary``1(``0)">
<summary>
Generate Default Column Map
</summary>
<param name="item"></param>
<typeparam name="T"></typeparam>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.ServiceProviderExtensions.GetAllServiceDescriptors(System.IServiceProvider)">
<summary>
Get all registered <see cref="T:Microsoft.Extensions.DependencyInjection.ServiceDescriptor"/>
</summary>
<param name="provider"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.XHttpContextExtensions.ToByteArray(Microsoft.AspNetCore.Http.IFormFile)">
<summary>
Convert IFormFile to Bytes Array
</summary>
<param name="source"></param>
<returns></returns>
</member>
<member name="M:xCommons.Extensions.XMiddlewareExtensions.UseXRequestLogger(Microsoft.AspNetCore.Builder.IApplicationBuilder)">
<summary>
Use XRequestLogger Middleware for log Requests ...
</summary>
<param name="app"></param>
</member>
<member name="T:xCommons.Filters.RequireXPoweredOperationFilter">
<summary>
RequireXPowered for NGSwag
</summary>
</member>
<member name="M:xCommons.Helpers.ObjectHelper.GetKeys``1">
<summary>
Convert Enum Keys to Array
</summary>
<typeparam name="T"></typeparam>
<returns></returns>
</member>
<member name="M:xCommons.Helpers.ObjectHelper.GetValues``1">
<summary>
Convert EnumValues to Array
</summary>
<typeparam name="T"></typeparam>
<returns></returns>
</member>
<member name="M:xCommons.Helpers.ObjectHelper.ToEnumerableValues``1">
<summary>
Convert an Enum to IEnumerable of it's Childs
</summary>
<typeparam name="T"></typeparam>
<returns></returns>
</member>
<member name="M:xCommons.Helpers.ObjectHelper.ToEnumerableKeys``1">
<summary>
Retrieve Keys of an Enumerable
</summary>
<typeparam name="T"></typeparam>
<returns></returns>
</member>
<member name="M:xCommons.Helpers.XDateHelper.UtcNowTimespan">
<summary>
retrieve utc now timestam unix like representation ...
</summary>
<returns></returns>
</member>
<member name="M:xCommons.Helpers.XGenericHelper.InvokeGenericMethod(System.Type,System.String,System.Type,System.Object[])">
<summary>
Invoke a Generic Method of Specified Type ...
</summary>
<param name="source"></param>
<param name="methodName"></param>
<param name="runtimeType"></param>
<param name="args"></param>
</member>
<member name="M:xCommons.Helpers.XGenericHelper.InvokeGenericMethod``1(System.Type,System.String,System.Type,System.Object[])">
<summary>
Invoke a Generic Method of Specified Type ...
</summary>
<typeparam name="TResponse"></typeparam>
<param name="source"></param>
<param name="methodName"></param>
<param name="runtimeType"></param>
<param name="args"></param>
<returns></returns>
</member>
<member name="M:xCommons.Helpers.XGenericHelper.InvokeGenericMethod(System.Type,System.String,System.Type[],System.Object[])">
<summary>
Invoke a Generic Method of Specified Type ...
</summary>
<param name="source"></param>
<param name="methodName"></param>
<param name="runtimeTypes"></param>
<param name="args"></param>
</member>
<member name="M:xCommons.Helpers.XGenericHelper.InvokeGenericMethod``1(System.Type,System.String,System.Type[],System.Object[])">
<summary>
Invoke a Generic Method of Specified Type ...
</summary>
<typeparam name="TResponse"></typeparam>
<param name="source"></param>
<param name="methodName"></param>
<param name="runtimeTypes"></param>
<param name="args"></param>
<returns></returns>
</member>
<member name="M:xCommons.Helpers.XGenericHelper.GetGenericMethodInfo(System.Type,System.String)">
<summary>
Extract a Generic Method's Overloads ...
</summary>
<param name="source"></param>
<param name="methodName"></param>
<returns></returns>
</member>
<member name="M:xCommons.Helpers.XNetworkHelper.GetIp">
<summary>
Retrieve Application Host's Machin IP Addresses ...
</summary>
<returns>string</returns>
</member>
<member name="M:xCommons.Helpers.XNetworkHelper.GetNetworkInfos">
<summary>
Retrieve All Available IP's in Application Host's Machin ...
</summary>
<returns>a Collection of XNetworkInfo class instances</returns>
</member>
<member name="T:xCommons.Helpers.XOSType">
<summary>
Several OS Type ...
</summary>
</member>
<member name="T:xCommons.Helpers.XOSCMDResult">
<summary>
OS Command Execution Result ...
</summary>
</member>
<member name="P:xCommons.Helpers.XOSCMDResult.Result">
<summary>
Execution Result ...
</summary>
<value></value>
</member>
<member name="P:xCommons.Helpers.XOSCMDResult.Error">
<summary>
Execution Error ...
</summary>
<value></value>
</member>
<member name="T:xCommons.Helpers.XOsHelper">
<summary>
a Helper Class which Provides OS Command Executions ...
</summary>
</member>
<member name="M:xCommons.Helpers.XOsHelper.GetOSType">
<summary>
Retrieve OS Type ...
</summary>
<returns></returns>
</member>
<member name="M:xCommons.Helpers.XOsHelper.GetOSDescription">
<summary>
Retrieve OS Description ...
</summary>
<returns></returns>
</member>
<member name="M:xCommons.Helpers.XOsHelper.Execute(System.String,System.String)">
<summary>
Execute an Specified Command ...
</summary>
<param name="cmd">Specified Command</param>
<param name="args">Command Arguments</param>
<returns></returns>
</member>
<member name="P:xCommons.Models.XNetworkInfo.Name">
<summary>
Network Name ...
</summary>
<value></value>
</member>
<member name="P:xCommons.Models.XNetworkInfo.Description">
<summary>
Network Description ...
</summary>
<value></value>
</member>
<member name="P:xCommons.Models.XNetworkInfo.IP">
<summary>
IP Address which Exists on Current Network ...
</summary>
<value></value>
</member>
<member name="P:xCommons.Models.XNetworkInfo.Gateway">
<summary>
Current Networks Gateway Address ...
</summary>
<value></value>
</member>
<member name="P:xCommons.Models.XNetworkInfo.NetworkInterface">
<summary>
Network Interface Object ...
</summary>
<value></value>
</member>
<member name="M:xCommons.Providers.XValidationProvider.NotNull(System.Object[])">
<summary>
given objects must not null
</summary>
<param name="values"></param>
</member>
<member name="M:xCommons.Providers.XValidationProvider.NotEmpty(System.String[])">
<summary>
given strings must not empty or null
</summary>
<param name="values"></param>
</member>
<member name="M:xCommons.Providers.XValidationProvider.NotZero(System.Int32[])">
<summary>
Check a numeric value is bigger than 0
</summary>
<param name="values"></param>
</member>
<member name="M:xCommons.Providers.XValidationProvider.NotZero(System.Int64[])">
<summary>
Check a numeric value is bigger than 0
</summary>
<param name="values"></param>
</member>
<member name="M:xCommons.Providers.XValidationProvider.NotZero(System.Decimal[])">
<summary>
Check a numeric value is bigger than 0
</summary>
<param name="values"></param>
</member>
<member name="M:xCommons.Providers.XValidationProvider.IsGuid(System.String[])">
<summary>
Check a Value is a Valid Guid ...
</summary>
<param name="values"></param>
</member>
<member name="M:xCommons.Providers.XValidationProvider.IsGuid(System.Guid[])">
<summary>
Check a Value is a Valid Guid ...
</summary>
<param name="values"></param>
</member>
<member name="M:xCommons.Providers.XValidationProvider.IsMD5(System.String[])">
<summary>
Check a Value is an MD5 ...
</summary>
<param name="values"></param>
</member>
<member name="M:xCommons.Providers.XValidationProvider.NotZeroChilds(System.Collections.Generic.IEnumerable{System.Object}[])">
<summary>
non zero childs
</summary>
<param name="values"></param>
</member>
<member name="M:xCommons.Providers.XValidationProvider.NotZeroChilds(System.Collections.Generic.ICollection{System.Object}[])">
<summary>
non zero childs
</summary>
<param name="values"></param>
</member>
<member name="M:xCommons.Providers.XValidationProvider.Url(System.String,System.Exception)">
<summary>
given string must be a valid URL ...
</summary>
<param name="url"></param>
<param name="exception"></param>
</member>
<member name="M:xCommons.Providers.XValidationProvider.EmailAddress(System.String,System.Exception)">
<summary>
given string must be a valid Email Address ...
</summary>
<param name="emailAdress"></param>
<param name="exception"></param>
</member>
<member name="M:xCommons.Providers.XValidationProvider.MobileNumber(System.String,System.Exception)">
<summary>
given string must be a valid Mobile Number ...
</summary>
<param name="mobileNumber"></param>
<param name="exception"></param>
</member>
<member name="M:XDIHelperExtension.AddXCommons(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
<summary>
Register XCommons Module Services
</summary>
<param name="services"></param>
</member>
</members>
</doc>