Classes

The following classes are available globally.

  • CBLAuthenticator is an opaque based authenticator class and not intended for application to implement a custom authenticator by subclassing the CBLAuthenticator class.

    Declaration

    Objective-C

    @interface CBLAuthenticator : NSObject

  • The CBLBasicAuthenticator class is an authenticator that will authenticate using HTTP Basic auth with the given username and password. This should only be used over an SSL/TLS connection, as otherwise it’s very easy for anyone sniffing network traffic to read the password.

    See more

    Declaration

    Objective-C

    @interface CBLBasicAuthenticator : CBLAuthenticator

  • A CBLBlob appears as a property of a CBLDocument; it contains arbitrary binary data, tagged with a MIME type. Blobs can be arbitrarily large, and their data is loaded only on demand (when the content or contentStream properties are accessed), not when the document is loaded. The document’s raw JSON form only contains the CBLBlob’s metadata (type, length and a digest of the data) in a small object. The data itself is stored externally to the document, keyed by the digest.

    See more

    Declaration

    Objective-C

    @interface CBLBlob : NSObject

  • Configuration for opening a database.

    See more

    Declaration

    Objective-C

    @interface CBLDatabaseConfiguration : NSObject <NSCopying>

  • A Couchbase Lite database.

    See more

    Declaration

    Objective-C

    @interface CBLDatabase : NSObject

  • CBLDocumentFragment provides access to a document object. CBLDocumentFragment also provides subscript access by either key or index to the data values of the document which are wrapped by CBLFragment objects.

    See more

    Declaration

    Objective-C

    @interface CBLDocumentFragment : NSObject <CBLDictionaryFragment>

  • A CBLLiveQuery automatically observes database changes and re-run the query that the CBLLiveQuery object is created from. If there is a new query result or an error occurred, the CBLLiveQuery will report the changed result via the added listener blocks.

    See more

    Declaration

    Objective-C

    @interface CBLLiveQuery : NSObject

  • CBLLiveQueryChange contains the information about the query result changes reported by a live query object.

    See more

    Declaration

    Objective-C

    @interface CBLLiveQueryChange : NSObject

  • A compiled database query. You create a query by calling the CBLDatabase method createQueryWhere:. The query can be further configured by setting properties before running it. Some properties alter the behavior of the query enough to trigger recompilation; it’s usually best to set these only once and then reuse the CBLQuery object. You can use NSPredicate / NSExpression variables to parameterize the query, making it flexible without needing recompilation. Then you just set the parameters property before running it.

    See more

    Declaration

    Objective-C

    @interface CBLPredicateQuery : NSObject

  • A database query. A CBLQuery instance can be constructed by calling one of the select methods.

    See more

    Declaration

    Objective-C

    @interface CBLQuery : NSObject

  • A query data source. used for specifiying the data source for your query. The current data source supported is the database.

    See more

    Declaration

    Objective-C

    @interface CBLQueryDataSource : NSObject

  • A database data source. You could also create an alias data source by calling the -as: method with a given alias name.

    See more

    Declaration

    Objective-C

    @interface CBLQueryDatabase : CBLQueryDataSource

  • A CBLQueryExpression represents an expression used for constructing a query statement.

    See more

    Declaration

    Objective-C

    @interface CBLQueryExpression : NSObject

  • A CBLQueryOrderBy represents a query ORDER BY clause by specifying properties or expressions that the result rows should be sorted by. A CBLQueryOrderBy can be construct as a single CBLQuerySortOrder instance with a propery name or an expression instance or as a chain of multiple CBLQueryOrderBy instances.

    See more

    Declaration

    Objective-C

    @interface CBLQueryOrderBy : NSObject

  • CBLQuerySortOrder is a subclass of the CBLQueryOrderBy that allows to create an ascending or a descending CBLQueryOrderBy instance.

    See more

    Declaration

    Objective-C

    @interface CBLQuerySortOrder : CBLQueryOrderBy

  • A single result from a CBLQuery. The NSEnumeration returned by -[CBLQuery run:] produces these.

    See more

    Declaration

    Objective-C

    @interface CBLQueryRow : NSObject

  • A single result from a full-text CBLQuery.

    See more

    Declaration

    Objective-C

    @interface CBLFullTextQueryRow : CBLQueryRow

  • A CBLQuerySelect represents the returning properties in each query result row.

    See more

    Declaration

    Objective-C

    @interface CBLQuerySelect : NSObject

  • Combined activity level and progress of a replicator.

    See more

    Declaration

    Objective-C

    @interface CBLReplicatorStatus : NSObject

  • A replicator for replicating document changes between a local database and a target database. The replicator can be bidirectional or either push or pull. The replicator can also be one-short or continuous. The replicator runs asynchronously, so observe the status property to be notified of progress.

    See more

    Declaration

    Objective-C

    @interface CBLReplicator : NSObject

  • The CBLSessionAuthenticator class is an authenticator that will authenticate by using the session ID of the session created by a Sync Gateway.

    See more

    Declaration

    Objective-C

    @interface CBLSessionAuthenticator : CBLAuthenticator