HuanMengAdmin/admin-server/MiaoYu.Core.Quartz/MiaoYu.Core.Quartz.xml
2024-07-18 02:27:50 +08:00

346 lines
12 KiB
XML

<?xml version="1.0"?>
<doc>
<assembly>
<name>MiaoYu.Core.Quartz</name>
</assembly>
<members>
<member name="T:MiaoYu.Core.Quartz.CoreQuartzStartup">
<summary>
</summary>
</member>
<member name="M:MiaoYu.Core.Quartz.CoreQuartzStartup.ConfigureServices(Microsoft.AspNetCore.Builder.WebApplicationBuilder)">
<summary>
</summary>
<param name="webApplicationBuilder"></param>
</member>
<member name="M:MiaoYu.Core.Quartz.CoreQuartzStartup.Configure(Microsoft.AspNetCore.Builder.WebApplication)">
<summary>
</summary>
<param name="webApplication"></param>
</member>
<member name="T:MiaoYu.Core.Quartz.Jobs.MemoryEventJob">
<summary>
本地事件任务
</summary>
</member>
<member name="M:MiaoYu.Core.Quartz.Jobs.MemoryEventJob.Execute(Quartz.IJobExecutionContext)">
<summary>
执行
</summary>
<param name="context"></param>
<returns></returns>
</member>
<member name="T:MiaoYu.Core.Quartz.Jobs.MemoryJob">
<summary>
本地同步任务
</summary>
</member>
<member name="T:MiaoYu.Core.Quartz.Jobs.MemoryJobAsync">
<summary>
异步任务
</summary>
</member>
<member name="T:MiaoYu.Core.Quartz.Jobs.QuartzJobBase`1">
<summary>
任务基础类
</summary>
<typeparam name="TQuartzJobInfo"></typeparam>
</member>
<member name="M:MiaoYu.Core.Quartz.Jobs.QuartzJobBase`1.RunAsync(System.IServiceProvider,`0)">
<summary>
运行逻辑
</summary>
<param name="serviceProvider"></param>
<param name="quartzJobInfo"></param>
<returns></returns>
</member>
<member name="M:MiaoYu.Core.Quartz.Jobs.QuartzJobBase`1.BeforeExecutionAsync(System.IServiceProvider,`0)">
<summary>
执行前
</summary>
<param name="serviceProvider"></param>
<param name="quartzJobInfo"></param>
<returns></returns>
</member>
<member name="M:MiaoYu.Core.Quartz.Jobs.QuartzJobBase`1.OnExitAsync(System.IServiceProvider,`0,System.Object)">
<summary>
执行后,退出
</summary>
<param name="serviceProvider"></param>
<param name="quartzJobInfo"></param>
<param name="result"></param>
<returns></returns>
</member>
<member name="M:MiaoYu.Core.Quartz.Jobs.QuartzJobBase`1.OnSuccessAsync(System.IServiceProvider,`0,System.Object)">
<summary>
成功执行
</summary>
<param name="serviceProvider"></param>
<param name="quartzJobInfo"></param>
<param name="result"></param>
<returns></returns>
</member>
<member name="M:MiaoYu.Core.Quartz.Jobs.QuartzJobBase`1.OnExceptionAsync(System.IServiceProvider,`0,System.Exception)">
<summary>
异常处理
</summary>
<param name="serviceProvider"></param>
<param name="quartzJobInfo"></param>
<param name="exception"></param>
<returns></returns>
</member>
<member name="T:MiaoYu.Core.Quartz.Models.IQuartzJobInfoEntity">
<summary>
作业任务信息
</summary>
</member>
<member name="P:MiaoYu.Core.Quartz.Models.IQuartzJobInfoEntity.JobPoint">
<summary>
定时任务 key
</summary>
</member>
<member name="P:MiaoYu.Core.Quartz.Models.IQuartzJobInfoEntity.Name">
<summary>
任务名称
</summary>
</member>
<member name="P:MiaoYu.Core.Quartz.Models.IQuartzJobInfoEntity.GroupName">
<summary>
分组名称
</summary>
</member>
<member name="P:MiaoYu.Core.Quartz.Models.IQuartzJobInfoEntity.Cron">
<summary>
间隔表达式
</summary>
</member>
<member name="P:MiaoYu.Core.Quartz.Models.IQuartzJobInfoEntity.Remark">
<summary>
备注
</summary>
</member>
<member name="P:MiaoYu.Core.Quartz.Models.IQuartzJobLogEntity.JobId">
<summary>
任务id
</summary>
</member>
<member name="P:MiaoYu.Core.Quartz.Models.IQuartzJobLogEntity.Text">
<summary>
任务日志
</summary>
</member>
<member name="T:MiaoYu.Core.Quartz.Models.QuartzJobEntity">
<summary>
定时任务信息
</summary>
</member>
<member name="P:MiaoYu.Core.Quartz.Models.QuartzJobEntity.JobPoint">
<summary>
</summary>
</member>
<member name="P:MiaoYu.Core.Quartz.Models.QuartzJobEntity.Name">
<summary>
</summary>
</member>
<member name="P:MiaoYu.Core.Quartz.Models.QuartzJobEntity.GroupName">
<summary>
</summary>
</member>
<member name="P:MiaoYu.Core.Quartz.Models.QuartzJobEntity.Cron">
<summary>
</summary>
</member>
<member name="P:MiaoYu.Core.Quartz.Models.QuartzJobEntity.Remark">
<summary>
</summary>
</member>
<member name="T:MiaoYu.Core.Quartz.Models.QuartzJobRequestModeEnum">
<summary>
请求方式
</summary>
</member>
<member name="T:MiaoYu.Core.Quartz.Models.QuartzJobTaskInfo">
<summary>
定时任务信息
</summary>
</member>
<member name="P:MiaoYu.Core.Quartz.Models.QuartzJobTaskInfo.Key">
<summary>
</summary>
</member>
<member name="P:MiaoYu.Core.Quartz.Models.QuartzJobTaskInfo.Name">
<summary>
</summary>
</member>
<member name="P:MiaoYu.Core.Quartz.Models.QuartzJobTaskInfo.GroupName">
<summary>
</summary>
</member>
<member name="P:MiaoYu.Core.Quartz.Models.QuartzJobTaskInfo.Cron">
<summary>
</summary>
</member>
<member name="P:MiaoYu.Core.Quartz.Models.QuartzJobTaskInfo.Remark">
<summary>
</summary>
</member>
<member name="T:MiaoYu.Core.Quartz.Services.IJobTaskInfo">
<summary>
作业任务信息
</summary>
</member>
<member name="P:MiaoYu.Core.Quartz.Services.IJobTaskInfo.Name">
<summary>
任务名称
</summary>
</member>
<member name="P:MiaoYu.Core.Quartz.Services.IJobTaskInfo.GroupName">
<summary>
分组名称
</summary>
</member>
<member name="P:MiaoYu.Core.Quartz.Services.IJobTaskInfo.Cron">
<summary>
定时表达式
</summary>
</member>
<member name="P:MiaoYu.Core.Quartz.Services.IJobTaskInfo.Remark">
<summary>
备注
</summary>
</member>
<member name="T:MiaoYu.Core.Quartz.Services.Impl.DIJobFactory">
<summary>
IJob 对象无法构造注入 需要此类实现 返回 注入后得 Job 实例
</summary>
</member>
<member name="T:MiaoYu.Core.Quartz.Services.Impl.QuartzJobService">
<summary>
任务调度服务
</summary>
</member>
<member name="M:MiaoYu.Core.Quartz.Services.Impl.QuartzJobService.RunAsync``2(``0)">
<summary>
开始运行一个调度器
</summary>
<typeparam name="TJobTaskInfo"></typeparam>
<typeparam name="TJob"></typeparam>
<param name="jobTaskInfo"></param>
<returns></returns>
</member>
<member name="M:MiaoYu.Core.Quartz.Services.Impl.QuartzJobService.RunAsync(System.String,System.String,System.Action{System.ValueTuple{System.String,System.String}},System.String)">
<summary>
开始运行一个调度器
</summary>
<param name="taskName"></param>
<param name="cron"></param>
<param name="call"></param>
<param name="groupName"></param>
<returns></returns>
</member>
<member name="M:MiaoYu.Core.Quartz.Services.Impl.QuartzJobService.CloseAsync(System.String,System.String)">
<summary>
关闭调度器
</summary>
<param name="taskName">任务名称</param>
<param name="groupName">组名称</param>
<returns></returns>
</member>
<member name="M:MiaoYu.Core.Quartz.Services.Impl.QuartzJobService.GetTrigger(System.String,System.String)">
<summary>
判断任务是否存在 和 运行状态
</summary>
<param name="taskName"></param>
<param name="groupName"></param>
<returns></returns>
</member>
<member name="M:MiaoYu.Core.Quartz.Services.Impl.QuartzJobService.IsValidExpression(System.String)">
<summary>
验证 Cron 表达式是否有效
</summary>
<param name="cronExpression"></param>
<returns></returns>
</member>
<member name="T:MiaoYu.Core.Quartz.Services.IQuartzJobService">
<summary>
</summary>
</member>
<member name="M:MiaoYu.Core.Quartz.Services.IQuartzJobService.RunAsync``2(``0)">
<summary>
开始运行一个任务调度器
</summary>
<typeparam name="TJobTaskInfo"></typeparam>
<typeparam name="TJob"></typeparam>
<param name="jobTaskInfo"></param>
<returns></returns>
</member>
<member name="M:MiaoYu.Core.Quartz.Services.IQuartzJobService.RunAsync(System.String,System.String,System.Action{System.ValueTuple{System.String,System.String}},System.String)">
<summary>
开始运行一个任务调度器
</summary>
<param name="taskName">任务名称唯一</param>
<param name="cron">任务表达式</param>
<param name="call">被执行事件</param>
<param name="groupName">分组</param>
<returns></returns>
</member>
<member name="M:MiaoYu.Core.Quartz.Services.IQuartzJobService.GetTrigger(System.String,System.String)">
<summary>
判断任务是否存在 和 运行状态
</summary>
<param name="taskName"></param>
<param name="groupName"></param>
<returns></returns>
</member>
<member name="M:MiaoYu.Core.Quartz.Services.IQuartzJobService.CloseAsync(System.String,System.String)">
<summary>
关闭任务调度
</summary>
<param name="taskName">任务名称</param>
<param name="groupName">组名称</param>
<returns></returns>
</member>
<member name="M:MiaoYu.Core.Quartz.Services.IQuartzJobService.IsValidExpression(System.String)">
<summary>
验证 Cron 表达式是否有效
</summary>
<param name="cronExpression"></param>
<returns></returns>
</member>
<member name="T:MiaoYu.Core.Quartz.Services.QuartzStartupConfig">
<summary>
Quartz 启动配置
</summary>
</member>
<member name="F:MiaoYu.Core.Quartz.Services.QuartzStartupConfig.JobTaskKey">
<summary>
作业任务 Key 名称
</summary>
</member>
<member name="F:MiaoYu.Core.Quartz.Services.QuartzStartupConfig.JobTaskInfoKey">
<summary>
任务信息 key 名称
</summary>
</member>
<member name="F:MiaoYu.Core.Quartz.Services.QuartzStartupConfig.JobTaskInfoCallKey">
<summary>
任务信息回调 key 名称
</summary>
</member>
</members>
</doc>