IDocument Interface |
An interface describing a Couchbase Lite document
Namespace: Couchbase.Lite
Assembly: Couchbase.Lite (in Couchbase.Lite.dll) Version: 2.0.0-b0033
SyntaxC#
public interface IDocument : IPropertyContainer, IThreadSafe, IDisposable
The IDocument type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | ActionQueue |
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.) |
| ConflictResolver |
Gets or sets the IConflictResolver that should resolve conflicts for this document
|
| Database |
Gets the IDatabase that owns this document
|
| Exists |
Gets whether or not this document exists (i.e. has been persisted)
|
| Id |
Gets the unique ID of this document
|
| IsDeleted |
Gets whether or not this document is deleted
|
| Item |
Bracket operator for returning an untyped property from this object
(Inherited from IPropertyContainer.) |
| Properties |
Gets or sets the raw properties for the object
(Inherited from IPropertyContainer.) |
| Sequence |
Gets the sequence number of this document
|
Methods| Name | Description | |
|---|---|---|
 | Contains |
Gets whether or not this object contains a given key
(Inherited from IPropertyContainer.) |
| Delete |
Deletes the document
|
| Dispose | (Inherited from IDisposable.) |
| DoAsync(Action) |
Convenience method for asynchronously scheduling a job for this
object
(Inherited from IThreadSafe.) |
| DoAsyncT(FuncT) |
Convenience method for asynchronously scheduling a job for this
object
(Inherited from IThreadSafe.) |
| DoSync(Action) |
Convenience method for scheduling and waiting for a job
on this object's queue
(Inherited from IThreadSafe.) |
| DoSyncT(FuncT) |
Convenience method for scheduling a job on this object's queue,
waiting for it to finish and returning the result
(Inherited from IThreadSafe.) |
| Get |
Gets the untyped value for the given key
(Inherited from IPropertyContainer.) |
| GetArray | (Inherited from IPropertyContainer.) |
| GetBlob |
Gets the IBlob for the given key
(Inherited from IPropertyContainer.) |
| GetBoolean |
Gets the Boolean for the given key
(Inherited from IPropertyContainer.) |
| GetDate |
Gets the DateTimeOffset? for the given key
(Inherited from IPropertyContainer.) |
| GetDouble |
Gets the Double for the given key
(Inherited from IPropertyContainer.) |
| GetFloat |
Gets the Single for the given key
(Inherited from IPropertyContainer.) |
| GetLong |
Gets the Int64 for the given key
(Inherited from IPropertyContainer.) |
| GetString |
Gets the String for the given key
(Inherited from IPropertyContainer.) |
| GetSubdocument |
Gets the ISubdocument for the given key
(Inherited from IPropertyContainer.) |
| Purge |
Purges the document, which leaves no trace behind for replication
|
| Remove |
Removes the given key from the object
(Inherited from IPropertyContainer.) |
| Revert |
Cancels all changes since the last save
(Inherited from IPropertyContainer.) |
| Save |
Saves the document to disk
|
| Set |
Sets the given key to the given value in this document
|
Events
See Also