Jump to top
Edit Page

DynamicLinkIOSParameters

interface

The DynamicLinkIOSParameters interface provides functionality to configure the behaviour of dynamic links for iOS devices.

If any parameter is declared then the iOS BundleId must also be set via setBundleId

Example
const linkParams = firebase.dynamicLinks().newDynamicLinkParameters('https://invertase.io', 'https://xyz.page.link');
linkParams
  .ios.setBundleId('io.invertase.testing')
  .ios.setAppStoreId('123456789')
  .ios.setMinimumVersion('18');

 const link = await firebase.dynamicLinks().buildLink({
   link: 'https://invertase.io',
   domainUriPrefix: 'https://xyz.page.link',
   ios: {
     bundleId: 'io.invertase.testing',
     appStoreId: '123456789',
     minimumVersion: '18',
   }
 });

Properties

appStoreId

</>

Sets the App Store ID, used to send users to the App Store when the app isn't installed.

appStoreId: undefined | string;

bundleId

</>

The bundle ID of the iOS app to use to open the link. The app must be connected to your project from the Overview page of the Firebase console.

bundleId: string;

customScheme

</>

Sets the app's custom URL scheme, if defined to be something other than your app's parameters ID.

customScheme: undefined | string;

fallbackUrl

</>

Sets the link to open when the app isn't installed. Specify this to do something other than install your app from the App Store when the app isn't installed, such as open the mobile web version of the content, or display a promotional page for your app.

fallbackUrl: undefined | string;

iPadBundleId

</>

Sets the bundle ID of the iOS app to use on iPads to open the link. The app must be connected to your project from the Overview page of the Firebase console.

iPadBundleId: undefined | string;

iPadFallbackUrl

</>

Sets the link to open on iPads when the app isn't installed. Specify this to do something other than install your app from the App Store when the app isn't installed, such as open the web version of the content, or display a promotional page for your app. Overrides the fallback link set by setFallbackUrl on iPad.

iPadFallbackUrl: undefined | string;

minimumVersion

</>

Sets the minimum version of your app that can open the link.

minimumVersion: undefined | string;