Schedule Class Content Studio 5.7 SDK
Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

Specifies a specific schedule definition used by the Content Studio Service Manager.
Inheritance Hierarchy

SystemObject
  ContentStudio.Document.SubscriptionSchedule

Namespace: ContentStudio.Document.Subscription
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax

public class Schedule

The Schedule type exposes the following members.

Constructors

  NameDescription
Public methodSchedule(String)
Initializes a new instance of the Schedule class with a start time set to now and without any weekdays or occurrences.
Public methodSchedule(String, DateTime, Boolean)
Initializes a new instance of the Schedule class.
Public methodSchedule(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.
Top
Properties

  NameDescription
Public propertyEnabled
Gets or sets a value indicating whether this Schedule is enabled.
Public propertyEnd
Gets the point in time when the schedule should be invalid.
Public propertyImmediate
Gets or sets a value indicating whether the schedule indicates that it is immediate.
Public propertyName
Gets the name or the schedule.
Public propertyNextOccurence
Gets the next point in time when the next occurrence, specified by this schedule, should occur.
Public propertyOccurences
Gets the hours (in the 24-hour format) when the schedule is effective.
Public propertyStart
Gets a value that specifies from when the schedule should be effective.
Public propertyWeekDays
Gets an array of week days that defines what days of the week that the schema is effective.
Top
Methods

  NameDescription
Public methodAddOccurences
Adds one or more occurrences to the schedule. If an occurrence already exists in the schedule the value is ignored.
Public methodAddWeekDays
Adds one of more week days to the schedule. If the week day already exists in the schedule the value is ignored.
Public methodClearAll
Clears all days and time occurrences of this instance.
Public methodClearDays
Clears the days collection.
Public methodClearOccurences
Clears the collection occurrences.
Public methodStatic memberCode exampleCreate
Creates the specified Schedule from an Xml source.
Public methodEnsureDaily
Ensures that this schedule applies to all days of the week.
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodStatic memberGetValidationSchema
Gets the validation schema used when validating a single schedule node.
Protected methodMemberwiseClone (Inherited from Object.)
Public methodRemoveOccurences
Removes an occurrence at a specific location.
Public methodRemoveWeekDay
Removes a week day from the collection of week days.
Public methodToString (Inherited from Object.)
Public methodToXml
Writes the content of this Schedule to an XmlWriter.
Top
See Also

Reference