LCQuery

public class LCQuery : NSObject, NSCopying, NSCoding

Query

Show on GitHub

application
The application this query belong to.
Declaration
Swift

public let application: LCApplication
Show on GitHub
objectClassName
The class name of the object.
Declaration
Swift

public let objectClassName: String
Show on GitHub
limit
The limit on the number of objects to return.
Declaration
Swift

public var limit: Int?
Show on GitHub
skip
The number of objects to skip before returning.
Declaration
Swift

public var skip: Int?
Show on GitHub
includeACL
The query result whether include ACL.
Declaration
Swift

public var includeACL: Bool?
Show on GitHub
whereString
If this property is a non-nil value, query will always use it as where condition, default is nil.
Declaration
Swift

public var whereString: String?
Show on GitHub
orderedKeys
The ordered keys.
Declaration
Swift

public var orderedKeys: String?
Show on GitHub
includedKeys
The included keys.
Declaration
Swift

public var includedKeys: Set<String>
Show on GitHub
selectedKeys
The selected keys.
Declaration
Swift

public var selectedKeys: Set<String>
Show on GitHub


                    
                    
                    init(application:className:)

Initialization.

Declaration

Swift

public init(
    application: LCApplication = .default,
    className: String)

Parameters

`application`	The application this query belong to, default is `LCApplication.default`.
`className`	The name of the class which will be queried.

Show on GitHub

copy(with:)
Undocumented
Declaration
Swift

public func copy(with zone: NSZone?) -> Any
Show on GitHub
init(coder:)
Undocumented
Declaration
Swift

public required init?(coder aDecoder: NSCoder)
Show on GitHub
encode(with:)
Undocumented
Declaration
Swift

public func encode(with aCoder: NSCoder)
Show on GitHub
Constraint
Constraint for key.
See more
Declaration
Swift

public enum Constraint
Show on GitHub


                    
                    
                    whereKey(_:_:)

Add a constraint for key.

Declaration

Swift

public func whereKey(_ key: String, _ constraint: Constraint)

Parameters

`key`	The key will be constrained.
`constraint`	See `Constraint`.

Show on GitHub


                    
                    
                    where(_:_:)

Add a constraint for key.

Throws

LCError

Declaration

Swift

public func `where`(_ key: String, _ constraint: Constraint) throws

Parameters

`key`	The key will be constrained.
`constraint`	See `Constraint`.

Show on GitHub


                    
                    
                    and(_:)

Performs a logical AND operation on an array of one or more expressions of query.

Throws

LCError

Declaration

Swift

public class func and(_ queries: [LCQuery]) throws -> LCQuery

Parameters


                                queries

An array of one or more expressions of query.

Return Value

A new LCQuery.

Show on GitHub


                    
                    
                    and(_:)

Performs a logical AND operation on self and the query.

Throws

LCError

Declaration

Swift

public func and(_ query: LCQuery) throws -> LCQuery

Parameters


                                query

The query.

Return Value

A new LCQuery.

Show on GitHub


                    
                    
                    or(_:)

Performs a logical OR operation on an array of one or more expressions of query.

Throws

LCError

Declaration

Swift

public class func or(_ queries: [LCQuery]) throws -> LCQuery

Parameters


                                queries

An array of one or more expressions of query.

Return Value

A new LCQuery.

Show on GitHub


                    
                    
                    or(_:)

Performs a logical OR operation on self and the query.

Throws

LCError

Declaration

Swift

public func or(_ query: LCQuery) throws -> LCQuery

Parameters


                                query

The query.

Return Value

A new LCQuery.

Show on GitHub

CachePolicy
The constants used to specify interaction with the cached responses.
See more
Declaration
Swift

public enum CachePolicy
Show on GitHub

Find


                    
                    
                    find(cachePolicy:)

Query objects synchronously.

Declaration

Swift

public func find<T>(cachePolicy: CachePolicy = .onlyNetwork) -> LCQueryResult<T> where T : LCObject

Parameters


                                cachePolicy

See CachePolicy, default is CachePolicy.onlyNetwork.

Return Value

The result of query.

Show on GitHub


                    
                    
                    find(cachePolicy:completionQueue:completion:)

Query objects asynchronously.

Declaration

Swift

@discardableResult
public func find<T: LCObject>(
    cachePolicy: CachePolicy = .onlyNetwork,
    completionQueue: DispatchQueue = .main,
    completion: @escaping (LCQueryResult<T>) -> Void) -> LCRequest

Parameters

`cachePolicy`	See `CachePolicy`, default is `CachePolicy.onlyNetwork`.
`completionQueue`	The queue where the `completion` be called, default is `DispatchQueue.main`.
`completion`	The result callback of query.

Return Value

LCRequest

Show on GitHub

Get First


                    
                    
                    getFirst(cachePolicy:)

Get first object synchronously.

Declaration

Swift

public func getFirst<T>(cachePolicy: CachePolicy = .onlyNetwork) -> LCValueResult<T> where T : LCObject

Parameters


                                cachePolicy

See CachePolicy, default is CachePolicy.onlyNetwork.

Return Value

The result of query.

Show on GitHub


                    
                    
                    getFirst(cachePolicy:completionQueue:completion:)

Get first object asynchronously.

Declaration

Swift

@discardableResult
public func getFirst<T: LCObject>(
    cachePolicy: CachePolicy = .onlyNetwork,
    completionQueue: DispatchQueue = .main,
    completion: @escaping (LCValueResult<T>) -> Void) -> LCRequest

Parameters

`cachePolicy`	See `CachePolicy`, default is `CachePolicy.onlyNetwork`.
`completionQueue`	The queue where the `completion` be called, default is `DispatchQueue.main`.
`completion`	The result callback of query.

Return Value

LCRequest

Show on GitHub

Get


                    
                    
                    get(_:cachePolicy:)

Get object by ID synchronously.

Declaration

Swift

public func get<T: LCObject>(
    _ objectId: LCStringConvertible,
    cachePolicy: CachePolicy = .onlyNetwork) -> LCValueResult<T>

Parameters

`objectId`	The ID of the object.
`cachePolicy`	See `CachePolicy`, default is `CachePolicy.onlyNetwork`.

Return Value

The result of query.

Show on GitHub


                    
                    
                    get(_:cachePolicy:completionQueue:completion:)

Get object by ID asynchronously.

Declaration

Swift

@discardableResult
public func get<T: LCObject>(
    _ objectId: LCStringConvertible,
    cachePolicy: CachePolicy = .onlyNetwork,
    completionQueue: DispatchQueue = .main,
    completion: @escaping (LCValueResult<T>) -> Void) -> LCRequest

Parameters

`objectId`	The ID of the object.
`cachePolicy`	See `CachePolicy`, default is `CachePolicy.onlyNetwork`.
`completionQueue`	The queue where the `completion` be called, default is `DispatchQueue.main`.
`completion`	The result callback of query.

Return Value

LCRequest

Show on GitHub

Count


                    
                    
                    count(cachePolicy:)

Count objects synchronously.

Declaration

Swift

public func count(cachePolicy: CachePolicy = .onlyNetwork) -> LCCountResult

Parameters


                                cachePolicy

See CachePolicy, default is CachePolicy.onlyNetwork.

Return Value

The result of query.

Show on GitHub


                    
                    
                    count(cachePolicy:completionQueue:completion:)

Count objects asynchronously.

Declaration

Swift

@discardableResult
public func count(
    cachePolicy: CachePolicy = .onlyNetwork,
    completionQueue: DispatchQueue = .main,
    completion: @escaping (LCCountResult) -> Void) -> LCRequest

Parameters

`cachePolicy`	See `CachePolicy`, default is `CachePolicy.onlyNetwork`.
`completionQueue`	The queue where the `completion` be called, default is `DispatchQueue.main`.
`completion`	The result callback of query.

Return Value

LCRequest

Show on GitHub