ResourceFeedReaderClientExtensions.CreateDocumentFeedReader Method (DocumentClient, String, FeedOptions, Object)

Creates a Feed Reader for Documents in the Azure DocumentDB database service.

Namespace:   Microsoft.Azure.Documents.Client
Assembly:  Microsoft.Azure.Documents.Client (in Microsoft.Azure.Documents.Client.dll)

Syntax

public static ResourceFeedReader<Document> CreateDocumentFeedReader(
    this DocumentClient client,
    string documentsFeedOrDatabaseLink,
    FeedOptions options = null,
    object partitionKey = null
)

public:
[ExtensionAttribute]
static ResourceFeedReader<Document^>^ CreateDocumentFeedReader(
    DocumentClient^ client,
    String^ documentsFeedOrDatabaseLink,
    FeedOptions^ options = null,
    Object^ partitionKey = null
)

<ExtensionAttribute>
Public Shared Function CreateDocumentFeedReader (
    client As DocumentClient,
    documentsFeedOrDatabaseLink As String,
    options As FeedOptions,
    partitionKey As Object
) As ResourceFeedReader(Of Document)

Parameters

• client
  Type: Microsoft.Azure.Documents.Client.DocumentClient

  The DocumentClient instance.

• documentsFeedOrDatabaseLink
  Type: System.String

  The link for documents or self-link for database in case a partition resolver is used with the client

• options
  Type: Microsoft.Azure.Documents.Client.FeedOptions

  the FeedOptions options for the request.

• partitionKey
  Type: System.Object

  The key used to determine the target collection

Return Value

Type: Microsoft.Azure.Documents.Client.ResourceFeedReader<Document>

A ResourceFeedReader<T> instance.

See Also

ResourceFeedReaderClientExtensions Class
Microsoft.Azure.Documents.Client Namespace

Return to top