Click or drag to resize

ISubdocument Interface

An interface representing an embedded JSON object in an IDocument

Namespace:  Couchbase.Lite
Assembly:  Couchbase.Lite (in Couchbase.Lite.dll) Version: 2.0.0-b0033
Syntax
C#
public interface ISubdocument : IPropertyContainer, 
	IThreadSafe

The ISubdocument type exposes the following members.

Properties
  NameDescription
Public propertyActionQueue
Gets the queue that is used for scheduling operations on the object. If operations are performed outside of this queue for properties marked with FromQueueOnly a ThreadSafetyViolationException will be thrown.
(Inherited from IThreadSafe.)
Public propertyDocument
Gets the parent document for this subdocument
Public propertyExists
Gets whether or not this subdocument has been saved into a document yet
Public propertyItem
Bracket operator for returning an untyped property from this object
(Inherited from IPropertyContainer.)
Public propertyProperties
Gets or sets the raw properties for the object
(Inherited from IPropertyContainer.)
Top
Methods
  NameDescription
Public methodContains
Gets whether or not this object contains a given key
(Inherited from IPropertyContainer.)
Public methodDoAsync(Action)
Convenience method for asynchronously scheduling a job for this object
(Inherited from IThreadSafe.)
Public methodDoAsyncT(FuncT)
Convenience method for asynchronously scheduling a job for this object
(Inherited from IThreadSafe.)
Public methodDoSync(Action)
Convenience method for scheduling and waiting for a job on this object's queue
(Inherited from IThreadSafe.)
Public methodDoSyncT(FuncT)
Convenience method for scheduling a job on this object's queue, waiting for it to finish and returning the result
(Inherited from IThreadSafe.)
Public methodGet
Gets the untyped value for the given key
(Inherited from IPropertyContainer.)
Public methodGetArray (Inherited from IPropertyContainer.)
Public methodGetBlob
Gets the IBlob for the given key
(Inherited from IPropertyContainer.)
Public methodGetBoolean
Gets the Boolean for the given key
(Inherited from IPropertyContainer.)
Public methodGetDate
Gets the DateTimeOffset? for the given key
(Inherited from IPropertyContainer.)
Public methodGetDouble
Gets the Double for the given key
(Inherited from IPropertyContainer.)
Public methodGetFloat
Gets the Single for the given key
(Inherited from IPropertyContainer.)
Public methodGetLong
Gets the Int64 for the given key
(Inherited from IPropertyContainer.)
Public methodGetString
Gets the String for the given key
(Inherited from IPropertyContainer.)
Public methodGetSubdocument
Gets the ISubdocument for the given key
(Inherited from IPropertyContainer.)
Public methodRemove
Removes the given key from the object
(Inherited from IPropertyContainer.)
Public methodRevert
Cancels all changes since the last save
(Inherited from IPropertyContainer.)
Public methodSet
Sets the given value to the given key in the object
(Inherited from IPropertyContainer.)
Top
See Also