Skip to content

Latest commit

 

History

History
110 lines (84 loc) · 4.21 KB

DYNAMIC_LINKS.md

File metadata and controls

110 lines (84 loc) · 4.21 KB
Raw

Dynamic Links

Note that the Invites feature has been removed in plugin version 9.0.0, and will be removed from Firebase itself on January 24, 2020.

Enabling Dynamic Links

You will be prompted during installation of the plugin to enable Dynamic Links (off by default). This will add "dynamic_links": true to your firebase.nativescript.json file, now remove the platforms folder so this change is picked up.

Android

iOS

  • You must have the App Store ID and App ID set in your developer console project settings.

Receiving Dynamic Links

Android

To have a dynamic link open your app you need to add an Intent filter to the <activity> in app/App_Resources/Android/AndroidManifest.xml:

  <intent-filter>
    <action android:name="android.intent.action.VIEW"/>
    <category android:name="android.intent.category.DEFAULT"/>
    <category android:name="android.intent.category.BROWSABLE"/>
    <data android:host="www.coolapp.com" android:scheme="http"/><!-- Change this -->
    <data android:host="www.coolapp.com" android:scheme="https"/><!-- .. and this! -->
  </intent-filter>

When users open a Dynamic Link with a deep link to the scheme and host you specify, your app will start the activity with this intent filter to handle the link. See the offical docs for details.

iOS

On iOS you'll need to add a custom URL scheme to app/App_Resources/iOS/Info.plist (if you don't have this one already):

	<key>CFBundleURLTypes</key>
	<array>
		<dict>
			<key>CFBundleTypeRole</key>
			<string>Editor</string>
			<key>CFBundleURLName</key>
			<string>firebaseplugin.deeplink.urlscheme</string><!-- anything you like, but must be unique -->
			<key>CFBundleURLSchemes</key>
			<array>
				<string>org.nativescript.firebasedemo</string><!-- the same as your bundle id (nativescript.id in package.json) -->
			</array>
		</dict>
	</array>

Now open the project in Xcode (the platforms/ios/<projectname>.xcworkspace file!) and in the Capabilities tab enable Associated Domains and add the following to the Associated Domains list:

applinks:app_code.app.goo.gl

Where app_code can be found in the Firebase console at the Dynamic Links section.

If you are using a custom domain, add in your App_Resources/iOS/Info.plist the following lines

<key>FirebaseDynamicLinksCustomDomains</key>
<array>
  <string>https://example.com/link</string>
  <string>https://example.com/promos</string>
</array>

See https://firebase.google.com/docs/dynamic-links/custom-domains#set_up_a_custom_domain_in_the for more info

Copy the entitlements file

The previous step created a the fileplatforms/ios/YourAppName/(Resources/)YourAppName.entitlements. Copy that file to app/App_Resources/iOS/ (if it doesn't exist yet, otherwise merge its contents), so it's not removed when you remove and re-add the iOS platform. The relevant content looks like this:

	<key>com.apple.developer.associated-domains</key>
	<array>
		<string>applinks:j4ctx.app.goo.gl</string>
	</array>

Note that since plugin version 5.1.8 the name of the file can either be <YourAppName>.entitlements or app.entitlements. YourAppName is the iOS foldername, see the path above.

Functions

addOnDynamicLinkReceivedCallback / init.onDynamicLinkCallback

When your app is launched from a dynamic link, you may want to capture that link and perform some action.

You can either add an onDynamicLinkCallback callback to init, or use addOnDynamicLinkReceivedCallback:

  firebase.init({
    onDynamicLinkCallback: function (result) {
      console.log("Dynamic Link: " + result.url+ ", matchConfidence: "+ result.matchConfidence); 
    }
  });

.. or:

  firebase.addOnDynamicLinkReceivedCallback(
    function (url) {
      // ..
    }
  );