LCObject

@dynamicMemberLookup
open class LCObject : NSObject, Sequence, LCValue, LCValueExtension, InternalOptionalSynchronizing

extension LCObject: LCValueConvertible

LeanCloud Object Type.

Show on GitHub

Property

application
The application this object belong to.
Declaration
Swift

public let application: LCApplication
Show on GitHub
ACL
Access Control List.
Declaration
Swift

@objc public dynamic var ACL: LCACL?
Show on GitHub


                    
                    
                    objectId

The identifier of this object.

Declaration

Swift

@objc
public dynamic private(set) var objectId: LCString? { get }

Show on GitHub


                    
                    
                    createdAt

The created date of this object.

Declaration

Swift

@objc
public dynamic private(set) var createdAt: LCDate? { get }

Show on GitHub


                    
                    
                    updatedAt

The updated date of this object.

Declaration

Swift

@objc
public dynamic private(set) var updatedAt: LCDate? { get }

Show on GitHub

hasObjectId
Undocumented
Declaration
Swift

public var hasObjectId: Bool { get }
Show on GitHub
hasDataToUpload
Whether this object has unsync-data to upload to server.
Declaration
Swift

public var hasDataToUpload: Bool { get }
Show on GitHub

Subclassing

objectClassName()
Set class name of current type.

The default implementation returns the class name without root module.
Declaration
Swift

open class func objectClassName() -> String
Return Value

The class name of current type.

Show on GitHub
register()
Register current object class manually.
Declaration
Swift

public static func register()
Show on GitHub

Initialization

init()
Initializing a new object with default application.
Declaration
Swift

public override required init()
Show on GitHub


                    
                    
                    init(application:)

Initializing a new object with an application.

Declaration

Swift

public required init(application: LCApplication)

Parameters


                                application

The application this object belong to.

Show on GitHub


                    
                    
                    init(application:objectId:)

Initializing a new object with an application and a identifier.

Declaration

Swift

public convenience init(
    application: LCApplication = .default,
    objectId: LCStringConvertible)

Parameters

`application`	The application this object belong to.
`objectId`	The identifier of an exist object.

Show on GitHub


                    
                    
                    init(application:className:)

Initializing a new object with an application and class name.

Declaration

Swift

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

Parameters

`application`	The application this object belong to.
`className`	The class name of this object.

Show on GitHub


                    
                    
                    init(application:className:objectId:)

Initializing a new object with an application, a identifier and class name.

Declaration

Swift

public convenience init(
    application: LCApplication = .default,
    className: LCStringConvertible,
    objectId: LCStringConvertible)

Parameters

`application`	The application this object belong to.
`className`	The class name of this object.
`objectId`	The identifier of an exist object.

Show on GitHub

NSCoding


                    
                    
                    init(coder:)

Returns an object initialized from data in a given unarchiver.

Declaration

Swift

public required convenience init?(coder: NSCoder)

Parameters


                                coder

An unarchiver object.

Show on GitHub


                    
                    
                    encode(with:)

Encodes the receiver using a given archiver.

Declaration

Swift

public func encode(with coder: NSCoder)

Parameters


                                coder

An archiver object.

Show on GitHub

NSCopying


                    
                    
                    copy(with:)

Will not do copying, just return a pointer to this object.

Declaration

Swift

open func copy(with zone: NSZone?) -> Any

Parameters


                                zone

Unused, just pass nil.

Show on GitHub

NSObjectProtocol


                    
                    
                    isEqual(_:)

Undocumented

Declaration

Swift

open override func isEqual(_ object: Any?) -> Bool

Show on GitHub


                    
                    
                    value(forKey:)

Undocumented

Declaration

Swift

open override func value(forKey key: String) -> Any?

Show on GitHub


                    
                    
                    value(forUndefinedKey:)

Undocumented

Declaration

Swift

open override func value(forUndefinedKey key: String) -> Any?

Show on GitHub

Sequence


                    
                    
                    makeIterator()

Declaration

Swift

open func makeIterator() -> DictionaryIterator<String, LCValue>

Show on GitHub

LCValue

jsonValue
Declaration
Swift

open var jsonValue: Any { get }
Show on GitHub
rawValue
Declaration
Swift

public var rawValue: Any { get }
Show on GitHub

Operation


                    
                    
                    subscript(_:)

Undocumented

Declaration

Swift

open subscript(key: String) -> LCValueConvertible? { get set }

Show on GitHub


                    
                    
                    subscript(dynamicMember:)

Undocumented

Declaration

Swift

open subscript(dynamicMember key: String) -> LCValueConvertible? { get set }

Show on GitHub


                    
                    
                    get(_:)

Get value for key.

Declaration

Swift

open func get(_ key: String) -> LCValueConvertible?

Parameters

key

The key for which to get the value.

Return Value

The value for key.

Show on GitHub


                    
                    
                    set(_:value:)

Set value for key.

This method allows you to set a value of a Swift built-in type which confirms LCValueConvertible.

Declaration

Swift

open func set(_ key: String, value: LCValueConvertible?) throws

Parameters

`key`	The key for which to set the value.
`value`	The new value.

Show on GitHub


                    
                    
                    unset(_:)

Unset value for key.

Declaration

Swift

open func unset(_ key: String) throws

Parameters

key

The key for which to unset.

Show on GitHub


                    
                    
                    increase(_:by:)

Increase a number by amount.

Declaration

Swift

open func increase(_ key: String, by: LCNumberConvertible = 1) throws

Parameters

`key`	The key of number which you want to increase.
`amount`	The amount to increase. If no amount is specified, 1 is used by default.

Show on GitHub


                    
                    
                    append(_:element:)

Append an element into an array.

Declaration

Swift

open func append(_ key: String, element: LCValueConvertible) throws

Parameters

`key`	The key of array into which you want to append the element.
`element`	The element to append.

Show on GitHub


                    
                    
                    append(_:elements:)

Append one or more elements into an array.

Declaration

Swift

open func append(_ key: String, elements: LCArrayConvertible) throws

Parameters

`key`	The key of array into which you want to append the elements.
`elements`	The array of elements to append.

Show on GitHub


                    
                    
                    append(_:element:unique:)

Append an element into an array with unique option.

Declaration

Swift

open func append(_ key: String, element: LCValueConvertible, unique: Bool) throws

Parameters

`key`	The key of array into which you want to append the element.
`element`	The element to append.
`unique`	Whether append element by unique or not. If true, element will not be appended if it had already existed in array; otherwise, element will always be appended.

Show on GitHub


                    
                    
                    append(_:elements:unique:)

Append one or more elements into an array with unique option.

Seealso

append(key: String, element: LCValue, unique: Bool)

Declaration

Swift

open func append(_ key: String, elements: LCArrayConvertible, unique: Bool) throws

Parameters

`key`	The key of array into which you want to append the element.
`elements`	The array of elements to append.
`unique`	Whether append element by unique or not.

Show on GitHub


                    
                    
                    remove(_:element:)

Remove an element from an array.

Declaration

Swift

open func remove(_ key: String, element: LCValueConvertible) throws

Parameters

`key`	The key of array from which you want to remove the element.
`element`	The element to remove.

Show on GitHub


                    
                    
                    remove(_:elements:)

Remove one or more elements from an array.

Declaration

Swift

open func remove(_ key: String, elements: LCArrayConvertible) throws

Parameters

`key`	The key of array from which you want to remove the element.
`elements`	The array of elements to remove.

Show on GitHub


                    
                    
                    relationForKey(_:)

Get relation object for key.

Declaration

Swift

open func relationForKey(_ key: String) -> LCRelation

Parameters

key

The key where relationship based on.

Return Value

The relation for key.

Show on GitHub


                    
                    
                    insertRelation(_:object:)

Insert an object into a relation.

Declaration

Swift

open func insertRelation(_ key: String, object: LCObject) throws

Parameters

`key`	The key of relation into which you want to insert the object.
`object`	The object to insert.

Show on GitHub


                    
                    
                    removeRelation(_:object:)

Remove an object from a relation.

Declaration

Swift

open func removeRelation(_ key: String, object: LCObject) throws

Parameters

`key`	The key of relation from which you want to remove the object.
`object`	The object to remove.

Show on GitHub

Save

SaveOption
Options for saving action.
See more
Declaration
Swift

public enum SaveOption
Show on GitHub


                    
                    
                    save(_:options:)

Save a batch of objects in one request synchronously.

Declaration

Swift

public class func save(
    _ objects: [LCObject],
    options: [LCObject.SaveOption] = [])
    -> LCBooleanResult

Parameters

`objects`	An array of objects to be saved.
`options`	See `LCObject.SaveOption`, default is `[]`, it will be applyed to all objects.

Return Value

LCBooleanResult.

Show on GitHub


                    
                    
                    save(_:options:completionQueue:completion:)

Save a batch of objects in one request asynchronously.

Declaration

Swift

@discardableResult
public class func save(
    _ objects: [LCObject],
    options: [LCObject.SaveOption] = [],
    completionQueue: DispatchQueue = .main,
    completion: @escaping (LCBooleanResult) -> Void)
    -> LCRequest

Parameters

`objects`	An array of objects to be saved.
`options`	See `LCObject.SaveOption`, default is `[]`, it will be applyed to all objects.
`completionQueue`	The queue where the `completion` be called, default is `DispatchQueue.main`.
`completion`	The callback of result.

Return Value

LCRequest.

Show on GitHub


                    
                    
                    save(options:)

Save object and its all descendant objects synchronously.

Declaration

Swift

public func save(
    options: [LCObject.SaveOption] = [])
    -> LCBooleanResult

Parameters


                                options

See LCObject.SaveOption, default is [].

Return Value

LCBooleanResult.

Show on GitHub


                    
                    
                    save(options:completionQueue:completion:)

Save object and its all descendant objects asynchronously.

Declaration

Swift

@discardableResult
public func save(
    options: [LCObject.SaveOption] = [],
    completionQueue: DispatchQueue = .main,
    completion: @escaping (LCBooleanResult) -> Void)
    -> LCRequest

Parameters

`options`	See `LCObject.SaveOption`, default is `[]`.
`completionQueue`	The queue where the `completion` be called, default is `DispatchQueue.main`.
`completion`	The callback of result.

Return Value

LCRequest.

Show on GitHub

Delete


                    
                    
                    delete(_:)

Delete a batch of objects in one request synchronously.

Declaration

Swift

public static func delete(
    _ objects: [LCObject])
    -> LCBooleanResult

Parameters


                                objects

An array of objects to be deleted.

Return Value

LCBooleanResult.

Show on GitHub


                    
                    
                    delete(_:completionQueue:completion:)

Delete a batch of objects in one request asynchronously.

Declaration

Swift

@discardableResult
public static func delete(
    _ objects: [LCObject],
    completionQueue: DispatchQueue = .main,
    completion: @escaping (LCBooleanResult) -> Void)
    -> LCRequest

Parameters

`objects`	An array of objects to be deleted.
`completionQueue`	The queue where the `completion` be called, default is `DispatchQueue.main`.
`completion`	The callback of result.

Return Value

LCRequest.

Show on GitHub

delete()
Delete current object synchronously.
Declaration
Swift

public func delete() -> LCBooleanResult
Show on GitHub


                    
                    
                    delete(completionQueue:completion:)

Delete current object asynchronously.

Declaration

Swift

@discardableResult
public func delete(
    completionQueue: DispatchQueue = .main,
    completion: @escaping (LCBooleanResult) -> Void)
    -> LCRequest

Parameters

`completionQueue`	The queue where the `completion` be called, default is `DispatchQueue.main`.
`completion`	The callback of result.

Return Value

LCRequest.

Show on GitHub

Fetch


                    
                    
                    fetch(_:keys:)

Fetch a batch of objects in one request synchronously.

Declaration

Swift

public static func fetch(
    _ objects: [LCObject],
    keys: [String]? = nil)
    -> LCBooleanResult

Parameters

`objects`	An array of objects to be fetched.
`keys`	Specify only return the values of the `keys`, or not return the values of the `keys` when add a “-” prefix to the key.

Return Value

LCBooleanResult.

Show on GitHub


                    
                    
                    fetch(_:keys:completionQueue:completion:)

Fetch a batch of objects in one request asynchronously.

Declaration

Swift

@discardableResult
public static func fetch(
    _ objects: [LCObject],
    keys: [String]? = nil,
    completionQueue: DispatchQueue = .main,
    completion: @escaping (LCBooleanResult) -> Void)
    -> LCRequest

Parameters

`objects`	An array of objects to be fetched.
`keys`	Specify only return the values of the `keys`, or not return the values of the `keys` when add a “-” prefix to the key.
`completionQueue`	The queue where the `completion` be called, default is `DispatchQueue.main`.
`completion`	The callback of result.

Return Value

LCRequest.

Show on GitHub


                    
                    
                    fetch(keys:)

Fetch object from server synchronously.

Declaration

Swift

public func fetch(
    keys: [String]? = nil)
    -> LCBooleanResult

Parameters


                                keys

Specify only return the values of the keys, or not return the values of the keys when add a “-” prefix to the key.

Return Value

LCBooleanResult.

Show on GitHub


                    
                    
                    fetch(keys:completionQueue:completion:)

Fetch object from server asynchronously.

Declaration

Swift

@discardableResult
public func fetch(
    keys: [String]? = nil,
    completionQueue: DispatchQueue = .main,
    completion: @escaping (LCBooleanResult) -> Void)
    -> LCRequest

Parameters

`keys`	Specify only return the values of the `keys`, or not return the values of the `keys` when add a “-” prefix to the key.
`completionQueue`	The queue where the `completion` be called, default is `DispatchQueue.main`.
`completion`	The callback of result.

Return Value

LCRequest.

Show on GitHub

lcValue
Declaration
Swift

public var lcValue: LCValue { get }
Show on GitHub