Files
ThingsGateway/framework/ThingsGateway.Web.Core/ThingsGateway.Web.Core.xml
T
Kimdiego2098 40f29fe399 2.0.0
2023-08-07 15:09:53 +08:00

291 lines
11 KiB
XML

<?xml version="1.0"?>
<doc>
<assembly>
<name>ThingsGateway.Web.Core</name>
</assembly>
<members>
<member name="T:ThingsGateway.Web.Core.AuthComponent">
<summary>
认证相关组件,需要在AddRazorPages前注入
</summary>
</member>
<member name="M:ThingsGateway.Web.Core.AuthComponent.Load(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.ComponentContext)">
<inheritdoc/>
</member>
<member name="T:ThingsGateway.Web.Core.LoggingMonitorComponent">
<summary>
LoggingMonitor操作日志写入数据库插件
</summary>
</member>
<member name="M:ThingsGateway.Web.Core.LoggingMonitorComponent.Load(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.ComponentContext)">
<inheritdoc/>
</member>
<member name="T:ThingsGateway.Web.Core.SignalRComponent">
<summary>
SignalR组件
</summary>
</member>
<member name="M:ThingsGateway.Web.Core.SignalRComponent.Load(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.ComponentContext)">
<inheritdoc/>
</member>
<member name="T:ThingsGateway.Web.Core.BlazorAuthorizeHandler">
<inheritdoc/>
</member>
<member name="M:ThingsGateway.Web.Core.BlazorAuthorizeHandler.HandleAsync(Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext)">
<inheritdoc/>
</member>
<member name="M:ThingsGateway.Web.Core.BlazorAuthorizeHandler.PipelineAsync(Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext,Microsoft.AspNetCore.Http.DefaultHttpContext)">
<inheritdoc/>
</member>
<member name="M:ThingsGateway.Web.Core.BlazorAuthorizeHandler.CheckVerificatFromCacheAsync(Microsoft.AspNetCore.Authorization.AuthorizationHandlerContext)">
<summary>
检查token有效性
</summary>
<param name="context">DefaultHttpContext</param>
<returns></returns>
</member>
<member name="T:ThingsGateway.Web.Core.LogExceptionHandler">
<summary>
全局异常处理提供器,只会捕获未经trycath处理的程序异常
</summary>
</member>
<member name="M:ThingsGateway.Web.Core.LogExceptionHandler.OnExceptionAsync(Microsoft.AspNetCore.Mvc.Filters.ExceptionContext)">
<inheritdoc/>
</member>
<member name="T:ThingsGateway.Web.Core.DatabaseLoggingWriter">
<summary>
数据库写入器
</summary>
</member>
<member name="M:ThingsGateway.Web.Core.DatabaseLoggingWriter.Write(Furion.Logging.LogMessage,System.Boolean)">
<summary>
此方法只会写入经由MVCFilter捕捉的方法日志,对于BlazorServer的内部操作,由<see cref="T:ThingsGateway.Admin.Application.OperDispatchProxy"/>执行
</summary>
<param name="logMsg"></param>
<param name="flush"></param>
</member>
<member name="M:ThingsGateway.Web.Core.DatabaseLoggingWriter.CreateOperationLog(System.String,System.String,ThingsGateway.Web.Core.LoggingMonitorJson,UAParser.ClientInfo)">
<summary>
创建操作日志
</summary>
<param name="operation">操作名称</param>
<param name="path">请求地址</param>
<param name="loggingMonitor">loggingMonitor</param>
<param name="clientInfo">客户端信息</param>
<returns></returns>
</member>
<member name="M:ThingsGateway.Web.Core.DatabaseLoggingWriter.CreateVisitLog(System.String,ThingsGateway.Web.Core.LoggingMonitorJson,UAParser.ClientInfo)">
<summary>
创建访问日志
</summary>
<param name="operation">访问类型</param>
<param name="loggingMonitor">loggingMonitor</param>
<param name="clientInfo">客户端信息</param>
</member>
<member name="T:ThingsGateway.Web.Core.LoggingConst">
<summary>
日志常量
</summary>
</member>
<member name="F:ThingsGateway.Web.Core.LoggingConst.Client">
<summary>
客户端信息
</summary>
</member>
<member name="F:ThingsGateway.Web.Core.LoggingConst.Method">
<summary>
请求方法:POST/GET
</summary>
</member>
<member name="F:ThingsGateway.Web.Core.LoggingConst.Operation">
<summary>
操作名称
</summary>
</member>
<member name="F:ThingsGateway.Web.Core.LoggingConst.Path">
<summary>
请求地址
</summary>
</member>
<member name="T:ThingsGateway.Web.Core.AuthorizationClaims">
<summary>
认证信息
</summary>
</member>
<member name="P:ThingsGateway.Web.Core.AuthorizationClaims.Type">
<summary>
类型
</summary>
</member>
<member name="P:ThingsGateway.Web.Core.AuthorizationClaims.Value">
<summary>
值
</summary>
</member>
<member name="T:ThingsGateway.Web.Core.LogException">
<summary>
异常信息
</summary>
</member>
<member name="P:ThingsGateway.Web.Core.LogException.Message">
<summary>
异常内容
</summary>
</member>
<member name="P:ThingsGateway.Web.Core.LogException.StackTrace">
<summary>
堆栈信息
</summary>
</member>
<member name="P:ThingsGateway.Web.Core.LogException.Type">
<summary>
异常类型
</summary>
</member>
<member name="T:ThingsGateway.Web.Core.LoggingMonitorJson">
<summary>
请求信息格式化
</summary>
</member>
<member name="P:ThingsGateway.Web.Core.LoggingMonitorJson.ActionName">
<summary>
方法名称
</summary>
</member>
<member name="P:ThingsGateway.Web.Core.LoggingMonitorJson.AuthorizationClaims">
<summary>
认证信息
</summary>
</member>
<member name="P:ThingsGateway.Web.Core.LoggingMonitorJson.ControllerName">
<summary>
控制器名
</summary>
</member>
<member name="P:ThingsGateway.Web.Core.LoggingMonitorJson.DisplayName">
<summary>
类名称
</summary>
</member>
<member name="P:ThingsGateway.Web.Core.LoggingMonitorJson.Environment">
<summary>
环境
</summary>
</member>
<member name="P:ThingsGateway.Web.Core.LoggingMonitorJson.Exception">
<summary>
异常信息
</summary>
</member>
<member name="P:ThingsGateway.Web.Core.LoggingMonitorJson.HttpMethod">
<summary>
请求方法
</summary>
</member>
<member name="P:ThingsGateway.Web.Core.LoggingMonitorJson.LocalIPv4">
<summary>
服务端
</summary>
</member>
<member name="P:ThingsGateway.Web.Core.LoggingMonitorJson.LogDateTime">
<summary>
日志时间
</summary>
</member>
<member name="P:ThingsGateway.Web.Core.LoggingMonitorJson.OsArchitecture">
<summary>
系统架构
</summary>
</member>
<member name="P:ThingsGateway.Web.Core.LoggingMonitorJson.OsDescription">
<summary>
系统名称
</summary>
</member>
<member name="P:ThingsGateway.Web.Core.LoggingMonitorJson.Parameters">
<summary>
参数列表
</summary>
</member>
<member name="P:ThingsGateway.Web.Core.LoggingMonitorJson.RemoteIPv4">
<summary>
客户端IPV4地址
</summary>
</member>
<member name="P:ThingsGateway.Web.Core.LoggingMonitorJson.RequestHeaderAuthorization">
<summary>
认证信息
</summary>
</member>
<member name="P:ThingsGateway.Web.Core.LoggingMonitorJson.RequestHeaderCookies">
<summary>
认证信息
</summary>
</member>
<member name="P:ThingsGateway.Web.Core.LoggingMonitorJson.RequestUrl">
<summary>
请求地址
</summary>
</member>
<member name="P:ThingsGateway.Web.Core.LoggingMonitorJson.ReturnInformation">
<summary>
返回信息
</summary>
</member>
<member name="P:ThingsGateway.Web.Core.LoggingMonitorJson.UserAgent">
<summary>
浏览器标识
</summary>
</member>
<member name="P:ThingsGateway.Web.Core.LoggingMonitorJson.Validation">
<summary>
验证错误信息
</summary>
</member>
<member name="T:ThingsGateway.Web.Core.Parameters">
<summary>
请求参数
</summary>
</member>
<member name="P:ThingsGateway.Web.Core.Parameters.Name">
<summary>
参数名
</summary>
</member>
<member name="P:ThingsGateway.Web.Core.Parameters.Value">
<summary>
值
</summary>
</member>
<member name="T:ThingsGateway.Web.Core.ReturnInformation">
<summary>
返回信息
</summary>
</member>
<member name="P:ThingsGateway.Web.Core.ReturnInformation.Value">
<summary>
返回值
</summary>
</member>
<member name="T:ThingsGateway.Web.Core.Validation">
<summary>
验证失败信息
</summary>
</member>
<member name="P:ThingsGateway.Web.Core.Validation.Message">
<summary>
错误详情
</summary>
</member>
<member name="T:ThingsGateway.Web.Core.Startup">
<inheritdoc/>
</member>
<member name="M:ThingsGateway.Web.Core.Startup.Configure(Microsoft.AspNetCore.Builder.IApplicationBuilder,Microsoft.AspNetCore.Hosting.IWebHostEnvironment)">
<inheritdoc/>
</member>
<member name="M:ThingsGateway.Web.Core.Startup.ConfigureServices(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
<inheritdoc/>
</member>
</members>
</doc>