How to Install the Objective-C 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

The easiest way to integrate our SDK into your project is to use CocoaPods.

Add the following pods into the target of Podfile:

pod 'AVOSCloud'   # (required) LeanStorage, SMS, LeanEngine etc.
pod 'AVOSCloudIM' # (optional) LeanMessage
pod 'AVOSCloudLiveQuery' # (optional) LiveQuery

After adding the pods, run pod update or pod install --repo-update under the same directory to complete the installation.

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

Installing Manually

Download SDK

Downloading Source Code

Clone the repository of the SDK to the root directory of the project:

git clone "https://github.com/leancloud/objc-sdk.git" leancloud-objc-sdk

Then check out the version you wish to use. The versions of the SDK are marked with tags so that you can check out the latest version with the following command:

cd leancloud-objc-sdk
git checkout $(git describe --tags $(git rev-list --tags --max-count=1))

Integrating SDK

The following two ways can be used to add the SDK into your project. You may select any one of them:

• Add the xcodeproj file of the SDK into the project.
• Compile the SDK into frameworks and add them to the project.

Integrating xcodeproj

Drag and drop AVOS/AVOS.xcodeproj into the project as a subproject:

Then set up Build Phases for the project. Add the following contents into Link Binary With Libraries:

Here we chose AVOSCloud and AVOSCloudIM as examples of frameworks being used. You can make your selections according to the platform you are building for and the modules you are using.

Adding System Dependencies

Now add the system frameworks and libraries the SDK depends on:

• libz
• libc++
• libicucore
• libsqlite3
• SystemConfiguration.framework
• MobileCoreServices.framework
• CoreTelephony.framework
• CoreLocation.framework

Like this:

The last step is to add -ObjC into Other Linker Flags.

You're all set!

Initializing Your Project

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

Import the basic modules into AppDelegate:

#import <AVOSCloud/AVOSCloud.h>

Then paste the following code into the application:didFinishLaunchingWithOptions: method:

[AVOSCloud setApplicationId:@"{{appid}}" clientKey:@"{{appkey}}"];

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 after [AVOSCloud setApplicationId:]; only needs to be called once
[AVOSCloud setAllLogsEnabled:YES];

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

Now let's try saving an object to the cloud. Add the following code into the viewDidLoad method or any other method that will be called when the app starts:

AVObject *testObject = [AVObject objectWithClassName:@"TestObject"];
[testObject setObject:@"Hello world!" forKey:@"words"];
[testObject save];

Hit Run to start debugging. This can be done in either a host machine or a 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.