A set of tools for Unity to allow handling deeplink activation from within Unity scripts, for Android and iOS, including iOS Universal Links.
- No support for handling multiple url-schemes (yet), a large majority of apps only need to support one anyways.
- Check out the repo's issues section
using Deeplinks;
private void Awake()
{
Deeplink.Received += OnDeeplinkReceived;
}
private void OnDeeplinkReceived(string deepLink)
{
Debug.Log("Deeplink: " + deepLink);
}- Note: If there are no handlers subscribed to
Deeplink.Receivedwhen a deeplink is received they will be stored until a handler is subcribed. The first handler that is subscribed will receive any queued deeplinks in the order they were originally received by the application. No deeplink events are 'lost' because a handler wasn't registered in time. It is recommended to only subcribe one handler which then routes the events to other parts of your application.
- Clone/download the repository
- Export the Assets folder as a .unitypackage
- Import the exported .unitypackage into your Unity project
- Make sure the SDK and JDK folder paths are set correctly
- Go to '(Unity/Edit)' -> 'Preferences' -> 'External Tools' menu
- Scroll down to 'Android' and set the SDK and JDK folder paths
No further setup is required unless the main Android activity has been overridden in your project by you or another plugin, if so then you can use this integration guide
Some might suggest having a "side-activity" e.g. DeeplinkHandlingActivity to handle the deeplink and start the main Unity player activity. This way, the main Unity player activity remains clean of "outside code", right? Wrong. Consider the Unity app is currently not running. Then:
- A deeplink gets activated
- DeeplinkHandlingActivity starts
- Tries to access the UnityPlayer object in order to send a message to a Unity script with the deeplink information
- At this point, since the Unity native libraries are not yet initialized, the call would fail with the error:
Native libraries not loaded - dropping message for ...
Bottom line: you need the Unity player activity initialized in order to call Unity functions from native code. The only way to handle the scenario above would be to have the Unity player activity itself handle the deeplink. Unity will make sure it's initialized prior to the call.
No setup reqired. (Unless UnityAppController is subclassed by something else in your project, you can use this integration guide)
UnityDeeplinks implements a native plugin for iOS, initialized by a private nested class Deeplink.UnityDeeplinkReceiver. The plugin listens for URL/Univeral Link activations and relayes them to the Unity script for processing. It, too, uses a similar approach as the one used for Android: the main Unity app controller gets subclassed.
Also, like in the Android case, if the app is currently not running, we can't simply have the native low-level deeplinking code make calls to Unity scripts until the Unity libraries are initialized. Therefore, we store the deeplink in a variable, wait for the app to initialize the plugin (an indication that the Unity native libraries are ready), and then send the stored deeplink to the Unity script.
- To support Universal Links, set them up as per their specification.
- Note: Universal Link settings in your XCode project are not removed during Unity rebuilds, unless you use the Replace option and overwrite your XCode project
- Prepare a dummy web page that is accessible by your mobile device:
<body>
<a href="myapp://?a=b">deeplink test</a>
</body>- Open the web page on the device browser and click the deeplink
- The Unity app should open and the Deeplink.Received event should be invoked, notifying any subscribed listeners.