ItemMetadata Class

When overridden, represents the metadata that is associated with an item in the synchronization scope.

System.Object
  Microsoft.Synchronization.MetadataStorage.ItemMetadata

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

public abstract class ItemMetadata

The ItemMetadata type exposes the following members.

  NameDescription
Protected methodItemMetadataInitializes a new instance of the ItemMetadata class.
Top

  NameDescription
Public propertyChangeVersionWhen overridden in a derived class, gets or sets the version of the most recent change made to the item.
Public propertyCreationVersionWhen overridden in a derived class, gets or sets the creation version for the item.
Public propertyGlobalIdWhen overridden in a derived class, gets the global ID of the item.
Public propertyIsDeletedWhen overridden in a derived class, gets or sets a value that indicates whether the item has been deleted from the item store.
Top

  NameDescription
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetByteFieldWhen overridden in a derived class, gets the value of the specified custom field.
Public methodGetBytesFieldWhen overridden in a derived class, gets the value of the specified custom field.
Public methodGetChangeUnitEnumeratorWhen overridden in a derived class, returns an object that can be used to enumerate the change units that are contained in this item.
Public methodGetChangeUnitVersionWhen overridden in a derived class, gets the version of a change unit that is contained in the item.
Public methodGetGuidFieldWhen overridden in a derived class, gets the value of the specified custom field.
Public methodGetHashCode (Inherited from Object.)
Public methodGetMergeWinnerIdWhen overridden in a derived class, gets the item ID that is used to identify the merged item in the synchronization community.
Public methodGetStringFieldWhen overridden in a derived class, gets the value of the specified custom field.
Public methodGetType (Inherited from Object.)
Public methodGetUInt16FieldWhen overridden in a derived class, gets the value of the specified custom field.
Public methodGetUInt32FieldWhen overridden in a derived class, gets the value of the specified custom field.
Public methodGetUInt64FieldWhen overridden in a derived class, gets the value of the specified custom field.
Public methodMarkAsDeletedWhen overridden in a derived class, marks an item as deleted from the item store.
Protected methodMemberwiseClone (Inherited from Object.)
Public methodResurrectDeletedItemWhen overridden in a derived class, restores an item that was previously marked as deleted in the metadata store.
Public methodSetChangeUnitVersionWhen overridden in a derived class, sets the version of a change unit that is contained in this item.
Public methodSetCustomField(String, Byte)When overridden in a derived class, sets the value of the specified custom field.
Public methodSetCustomField(String, Byte[])When overridden in a derived class, sets the value of the specified custom field.
Public methodSetCustomField(String, Guid)When overridden in a derived class, sets the value of the specified custom field.
Public methodSetCustomField(String, String)When overridden in a derived class, sets the value of the specified custom field.
Public methodSetCustomField(String, UInt16)When overridden in a derived class, sets the value of the specified custom field.
Public methodSetCustomField(String, UInt32)When overridden in a derived class, sets the value of the specified custom field.
Public methodSetCustomField(String, UInt64)When overridden in a derived class, sets the value of the specified custom field.
Public methodSetMergeWinnerIdOnDeletedItemWhen overridden in a derived class, sets the winning item ID on a merge tombstone.
Public methodToString (Inherited from Object.)
Top

The metadata for an item contains its creation version, its current version, its global ID, and a value that indicates whether the item has been deleted from the item store. The metadata can also contain custom fields as defined by the FieldSchema class that is used to initialize the replica metadata.

Metadata Storage Service implements ItemMetadata. To obtain an instance of this implementation of ItemMetadata, first create a SqlMetadataStore object. Then, create or get a ReplicaMetadata object, and then call CreateItemMetadata or ReplicaMetadata.FindItemMetadataById.

The Metadata Storage Service implementation of this class does not save property changes to the disk until the object is passed to SaveItemMetadata.

Notes to Inheritors

When you inherit from ItemMetadata, you must override all its members.

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