Receive Dynamic Links with Unity

To receive the Firebase Dynamic Links that you created, you must include the Dynamic Links SDK in your app and register your app to handle the InviteReceived event.

The Unity SDK works for both Android and iOS, with some additional setup required for each platform.

Before you begin

Before you can use Firebase Dynamic Links, you will need to create a Firebase project, and add the Firebase Unity SDK packages to your Unity project.

Setup:

Prerequisites

If you don't have a Unity project already, you can download one of our quickstart samples and experiment with a specific Firebase feature. If you're using a quickstart, remember to get the bundle identifier from the project settings; you'll need it for the next step.

Set up your app in Firebase console

To add Firebase to your app you'll need a Firebase project and a Firebase configuration file for your app.

Create a Firebase project in the Firebase console, if you don't already have one. If you already have an existing Google project associated with your mobile app, click Import Google Project. Otherwise, click Create New Project.

Add the Firebase Unity SDK to your app

1. Download the Firebase Unity SDK
2. Select the Assets > Import Package > Custom Package menu item.
3. Import the FirebaseInvites.unitypackage package from the Firebase Unity SDK, downloaded previously.
4. When the Import Unity Package window appears, click the Import button.

Build your app

Register to receive incoming Dynamic Links

To check for Dynamic Links, you need to register for the InviteReceived event.

void Start() {
    var app = Firebase.FirebaseApp.Create();
    Firebase.Invites.FirebaseInvites.InviteReceived += OnInviteReceived;
    Firebase.Invites.FirebaseInvites.InviteNotReceived += OnInviteNotReceived;
    Firebaes.Invites.FirebaseInvites.ErrorReceived += OnErrorReceived;
}

void OnInviteReceived(object sender,
                      Firebase.Invites.InviteReceivedEventArgs e) {
  if (e.InvitationId != "") {
    Debug.Log("Invite received: Invitation ID: " + e.InvitationId);
    Firebase.Invites.FirebaseInvites.ConvertInvitationAsync(
        e.InvitationId).ContinueWith(HandleConversionResult);
  }
  if (e.DeepLink != "") {
    Debug.Log("Invite received: Deep Link: " + e.DeepLink);
  }
}

void OnInviteNotReceived(object sender, System.EventArgs e) {
  Debug.Log("No Invite or Deep Link received on start up");
}

void OnErrorReceived(object sender,
                     Firebase.Invites.InviteErrorReceivedEventArgs e) {
  Debug.LogError("Error occurred received the invite: " + e.ErrorMessage);
}