appsonair-react-native-applink/lib/typescript/commonjs/src/index.d.ts

A self-hosted dynamic link service for app download tracking, deep linking, and engagement analytics.

import { type EmitterSubscription } from 'react-native';
import type { AppLinkParams, CreateAppLinkResponse } from './types';
export * from './types';
/**
 * Initializes the Appsonair React Native AppLink module.
 * Should be called once during app startup to set up deep link handling.
 *
 * @returns {Promise<boolean>} A promise that resolves to `true` if initialization succeeds.
 */
export declare const initializeAppLink: () => Promise<boolean>;
/**
 * Creates a new app link using the provided parameters.
 * The resulting app link can be used to navigate to specific content within the app.
 *
 * @param {AppLinkParams} params - Parameters used to generate the deep link.
 * @returns {Promise<CreateAppLinkResponse>} A promise that resolves to the generated deep link URL, or `null` if creation fails.
 */
export declare const createAppLink: ({ url, name, urlPrefix, shortId, metaTitle, metaDescription, metaImageUrl, isOpenInBrowserAndroid, isOpenInAndroidApp, androidFallbackUrl, isOpenInBrowserApple, isOpenInIosApp, iOSFallbackUrl, }: AppLinkParams) => Promise<CreateAppLinkResponse>;
/**
 * Fetches referral details from the Appsonair deep link service.
 * This method retrieves any available referral metadata associated with the user's session.
 *
 * @returns A Promise that resolves to an object containing referral details, or `null` if no referral data is available.
 */
export declare const getReferralDetails: () => Promise<any>;
/**
 * Registers a listener for when a deep link is successfully processed.
 * The callback receives the processed deep link URL and any associated result data.
 *
 * @param {(event: { url: string; result: string }) => void} callback - Function to be called when a deep link is processed.
 * @returns {EmitterSubscription | null} An event subscription, or `null` if the listener could not be registered.
 */
export declare const onDeepLinkProcessed: (callback: (event: {
    url: string;
    result: string;
}) => void) => EmitterSubscription | null;
//# sourceMappingURL=index.d.ts.map