capacitor-plugin-segment-appsflyer

Integration appsflyer

Install

npm install capacitor-plugin-segment-appsflyer
npx cap sync

API

• echo(...)
• addListener('conversion_callback', ...)
• addListener('oaoa_callback', ...)
• addListener('udl_callback', ...)
• initialize(...)
• identify(...)
• track(...)
• trackPage(...)
• Interfaces
• Type Aliases

echo(...)

echo(options: { value: string; }) => Promise<{ value: string; }>

| Param | Type | | ------------- | ------------------------------- | | options | { value: string; } |

Returns: Promise<{ value: string; }>

addListener('conversion_callback', ...)

addListener(eventName: 'conversion_callback', listenerFunc: (event: OnConversionDataResult) => void) => PluginListenerHandle

| Param | Type | | ------------------ | --------------------------------------------------------------------------------------------- | | eventName | 'conversion_callback' | | listenerFunc | (event: OnConversionDataResult) => void |

Returns: PluginListenerHandle

addListener('oaoa_callback', ...)

addListener(eventName: 'oaoa_callback', listenerFunc: (event: OnAppOpenAttribution) => void) => PluginListenerHandle

| Param | Type | | ------------------ | ----------------------------------------------------------------------------------------- | | eventName | 'oaoa_callback' | | listenerFunc | (event: OnAppOpenAttribution) => void |

Returns: PluginListenerHandle

addListener('udl_callback', ...)

addListener(eventName: 'udl_callback', listenerFunc: (event: OnDeepLink) => void) => PluginListenerHandle

| Param | Type | | ------------------ | --------------------------------------------------------------------- | | eventName | 'udl_callback' | | listenerFunc | (event: OnDeepLink) => void |

Returns: PluginListenerHandle

initialize(...)

initialize(options: { writeKey: string; isDebug?: boolean; waitForATTUserAuthorization?: number; trackLifecycleEvents?: boolean; }) => Promise<void>

| Param | Type | | ------------- | --------------------------------------------------------------------------------------------------------------------------- | | options | { writeKey: string; isDebug?: boolean; waitForATTUserAuthorization?: number; trackLifecycleEvents?: boolean; } |

identify(...)

identify(options: { userId: string; traits?: Record<string, unknown>; }) => Promise<void>

| Param | Type | | ------------- | ---------------------------------------------------------------------------------------------- | | options | { userId: string; traits?: Record<string, unknown>; } |

track(...)

track(options: { eventName: string; properties: Record<string, unknown>; }) => Promise<void>

| Param | Type | | ------------- | ---------------------------------------------------------------------------------------------------- | | options | { eventName: string; properties: Record<string, unknown>; } |

trackPage(...)

trackPage(options: { eventName: string; properties: Record<string, unknown>; }) => Promise<void>

| Param | Type | | ------------- | ---------------------------------------------------------------------------------------------------- | | options | { eventName: string; properties: Record<string, unknown>; } |

Interfaces

PluginListenerHandle

| Prop | Type | | ------------ | ----------------------------------------- | | remove | () => Promise<void> |

OnConversionDataResult

| Prop | Type | | ------------------ | ------------------- | | callbackName | string | | errorMessage | string | | data | any |

OnAppOpenAttribution

| Prop | Type | | ------------------ | ------------------- | | callbackName | string | | errorMessage | string | | data | any |

OnDeepLink

| Prop | Type | | -------------- | ------------------- | | status | string | | error | string | | deepLink | any |

Type Aliases

Record

Construct a type with a set of properties K of type T

{ [P in K]: T; }