Exago .NET API Documentation
CreateWeeklySchedule(String,Int32,List<DayOfWeek>,DateTime,Int32,Nullable<TimeSpan>,SchedulerEmailInfo) Method
WebReports.Api.Scheduler Namespace > ReportScheduler Class > CreateWeeklySchedule Method : CreateWeeklySchedule(String,Int32,List<DayOfWeek>,DateTime,Int32,Nullable<TimeSpan>,SchedulerEmailInfo) Method
A friendly name that will appear in the Schedule Name column of the  Schedule Manager.
Indicates the interval at which to run the schedule (e.g. every 2 weeks)

The days of the week that the schedule will run, as an array of Boolean values.

The schedule will run only on the days contained in the array, with the first element of the array representing Sunday, the second element representing Monday, and so on. The array must contain exactly seven Boolean values. Set the value to true to have the schedule run for that day, or false for it to skip that day.

Summary (.NET Xml Comment Files)

The date on which to begin running the schedule.

 If the schedTime argument is null, Exago will use the time component of this argument as the schedule time.
A finite number of executions this schedule will run for. If greater than zero this value will take precedence over rangeEndDate
The time to run the schedule. If no value is provided or the value is null, the Scheduler Service's will look to the time portion of the rangeStartDate or schedDateTime argument instead.
SchedulerEmailInfo object with Information on email addresses, subject and body. If null, the report output will be instead be saved to the <report_path> in the Scheduler Service's configuration file.
Schedule the Api object's active report to run every N weeks. The schedule will repeat until it has run a finite number of times.
Syntax
public System.string CreateWeeklySchedule( 
   System.string name,
   System.int everyNWeeks,
   System.Collections.Generic.List<DayOfWeek> days,
   System.DateTime rangeStartDate,
   System.int rangeEndAfterNOccurrences,
   System.Nullable<TimeSpan> schedTime,
   SchedulerEmailInfo emailInfo
)

Parameters

name
A friendly name that will appear in the Schedule Name column of the  Schedule Manager.
everyNWeeks
Indicates the interval at which to run the schedule (e.g. every 2 weeks)
days

The days of the week that the schedule will run, as an array of Boolean values.

The schedule will run only on the days contained in the array, with the first element of the array representing Sunday, the second element representing Monday, and so on. The array must contain exactly seven Boolean values. Set the value to true to have the schedule run for that day, or false for it to skip that day.

rangeStartDate
Summary (.NET Xml Comment Files)

The date on which to begin running the schedule.

 If the schedTime argument is null, Exago will use the time component of this argument as the schedule time.
rangeEndAfterNOccurrences
A finite number of executions this schedule will run for. If greater than zero this value will take precedence over rangeEndDate
schedTime
The time to run the schedule. If no value is provided or the value is null, the Scheduler Service's will look to the time portion of the rangeStartDate or schedDateTime argument instead.
emailInfo
SchedulerEmailInfo object with Information on email addresses, subject and body. If null, the report output will be instead be saved to the <report_path> in the Scheduler Service's configuration file.

Return Value

jobId string that uniquely identifies the newly created job
See Also

Reference

ReportScheduler Class
ReportScheduler Members
Overload List