How to Install Swift SDK

Installing SDK

There are several ways for you to install our SDK and the most convenient one is to use a package manager.

Installing with Package Manager

CocoaPods is a tool used to manage third-party dependencies (pods) used by macOS and iOS apps. It makes it easy for you to manage the versions of all the third-party libraries your app depends on. See Using CocoaPods for more details.

To get started, make sure you have Ruby installed (macOS comes with Ruby but we recommend you installing Xcode which comes with newer version of it) and run the following command to install cocoapods:

$ sudo gem install cocoapods

Now create a Podfile (with no extension) under the root directory of your project and add the following content:

target 'YOUR_APP_TARGET' do # Replace YOUR_APP_TARGET with your app's name
    use_frameworks!
    inhibit_all_warnings!

    pod 'LeanCloud', '~> SDK_VERSION' # In most cases you can use the latest version for SDK_VERSION; you can find it on https://github.com/leancloud/swift-sdk/releases
end

Then install the SDK with the following command:

$ pod update

Or

$ pod install --repo-update

See official documentation for the differences between them.

After installing the SDK, you can open your project with <PROJECT_NAME>.xcworkspace under the root directory of your project.

Installing Manually

Download SDK

Initializing Your Project

To begin with, get your App ID and App Key from your app's Dashboard > Settings > App Keys.

Add the following line to the top of AppDelegate.swift:

import LeanCloud

Then add the code below into the function application(_:didFinishLaunchingWithOptions:):

do {
    try LCApplication.default.set(
        id: "{{appid}}",
        key: "{{appkey}}"
    )
} catch {
    fatalError("\(error)")
}

Enabling Debug Logs

You can easily trace the problems in your project by turning debug logs on during the development phase. Once enabled, details of every request made by the SDK along with errors will be output to IDE, browser console, or your app's Dashboard > LeanEngine > App logs.

// Place the line before LCApplication.default.set; only needs to be called once
LCApplication.logLevel = .all

Verifying

First of all, make sure you are able to connect to LeanCloud server. You can test it by running the following command:

ping "{{domain}}"

If everything goes well, you will see the following response:

PING api-ucloud.leancloud.cn (123.59.41.31): 56 data bytes
64 bytes from 123.59.41.31: icmp_seq=0 ttl=51 time=9.032 ms
64 bytes from 123.59.41.31: icmp_seq=1 ttl=51 time=7.290 ms
64 bytes from 123.59.41.31: icmp_seq=2 ttl=51 time=8.131 ms
64 bytes from 123.59.41.31: icmp_seq=3 ttl=51 time=9.689 ms
64 bytes from 123.59.41.31: icmp_seq=4 ttl=51 time=6.559 ms
64 bytes from 123.59.41.31: icmp_seq=5 ttl=51 time=8.665 ms
64 bytes from 123.59.41.31: icmp_seq=6 ttl=51 time=8.041 ms
64 bytes from 123.59.41.31: icmp_seq=7 ttl=51 time=8.203 ms
64 bytes from 123.59.41.31: icmp_seq=8 ttl=51 time=6.288 ms
64 bytes from 123.59.41.31: icmp_seq=9 ttl=51 time=7.938 ms

--- api-ucloud.leancloud.cn ping statistics ---
10 packets transmitted, 10 packets received, 0.0% packet loss
round-trip min/avg/max/stddev = 6.288/7.984/9.689/0.997 ms

Then add the following code into your project:

do {
    let testObject = LCObject(className: "TestObject")
    try testObject.set("words", value: "Hello world!")
    _ = testObject.save { result in
        switch result {
        case .success:
            break
        case .failure(let error):
            print(error)
        }
    }
} catch {
    print(error)
}

Hit Run to start debugging. This can be done in either host machine or virtual machine.

Then go to your app's Dashboard > LeanStorage > Data > TestObject. If you see the following content, it means that you have correctly installed the SDK.

See Debugging if you're not seeing the content.

Debugging

This guide is written for the latest version of our SDK. If you encounter any error, please first make sure you have the latest version installed.

401 Unauthorized

If you get a 401 error or see the following content in network logs:

{
  "code": 401,
  "error": "Unauthorized."
}

It means that the App ID or App Key might be incorrect or don't match. If you have multiple apps, you might have used the App ID of one app with the App Key of another one, which will lead to such error.

Client Cannot Access the Internet

Make sure you have granted enough permissions for your mobile app.