pluginbase.Objects.Tasks.TaskAttribute Class Reference

Annotates a method in a class as a recurring task. Must use binding extension to active More...

Inheritance diagram for pluginbase.Objects.Tasks.TaskAttribute:

Public Member Functions
	TaskAttribute (double freqSeconds)
	Initializes a new instance of the pluginbase.Objects.Tasks.TaskAttribute class. More...
	TaskAttribute (double freqSeconds, object scopeEnum)
	Initializes a new instance of the pluginbase.Objects.Tasks.TaskAttribute class. More...
Public Member Functions inherited from pluginbase.Helpers.Attributes.ScopeAttribute
	ScopeAttribute ()
	ScopeAttribute (object scopeEnum)
bool	HasScope (Enum scope)
override string	ToString ()

Public Attributes
readonly TimeSpan	Frequency
	The frequency of the running task More...

Additional Inherited Members
Public Types inherited from pluginbase.Helpers.Attributes.ScopeAttribute
enum	Special { Special.Wildcard }
Properties inherited from pluginbase.Helpers.Attributes.ScopeAttribute
Enum	Scope [get, set]
bool	IsFlags [get]
bool	ScopeDefined [get]

Detailed Description

Annotates a method in a class as a recurring task. Must use binding extension to active

Attribute: AttributeUsage(AttributeTargets.Method, AllowMultiple = true, Inherited = true)

Constructor & Destructor Documentation

TaskAttribute() [1/2]

pluginbase.Objects.Tasks.TaskAttribute.TaskAttribute

(

double

freqSeconds

)

Initializes a new instance of the pluginbase.Objects.Tasks.TaskAttribute class.

Parameters

freqSeconds

Frequqnecy of task in seconds.

            :this(freqSeconds, null)
        { }

TaskAttribute() [2/2]

pluginbase.Objects.Tasks.TaskAttribute.TaskAttribute	(	double	freqSeconds,
		object	scopeEnum
	)

Initializes a new instance of the pluginbase.Objects.Tasks.TaskAttribute class.

Parameters

freqSeconds	Freq of tasks in seconds.
scopeEnum	Scopes that apply, comma separated

            : base(scopeEnum)
        {
            this.Frequency = TimeSpan.FromSeconds(freqSeconds);
        }

Member Data Documentation

Frequency

readonly TimeSpan pluginbase.Objects.Tasks.TaskAttribute.Frequency

The frequency of the running task

---

The documentation for this class was generated from the following file:

• pluginbase/Objects/Tasks/TaskAttribute.cs