Cis/Cis.Core/Cis.Core.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>Cis.Core</name>
    </assembly>
    <members>
        <member name="M:Cis.Core.CacheSetup.AddCache(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
            <summary>
            Redis 缓存注册
            </summary>
            <param name="services"></param>
        </member>
        <member name="T:Cis.Core.SqlSugarCache">
            <summary>
            SqlSugar二级缓存（必须是内存缓存）
            </summary>
        </member>
        <member name="T:Cis.Core.NotTableAttribute">
            <summary>
            非实体表特性
            </summary>
        </member>
        <member name="F:Cis.Core.SqlSugarConst.DefaultConfigId">
            <summary>
            默认数据库标识
            </summary>
        </member>
        <member name="F:Cis.Core.SqlSugarConst.DefaultPrimaryKey">
            <summary>
            默认表主键
            </summary>
        </member>
        <member name="T:Cis.Core.EntityBaseId">
            <summary>
            框架实体基类Id
            </summary>
        </member>
        <member name="P:Cis.Core.EntityBaseId.Id">
            <summary>
            雪花Id
            </summary>
        </member>
        <member name="T:Cis.Core.EntityBase">
            <summary>
            框架实体基类
            </summary>
        </member>
        <member name="P:Cis.Core.EntityBase.CreateTime">
            <summary>
            创建时间
            </summary>
        </member>
        <member name="P:Cis.Core.EntityBase.UpdateTime">
            <summary>
            更新时间
            </summary>
        </member>
        <member name="P:Cis.Core.EntityBase.CreateUserId">
            <summary>
            创建者Id
            </summary>
        </member>
        <member name="P:Cis.Core.EntityBase.UpdateUserId">
            <summary>
            修改者Id
            </summary>
        </member>
        <member name="P:Cis.Core.EntityBase.IsDelete">
            <summary>
            软删除
            </summary>
        </member>
        <member name="T:Cis.Core.DataEntityBase">
            <summary>
            业务数据实体基类(数据权限)
            </summary>
        </member>
        <member name="P:Cis.Core.DataEntityBase.CreateOrgId">
            <summary>
            创建者部门Id
            </summary>
        </member>
        <member name="P:Cis.Core.Pagination.Index">
            <summary>
            当前页
            </summary>
        </member>
        <member name="P:Cis.Core.Pagination.Size">
            <summary>
            页码容量
            </summary>
        </member>
        <member name="P:Cis.Core.Pagination.Field">
            <summary>
            排序字段
            </summary>
        </member>
        <member name="P:Cis.Core.Pagination.Order">
            <summary>
            排序方向
            </summary>
        </member>
        <member name="P:Cis.Core.Pagination.Total">
            <summary>
            总记录数
            </summary>
        </member>
        <member name="P:Cis.Core.Pagination.Number">
            <summary>
            页码数
            </summary>
        </member>
        <member name="T:Cis.Core.RespParamProvider">
            <summary>
            全局规范化结果
            </summary>
        </member>
        <member name="M:Cis.Core.RespParamProvider.OnException(Microsoft.AspNetCore.Mvc.Filters.ExceptionContext,Furion.FriendlyException.ExceptionMetadata)">
            <summary>
            异常返回值
            </summary>
            <param name="context"></param>
            <param name="metadata"></param>
            <returns></returns>
        </member>
        <member name="M:Cis.Core.RespParamProvider.OnSucceeded(Microsoft.AspNetCore.Mvc.Filters.ActionExecutedContext,System.Object)">
            <summary>
            成功返回值
            </summary>
            <param name="context"></param>
            <param name="data"></param>
            <returns></returns>
        </member>
        <member name="M:Cis.Core.RespParamProvider.OnValidateFailed(Microsoft.AspNetCore.Mvc.Filters.ActionExecutingContext,Furion.DataValidation.ValidationMetadata)">
            <summary>
            验证失败返回值
            </summary>
            <param name="context"></param>
            <param name="metadata"></param>
            <returns></returns>
        </member>
        <member name="M:Cis.Core.RespParamProvider.OnResponseStatusCodes(Microsoft.AspNetCore.Http.HttpContext,System.Int32,Furion.UnifyResult.UnifyResultSettingsOptions)">
            <summary>
            特定状态码返回值
            </summary>
            <param name="context"></param>
            <param name="statusCode"></param>
            <param name="unifyResultSettings"></param>
            <returns></returns>
        </member>
        <member name="M:Cis.Core.RespParamProvider.RESTfulResult(System.Int32,System.Boolean,System.Object,System.Object)">
            <summary>
            返回 RESTful 风格结果集
            </summary>
            <param name="statusCode"></param>
            <param name="succeeded"></param>
            <param name="data"></param>
            <param name="errors"></param>
            <returns></returns>
        </member>
        <member name="T:Cis.Core.RespParam`1">
            <summary>
            全局返回结果
            </summary>
            <typeparam name="T"></typeparam>
        </member>
        <member name="P:Cis.Core.RespParam`1.Code">
            <summary>
            状态码
            </summary>
        </member>
        <member name="P:Cis.Core.RespParam`1.Type">
            <summary>
            类型success、warning、error
            </summary>
        </member>
        <member name="P:Cis.Core.RespParam`1.Message">
            <summary>
            错误信息
            </summary>
        </member>
        <member name="P:Cis.Core.RespParam`1.Data">
            <summary>
            数据
            </summary>
        </member>
        <member name="P:Cis.Core.RespParam`1.Extras">
            <summary>
            附加数据
            </summary>
        </member>
        <member name="P:Cis.Core.RespParam`1.Timestamp">
            <summary>
            时间戳
            </summary>
        </member>
        <member name="M:Cis.Core.Common.ServiceBase`1.Add(`0)">
            <summary>
            添加实体类
            </summary>
            <param name="entity">实体类</param>
            <returns></returns>
        </member>
        <member name="M:Cis.Core.Common.ServiceBase`1.AddReturnId(`0)">
            <summary>
            添加实体类并返回 id
            </summary>
            <param name="entity">实体类</param>
            <returns></returns>
        </member>
        <member name="M:Cis.Core.Common.ServiceBase`1.AddList(System.Collections.Generic.List{`0})">
            <summary>
            批量添加实体类
            </summary>
            <param name="list">实体类列表</param>
            <returns></returns>
        </member>
        <member name="M:Cis.Core.Common.ServiceBase`1.Update(`0)">
            <summary>
            更新实体类
            </summary>
            <param name="entity">实体类</param>
            <returns></returns>
        </member>
        <member name="M:Cis.Core.Common.ServiceBase`1.UpdateList(System.Collections.Generic.List{`0})">
            <summary>
            批量更新实体类
            </summary>
            <param name="list">实体类列表</param>
            <returns></returns>
        </member>
        <member name="M:Cis.Core.Common.ServiceBase`1.Delete(System.Int64)">
            <summary>
            删除实体类
            </summary>
            <param name="id">实体类 id</param>
            <returns></returns>
        </member>
        <member name="M:Cis.Core.Common.ServiceBase`1.DeleteArray(System.String)">
            <summary>
            批量删除实体类
            </summary>
            <param name="ids">实体类数组</param>
            <returns></returns>
        </member>
        <member name="M:Cis.Core.Common.ServiceBase`1.FakeDelete(System.Int64,System.Boolean)">
            <summary>
            假删除实体类
            </summary>
            <param name="id">实体类 id</param>
            <param name="isDelete">是否假删除</param>
            <returns></returns>
        </member>
        <member name="M:Cis.Core.Common.ServiceBase`1.Get(System.Int64)">
            <summary>
            获取实体类
            </summary>
            <param name="id">实体类 id</param>
            <returns></returns>
        </member>
        <member name="M:Cis.Core.Common.ServiceBase`1.GetByQ(System.String)">
            <summary>
            获取实体类
            </summary>
            <param name="queryJson">equal:id,isDelete; between:[startTime,endTime];</param>
            <returns></returns>
        </member>
        <member name="M:Cis.Core.Common.ServiceBase`1.GetList(System.String)">
            <summary>
            批量获取实体类
            </summary>
            <param name="queryJson">equal:isDelete; between:[startTime,endTime];</param>
            <returns></returns>
        </member>
        <member name="M:Cis.Core.Common.ServiceBase`1.GetPageList(System.String,System.String)">
            <summary>
            批量获取分页实体类
            </summary>
            <param name="queryJson">equal:isDelete; between:[startTime,endTime];</param>
            <param name="pagination">index,size</param>
            <returns></returns>
        </member>
        <member name="T:Cis.Core.StatusEnum">
            <summary>
            通用状态枚举
            </summary>
        </member>
        <member name="F:Cis.Core.StatusEnum.Disable">
            <summary>
            停用
            </summary>
        </member>
        <member name="F:Cis.Core.StatusEnum.Enable">
            <summary>
            启用
            </summary>
        </member>
        <member name="T:Cis.Core.ObjectExtension">
            <summary>
            对象拓展
            </summary>
        </member>
        <member name="M:Cis.Core.ObjectExtension.HasImplementedRawGeneric(System.Type,System.Type)">
            <summary>
            判断类型是否实现某个泛型
            </summary>
            <param name="type">类型</param>
            <param name="generic">泛型类型</param>
            <returns>bool</returns>
        </member>
        <member name="M:Cis.Core.ObjectExtension.ToQueryString(System.Collections.Generic.Dictionary{System.String,System.String},System.Boolean)">
            <summary>
            将字典转化为QueryString格式
            </summary>
            <param name="dict"></param>
            <param name="urlEncode"></param>
            <returns></returns>
        </member>
        <member name="M:Cis.Core.ObjectExtension.UrlEncode(System.String)">
            <summary>
            将字符串URL编码
            </summary>
            <param name="str"></param>
            <returns></returns>
        </member>
        <member name="M:Cis.Core.ObjectExtension.ToDataTable``1(System.Collections.Generic.List{``0})">
            <summary>
            List转DataTable
            </summary>
            <typeparam name="T"></typeparam>
            <param name="list"></param>
            <returns></returns>
        </member>
        <member name="M:Cis.Core.ObjectExtension.ToJson(System.Object)">
            <summary>
            对象序列化成Json字符串
            </summary>
            <param name="obj"></param>
            <returns></returns>
        </member>
        <member name="M:Cis.Core.ObjectExtension.ToObject``1(System.String)">
            <summary>
            Json字符串反序列化成对象
            </summary>
            <typeparam name="T"></typeparam>
            <param name="json"></param>
            <returns></returns>
        </member>
        <member name="M:Cis.Core.ObjectExtension.ToJObject(System.String)">
            <summary>
            字串反序列化成linq对象
            </summary>
            <param name="Json">字串</param>
            <returns></returns>
        </member>
        <member name="M:Cis.Core.ObjectExtension.ToSplitObjects(System.String,System.String)">
            <summary>
            字符串拆分转 object[]
            </summary>
            <param name="str"></param>
            <param name="trimstr">默认英文逗号隔开</param>
            <returns></returns>
        </member>
        <member name="M:Cis.Core.ObjectExtension.IsIgnoreColumn(System.Reflection.PropertyInfo)">
            <summary>
            排除SqlSugar忽略的列
            </summary>
            <param name="pi"></param>
            <returns></returns>
        </member>
        <member name="T:Cis.Core.DbConnectionOptions">
            <summary>
            数据库配置选项
            </summary>
        </member>
        <member name="P:Cis.Core.DbConnectionOptions.ConnectionConfigs">
            <summary>
            数据库集合
            </summary>
        </member>
        <member name="P:Cis.Core.DbConnectionConfig.EnableInitDb">
            <summary>
            启用库表初始化
            </summary>
        </member>
        <member name="T:Cis.Core.RedisOptions">
            <summary>
            Redis 配置选项
            </summary>
        </member>
        <member name="P:Cis.Core.RedisOptions.ConnectionString">
            <summary>
            Redis 连接字符串
            </summary>
        </member>
        <member name="T:Cis.Core.SnowIdOptions">
            <summary>
            雪花Id配置选项
            </summary>
        </member>
        <member name="P:Cis.Core.SnowIdOptions.WorkerId">
            <summary>
            机器码
            </summary>
        </member>
        <member name="T:Cis.Core.IEntityFilter">
            <summary>
            自定义实体过滤器接口
            </summary>
        </member>
        <member name="M:Cis.Core.IEntityFilter.AddEntityFilter">
            <summary>
            实体过滤器
            </summary>
            <returns></returns>
        </member>
        <member name="T:Cis.Core.ISqlSugarEntitySeedData`1">
            <summary>
            实体种子数据接口
            </summary>
            <typeparam name="TEntity"></typeparam>
        </member>
        <member name="M:Cis.Core.ISqlSugarEntitySeedData`1.HasData">
            <summary>
            种子数据
            </summary>
            <returns></returns>
        </member>
        <member name="T:Cis.Core.SqlSugarPagedList`1">
            <summary>
            分页泛型集合
            </summary>
            <typeparam name="TEntity"></typeparam>
        </member>
        <member name="P:Cis.Core.SqlSugarPagedList`1.Page">
            <summary>
            页码
            </summary>
        </member>
        <member name="P:Cis.Core.SqlSugarPagedList`1.PageSize">
            <summary>
            页容量
            </summary>
        </member>
        <member name="P:Cis.Core.SqlSugarPagedList`1.Total">
            <summary>
            总条数
            </summary>
        </member>
        <member name="P:Cis.Core.SqlSugarPagedList`1.TotalPages">
            <summary>
            总页数
            </summary>
        </member>
        <member name="P:Cis.Core.SqlSugarPagedList`1.Items">
            <summary>
            当前页集合
            </summary>
        </member>
        <member name="P:Cis.Core.SqlSugarPagedList`1.HasPrevPage">
            <summary>
            是否有上一页
            </summary>
        </member>
        <member name="P:Cis.Core.SqlSugarPagedList`1.HasNextPage">
            <summary>
            是否有下一页
            </summary>
        </member>
        <member name="T:Cis.Core.SqlSugarPagedExtensions">
            <summary>
            分页拓展类
            </summary>
        </member>
        <member name="M:Cis.Core.SqlSugarPagedExtensions.ToPagedList``1(SqlSugar.ISugarQueryable{``0},System.Int32,System.Int32)">
            <summary>
            分页拓展
            </summary>
            <param name="entity"></param>
            <param name="pageIndex"></param>
            <param name="pageSize"></param>
            <returns></returns>
        </member>
        <member name="M:Cis.Core.SqlSugarPagedExtensions.ToPagedListAsync``1(SqlSugar.ISugarQueryable{``0},System.Int32,System.Int32)">
            <summary>
            分页拓展
            </summary>
            <param name="entity"></param>
            <param name="pageIndex"></param>
            <param name="pageSize"></param>
            <returns></returns>
        </member>
        <member name="T:Cis.Core.SqlSugarRepository`1">
            <summary>
            SqlSugar仓储类
            </summary>
            <typeparam name="T"></typeparam>
        </member>
        <member name="M:Cis.Core.SqlSugarSetup.AddSqlSugar(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
            <summary>
            Sqlsugar 上下文初始化
            </summary>
            <param name="services"></param>
        </member>
        <member name="M:Cis.Core.SqlSugarSetup.InitDataBase(SqlSugar.SqlSugarScope,Cis.Core.DbConnectionOptions)">
            <summary>
            初始化数据库结构
            </summary>
        </member>
        <member name="T:Cis.Core.SqlSugarUnitOfWork">
            <summary>
            SqlSugar 事务和工作单元
            </summary>
        </member>
        <member name="F:Cis.Core.SqlSugarUnitOfWork._sqlSugarClient">
            <summary>
            SqlSugar 对象
            </summary>
        </member>
        <member name="M:Cis.Core.SqlSugarUnitOfWork.#ctor(SqlSugar.ISqlSugarClient)">
            <summary>
            构造函数
            </summary>
            <param name="sqlSugarClient"></param>
        </member>
        <member name="M:Cis.Core.SqlSugarUnitOfWork.BeginTransaction(Microsoft.AspNetCore.Mvc.Filters.FilterContext,Furion.DatabaseAccessor.UnitOfWorkAttribute)">
            <summary>
            开启工作单元处理
            </summary>
            <param name="context"></param>
            <param name="unitOfWork"></param>
            <exception cref="T:System.NotImplementedException"></exception>
        </member>
        <member name="M:Cis.Core.SqlSugarUnitOfWork.CommitTransaction(Microsoft.AspNetCore.Mvc.Filters.FilterContext,Furion.DatabaseAccessor.UnitOfWorkAttribute)">
            <summary>
            提交工作单元处理
            </summary>
            <param name="resultContext"></param>
            <param name="unitOfWork"></param>
            <exception cref="T:System.NotImplementedException"></exception>
        </member>
        <member name="M:Cis.Core.SqlSugarUnitOfWork.RollbackTransaction(Microsoft.AspNetCore.Mvc.Filters.FilterContext,Furion.DatabaseAccessor.UnitOfWorkAttribute)">
            <summary>
            回滚工作单元处理
            </summary>
            <param name="resultContext"></param>
            <param name="unitOfWork"></param>
            <exception cref="T:System.NotImplementedException"></exception>
        </member>
        <member name="M:Cis.Core.SqlSugarUnitOfWork.OnCompleted(Microsoft.AspNetCore.Mvc.Filters.FilterContext,Microsoft.AspNetCore.Mvc.Filters.FilterContext)">
            <summary>
            执行完毕（无论成功失败）
            </summary>
            <param name="context"></param>
            <param name="resultContext"></param>
            <exception cref="T:System.NotImplementedException"></exception>
        </member>
    </members>
</doc>