@innomobile/capacitor-branch-deep-links v1.0.0

@innomobile/capacitor-branch-deep-links

Branch.io deep links

Please refer to Branch's SDK Documentation for Capacitor for installation. You do not need to add Branch to the MainActivitcy class in Android. Remove it if you added it.

Install

npm install @innomobile/capacitor-branch-deep-links
npx cap sync

Inside your project use

import {BranchDeepLinks, BranchShortUrlAnalytics} from '@innomobile/capacitor-branch-deep-links';

@Injectable({
  providedIn: 'root',
})
export class BranchService {
  
  async generateShortUrl(analytics, properties) {
    try {
      const response = await BranchDeepLinks.generateShortUrl({analytics, properties})
      return response.url
    } catch (err) {
      // do something on error
    }
  }
}

API

• addListener(...)
• addListener(...)
• handleUrl(...)
• generateShortUrl(...)
• showShareSheet(...)
• getStandardEvents()
• sendBranchEvent(...)
• disableTracking(...)
• setIdentity(...)
• logout()
• Interfaces

addListener(...)

addListener(eventName: 'init', listenerFunc: (event: BranchInitEvent) => void) => Promise<PluginListenerHandle> & PluginListenerHandle

Returns: any

addListener(...)

addListener(eventName: 'initError', listenerFunc: (error: any) => void) => Promise<PluginListenerHandle> & PluginListenerHandle

Returns: any

handleUrl(...)

handleUrl(options: BranchUrlParams) => any

Returns: any

generateShortUrl(...)

generateShortUrl(options: BranchShortUrlParams) => any

Returns: any

showShareSheet(...)

showShareSheet(options: BranchShowShareSheetParams) => any

Returns: any

getStandardEvents()

getStandardEvents() => any

Returns: any

sendBranchEvent(...)

sendBranchEvent(options: { eventName: string; metaData: { [key: string]: any; }; }) => any

Returns: any

disableTracking(...)

disableTracking(options: { isEnabled: false; }) => any

Returns: any

setIdentity(...)

setIdentity(options: { newIdentity: string; }) => any

Returns: any

logout()

logout() => any

Returns: any

Interfaces

PluginListenerHandle

BranchUrlParams

BranchShortUrlParams

BranchShortUrlAnalytics

BranchShortUrlProperties

BranchShortUrlResponse

BranchShowShareSheetParams

BranchTrackingResponse

BranchReferringParamsResponse

BranchReferringParams

BranchLoggedOutResponse