Cloud Code SDK

Getting Started

To get started with the Cloud Code SDK:

• Install the version of the package you wish using Package Manager
  • You'll need a scoped registry set up to access the preview package:
    • URL: https://artifactory.prd.it.unity3d.com/artifactory/api/npm/upm-candidates
    • Scope: com.unity.services
• Sign in to your cloud project using the Services window in Unity
• Implement the Authentication sign in flow at a convenient point in your application.

Note: The Cloud Code SDK requires that an authentication flow from the Authentication SDK has been completed prior to using any of the Cloud Code APIs, as a valid player ID and access token are required to access the Cloud Code services. This can be achieved with the following code snippet for anonymous authentication, or see the documentation for the Authentication SDK for more details and other sign in methods:

await AuthenticationService.Instance.SignInAnonymouslyAsync();

Using the SDK

Use of the Cloud Code SDK requires authoring one or more cloud functions in the Cloud Code dashboard.

CallEndpointAsync

/// <summary>
/// Calls a Cloud Code function.
/// </summary>
/// <param name="function">Cloud Code function to call</param>
/// <param name="args">Arguments for the cloud code function</param>
/// <typeparam name="TRequest">Class with fields for each argument to provide to the Cloud Code function</typeparam>
/// <typeparam name="TResult">Serialized from JSON returned by Cloud Code</typeparam>
/// <returns></returns>
public static async Task<TResult> CallEndpointAsync<TRequest, TResult>(string function, TRequest args)

Example Use

using System.Threading.Tasks;
using Unity.Services.Authentication;
using Unity.Services.CloudCode;
using UnityEngine;

class Example : MonoBehaviour
{
    class RequestType
    {
        public int a;
        public int b;
    }

    class ResultType
    {
        public int value;
    }

    public async Task CallMethod()
    {
        if (!AuthenticationService.Instance.IsSignedIn)
        {
            await AuthenticationService.Instance.SignInAnonymouslyAsync();
        }

        var request = new RequestType {a = 13, b = 37};
        ResultType result = await CloudCode.CallEndpointAsync<ResultType>("add", request);

        Debug.Log(result.value.ToString());
    }
}