IDocumentReader<TDocument>.ReadDocumentAsync Method
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.
Reads a document.
public:
System::Threading::Tasks::Task<System::Cloud::DocumentDb::IDatabaseResponse<TDocument> ^> ^ ReadDocumentAsync(System::Cloud::DocumentDb::RequestOptions<TDocument> ^ requestOptions, System::String ^ id, System::Threading::CancellationToken cancellationToken);public System.Threading.Tasks.Task<System.Cloud.DocumentDb.IDatabaseResponse<TDocument>> ReadDocumentAsync(System.Cloud.DocumentDb.RequestOptions<TDocument> requestOptions, string id, System.Threading.CancellationToken cancellationToken);abstract member ReadDocumentAsync : System.Cloud.DocumentDb.RequestOptions<'Document> * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Cloud.DocumentDb.IDatabaseResponse<'Document>>Public Function ReadDocumentAsync (requestOptions As RequestOptions(Of TDocument), id As String, cancellationToken As CancellationToken) As Task(Of IDatabaseResponse(Of TDocument))Parameters
- requestOptions
- RequestOptions<TDocument>
The request options.
- id
- String
The document id requested to read.
- cancellationToken
- CancellationToken
The token represents request cancellation.
Returns
A Task containing a IDatabaseResponse<T> that wraps the result document.
Exceptions
Thrown when an error occurred on a client side. For example on a bad request, permissions error or client timeout.
Thrown when an error occurred on a database server side, including internal server error.
Thrown when a request failed but can be retried. This includes throttling and server not available cases.
A generic exception thrown in all other not covered above cases.
