Class Scope

Inheritance
object
Scope
Implements
Inherited Members
Namespace: Couchbase.Lite
Assembly: Couchbase.Lite.dll
Syntax
public sealed class Scope : IDisposable

Properties

| Improve this Doc View Source

Name

Gets the Scope Name

Declaration
public string Name { get; }
Property Value
Type Description
string
Remarks

Naming rules: Must be between 1 and 251 characters in length. Can only contain the characters A-Z, a-z, 0-9, and the symbols _, -, and %. Cannot start with _ or %. Case sensitive.

Methods

| Improve this Doc View Source

Dispose()

Declaration
public void Dispose()
| Improve this Doc View Source

Equals(object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
object obj
Returns
Type Description
bool
Overrides
| Improve this Doc View Source

GetCollection(string)

Gets one collection of the given name

Declaration
public Collection GetCollection(string name)
Parameters
Type Name Description
string name

The collection name
Returns
Type Description
Collection

The collection of the given name. null if the collection doesn't exist in the Scope
Exceptions
Type Condition
CouchbaseException

Thrown if an error condition is returned from LiteCore
CouchbaseLiteException

Thrown with LiteCore.Interop.C4ErrorCode.NotFound if Couchbase.Lite.Scope.Database is closed
InvalidOperationException

Thrown if Collection is not valid.
| Improve this Doc View Source

GetCollections()

Get all collections in this scope object.

Declaration
public IReadOnlyList<Collection> GetCollections()
Returns
Type Description
IReadOnlyList<Collection>

All collections in this scope object. Empty list if these is no collection in the Scope.
Exceptions
Type Condition
CouchbaseException

Thrown if an error condition is returned from LiteCore
| Improve this Doc View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
int
Overrides
| Improve this Doc View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides

Implements