DocumentFragment(TDocument) Class

DocumentFragment<TDocument> Class

Couchbase .NET SDK 2.3.3

Represents one more fragments of an IDocument<T> that is returned by the sub-document API.

Inheritance Hierarchy

System.Object
Couchbase.OperationResult
Couchbase.DocumentFragment<TDocument>

Namespace: Couchbase
Assembly: Couchbase.NetClient (in Couchbase.NetClient.dll) Version: 0.0.0.0 (0.0.0.0)

Syntax

C++

Copy to Clipboard Print

public class DocumentFragment<TDocument> : OperationResult, 
	IDocumentFragment<TDocument>, IOperationResult<TDocument>, IOperationResult, IResult, 
	IDocumentFragment, ITypeSerializerProvider

public class DocumentFragment<TDocument> : OperationResult, 
	IDocumentFragment<TDocument>, IOperationResult<TDocument>, IOperationResult, IResult, 
	IDocumentFragment, ITypeSerializerProvider

Public Class DocumentFragment(Of TDocument)
	Inherits OperationResult 
	Implements IDocumentFragment(Of TDocument), IOperationResult(Of TDocument), 
	IOperationResult, IResult, IDocumentFragment, ITypeSerializerProvider

Public Class DocumentFragment(Of TDocument)
	Inherits OperationResult 
	Implements IDocumentFragment(Of TDocument), IOperationResult(Of TDocument), 
	IOperationResult, IResult, IDocumentFragment, ITypeSerializerProvider

generic<typename TDocument>
public ref class DocumentFragment : public OperationResult, 
	IDocumentFragment<TDocument>, IOperationResult<TDocument>, IOperationResult, IResult, 
	IDocumentFragment, ITypeSerializerProvider

generic<typename TDocument>
public ref class DocumentFragment : public OperationResult, 
	IDocumentFragment<TDocument>, IOperationResult<TDocument>, IOperationResult, IResult, 
	IDocumentFragment, ITypeSerializerProvider

type DocumentFragment<'TDocument> =  
    class 
        inherit OperationResult 
        interface IDocumentFragment<'TDocument>
        interface IOperationResult<'TDocument>
        interface IOperationResult 
        interface IResult 
        interface IDocumentFragment 
        interface ITypeSerializerProvider 
    end

type DocumentFragment<'TDocument> =  
    class 
        inherit OperationResult 
        interface IDocumentFragment<'TDocument>
        interface IOperationResult<'TDocument>
        interface IOperationResult 
        interface IResult 
        interface IDocumentFragment 
        interface ITypeSerializerProvider 
    end

Type Parameters

TDocument: The document

The DocumentFragment<TDocument> type exposes the following members.

Constructors

	Name	Description
	DocumentFragment<TDocument>	Initializes a new instance of the DocumentFragment<TDocument> class

Top

Methods

	Name	Description
	Content(Int32)	The value if it exists for a specific index.
	Content(String)	The value if it exists for a specific path.
	Content<TContent>(Int32)	The value if it exists for a specific index.
	Content<TContent>(String)	The value if it exists for a specific path.
	Count	The count of the sub-document operations chained togather.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Exists	Checks whether the given path is part of this result set, eg. an operation targeted it, and the operation executed successfully.
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsNmv	Checks if the server responded with a Not My Vbucket. (Inherited from OperationResult.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OpStatus(Int32)	Gets the ResponseStatus for a specific operation at it's index.
	OpStatus(String)	Gets the ResponseStatus for a specific operation at it's path.
	ShouldRetry	(Inherited from OperationResult.)
	ToString	Returns a String that represents this instance. (Inherited from OperationResult.)

Top

Extension Methods

	Name	Description
	Content<TDocument, TContent>	Get the result type TContent from a document of type TDocument, using a given lambda expression path. (Defined by SubdocExtensions.)
	Exists<TDocument, TContent>	Get the existence result for a fragement of type TContent from a document of type TDocument, using a given lambda expression path. (Defined by SubdocExtensions.)

Top

Properties

	Name	Description
	Cas	The 'Check and Set' or 'CAS' value for enforcing optimistic concurrency. (Inherited from OperationResult.)
	Durability	The level of durability that the operation achieved (Inherited from OperationResult.)
	Exception	If Success is false and an exception has been caught internally, this field will contain the exception. (Inherited from OperationResult.)
	Expiry	The time-to-live or TTL for the document before it's evicted from disk in milliseconds.
	Id	The unique identifier or key for the document.
	Message	If Success is false, the reason why the operation failed. (Inherited from OperationResult.)
	Serializer
	Status	The status returned from the Couchbase Server after an operation. (Inherited from OperationResult.)
	Success	True if the operation succeeded. (Inherited from OperationResult.)
	Token	Gets the mutation token for the operation if enhanced durability is enabled. (Inherited from OperationResult.)

Top

Reference

Couchbase Namespace