Interface IDocumentFragment

Inherited Members

IOperationResult.Token

IOperationResult.Cas

IOperationResult.Status

IOperationResult.Durability

IOperationResult.IsNmv()

IOperationResult.Id

IOperationResult.OpCode

IResult.Success

IResult.Message

IResult.Exception

IResult.ShouldRetry()

Namespace: Couchbase.Core.IO.Operations.SubDocument

Assembly: Couchbase.NetClient.dll

Syntax

[Obsolete("This interface is not required and will be removed in a future release.")]
public interface IDocumentFragment : IOperationResult, IResult

Methods

Content(int)

The value if it exists for a specific index.

Declaration

object Content(int index)

Parameters

Type	Name	Description
int	index	The ordinal of the operation to retrieve the value from.

Returns

Type	Description
object	An object representing the result of a operation.

Remarks

If no value exists, the default value for the Type will be returned.

Content(string)

The value if it exists for a specific path.

Declaration

object Content(string path)

Parameters

Type	Name	Description
string	path	The path of the operation to retrieve the value from.

Returns

Type	Description
object	An object representing the result of a operation.

Remarks

If no value exists, the default value (null) for the object will be returned.

Content<TContent>(int)

The value if it exists for a specific index.

Declaration

TContent Content<TContent>(int index)

Parameters

Type	Name	Description
int	index	The ordinal of the operation to retrieve the value from.

Returns

Type	Description
TContent	An object of type Type representing the value of the operation.

Type Parameters

Name	Description
TContent	The Type to cast the value to.

Remarks

If no value exists, the default value for the Type will be returned.

Content<TContent>(string)

The value if it exists for a specific path.

Declaration

TContent Content<TContent>(string path)

Parameters

Type	Name	Description
string	path	The path of the operation to retrieve the value from.

Returns

Type	Description
TContent	An object of type Type representing the value of the operation.

Type Parameters

Name	Description
TContent	The Type to cast the value to.

Remarks

If no value exists, the default value for the Type will be returned.

Count()

The count of the sub-document operations chained togather.

Declaration

int Count()

Returns

Type	Description
int	An int that is the count of the total operations chained togather.

Exists(string)

Checks whether the given path is part of this result set, eg. an operation targeted it, and the operation executed successfully.

Declaration

bool Exists(string path)

Parameters

Type	Name	Description
string	path	The path for the sub-document operation.

Returns

Type	Description
bool	true if that path is part of the successful result set, false in any other case.

OpStatus(int)

Gets the ResponseStatus for a specific operation at it's index.

Declaration

ResponseStatus OpStatus(int index)

Parameters

Type	Name	Description
int	index	The ordinal of the operation.

Returns

Type	Description
ResponseStatus	The ResponseStatus that the server returned.

OpStatus(string)

Gets the ResponseStatus for a specific operation at it's path.

Declaration

ResponseStatus OpStatus(string path)

Parameters

Type	Name	Description
string	path	The path of the operation.

Returns

Type	Description
ResponseStatus	The ResponseStatus that the server returned.