ReplicaMetadata Class

Article
10/22/2010

When overridden, provides access to the replica metadata and item metadata in the metadata store. ReplicaMetadata also provides services for delete detection and helpers for implementing synchronization provider methods.

Inheritance Hierarchy

System.Object
Microsoft.Synchronization.MetadataStorage.ReplicaMetadata

Namespace: Microsoft.Synchronization.MetadataStorage
Assembly: Microsoft.Synchronization.MetadataStorage (in Microsoft.Synchronization.MetadataStorage.dll)

Syntax

'Declaration
Public MustInherit Class ReplicaMetadata
'Usage
Dim instance As ReplicaMetadata

public abstract class ReplicaMetadata

public ref class ReplicaMetadata abstract

[<AbstractClassAttribute>]
type ReplicaMetadata =  class end

public abstract class ReplicaMetadata

The ReplicaMetadata type exposes the following members.

Constructors

	Name	Description
	ReplicaMetadata	Initializes a new instance of the ReplicaMetadata class that contains the specified ID format schema and replica ID.

Top

Properties

	Name	Description
	CustomReplicaMetadata	When overridden in a derived class, gets or sets the custom metadata field that is associated with this replica.
	DeleteDetector	When overridden in a derived class, an object that represents the delete detection service.
	IdFormats	Gets the ID format schema for the replica.
	LastDeletedItemsCleanupTime	When overridden in a derived class, gets the time when deleted items were last cleaned up by CleanupDeletedItems.
	ProviderVersion	When overridden in a derived class, gets or sets the version of the provider that operates on this metadata.
	ReplicaId	Gets the ID of the replica that is associated with this metadata.

Top

Methods

	Name	Description
	CleanupDeletedItems	When overridden in a derived class, removes items that are marked as deleted and that are older than the last successful cleanup time.
	CreateItemMetadata	When overridden in a derived class, creates a new item metadata object that can be used to add a new item metadata entry to the metadata store.
	Equals	(Inherited from Object.)
	ExcludeItemFromAllKnowledgeByGlobalId	Removes knowledge about the specified item from the knowledge.
	Finalize	(Inherited from Object.)
	FindItemMetadataById	When overridden in a derived class, gets item metadata for the item that has the specified global ID.
	FindItemMetadataByIndexedField	When overridden in a derived class, returns a list of item metadata entries that have the specified value for the indexed field.
	FindItemMetadataByIndexedFields	When overridden in a derived class, returns a list of item metadata entries that have the specified values for the set of indexed fields.
	FindItemMetadataByMergeWinnerId	When overridden in a derived class, returns a list of item metadata entries that represent merge tombstones that have the specified value for their merge winner ID property.
	FindItemMetadataByUniqueIndexedField	When overridden in a derived class, returns the unique item metadata entry that has the specified value for the indexed field.
	FindItemMetadataByUniqueIndexedFields	When overridden in a derived class, returns the unique item metadata entry that has the specified values for the indexed fields.
	GetAllItems	When overridden in a derived class, gets all the items that are contained in the metadata store for this replica.
	GetChangeBatch	When overridden in a derived class, gets a change batch that contains item metadata for items that are not contained in the specified knowledge from the destination provider.
	GetFilteredChangeBatch	When overridden in a derived class, gets a change batch that contains item metadata for items that are not contained in the specified knowledge from the destination provider and that are accepted by the specified filter.
	GetFilteredFullEnumerationChangeBatch	Gets a filtered change batch that contains item metadata for items that have IDs greater than or equal to the specified lower bound, as part of a full enumeration.
	GetFilteredFullEnumerationLocalVersions	When overridden in a derived class, gets a filtered change batch that contains the versions of items and change units stored in this replica that correspond to the items and change units referred to in a batch of changes that are sent from some other provider, as part of a full enumeration.
	GetFilteredLocalVersions	When overridden in a derived class, gets a filtered batch of changes that contains the versions of items and change units that are stored in this replica. These items and change units correspond to the items and change units referred to in a batch of changes that is sent from some other provider.
	GetForgottenKnowledge	When overridden in a derived class, gets the forgotten knowledge for this replica.
	GetFullEnumerationChangeBatch	When overridden in a derived class, gets a change batch that contains item metadata for items that have IDs equal to or greater than the specified lower bound, as part of a full enumeration.
	GetFullEnumerationLocalVersions	When overridden in a derived class, gets a change batch that contains the versions of items and change units stored in this replica that correspond to the items and change units referred to in a batch of changes that are sent from some other provider, as part of a full enumeration.
	GetHashCode	(Inherited from Object.)
	GetItemCount	When overridden in a derived class, gets the total number of items in the metadata store and the number of deleted items in the metadata store.
	GetKnowledge	When overridden in a derived class, gets the current knowledge for this replica.
	GetLocalVersions	When overridden in a derived class, gets a batch of changes that contains the versions of items and change units that are stored in this replica. These items and change units correspond to the items and change units referred to in a batch of changes that is sent from some other provider.
	GetNextTickCount	When overridden in a derived class, increments the previously saved tick count for this replica, saves the new value to the store, and returns the new value.
	GetType	(Inherited from Object.)
	MemberwiseClone	(Inherited from Object.)
	RemoveItemMetadata	When overridden in a derived class, removes item metadata from the metadata store.
	SaveItemMetadata	When overridden in a derived class, saves item metadata property changes to the metadata store.
	SaveReplicaMetadata	When overridden in a derived class, saves replica metadata property changes to the metadata store.
	SetForgottenKnowledge	When overridden in a derived class, sets the forgotten knowledge for this replica.
	SetKnowledge	When overridden in a derived class, sets the current knowledge for this replica.
	ToString	(Inherited from Object.)

Top

Remarks

ReplicaMetadata provides access to the metadata for the replica as a whole and access to metadata for items in the replica. For more information, see Accessing Replica Metadata.

ReplicaMetadata provides methods that help implement synchronization provider methods, such as GetChangeBatch. For more information, see Interoperating with a Provider.

ReplicaMetadata provides methods that can be used to determine which items were deleted from the replica and, therefore, should be marked as deleted in the metadata store. For more information, see Detecting Deleted Items.

Notes to Inheritors

When you inherit from ReplicaMetadata, you must override all members except IdFormats and ReplicaId.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.