Content Studio Web Content Management System
SystemObject
ContentStudio.Document.SubscriptionSchedule
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Top
Top
Top
[This is preliminary documentation and is subject to change.]
Specifies a specific schedule definition used by the Content Studio Service Manager.
Inheritance Hierarchy
ContentStudio.Document.SubscriptionSchedule
Namespace: ContentStudio.Document.Subscription
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
The Schedule type exposes the following members.
Constructors
Name | Description | |
---|---|---|
Schedule(String) |
Initializes a new instance of the Schedule class with a start time set to now
and without any weekdays or occurrences.
| |
Schedule(String, DateTime, Boolean) |
Initializes a new instance of the Schedule class.
| |
Schedule(String, DateTime, Boolean, NullableDateTime) |
Initializes a new instance of the Schedule class
with a start date value and whether this schedule specifies an the next occurrence to be immediate.
Additionally there is an option to provide a value that specifies when the schedule will expire.
The schedule is without any weekdays or occurrences.
|
Properties
Name | Description | |
---|---|---|
Enabled |
Gets or sets a value indicating whether this Schedule is enabled.
| |
End |
Gets the point in time when the schedule should be invalid.
| |
Immediate |
Gets or sets a value indicating whether the schedule indicates that it is immediate.
| |
Name |
Gets the name or the schedule.
| |
NextOccurence |
Gets the next point in time when the next occurrence,
specified by this schedule, should occur.
| |
Occurences |
Gets the hours (in the 24-hour format) when the schedule is effective.
| |
Start |
Gets a value that specifies from when the schedule should be effective.
| |
WeekDays |
Gets an array of week days that defines what days of the week that
the schema is effective.
|
Methods
Name | Description | |
---|---|---|
AddOccurences |
Adds one or more occurrences to the schedule.
If an occurrence already exists in the schedule the value is ignored.
| |
AddWeekDays |
Adds one of more week days to the schedule.
If the week day already exists in the schedule the value is ignored.
| |
ClearAll |
Clears all days and time occurrences of this instance.
| |
ClearDays |
Clears the days collection.
| |
ClearOccurences |
Clears the collection occurrences.
| |
Create |
Creates the specified Schedule from an Xml source.
| |
EnsureDaily |
Ensures that this schedule applies to all days of the week.
| |
Equals | (Inherited from Object.) | |
Finalize | (Inherited from Object.) | |
GetHashCode | (Inherited from Object.) | |
GetType | (Inherited from Object.) | |
GetValidationSchema |
Gets the validation schema used when validating a single schedule node.
| |
MemberwiseClone | (Inherited from Object.) | |
RemoveOccurences |
Removes an occurrence at a specific location.
| |
RemoveWeekDay |
Removes a week day from the collection of week days.
| |
ToString | (Inherited from Object.) | |
ToXml |
Writes the content of this Schedule to an XmlWriter.
|
See Also