How to Install the .NET SDK

Installing SDK

Unity

• Supports Unity 5.3+.

Supports iOS, Android, UWP, Windows Desktop, and web games built with Unity.

Installing LeanStorage

Download the latest version of Unity Storage, unzip it, and import it into your Unity project.

Installing LeanMessage

Download the latest version of Unity Realtime, unzip it, and import it into your Unity project.

Breakdown

You will find the following dependencies after unzipping the files:

Name	Description	Required
AssemblyLister.dll	LeanCloud dependency detection module. Used to check if dependencies are imported correctly.	Yes
LeanCloud.Core.dll	Core library. Includes definitions and methods for built-in types like AVObject and AVUser.	Yes
LeanCloud.Storage.dll	LeanStorage library. Includes methods for local caching and HTTP requests.	Yes
LeanCloud.Realtime.dll	LeanMessage library. Includes methods used for LeanMessage services.	No

.NET Framework

.NET Framework supports the .NET Framework 4.5+ runtime.

Install nuget in Visual Studio:

# LeanStorage (required)
PM> Install-Package LeanCloud.Storage
# LiveQuery (optional)
PM> Install-Package LeanCloud.LiveQuery
# LeanMessage (optional)
PM> Install-Package LeanCloud.Realtime

Initializing Your Project

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

Import basic modules:

// LeanStorage
using LeanCloud;
// LeanMessage (optional)
using LeanCloud.Realtime;

Initializing LeanStorage

Run the following code before using LeanStorage:

AVClient.Initialize("{{appid}}", "{{appkey}}");

Initializing LeanMessage

Run the following code before using LeanMessage:

const realtime = new AVRealtime("{{appid}}", "{{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.

// Enable debug logs for LeanStorage
AVClient.HttpLog(Debug.Log);

// Enable debug logs for LeanMessage
AVRealtime.WebSocketLog(Debug.Log);

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:

AVObject testObject = new AVObject("TestObject");
testObject["words"] = "Hello world!";
Task saveTask = testObject.SaveAsync();
await saveTask;

Save the file and run it.

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.