Share via

Microsoft.Synchronization Namespace

  • Article

The core components of Sync Framework can be used to manage metadata and to create synchronization providers and applications. Some types in this namespace are also used by Sync Framework database providers.

Classes

  Class Description
Public class ActiveChangeApplicationContextException The exception that is thrown by the change application service when an active ChangeApplicationContext object has not been fully processed and a second ChangeApplicationContext object is requested.
Public class ChangeApplicationContext Represents information returned by the change application service about a change to be applied.
Public class ChangeApplicationServices Represents a change application service object that can be used to perform change application actions individually.
Public class ChangeBatch Represents metadata for a set of changes. This class cannot be inherited.
Public class ChangeBatchBase When overridden by a derived class, represents metadata for a set of changes.
Public class ChangeBatchIsReadOnlyException The exception that is thrown when an item change or conflict is added to a ChangeBatch object that is read-only.
Public class ChangeBatchNeedsFilterForgottenKnowledgeException The exception that is thrown when a required filter forgotten knowledge is not set in the change batch.
Public class ChangeBatchNeedsKnowledgeException The exception that is thrown when a change batch object does not contain learned knowledge.
Public class ChangeCountMismatchException The exception that is thrown by a change applier when the number of destination item versions does not match the number of source item changes.
Public class ChangeDataAdapter An abstract class that, when overridden in a derived class, converts data between a managed provider and an unmanaged provider.
Public class ChangeDeferredByProviderException The exception that is thrown when a provider defers applying a change to the next synchronization session.
Public class ChangeNeedsKnowledgeException The exception that is thrown when an ItemChange object does not contain required knowledge.
Public class ChangeNotExpectedException The exception that is thrown by a change applier when the order of destination item versions or change unit versions is not the same as the order of source item changes or change unit changes.
Public class ChangeUnitChange Represents a change to a change unit that is contained in an item. This class cannot be inherited.
Public class ChangeUnitCountMismatchException The exception that is thrown by a change applier when the number of change units in a destination item version does not match the number of change units in the corresponding source item change.
Public class ChangeUnitListFilterInfo Represents a filter that can be used to control which change units are included for items in a ChangeBatch object.
Public class ChangeVersionNotInKnowledgeException The exception that is thrown by a change applier when the version of a source item change is not contained in the associated knowledge.
Public class ClockVector Represents a clock vector in a knowledge structure. This class cannot be inherited.
Public class ClockVectorElement Represents a clock vector element of a knowledge structure. This class cannot be inherited.
Public class CombinedFilterInfo Represents information about a filter that is the combination of two or more filters.
Public class CreateFailuresMustBeForEntireItemException The exception that is thrown by SaveChangeWithChangeUnitsContext or LoadChangeContext when a recoverable error is recorded for a change unit change when the change represents an item creation.
Public class CustomFilterInfo Represents information about a custom filter.
Public class CustomIdFormatRequiresIdGeneratorException The exception that is thrown when a custom ID format is specified in the IdFormats property of a provider, but the provider does not implement ISimpleSyncProviderIdGenerator.
Public class DuplicateItemException The exception that is thrown when an attempt is made to add an entry to a replica key map, and either the replica ID or the replica key already exists in the map.
Public class DuplicateItemInMetadataStoreException The exception that is thrown when a provider attempts to add an item that already exists to the metadata store.
Public class FilterChange Represents information about a change that causes an item to move in or out of a filter.
Public class FilterInfo When overridden in a derived class, represents information about the filter used to control the data that is included in a ChangeBatch object.
Public class FilterKeyMap Represents a mapping between filter keys and ISyncFilter objects.
Public class ForgottenKnowledge Represents knowledge that has been forgotten because of tombstone cleanup.
Public class ForgottenKnowledgeNotContainedException The exception that is thrown when a ForgottenKnowledge object is not contained by its associated SyncKnowledge object.
Public class FrameworkVersionMismatchException The exception that is thrown when the Sync Framework version for the simple provider does not match the Sync Framework version of the associated metadata store.
Public class FullEnumerationChangeBatch Represents metadata for a set of changes for a full enumeration. This class cannot be inherited.
Public class FullEnumerationExpectedException The exception that is thrown when the change batch to be processed by the change application service is part of a recovery synchronization, but the change application service is not in recovery synchronization mode.
Public class FullEnumerationNeededEventArgs Provides data for the SyncCallbacks.FullEnumerationNeeded event.
Public class IncompleteReplicaKeyMapException The exception that is thrown by KnowledgeBuilder when KnowledgeBuilder.ReplicaKeyMap is found to be incomplete in some way.
Public class InvalidFeedException The exception that is thrown when a FeedSync feed is invalid.
Public class InvalidKnowledgeMarkerException The exception that is thrown when a specified knowledge marker is not the kind of marker contained in a knowledge object.
Public class InvalidKnowledgeVersionException The exception that is thrown when a component is passed a knowledge version that it does not support.
Public class InvalidOrderException The exception that is thrown when an attempt is made to create a clock vector that contains clock vector elements that are not correctly ordered.
Public class InvalidReplicaKeyException The exception that is thrown when a clock vector is added to a KnowledgeBuilder object, but the clock vector contains an element that contains a replica key that is not found in KnowledgeBuilder.ReplicaKeyMap.
Public class InvalidSerializationVersionException The exception that is thrown when an object is serialized, and the object contains elements that are incompatible with the specified serialization version.
Public class InvalidSyncTimeException The exception that is thrown when a FeedClockVectorElement object is created by using an invalid SyncTime value.
Public class ItemChange Represent a change to an item. This class cannot be inherited.
Public class ItemChangeSkippedEventArgs Provides data for the ItemChangeSkipped event.
Public class ItemChangeUnitOverride Represents a change unit and an associated clock vector that differs from the scope clock vector of the parent knowledge object. This class cannot be inherited.
Public class ItemChangingEventArgs Provides data for the ItemChanging event.
Public class ItemConflictingEventArgs Provides data for the ItemConflicting event.
Public class ItemConstraintEventArgs Provides data for the ItemConstraint event.
Public class ItemDataModifiedConcurrentlyException The exception that is thrown by a synchronization provider when item data changes unexpectedly.
Public class ItemHasChangeUnitsException The exception that is thrown when an attempt is made to get or set the ChangeVersion property on an ItemChange object that contains change units.
Public class ItemHasNoChangeUnitsException The exception that is thrown when a method is called that requires an item to have change units, but the item does not have change units.
Public class ItemHasNoDataException The exception that is thrown when a provider tries to load data for an item that does not exist.
Public class ItemHasNoVersionDataException The exception that is thrown when an ItemChange object does not have the version data that is requested.
Public class ItemListFilteredFullEnumerationNotSupportedException The exception that is thrown by the change application service when the destination provider is using an item filter, and the change batch to be processed is part of a recovery synchronization.
Public class ItemListFilterInfo Represents information about the filter that is used to control which item changes are included in a ChangeBatch object.
Public class ItemMustExistException The exception that is thrown when a provider reports that an item does not exist, although the creation version of the item is contained in the knowledge from that provider.
Public class ItemNotFoundInMetadataStoreException The exception that is thrown when a simple provider attempts to access an item that does not have an entry in the metadata store.
Public class ItemNotInFeedMetadataException The exception that is thrown when an attempt is made to load item data from a FeedSync feed when the item does not exist in the feed.
Public class ItemOverride Represents an item and an associated clock vector that differs from the scope clock vector of the parent knowledge object. This class cannot be inherited.
Public class ItemRangeOverride Represents an item ID range and an associated clock vector that differs from the scope clock vector of the parent knowledge object. This class cannot be inherited.
Public class KnowledgeBuilder Reconstructs a SyncKnowledge object from its constituent parts.
Public class KnowledgeCookie Represents a lightweight, read-only representation of a knowledge object that can be used for fast comparisons.
Public class KnowledgeDecreasedUnexpectedlyException The exception that is thrown when synchronization knowledge decreases unexpectedly.
Public class KnowledgeFragmentBuilder Reconstructs a SyncKnowledge object from its constituent parts, in the format that is compatible with WindowsSync or later.
Public class KnowledgeFragmentInspector Takes a snapshot of a SyncKnowledge object that is in the format that is compatible with WindowsSync or later, and provides methods for inspecting the details of the knowledge.
Public class KnowledgeInspector Takes a snapshot of a SyncKnowledge object and provides methods for inspecting the details of the knowledge.
Public class KnowledgeSyncProvider When overridden by a derived class, represents a synchronization provider that uses knowledge to perform synchronization.
Public class KnowledgeSyncProviderConfiguration Represents configuration information for a KnowledgeSyncProvider object.
Public class LoadChangeContext When overridden by a derived class, represents information about a change to be loaded from the item store.
Public class LoadConflictDataException The exception that is thrown when the requested conflict data could not be loaded. This occurs when a recoverable error is set while data is being loaded, or if data conversion fails.
Public class LoggedConflict Represents metadata and data for a conflict that can be logged.
Public class MemoryConflictLog Represents a conflict log that exists in memory.
Public class MetadataStoreVersion2RequiredException The exception that is thrown when a provider attempts to access a metadata store that was created in Sync Framework 1.0.
Public class NegativeRangeException The exception that is thrown by KnowledgeBuilder.BuildSyncKnowledge when an ItemRangeOverride object that is used to build the knowledge contains a ClockVector property that does not contain KnowledgeBuilder.ScopeClockVector.
Public class NewItemMustContainAllFieldsException The exception that is thrown when required fields, such as an item ID, are not set for an item that is being created.
Public class NotifyingChangeApplier Represents a change applier that examines a set of changes from a source provider, detects conflicts with items in the destination replica, and makes calls to a registered change applier target to save changes or save conflicts as appropriate.
Public class NotifyingChangeApplierIChangeDataRetrieverAdapter Represents an adapter that can convert between a managed IChangeDataRetriever and an unmanaged ISynchronousDataRetriever.
Public class ObjectNeedsStateException The exception that is thrown when a SyncSessionContext object is required and none is specified.
Public class OptimisticConcurrencyException The exception that is thrown when a metadata store update fails because of a concurrent update.
Public class Override When overridden by a derived class, represents a synchronization entity and an associated clock vector that differs from the scope clock vector of the parent knowledge object.
Public class ProviderVersionMismatchException The exception that is thrown when the version of the simple provider returned by GetProviderVersion does not match the provider version of the associated metadata store returned by GetProviderVersion.
Public class Range Represents a range of item IDs, and the clock vector that defines what is known about the items in the range.
Public class RangeOutOfOrderException The exception that is thrown when a range of items is not in the expected order, or when a range override is specified incorrectly.
Public class RangeSet Represents a set of Range objects, each of which contains knowledge about a set of change units within a range of items.
Public class RecoverableErrorData Represents information about a recoverable error. This class cannot be inherited.
Public class RecoverableErrorMustFailEntireItemException The exception that is thrown when a recoverable error is set at the change unit level rather than at the item level.
Public class ReplicaKeyMap Represents a mapping between replica keys and replica IDs.
Public class ReplicaNotFoundException The exception that is thrown when a specified replica cannot be found in a ReplicaKeyMap object.
Public class SaveChangeContext Represents information about a change to be saved to the item store.
Public class SaveChangeWithChangeUnitsContext Represents information about a change to be saved to the item store when the change contains change units.
Public class SessionProgressEventArgs Provides data for the SessionProgress event.
Public class SessionStateChangedEventArgs Provides data for the StateChanged event.
Public class SimpleProviderInvalidOperationException The exception that is thrown when a provider performs an operation that is not valid, such as trying to add the same schema more than once.
Public class SimpleProvidersException The base class for all exceptions that are thrown by simple providers.
Public class SyncAbortedException The exception that is thrown when the synchronization session is canceled.
Public class SyncAgent The SyncAgent object orchestrates synchronization.
Public class SyncBatchProgress Represents progress information, including conflict information, for a batch of changes during a synchronization session.
Public class SyncCallbacks Represents application callbacks that are used to dispatch a synchronization event.
Public class SyncConstraintConflictNotAllowedException The exception that is thrown when a constraint conflict is encountered in a synchronization session but conflicts are not allowed.
Public class SyncDataConverter When implemented, converts data between two providers that synchronize the same type of data, such as contacts information, but transfer that data in a different format.
Public class SyncException The exception that is thrown when an error occurs during synchronization.
Public class SyncGlobalId Represents an identifier for an item that is unique throughout the synchronization community.
Public class SyncId Represents an identifier for an item, change unit, or replica.
Public class SyncIdFormat Represents the format of a synchronization entity ID. This class cannot be inherited.
Public class SyncIdFormatGroup Represents the format schema for the group of IDs that are used to identify entities in a synchronization session. This class cannot be inherited.
Public class SyncIdFormatMismatchException The exception that is thrown when an ID format is specified that is not in the format that is expected.
Public class SyncInvalidOperationException The exception that is thrown when a method call is invalid for the current state of the object.
Public class SyncKnowledge Represents knowledge that a replica has about its item store.
Public class SyncOperationStatistics Represents statistics about a bidirectional synchronization session.
Public class SyncOrchestrator Initiates and controls synchronization sessions.
Public class SyncOrchestratorStateChangedEventArgs Provides data for the StateChanged event.
Public class SyncProvider When overridden by a derived class, represents a synchronization provider.
Public class SyncRuntimeInternalErrorException The exception that is thrown when an internal error has occurred in Sync Framework.
Public class SyncSessionContext Represents information about the current synchronization session.
Public class SyncSessionStatistics Represents statistics about a single, unidirectional synchronization session.
Public class SyncStagedProgressEventArgs Provides data for the SessionProgress event.
Public class SyncVersion Represents a version for an item or a change unit.
Public class UnmanagedSyncProviderWrapper Represents a managed object that wraps an unmanaged synchronization provider.
Public class UserLoadChangeContext Represents information about a change to be loaded from the item store. This class cannot be inherited.

Interfaces

  Interface Description
Public interface IChangeDataRetriever Represents the mechanism by which the destination provider retrieves item data from the source provider.
Public interface IChangeDataRetrieverAdapter When overridden, adapts a change data retriever between a managed and unmanaged representation.
Public interface IChangeDataRetrieverAdapter2 When overridden, provides additional functionality to an IChangeDataRetrieverAdapter class.
Public interface IClockVector Represents a clock vector that defines the changes that are contained in a knowledge structure.
Public interface IClockVectorElement When overridden, represents an element of a clock vector that is contained in a knowledge structure.
Public interface IConflictLogAccess When implemented by a derived class, represents access to a conflict log so that a change applier can manage conflicts in the log.
Public interface IConflictLogWriter When implemented by a derived class, represents a writer that saves conflicts to a conflict log.
Public interface IFilteredReplicaNotifyingChangeApplierTarget When overridden by a derived class, represents an object that can provide information about a filtered replica to a notifying change applier.
Public interface IFilterTrackingNotifyingChangeApplierTarget When overridden by a derived class, represents an object that can provide information, about a replica that tracks filters, to a notifying change applier.
Public interface IFilterTrackingProvider When overridden by a derived class, represents a synchronization provider that synchronizes data to and from a replica that tracks filters.
Public interface INotifyingChangeApplierTarget Represents an object that can save item changes to a replica.
Public interface INotifyingChangeApplierTarget2 When implemented by a derived class, represents additional methods on an object that can save item changes to a replica.
Public interface IRequestFilteredSync When implemented by a derived class, represents a destination provider that can specify a filter to be used by the source provider during change enumeration.
Public interface ISupportFilteredSync When implemented by a derived class, represents a source provider that supports filtered change enumeration and that can negotiate the type of filter used.
Public interface ISupportLastWriteTime When overridden, retrieves the date and time that an item or change unit was most recently changed.
Public interface ISyncFilter When overridden by a derived class, represents a custom filter.
Public interface ISyncFilterDeserializer When overridden by a derived class, deserializes custom filter information.

Delegates

  Delegate Description
Public delegate FilterRequestCallback Represents the method that mediates filter negotiation between a destination provider and a source provider.
Public delegate RequestTrackedFilterCallback Informs the source provider of a filter that is tracked by the destination replica.

Enumerations

  Enumeration Description
Public enumeration ChangeApplicationAction Represents the action a destination provider must take to apply a change.
Public enumeration ChangeKind Represents the type of change that is made to an item.
Public enumeration CollisionConflictResolutionPolicy Represents the options for the collision conflict resolution policy to use for the synchronization session.
Public enumeration CompatibilityLevel Represents the version that components must be to operate with each other.
Public enumeration ConflictResolutionAction Represents actions that are taken to resolve a specific conflict.
Public enumeration ConflictResolutionPolicy Represents the options for the conflict resolution policy to use for the synchronization session.
Public enumeration ConstraintConflictReason Represents the reasons that a constraint conflict can occur.
Public enumeration ConstraintConflictResolutionAction Represents actions that are taken to resolve a specific constraint conflict.
Public enumeration FilterCombinationType Represents the way that filters are combined.
Public enumeration FilteringType Indicates the type of information that is included in a change batch during filtered synchronization.
Public enumeration FilterTrackingStatus Represents information about whether a filter is tracked by a replica.
Public enumeration FullEnumerationAction Represents the action to be taken by an application in response to SyncCallbacks.FullEnumerationNeeded.
Public enumeration KnowledgeCookieComparisonResult Represents the possible results when a knowledge cookie is compared with a knowledge object by using Compare.
Public enumeration MarkerType Represents the type of markers contained in a SyncKnowledge object.
Public enumeration SaveChangeAction Represents the type of action that is indicated by a change.
Public enumeration SessionProgressStage Represents the stages of a synchronization session.
Public enumeration SyncDirectionOrder Indicates the direction of synchronization. For two-way synchronizations this also includes the order in which the synchronizations are performed.
Public enumeration SyncOrchestratorState Represents the possible states of a SyncOrchestrator object.
Public enumeration SyncProviderPosition Represents the position of a provider, relative to the other provider in the synchronization session.
Public enumeration SyncSessionState Defines the state that a synchronization session is in.
Public enumeration SyncStage Defines the different phases of synchronization from the perspective of the client.