Protocols

The following protocols are available globally.

  • ENTERPRISE EDITION ONLY.

    The authenticator used by URLEndpointListener to authenticate clients.

    Declaration

    Swift

    @available(macOS 10.12, iOS 10.0, *)
    public protocol ListenerAuthenticator
  • ENTERPRISE EDITION ONLY

    PredictionFunction protocol that allows to create an expression that refers to one of the properties of the prediction result dictionary.

    See more

    Declaration

    Swift

    public protocol PredictionFunction : ExpressionProtocol
  • ENTERPRISE EDITION ONLY

    PredictiveModel protocol that allows to integrate machine learning model into CBL Query via invoking the Function.prediction() function.

    See more

    Declaration

    Swift

    public protocol PredictiveModel
  • The stream oriented transportation; the
                            replicator will apply framing to each message.
    

    ENTERPRISE EDITION ONLY.

    A delegate used by the replicator to create MessageEndpointConnection objects.

    See more

    Declaration

    Swift

    public protocol MessageEndpointDelegate : AnyObject
  • ENTERPRISE EDITION ONLY.

    The protocol implemented by the application using a custom transporation method to exchange replication data between peers.

    See more

    Declaration

    Swift

    public protocol MessageEndpointConnection : AnyObject
  • ENTERPRISE EDITION ONLY.

    The replicator connection used by the application to tell the replicator to consume the data received from the other peer or to close the connection.

    See more

    Declaration

    Swift

    public protocol ReplicatorConnection
  • ArrayProtocol defines a set of methods for readonly accessing array data.

    See more

    Declaration

    Swift

    public protocol ArrayProtocol : ArrayFragment
  • Authenticator objects provide server authentication credentials to the replicator. Authenticator is a base opaque protocol; you must instantiate one of its implementation.

    Declaration

    Swift

    public protocol Authenticator
  • Collation defines how strings are compared and is used when creating a COLLATE expression. The COLLATE expression can be used in the WHERE clause when comparing two strings or in the ORDER BY clause when specifying how the order of the query results.

    Declaration

    Swift

    public protocol CollationProtocol
  • Conflict Resolver protocol

    See more

    Declaration

    Swift

    public protocol ConflictResolverProtocol
  • A query data source. used for specifiying the data source for your query.

    Declaration

    Swift

    public protocol DataSourceProtocol
  • A query data source with the aliasing function.

    See more

    Declaration

    Swift

    public protocol DataSourceAs : DataSourceProtocol
  • DictionaryProtocol defines a set of methods for readonly accessing dictionary data.

    See more

    Declaration

    Swift

    public protocol DictionaryProtocol : DictionaryFragment
  • Replication target endpoint.

    Declaration

    Swift

    public protocol Endpoint
  • Query expression.

    See more

    Declaration

    Swift

    public protocol ExpressionProtocol
  • FragmentProtocol provides readonly access to the data value wrapped by a fragment object.

    See more

    Declaration

    Swift

    public protocol FragmentProtocol
  • ArrayFragment protocol provides subscript access to Fragment objects by index.

    See more

    Declaration

    Swift

    public protocol ArrayFragment
  • DictionaryFragment protocol provides subscript access to Fragment objects by key.

    See more

    Declaration

    Swift

    public protocol DictionaryFragment
  • Full-text expression.

    See more

    Declaration

    Swift

    @available(*, deprecated, message: "Use FullTextFunction.match(indexName: String, query: String﹚ instead.")
    public protocol FullTextExpressionProtocol
  • Index protocol.

    Declaration

    Swift

    public protocol Index
  • Undocumented

    Declaration

    Swift

    public protocol IndexConfiguration
  • Join component representing a JOIN clause in the query statement.

    Declaration

    Swift

    public protocol JoinProtocol
  • Join ON clause used for specifying join conditions.

    See more

    Declaration

    Swift

    public protocol JoinOnProtocol : JoinProtocol
  • Logger protocol

    See more

    Declaration

    Swift

    public protocol Logger
  • Meta expression.

    See more

    Declaration

    Swift

    public protocol MetaExpressionProtocol : ExpressionProtocol
  • MutableArrayProtocol protocol defines a set of methods for getting and setting array data.

    See more

    Declaration

    Swift

    public protocol MutableArrayProtocol : ArrayProtocol, MutableArrayFragment
  • MutableDictionaryProtocol defines a set of methods for getting and setting dictionary data.

    See more

    Declaration

    Swift

    public protocol MutableDictionaryProtocol : DictionaryProtocol, MutableDictionaryFragment
  • MutableFragmentProtocol provides read and write access to the data value wrapped by a fragment object.

    See more

    Declaration

    Swift

    public protocol MutableFragmentProtocol : FragmentProtocol
  • MutableArrayFragment protocol provides subscript access to Fragment objects by index.

    See more

    Declaration

    Swift

    public protocol MutableArrayFragment
  • MutableDictionaryFragment protocol provides subscript access to CBLMutableFragment objects by key.

    See more

    Declaration

    Swift

    public protocol MutableDictionaryFragment
  • Ordering represents a single ordering component in the query ORDER BY clause.

    Declaration

    Swift

    public protocol OrderingProtocol
  • SortOrder allows to specify the ordering direction which is ascending or descending order. The default ordering is the ascending order.

    See more

    Declaration

    Swift

    public protocol SortOrder : OrderingProtocol
  • Property expression.

    See more

    Declaration

    Swift

    public protocol PropertyExpressionProtocol : ExpressionProtocol
  • SelectResult represents a signle return value of the query statement.

    Declaration

    Swift

    public protocol SelectResultProtocol
  • SelectResult with the aliasing function. The alias name can be used as the key for accessing the result value from the query Result object.

    See more

    Declaration

    Swift

    public protocol SelectResultAs : SelectResultProtocol
  • SelectResult with the from function that you can specify the data source alias name.

    See more

    Declaration

    Swift

    public protocol SelectResultFrom : SelectResultProtocol
  • Variable expression that expresses an array item in the ArrayExpression.

    Declaration

    Swift

    public protocol VariableExpressionProtocol : ExpressionProtocol