Learn about deep linking and how AXIS supports it.*
This article covers deep linking to the AXIS Reference Apps and provides some guidance for setting this up.
Use the links below to navigate the topics covered here, or simply read on.
- What is mobile deep linking?
- How do I set up deep linking for my apps?
- Which page routes does AXIS support?
What is mobile deep linking?
Mobile deep linking is a function that allows an app to be launched and opened on a specific page when a user clicks on a link elsewhere on their device – e.g., a marketing email, a website, or in an app notification. While a regular link can simply launch your app (if the user has it installed) a deep link goes a step further and takes them to predefined, in-app content.
AXIS supports deep linking to your native mobile apps.
Say a user follows a sports team that's involved in an event about to start. With deep linking enabled, a URL shared with the user means they can be taken directly to the event detail page in their app, ready for the start.
A deep link could also take users to newly available content, such as a show, movie, or promotional trailer, allowing you to serve up assets without the user having to search for them.
Deep linking gives you the ability to deliver users straight to your AXIS content with a single click. It’s a short and seamless journey to content discovery, and a key tool for targeting, converting, and (re)engaging users.
How do I set up deep linking for my apps?
While mobile deep linking is not specifically an AXIS feature, you can configure it to work on your AXIS reference apps. We’ve provided some high-level information below, with links to the external documentation that defines the configuration process in more detail.
The setup process is a developer task and differs depending on whether you’re configuring for iOS or Android devices, as described below. Supported AXIS destinations are listed in the next section.
Note: The steps set out below assume that the user already has the app installed on their device.
Deep linking for iOS
AXIS supports the use of URL schemes for iOS deep linking. To configure deep links to your iOS app:
- Define the URL paths for your domain in the iOS AASA (apple-app-site-association) file. The paths will start with your custom scheme name.
- Register the file on your web domain to verify ownership, and so the system associates your domain with the apps and knows where to direct the relevant URL.
- Process incoming URLs
More detailed information about the iOS process can be found on the Apple developer site.
Deep linking for Android
Android deep links require the use of intents.
- Add intent filters to the AndroidManifest file and set MainActivity as the target
- (Optional) Read data from URL parameters
- From MainActivity, use the following code to provide navigation to anywhere within the app:
// Navigate based on PageKey activityViewModel.contentActions.pageNavigator.changePage(Screen.forPageKey(PageKey.ACCOUNT_CHANGE_PASSWORD)) // Navigate based on path activityViewModel.contentActions.pageNavigator.changePage(Screen.forPath("/new-page")) // Navigate to a static page activityViewModel.contentActions.pageNavigator.changeToStaticPage( PagePath.PAGE_ACCOUNT_DOWNLOADS, DownloadUiUtils.DOWNLOADS_PAGE_ROUTE)
4. (Optional) Verify the domain to avoid the app chooser dialog (users being prompted to choose which app to use to open the link).
The Android developer site provides more detailed information about the setup process for Android apps.
Which page routes does AXIS support?
Listed below are the paths/page routes available for deep linking in AXIS, out of the box:
- Sub Category
- List Detail
- List Detail Featured
- Item Detail
- Account Profile Bookmark
- Account Profile Watched
- Enhanced Search
- Support (Simple)
- Support (Complex)
- Movie Detail
- Show Detail
- Program Detail
- Episode Detail
- Season Detail
- Channel Detail
- Custom Asset Detail
- Competition Detail
- Event Detail
- Confederation Detail
- Persona Detail
- Team Detail
- Web View