Share via

SPSiteSequence members

  • Article

Abstract class that represents the upgrade sequence for a site collection.

The SPSiteSequence type exposes the following members.

Constructors

  Name Description
Protected method SPSiteSequence Initializes a new instance of the SPSiteSequence class.

Top

Properties

  Name Description
Protected property Actions Gets the actions for the action sequence. (Inherited from SPActionSequence.)
Public property Applicable Obsolete. Reserved for internal use. This property is deprecated. (Inherited from SPSequence.)
Public property ApplicableRootWebTemplate If this site sequence is only applicable to a special root web template, return the number. otherwise, return 0.
Public property CanUpgrade Gets a Boolean value that indicates whether the site collection can be upgraded. (Overrides SPSequence.CanUpgrade.)
Public property ContentDatabase Property for typed upgradable object.
Public property ContentDatabaseConnectionString Gets the connection string for the content database of the site collection.
Public property ContinueOnFailure Fail-forward by default for an SPSite. (Overrides SPSequence.ContinueOnFailure.)
Protected property HierarchyManager Gets the SPHierarchyManager object used by the SPSequence object. (Inherited from SPSequence.)
Protected property Id Gets the ID of the sequence. (Inherited from SPSequence.)
Public property IsApplicable Gets a Boolean that indicates whether the current upgrade sequence should be executed during the upgrade operation based the state of the site collection object. (Overrides SPSequence.IsApplicable.)
Public property IsBackwardsCompatible Determines whether or not this object is within the backwards compatible range. (Inherited from SPSequence.)
Public property Log Gets an SPLog object that represents the log of the upgrade session. The upgrade session object can be retrieved by the Session property. (Inherited from SPDelegate.)
Protected property Manager Gets the Microsoft SharePoint Foundation Upgrade Manager. (Inherited from SPDelegate.)
Public property NeedsUpgrade Gets or sets a Boolean value that specifies whether the sequence object needs an upgrade. (Inherited from SPSequence.)
Protected property Object Gets the delegating object. (Inherited from SPDelegate.)
Public property PlaceHolderSequence This sequence does not have any upgrade logic (yet) (Inherited from SPSequence.)
Public property SchemaVersion Gets or sets the schema version of the site collection sequence.
Protected property Session Gets the upgrade session of the delegate. (Inherited from SPDelegate.)
Public property Site Gets the site collection that is being upgraded by the sequence.
Protected property Stopped Gets or sets a Boolean value that specifies whether the upgrade is stopped. (Inherited from StopEventReceiver.)
Public property TargetCompatibilityLevel Determines target compatibility level for this site collection based on the site compatibility level and upgrade flags.
Public property TargetSchemaVersion Gets the target schema version for the site collection upgrade sequence.
Protected property Type Gets the type of the delegate. (Inherited from SPDelegate.)
Protected property UpgradableObject Gets the object of UpgradableObject type which is being upgraded by this sequence. (Inherited from SPSequence.)

Top

Methods

  Name Description
Public method AddNextLevelObjects Adds any objects that should be upgraded after the current upgradable object has finished being upgraded. The current upgradable object can be retrieved by the UpgradableObject method. (Inherited from SPSequence.)
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method FinalizeUpgrade Performs an explicitly called operation to finalize upgrade.  (Inherited from SPSequence.)
Protected method GetAllVersions Get the associated version for all SPSiteSequences of this SPSite.
Public method GetHashCode (Inherited from Object.)
Public method GetProperty Returns one of the per-sequence properties from the upgrade config files (Inherited from SPSequence.)
Public method GetType (Inherited from Object.)
Protected method GetVersion Returns the associated site collection version based on the specified ID and default version.
Public method Initialize Initializes the upgrade sequence for the specified object. (Inherited from SPSequence.)
Protected method IsRootWebTemplate A protected method that determines if the root Web is using a Web template as specified by the templateId parameter.
Protected method MemberwiseClone (Inherited from Object.)
Public method PostUpgrade Executed by the SharePoint upgrade infrastructure after the IUpgrader.Upgrade method is implemented. (Inherited from SPActionSequence.)
Public method PreUpgrade Executed by the SharePoint upgrade infrastructure before the IUpgrader.Upgrade method is implemented. (Inherited from SPActionSequence.)
Public method SetPostUpgradeDependencies By default this object has no post-upgrade dependencies. (Inherited from SPSequence.)
Public method SetPreUpgradeDependencies By default this object has no pre-upgrade dependencies. (Inherited from SPSequence.)
Protected method SetVersion Sets the version of the site collection sequence within the Versions table of the Microsoft SharePoint Foundation database.
Public method ToString (Inherited from Object.)
Public method Upgrade Executes the upgrade logic. (Inherited from SPActionSequence.)

Top

Events

  Name Description
Public event UpdatingProgress Occurs while the upgrade is in progress. (Inherited from SPActionSequence.)

Top

See also

Reference

SPSiteSequence class

Microsoft.SharePoint.Upgrade namespace