ChangeFeedItem<T> Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
The typed response that contains the current, previous, and metadata change feed resource when ChangeFeedMode is initialized to AllVersionsAndDeletes.
public class ChangeFeedItem<T>type ChangeFeedItem<'T> = classPublic Class ChangeFeedItem(Of T)Type Parameters
- T
- Inheritance
-
ChangeFeedItem<T>
Examples
public class ToDoActivity
{
public string type { get; set; }
public string id { get; set; }
public string status { get; set; }
}
ChangeFeedMode changeFeedMode = ChangeFeedMode.AllVersionsAndDeletes;
PartitionKey partitionKey = new PartitionKey(@"learning");
ChangeFeedStartFrom changeFeedStartFrom = ChangeFeedStartFrom.Now(FeedRange.FromPartitionKey(partitionKey));
using (FeedIterator<ChangeFeedItem<ToDoActivity>> feedIterator = container.GetChangeFeedIterator<ChangeFeedItemChanges<ToDoActivity>>(
changeFeedStartFrom: changeFeedStartFrom,
changeFeedMode: changeFeedMode))
{
while (feedIterator.HasMoreResults)
{
FeedResponse<ChangeFeedItem<ToDoActivity>> feedResponse = await feedIterator.ReadNextAsync();
if (feedResponse.StatusCode != HttpStatusCode.NotModified)
{
IEnumerable<ChangeFeedItem<ToDoActivity>> feedResource = feedResponse.Resource;
foreach(ChangeFeedItem<ToDoActivity> itemChanges in feedResource)
{
ToDoActivity currentToDoActivity = itemChanges.Current;
ToDoActivity previousToDoActivity = itemChanges.Previous;
ChangeFeedMetadata toDoActivityMetadata = itemChanges.Metadata;
}
}
}
}
Remarks
ChangeFeedItem<T> is an optional helper class that uses Newtonsoft serialization libraries. Users are welcome to create their own custom helper class.
Constructors
| Name | Description |
|---|---|
| ChangeFeedItem<T>() | |
Properties
| Name | Description |
|---|---|
| Current |
The current version of the item for all versions and deletes change feed mode. It is always null for delete change feed operations. |
| Metadata |
The item metadata for all versions and deletes change feed mode. |
| Previous |
The previous version of the item for all versions and deletes change feed mode. The previous version on delete and replace operations is not exposed by default and requires container-level opt-in. Refer to https://aka.ms/cosmosdb-change-feed-deletes for more information. |
