Share via


TimerJobUtility members

Extends the ContentIterator class to provide additional functionality that is useful for writing timer jobs.

The TimerJobUtility type exposes the following members.

Constructors

  Name Description
Public method TimerJobUtility Initializes a new instance of a TimerJobUtility object.

Top

Properties

  Name Description
Public property Cancel Gets or sets whether the current iteration should be canceled. (Inherited from ContentIterator.)
Public property CancellationGranularity Gets or sets the granularity at which a timer job can be paused or cancelled.
Public property Cancelled Gets a flag that indicates whether the iteration was canceled. (Inherited from ContentIterator.)
Public property DisableEventFiring Gets or sets whether to disable the event receiver firing during the execution of the timer job.
Public property JobState Gets the state of the timer job.
Public property Name Gets or sets the name of the content iterator. (Inherited from ContentIterator.)
Public property ResumeGranularity Gets or sets the granularity at which the timer job will be resumed.
Public property StrictQuerySemantics Gets or sets whether the query should follow strict query semantics. (Inherited from ContentIterator.)

Top

Methods

  Name Description
Public method ExecuteSitesProcessingDirect Iterates over every site collection in the farm. (Inherited from ContentIterator.)
Public method ExecuteTimerJob This member is reserved for internal use and is not intended to be used directly from your code.
Protected method GetMonitoredScopeName (Inherited from ContentIterator.)
Protected method OnProcessedList Executes the timer job process for a specified SPList object. (Overrides ContentIterator.OnProcessedList(String, SPList, String, String).)
Protected method OnProcessedListItemsBatch Executes timer job processing for the specified batch of items (SPListItemCollection object). (Overrides ContentIterator.OnProcessedListItemsBatch(String, SPListItemCollection, Int32, Int32).)
Protected method OnProcessedSite Processes the timer job on the site. (Overrides ContentIterator.OnProcessedSite(SPSite, String).)
Protected method OnProcessedWeb Executes timer job processing for the specified SPWeb object. (Overrides ContentIterator.OnProcessedWeb(String, SPWeb, String).)
Protected method ProcessFile Determines if a SPList object or a SPFolder object has items of a specified content type for a batch of items on a processed file. (Inherited from ContentIterator.)
Public method ProcessFiles(SPListItemCollection, ContentIterator.FileProcessor, ContentIterator.FileProcessorErrorCallout) Iterates over all of the files in an item collection. (Inherited from ContentIterator.)
Public method ProcessFiles(SPListItemCollection, Boolean, ContentIterator.FileProcessor, ContentIterator.FileProcessorErrorCallout) This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ContentIterator.)
Public method ProcessFilesInFolder(SPFolder, Boolean, ContentIterator.FileProcessor, ContentIterator.FileProcessorErrorCallout) Iterates over items in a folder. (Inherited from ContentIterator.)
Public method ProcessFilesInFolder(SPList, SPFolder, Boolean, ContentIterator.FileProcessor, ContentIterator.FileProcessorErrorCallout) Iterates over items in a folder. (Inherited from ContentIterator.)
Public method ProcessItems(SPListItemCollection, ContentIterator.ItemProcessor, ContentIterator.ItemProcessorErrorCallout) Iterates over all items in a collection. (Inherited from ContentIterator.)
Public method ProcessItems(SPListItemCollection, Boolean, ContentIterator.ItemProcessor, ContentIterator.ItemProcessorErrorCallout) Iterates over items in a folder. (Inherited from ContentIterator.)
Public method ProcessItems(SPListItemCollection, Boolean, Boolean, ContentIterator.ItemProcessor, ContentIterator.ItemProcessorErrorCallout) Iterates over items in a folder. (Inherited from ContentIterator.)
Public method ProcessItemsInFolder(SPList, SPFolder, Boolean, Boolean, ContentIterator.ItemProcessor, ContentIterator.ItemProcessorErrorCallout) Iterates over items in a folder. (Inherited from ContentIterator.)
Public method ProcessItemsInFolder(SPList, SPFolder, Boolean, Boolean, Boolean, ContentIterator.ItemProcessor, ContentIterator.ItemProcessorErrorCallout) Iterates over items in a folder. (Inherited from ContentIterator.)
Public method ProcessListItems(SPList, ContentIterator.ItemProcessor, ContentIterator.ItemProcessorErrorCallout) Processes list items. (Inherited from ContentIterator.)
Public method ProcessListItems(SPList, SPQuery, ContentIterator.ItemProcessor, ContentIterator.ItemProcessorErrorCallout) Processes list items. (Inherited from ContentIterator.)
Public method ProcessListItems(SPList, SPQuery, ContentIterator.ItemsProcessor, ContentIterator.ItemsProcessorErrorCallout) Processes list items. (Inherited from ContentIterator.)
Public method ProcessListItems(SPList, Boolean, ContentIterator.ItemProcessor, ContentIterator.ItemProcessorErrorCallout) Processes list items. (Inherited from ContentIterator.)
Public method ProcessListItems(SPList, SPQuery, Boolean, ContentIterator.ItemProcessor, ContentIterator.ItemProcessorErrorCallout) Processes list items. (Inherited from ContentIterator.)
Public method ProcessListItems(SPList, String, Boolean, ContentIterator.ItemsProcessor, ContentIterator.ItemsProcessorErrorCallout) Processes list items. (Inherited from ContentIterator.)
Public method ProcessListItems(SPList, String, UInt32, Boolean, ContentIterator.ItemsProcessor, ContentIterator.ItemsProcessorErrorCallout) Processes list items. (Inherited from ContentIterator.)
Public method ProcessListItems(SPList, String, UInt32, Boolean, SPFolder, ContentIterator.ItemsProcessor, ContentIterator.ItemsProcessorErrorCallout) Processes list items. (Inherited from ContentIterator.)
Public method ProcessLists Processes a collection of lists. (Inherited from ContentIterator.)
Public method ProcessSite(SPSite, ContentIterator.SiteProcessor) Executes timer job processing for the specified site collection.
Public method ProcessSite(SPSite, ContentIterator.WebProcessor, ContentIterator.WebProcessorErrorCallout) Processes all SPSite objects within a site collection. (Inherited from ContentIterator.)
Public method ProcessSite(SPSite, Boolean, ContentIterator.WebProcessor, ContentIterator.WebProcessorErrorCallout) Processes all SPSite objects within the site collection. (Inherited from ContentIterator.)
Public method ProcessSites Processes an SPSiteCollection object. (Inherited from ContentIterator.)
Public method ProcessWorkItem Processes a single work item.
Protected method ResumeProcessListItemsBatch Resumes processing the list of items in a batch. (Overrides ContentIterator.ResumeProcessListItemsBatch(String, String).)
Protected method ResumeProcessLists Resume processing a collection of lists. (Overrides ContentIterator.ResumeProcessLists(String, SPListCollection, [], Int32, Int32).)
Protected method ResumeProcessSites Manages resume for a collection of sites. (Overrides ContentIterator.ResumeProcessSites(SPSiteCollection, [], Int32, Int32).)
Protected method ResumeProcessWebs Resumes processing webs. (Overrides ContentIterator.ResumeProcessWebs(String, SPWebCollection, [], Int32, Int32).)
Public method ShouldCancel Determines whether the iteration should be cancelled at the specified granularity. (Inherited from ContentIterator.)
Protected method ShouldCancelCore Determines whether the iteration should be cancelled. (Overrides ContentIterator.ShouldCancelCore(IterationGranularity).)
Public methodStatic member ValidateLockType Validates the lock type.

Top

See also

Reference

TimerJobUtility class

Microsoft.Office.Server.Utilities namespace