bolts

Class AppLinkNavigation

java.lang.Object

bolts.AppLinkNavigation

public class AppLinkNavigation
extends java.lang.Object

Represents a pending request to navigate to an App Link. Most developers will simply use navigateInBackground(android.content.Context, android.net.Uri) to open a URL, but developers can build custom requests with additional navigation and app data attached to them by creating AppLinkNavigations themselves.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AppLinkNavigation.NavigationResult The result of calling navigate(android.content.Context) on an AppLinkNavigation.

Constructor Summary

Constructors

Constructor and Description
AppLinkNavigation(AppLink appLink, android.os.Bundle extras, android.os.Bundle appLinkData) Creates an AppLinkNavigation with the given link, extras, and App Link data.

Method Summary

Methods

Modifier and Type	Method and Description
AppLink	getAppLink()
android.os.Bundle	getAppLinkData() Gets the al_applink_data for the AppLinkNavigation.
static AppLinkResolver	getDefaultResolver() Gets the default resolver to be used for App Link resolution.
android.os.Bundle	getExtras() The extras for the AppLinkNavigation.
AppLinkNavigation.NavigationResult	navigate(android.content.Context context) Performs the navigation.
static AppLinkNavigation.NavigationResult	navigate(android.content.Context context, AppLink appLink) Navigates to an AppLink.
static Task<AppLinkNavigation.NavigationResult>	navigateInBackground(android.content.Context context, java.lang.String destinationUrl) Navigates to an AppLink for the given destination using the default App Link resolution strategy.
static Task<AppLinkNavigation.NavigationResult>	navigateInBackground(android.content.Context context, java.lang.String destinationUrl, AppLinkResolver resolver) Navigates to an AppLink for the given destination using the App Link resolution strategy specified.
static Task<AppLinkNavigation.NavigationResult>	navigateInBackground(android.content.Context context, android.net.Uri destination) Navigates to an AppLink for the given destination using the default App Link resolution strategy.
static Task<AppLinkNavigation.NavigationResult>	navigateInBackground(android.content.Context context, android.net.Uri destination, AppLinkResolver resolver) Navigates to an AppLink for the given destination using the App Link resolution strategy specified.
static Task<AppLinkNavigation.NavigationResult>	navigateInBackground(android.content.Context context, java.net.URL destination) Navigates to an AppLink for the given destination using the default App Link resolution strategy.
static Task<AppLinkNavigation.NavigationResult>	navigateInBackground(android.content.Context context, java.net.URL destination, AppLinkResolver resolver) Navigates to an AppLink for the given destination using the App Link resolution strategy specified.
static void	setDefaultResolver(AppLinkResolver resolver) Sets the default resolver to be used for App Link resolution.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AppLinkNavigation

public AppLinkNavigation(AppLink appLink,
                 android.os.Bundle extras,
                 android.os.Bundle appLinkData)

Creates an AppLinkNavigation with the given link, extras, and App Link data.

Parameters:

appLink - the AppLink being navigated to.

extras - the extras to include in the App Link navigation.

appLinkData - additional App Link data for the navigation.

Method Detail

getAppLink

public AppLink getAppLink()

Returns:

the App Link to navigate to.

getAppLinkData

public android.os.Bundle getAppLinkData()

Gets the al_applink_data for the AppLinkNavigation. This will generally contain data common to navigation attempts such as back-links, user agents, and other information that may be used in routing and handling an App Link request.

Returns:

the App Link data.

getExtras

public android.os.Bundle getExtras()

The extras for the AppLinkNavigation. This will generally contain application-specific data that should be passed along with the request, such as advertiser or affiliate IDs or other such metadata relevant on this device.

Returns:

the extras for the AppLinkNavigation.

navigate

public AppLinkNavigation.NavigationResult navigate(android.content.Context context)

Performs the navigation.

Parameters:

context - the Context from which the navigation should be performed.

Returns:

the AppLinkNavigation.NavigationResult performed by navigating.

setDefaultResolver

public static void setDefaultResolver(AppLinkResolver resolver)

Sets the default resolver to be used for App Link resolution. Setting this to null will cause the navigateInBackground(android.content.Context, android.net.Uri) methods to use the basic, built-in resolver provided by Bolts.

Parameters:

resolver - the resolver to use by default.

getDefaultResolver

public static AppLinkResolver getDefaultResolver()

Gets the default resolver to be used for App Link resolution. If the developer has not set a default resolver, this will return null, but the basic, built-in resolver provided by Bolts will be used.

Returns:

the default resolver, or null if none is set.

navigate

public static AppLinkNavigation.NavigationResult navigate(android.content.Context context,
                                          AppLink appLink)

Navigates to an AppLink.

Parameters:

context - the Context from which the navigation should be performed.

appLink - the AppLink being navigated to.

Returns:

the AppLinkNavigation.NavigationResult performed by navigating.

navigateInBackground

public static Task<AppLinkNavigation.NavigationResult> navigateInBackground(android.content.Context context,
                                                            android.net.Uri destination,
                                                            AppLinkResolver resolver)

Navigates to an AppLink for the given destination using the App Link resolution strategy specified.

Parameters:

context - the Context from which the navigation should be performed.

destination - the destination URL for the App Link.

resolver - the resolver to use for fetching App Link metadata.

Returns:

the AppLinkNavigation.NavigationResult performed by navigating.

navigateInBackground

public static Task<AppLinkNavigation.NavigationResult> navigateInBackground(android.content.Context context,
                                                            java.net.URL destination,
                                                            AppLinkResolver resolver)

Navigates to an AppLink for the given destination using the App Link resolution strategy specified.

Parameters:

context - the Context from which the navigation should be performed.

destination - the destination URL for the App Link.

resolver - the resolver to use for fetching App Link metadata.

Returns:

the AppLinkNavigation.NavigationResult performed by navigating.

navigateInBackground

public static Task<AppLinkNavigation.NavigationResult> navigateInBackground(android.content.Context context,
                                                            java.lang.String destinationUrl,
                                                            AppLinkResolver resolver)

Navigates to an AppLink for the given destination using the App Link resolution strategy specified.

Parameters:

context - the Context from which the navigation should be performed.

destinationUrl - the destination URL for the App Link.

resolver - the resolver to use for fetching App Link metadata.

Returns:

the AppLinkNavigation.NavigationResult performed by navigating.

navigateInBackground

public static Task<AppLinkNavigation.NavigationResult> navigateInBackground(android.content.Context context,
                                                            android.net.Uri destination)

Navigates to an AppLink for the given destination using the default App Link resolution strategy.

Parameters:

context - the Context from which the navigation should be performed.

destination - the destination URL for the App Link.

Returns:

the AppLinkNavigation.NavigationResult performed by navigating.

navigateInBackground

public static Task<AppLinkNavigation.NavigationResult> navigateInBackground(android.content.Context context,
                                                            java.net.URL destination)

Navigates to an AppLink for the given destination using the default App Link resolution strategy.

Parameters:

context - the Context from which the navigation should be performed.

destination - the destination URL for the App Link.

Returns:

the AppLinkNavigation.NavigationResult performed by navigating.

navigateInBackground

public static Task<AppLinkNavigation.NavigationResult> navigateInBackground(android.content.Context context,
                                                            java.lang.String destinationUrl)

Navigates to an AppLink for the given destination using the default App Link resolution strategy.

Parameters:

context - the Context from which the navigation should be performed.

destinationUrl - the destination URL for the App Link.

Returns:

the AppLinkNavigation.NavigationResult performed by navigating.