[]
        
(Showing Draft Content)

GrapeCity.Forguncy.ServerApi.ScheduleApiAttribute

类 ScheduleApiAttribute

指定该Action应定期执行。

继承
object
System.Attribute
ScheduleApiAttribute
命名空间: GrapeCity.Forguncy.ServerApi
程序集: GrapeCity.Forguncy.ServerApi.dll
语法
public class ScheduleApiAttribute : Attribute

构造函数

ScheduleApiAttribute(string, string)

指定这是在指定的时间和时间间隔内执行的预定Action。

声明
public ScheduleApiAttribute(string startWhen, string interval)
参数
类型 名称 描述
string startWhen

定期执行时间。 如 "12:30:00"。

string interval

定期执行的时间间隔。 应指定为字符串,如 "7"。

示例

下面的代码示例是一种每周12:30运行(每周7天)的方法。

public class Class1 : ForguncyApi
{
    [ScheduleApi("12:30:0", "7")]
    public void SampleScheduleApi1()
    {
        //在这里描述过程。
    }
}

ScheduleApiAttribute(string)

指定Action应以指定的时间间隔定期执行。

声明
public ScheduleApiAttribute(string interval)
参数
类型 名称 描述
string interval

定期处理间隔。 用诸如“ 3:0:0”之类的字符串指定。

示例

下面是一个每三小时运行一次的方法的示例代码。

public class Class1 : ForguncyApi
{
    [ScheduleApi("3:0:0")]
    public void SampleScheduleApi2()
    {
        //在这里描述过程。
    }
}

属性

Interval

获取当前设置的定期执行间隔。

声明
public TimeSpan Interval { get; }
属性值
类型 描述
System.TimeSpan

IsValid

获取设置的间隔是否有效。

声明
public bool IsValid { get; }
属性值
类型 描述
bool

StartWhen

获取当前设置的定期执行的执行时间。

声明
public TimeSpan StartWhen { get; }
属性值
类型 描述
System.TimeSpan

StartWhenServerStart

获取是否从Forguncy Server启动时开始安排运行。

声明
public bool StartWhenServerStart { get; }
属性值
类型 描述
bool