View Source

Class ContentScheduleCollection

Inheritance

System.Object

Namespace: Umbraco.Core.Models

Assembly: Umbraco.Core.dll

Syntax

public class ContentScheduleCollection : INotifyCollectionChanged, IDeepCloneable, IEquatable<ContentScheduleCollection>

Properties

FullSchedule

Returns all schedules registered

Declaration

public IReadOnlyList<ContentSchedule> FullSchedule { get; }

Property Value

Type	Description
System.Collections.Generic.IReadOnlyList<ContentSchedule>

Methods

Add(Nullable<DateTime>, Nullable<DateTime>)

Adds a new schedule for invariant content

Declaration

public bool Add(DateTime? releaseDate, DateTime? expireDate)

Parameters

Type	Name	Description
System.Nullable<System.DateTime>	releaseDate
System.Nullable<System.DateTime>	expireDate

Returns

Type	Description
System.Boolean

Add(String, Nullable<DateTime>, Nullable<DateTime>)

Adds a new schedule for a culture

Declaration

public bool Add(string culture, DateTime? releaseDate, DateTime? expireDate)

Parameters

Type	Name	Description
System.String	culture
System.Nullable<System.DateTime>	releaseDate
System.Nullable<System.DateTime>	expireDate

Returns

Type	Description
System.Boolean	true if successfully added, false if validation fails

Add(ContentSchedule)

Add an existing schedule

Declaration

public void Add(ContentSchedule schedule)

Parameters

Type	Name	Description
ContentSchedule	schedule

Clear(String, ContentScheduleAction, Nullable<DateTime>)

Clear all of the scheduled change type for the culture

Declaration

public void Clear(string culture, ContentScheduleAction action, DateTime? date = null)

Parameters

Type	Name	Description
System.String	culture
ContentScheduleAction	action
System.Nullable<System.DateTime>	date	If specified, will clear all entries with dates less than or equal to the value

Clear(ContentScheduleAction, Nullable<DateTime>)

Clear all of the scheduled change type for invariant content

Declaration

public void Clear(ContentScheduleAction action, DateTime? changeDate = null)

Parameters

Type	Name	Description
ContentScheduleAction	action
System.Nullable<System.DateTime>	changeDate	If specified, will clear all entries with dates less than or equal to the value

ClearCollectionChangedEvents()

Clears all CollectionChanged event handlers

Declaration

public void ClearCollectionChangedEvents()

DeepClone()

Declaration

public object DeepClone()

Returns

Type	Description
System.Object

Equals(Object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj

Returns

Type	Description
System.Boolean

Equals(ContentScheduleCollection)

Declaration

public bool Equals(ContentScheduleCollection other)

Parameters

Type	Name	Description
ContentScheduleCollection	other

Returns

Type	Description
System.Boolean

GetPending(ContentScheduleAction, DateTime)

Returns all pending schedules based on the date and type provided

Declaration

public IReadOnlyList<ContentSchedule> GetPending(ContentScheduleAction action, DateTime date)

Parameters

Type	Name	Description
ContentScheduleAction	action
System.DateTime	date

Returns

Type	Description
System.Collections.Generic.IReadOnlyList<ContentSchedule>

GetSchedule(Nullable<ContentScheduleAction>)

Gets the schedule for invariant content

Declaration

public IEnumerable<ContentSchedule> GetSchedule(ContentScheduleAction? action = null)

Parameters

Type	Name	Description
System.Nullable<ContentScheduleAction>	action

Returns

Type	Description
System.Collections.Generic.IEnumerable<ContentSchedule>

GetSchedule(String, Nullable<ContentScheduleAction>)

Gets the schedule for a culture

Declaration

public IEnumerable<ContentSchedule> GetSchedule(string culture, ContentScheduleAction? action = null)

Parameters

Type	Name	Description
System.String	culture
System.Nullable<ContentScheduleAction>	action

Returns

Type	Description
System.Collections.Generic.IEnumerable<ContentSchedule>

Remove(ContentSchedule)

Remove a scheduled change

Declaration

public void Remove(ContentSchedule change)

Parameters

Type	Name	Description
ContentSchedule	change

Events

CollectionChanged

Declaration

public event NotifyCollectionChangedEventHandler CollectionChanged

Event Type

Type	Description
System.Collections.Specialized.NotifyCollectionChangedEventHandler