Export (0) Print
Expand All

Microsoft.Synchronization Namespace

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.

  ClassDescription
Public classActiveChangeApplicationContextExceptionThe 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 classChangeApplicationContextRepresents information returned by the change application service about a change to be applied.
Public classChangeApplicationServicesRepresents a change application service object that can be used to perform change application actions individually.
Public classChangeBatchRepresents metadata for a set of changes. This class cannot be inherited.
Public classChangeBatchBaseWhen overridden by a derived class, represents metadata for a set of changes.
Public classChangeBatchIsReadOnlyExceptionThe exception that is thrown when an item change or conflict is added to a ChangeBatch object that is read-only.
Public classChangeBatchNeedsFilterForgottenKnowledgeExceptionThe exception that is thrown when a required filter forgotten knowledge is not set in the change batch.
Public classChangeBatchNeedsKnowledgeExceptionThe exception that is thrown when a change batch object does not contain learned knowledge.
Public classChangeCountMismatchExceptionThe 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 classChangeDataAdapterAn abstract class that, when overridden in a derived class, converts data between a managed provider and an unmanaged provider.
Public classChangeDeferredByProviderExceptionThe exception that is thrown when a provider defers applying a change to the next synchronization session.
Public classChangeNeedsKnowledgeExceptionThe exception that is thrown when an ItemChange object does not contain required knowledge.
Public classChangeNotExpectedExceptionThe 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 classChangeUnitChangeRepresents a change to a change unit that is contained in an item. This class cannot be inherited.
Public classChangeUnitCountMismatchExceptionThe 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 classChangeUnitListFilterInfoRepresents a filter that can be used to control which change units are included for items in a ChangeBatch object.
Public classChangeVersionNotInKnowledgeExceptionThe exception that is thrown by a change applier when the version of a source item change is not contained in the associated knowledge.
Public classClockVectorRepresents a clock vector in a knowledge structure. This class cannot be inherited.
Public classClockVectorElementRepresents a clock vector element of a knowledge structure. This class cannot be inherited.
Public classCombinedFilterInfoRepresents information about a filter that is the combination of two or more filters.
Public classCreateFailuresMustBeForEntireItemExceptionThe 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 classCustomFilterInfoRepresents information about a custom filter.
Public classCustomIdFormatRequiresIdGeneratorExceptionThe 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 classDuplicateItemExceptionThe 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 classDuplicateItemInMetadataStoreExceptionThe exception that is thrown when a provider attempts to add an item that already exists to the metadata store.
Public classFilterChangeRepresents information about a change that causes an item to move in or out of a filter.
Public classFilterInfoWhen overridden in a derived class, represents information about the filter used to control the data that is included in a ChangeBatch object.
Public classFilterKeyMapRepresents a mapping between filter keys and ISyncFilter objects.
Public classForgottenKnowledgeRepresents knowledge that has been forgotten because of tombstone cleanup.
Public classForgottenKnowledgeNotContainedExceptionThe exception that is thrown when a ForgottenKnowledge object is not contained by its associated SyncKnowledge object.
Public classFrameworkVersionMismatchExceptionThe 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 classFullEnumerationChangeBatchRepresents metadata for a set of changes for a full enumeration. This class cannot be inherited.
Public classFullEnumerationExpectedExceptionThe 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 classFullEnumerationNeededEventArgsProvides data for the SyncCallbacks.FullEnumerationNeeded event.
Public classIncompleteReplicaKeyMapExceptionThe exception that is thrown by KnowledgeBuilder when KnowledgeBuilder.ReplicaKeyMap is found to be incomplete in some way.
Public classInvalidFeedExceptionThe exception that is thrown when a FeedSync feed is invalid.
Public classInvalidKnowledgeMarkerExceptionThe exception that is thrown when a specified knowledge marker is not the kind of marker contained in a knowledge object.
Public classInvalidKnowledgeVersionExceptionThe exception that is thrown when a component is passed a knowledge version that it does not support.
Public classInvalidOrderExceptionThe 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 classInvalidReplicaKeyExceptionThe 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 classInvalidSerializationVersionExceptionThe exception that is thrown when an object is serialized, and the object contains elements that are incompatible with the specified serialization version.
Public classInvalidSyncTimeExceptionThe exception that is thrown when a FeedClockVectorElement object is created by using an invalid SyncTime value.
Public classItemChangeRepresent a change to an item. This class cannot be inherited.
Public classItemChangeSkippedEventArgsProvides data for the ItemChangeSkipped event.
Public classItemChangeUnitOverrideRepresents 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 classItemChangingEventArgsProvides data for the ItemChanging event.
Public classItemConflictingEventArgsProvides data for the ItemConflicting event.
Public classItemConstraintEventArgsProvides data for the ItemConstraint event.
Public classItemDataModifiedConcurrentlyExceptionThe exception that is thrown by a synchronization provider when item data changes unexpectedly.
Public classItemHasChangeUnitsExceptionThe 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 classItemHasNoChangeUnitsExceptionThe 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 classItemHasNoDataExceptionThe exception that is thrown when a provider tries to load data for an item that does not exist.
Public classItemHasNoVersionDataExceptionThe exception that is thrown when an ItemChange object does not have the version data that is requested.
Public classItemListFilteredFullEnumerationNotSupportedExceptionThe 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 classItemListFilterInfoRepresents information about the filter that is used to control which item changes are included in a ChangeBatch object.
Public classItemMustExistExceptionThe 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 classItemNotFoundInMetadataStoreExceptionThe exception that is thrown when a simple provider attempts to access an item that does not have an entry in the metadata store.
Public classItemNotInFeedMetadataExceptionThe 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 classItemOverrideRepresents 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 classItemRangeOverrideRepresents 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 classKnowledgeBuilderReconstructs a SyncKnowledge object from its constituent parts.
Public classKnowledgeCookieRepresents a lightweight, read-only representation of a knowledge object that can be used for fast comparisons.
Public classKnowledgeDecreasedUnexpectedlyExceptionThe exception that is thrown when synchronization knowledge decreases unexpectedly.
Public classKnowledgeFragmentBuilderReconstructs a SyncKnowledge object from its constituent parts, in the format that is compatible with WindowsSync or later.
Public classKnowledgeFragmentInspectorTakes 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 classKnowledgeInspectorTakes a snapshot of a SyncKnowledge object and provides methods for inspecting the details of the knowledge.This class has been superseded by the KnowledgeFragmentInspector. For developing new applications, use KnowledgeFragmentInspector.
Public classKnowledgeSyncProviderWhen overridden by a derived class, represents a synchronization provider that uses knowledge to perform synchronization.
Public classKnowledgeSyncProviderConfigurationRepresents configuration information for a KnowledgeSyncProvider object.
Public classLoadChangeContextWhen overridden by a derived class, represents information about a change to be loaded from the item store.
Public classLoadConflictDataExceptionThe 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 classLoggedConflictRepresents metadata and data for a conflict that can be logged.
Public classMemoryConflictLogRepresents a conflict log that exists in memory.
Public classMetadataStoreVersion2RequiredExceptionThe exception that is thrown when a provider attempts to access a metadata store that was created in Sync Framework 1.0.
Public classNegativeRangeExceptionThe 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 classNewItemMustContainAllFieldsExceptionThe exception that is thrown when required fields, such as an item ID, are not set for an item that is being created.
Public classNotifyingChangeApplierRepresents 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 classNotifyingChangeApplierIChangeDataRetrieverAdapterRepresents an adapter that can convert between a managed IChangeDataRetriever and an unmanaged ISynchronousDataRetriever.
Public classObjectNeedsStateExceptionThe exception that is thrown when a SyncSessionContext object is required and none is specified.
Public classOptimisticConcurrencyExceptionThe exception that is thrown when a metadata store update fails because of a concurrent update.
Public classOverrideWhen 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 classProviderVersionMismatchExceptionThe 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 classRangeRepresents a range of item IDs, and the clock vector that defines what is known about the items in the range.
Public classRangeOutOfOrderExceptionThe exception that is thrown when a range of items is not in the expected order, or when a range override is specified incorrectly.
Public classRangeSetRepresents a set of Range objects, each of which contains knowledge about a set of change units within a range of items.
Public classRecoverableErrorDataRepresents information about a recoverable error. This class cannot be inherited.
Public classRecoverableErrorMustFailEntireItemExceptionThe exception that is thrown when a recoverable error is set at the change unit level rather than at the item level.
Public classReplicaKeyMapRepresents a mapping between replica keys and replica IDs.
Public classReplicaNotFoundExceptionThe exception that is thrown when a specified replica cannot be found in a ReplicaKeyMap object.
Public classSaveChangeContextRepresents information about a change to be saved to the item store.
Public classSaveChangeWithChangeUnitsContextRepresents information about a change to be saved to the item store when the change contains change units.
Public classSessionProgressEventArgsProvides data for the SessionProgress event.
Public classSessionStateChangedEventArgsProvides data for the StateChanged event.
Public classSimpleProviderInvalidOperationExceptionThe 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 classSimpleProvidersExceptionThe base class for all exceptions that are thrown by simple providers.
Public classSyncAbortedExceptionThe exception that is thrown when the synchronization session is canceled.
Public classSyncAgentThe SyncAgent object orchestrates synchronization.
Public classSyncBatchProgressRepresents progress information, including conflict information, for a batch of changes during a synchronization session.
Public classSyncCallbacksRepresents application callbacks that are used to dispatch a synchronization event.
Public classSyncConstraintConflictNotAllowedExceptionThe exception that is thrown when a constraint conflict is encountered in a synchronization session but conflicts are not allowed.
Public classSyncDataConverterWhen 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 classSyncExceptionThe exception that is thrown when an error occurs during synchronization.
Public classSyncGlobalIdRepresents an identifier for an item that is unique throughout the synchronization community.
Public classSyncIdRepresents an identifier for an item, change unit, or replica.
Public classSyncIdFormatRepresents the format of a synchronization entity ID. This class cannot be inherited.
Public classSyncIdFormatGroupRepresents the format schema for the group of IDs that are used to identify entities in a synchronization session. This class cannot be inherited.
Public classSyncIdFormatMismatchExceptionThe exception that is thrown when an ID format is specified that is not in the format that is expected.
Public classSyncInvalidOperationExceptionThe exception that is thrown when a method call is invalid for the current state of the object.
Public classSyncKnowledgeRepresents knowledge that a replica has about its item store.
Public classSyncOperationStatisticsRepresents statistics about a bidirectional synchronization session.
Public classSyncOrchestratorInitiates and controls synchronization sessions.
Public classSyncOrchestratorStateChangedEventArgsProvides data for the StateChanged event.
Public classSyncProviderWhen overridden by a derived class, represents a synchronization provider.
Public classSyncRuntimeInternalErrorExceptionThe exception that is thrown when an internal error has occurred in Sync Framework.
Public classSyncSessionContextRepresents information about the current synchronization session.
Public classSyncSessionStatisticsRepresents statistics about a single, unidirectional synchronization session.
Public classSyncStagedProgressEventArgsProvides data for the SessionProgress event.
Public classSyncVersionRepresents a version for an item or a change unit.
Public classUnmanagedSyncProviderWrapperRepresents a managed object that wraps an unmanaged synchronization provider.
Public classUserLoadChangeContextRepresents information about a change to be loaded from the item store. This class cannot be inherited.

  InterfaceDescription
Public interfaceIChangeDataRetrieverRepresents the mechanism by which the destination provider retrieves item data from the source provider.
Public interfaceIChangeDataRetrieverAdapterWhen overridden, adapts a change data retriever between a managed and unmanaged representation.
Public interfaceIChangeDataRetrieverAdapter2When overridden, provides additional functionality to an IChangeDataRetrieverAdapter class.
Public interfaceIClockVectorRepresents a clock vector that defines the changes that are contained in a knowledge structure.
Public interfaceIClockVectorElementWhen overridden, represents an element of a clock vector that is contained in a knowledge structure.
Public interfaceIConflictLogAccessWhen implemented by a derived class, represents access to a conflict log so that a change applier can manage conflicts in the log.
Public interfaceIConflictLogWriterWhen implemented by a derived class, represents a writer that saves conflicts to a conflict log.
Public interfaceIFilteredReplicaNotifyingChangeApplierTargetWhen overridden by a derived class, represents an object that can provide information about a filtered replica to a notifying change applier.
Public interfaceIFilterTrackingNotifyingChangeApplierTargetWhen overridden by a derived class, represents an object that can provide information, about a replica that tracks filters, to a notifying change applier.
Public interfaceIFilterTrackingProviderWhen overridden by a derived class, represents a synchronization provider that synchronizes data to and from a replica that tracks filters.
Public interfaceINotifyingChangeApplierTargetRepresents an object that can save item changes to a replica.
Public interfaceINotifyingChangeApplierTarget2When implemented by a derived class, represents additional methods on an object that can save item changes to a replica.
Public interfaceIRequestFilteredSyncWhen 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 interfaceISupportFilteredSyncWhen implemented by a derived class, represents a source provider that supports filtered change enumeration and that can negotiate the type of filter used.
Public interfaceISupportLastWriteTimeWhen overridden, retrieves the date and time that an item or change unit was most recently changed.
Public interfaceISyncFilterWhen overridden by a derived class, represents a custom filter.
Public interfaceISyncFilterDeserializerWhen overridden by a derived class, deserializes custom filter information.

  DelegateDescription
Public delegateFilterRequestCallbackRepresents the method that mediates filter negotiation between a destination provider and a source provider.
Public delegateRequestTrackedFilterCallbackInforms the source provider of a filter that is tracked by the destination replica.

  EnumerationDescription
Public enumerationChangeApplicationActionRepresents the action a destination provider must take to apply a change.
Public enumerationChangeKindRepresents the type of change that is made to an item.
Public enumerationCollisionConflictResolutionPolicyRepresents the options for the collision conflict resolution policy to use for the synchronization session.
Public enumerationCompatibilityLevelRepresents the version that components must be to operate with each other.
Public enumerationConflictResolutionActionRepresents actions that are taken to resolve a specific conflict.
Public enumerationConflictResolutionPolicyRepresents the options for the conflict resolution policy to use for the synchronization session.
Public enumerationConstraintConflictReasonRepresents the reasons that a constraint conflict can occur.
Public enumerationConstraintConflictResolutionActionRepresents actions that are taken to resolve a specific constraint conflict.
Public enumerationFilterCombinationTypeRepresents the way that filters are combined.
Public enumerationFilteringTypeIndicates the type of information that is included in a change batch during filtered synchronization.
Public enumerationFilterTrackingStatusRepresents information about whether a filter is tracked by a replica.
Public enumerationFullEnumerationActionRepresents the action to be taken by an application in response to SyncCallbacks.FullEnumerationNeeded.
Public enumerationKnowledgeCookieComparisonResultRepresents the possible results when a knowledge cookie is compared with a knowledge object by using Compare.
Public enumerationMarkerTypeRepresents the type of markers contained in a SyncKnowledge object.
Public enumerationSaveChangeActionRepresents the type of action that is indicated by a change.
Public enumerationSessionProgressStageRepresents the stages of a synchronization session.
Public enumerationSyncDirectionOrderIndicates the direction of synchronization. For two-way synchronizations this also includes the order in which the synchronizations are performed.
Public enumerationSyncOrchestratorStateRepresents the possible states of a SyncOrchestrator object.
Public enumerationSyncProviderPositionRepresents the position of a provider, relative to the other provider in the synchronization session.
Public enumerationSyncSessionStateDefines the state that a synchronization session is in.
Public enumerationSyncStageDefines the different phases of synchronization from the perspective of the client.
Show:
© 2014 Microsoft