@houseninja/capacitor-branch

Please refer to Branch's SDK Documentation for Capacitor.

Install

npm install @houseninja/capacitor-branch

Sync capacitor

npx cap sync

API

• addListener('init', ...)
• addListener('initError', ...)
• handleUrl(...)
• generateShortUrl(...)
• showShareSheet(...)
• getStandardEvents()
• sendBranchEvent(...)
• disableTracking(...)
• setIdentity(...)
• logout()
• getBranchQRCode(...)
• removeAllListeners()
• Interfaces

addListener('init', ...)

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

Param	Type
eventName	'init'
listenerFunc	(event: BranchInitEvent) => void

Returns: PluginListenerHandle

---

addListener('initError', ...)

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

Param	Type
eventName	'initError'
listenerFunc	(error: any) => void

Returns: PluginListenerHandle

---

handleUrl(...)

handleUrl(options: BranchUrlParams) => Promise<void>

Param	Type
options	BranchUrlParams

---

generateShortUrl(...)

generateShortUrl(options: BranchShortUrlParams) => Promise<BranchShortUrlResponse>

Param	Type
options	BranchShortUrlParams

Returns: Promise<BranchShortUrlResponse>

---

showShareSheet(...)

showShareSheet(options: BranchShowShareSheetParams) => Promise<void>

Param	Type
options	BranchShowShareSheetParams

---

getStandardEvents()

getStandardEvents() => Promise<{ [index: number]: string; }>

Returns: Promise<{ [index: number]: string; }>

---

sendBranchEvent(...)

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

Param	Type
options	{ eventName: string; metaData: { [key: string]: any; }; }

---

disableTracking(...)

disableTracking(options: { isEnabled: false; }) => Promise<BranchTrackingResponse>

Param	Type
options	{ isEnabled: false; }

Returns: Promise<BranchTrackingResponse>

---

setIdentity(...)

setIdentity(options: { newIdentity: string; }) => Promise<BranchReferringParamsResponse>

Param	Type
options	{ newIdentity: string; }

Returns: Promise<BranchReferringParamsResponse>

---

logout()

logout() => Promise<BranchLoggedOutResponse>

Returns: Promise<BranchLoggedOutResponse>

---

getBranchQRCode(...)

getBranchQRCode(options: BranchQRCodeParams) => Promise<BranchQRCodeResponse>

Param	Type
options	BranchQRCodeParams

Returns: Promise<BranchQRCodeResponse>

---

removeAllListeners()

removeAllListeners() => Promise<void>

---

Interfaces

PluginListenerHandle

Prop	Type
remove	() => Promise<void>

BranchInitEvent

BranchUrlParams

Prop	Type
url	string

BranchShortUrlResponse

Prop	Type
url	string

BranchShortUrlParams

Prop	Type
analytics	BranchShortUrlAnalytics
properties	BranchShortUrlProperties

BranchShortUrlAnalytics

Prop	Type
alias	string
campaign	string
channel	string
duration	number
feature	string
stage	string
tags	Array<string>

Array

Prop	Type	Description
length	number	Gets or sets the length of the array. This is a number one higher than the highest index in the array.

Method	Signature	Description
toString	() => string	Returns a string representation of an array.
toLocaleString	() => string	Returns a string representation of an array. The elements are converted to string using their toLocalString methods.
pop	() => T | undefined	Removes the last element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.
push	(...items: T[]) => number	Appends new elements to the end of an array, and returns the new length of the array.
concat	(...items: ConcatArray<T>[]) => T[]	Combines two or more arrays. This method returns a new array without modifying any existing arrays.
concat	(...items: (T | ConcatArray<T>)[]) => T[]	Combines two or more arrays. This method returns a new array without modifying any existing arrays.
join	(separator?: string | undefined) => string	Adds all the elements of an array into a string, separated by the specified separator string.
reverse	() => T[]	Reverses the elements in an array in place. This method mutates the array and returns a reference to the same array.
shift	() => T | undefined	Removes the first element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.
slice	(start?: number | undefined, end?: number | undefined) => T[]	Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.
sort	(compareFn?: ((a: T, b: T) => number) | undefined) => this	Sorts an array in place. This method mutates the array and returns a reference to the same array.
splice	(start: number, deleteCount?: number | undefined) => T[]	Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
splice	(start: number, deleteCount: number, ...items: T[]) => T[]	Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
unshift	(...items: T[]) => number	Inserts new elements at the start of an array, and returns the new length of the array.
indexOf	(searchElement: T, fromIndex?: number | undefined) => number	Returns the index of the first occurrence of a value in an array, or -1 if it is not present.
lastIndexOf	(searchElement: T, fromIndex?: number | undefined) => number	Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.
every	<S extends T>(predicate: (value: T, index: number, array: T[]) => value is S, thisArg?: any) => this is S[]	Determines whether all the members of an array satisfy the specified test.
every	(predicate: (value: T, index: number, array: T[]) => unknown, thisArg?: any) => boolean	Determines whether all the members of an array satisfy the specified test.
some	(predicate: (value: T, index: number, array: T[]) => unknown, thisArg?: any) => boolean	Determines whether the specified callback function returns true for any element of an array.
forEach	(callbackfn: (value: T, index: number, array: T[]) => void, thisArg?: any) => void	Performs the specified action for each element in an array.
map	<U>(callbackfn: (value: T, index: number, array: T[]) => U, thisArg?: any) => U[]	Calls a defined callback function on each element of an array, and returns an array that contains the results.
filter	<S extends T>(predicate: (value: T, index: number, array: T[]) => value is S, thisArg?: any) => S[]	Returns the elements of an array that meet the condition specified in a callback function.
filter	(predicate: (value: T, index: number, array: T[]) => unknown, thisArg?: any) => T[]	Returns the elements of an array that meet the condition specified in a callback function.
reduce	(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T) => T	Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
reduce	(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T, initialValue: T) => T
reduce	<U>(callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U, initialValue: U) => U	Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
reduceRight	(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T) => T	Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
reduceRight	(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T, initialValue: T) => T
reduceRight	<U>(callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U, initialValue: U) => U	Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

ConcatArray

Prop	Type
length	number

Method	Signature
join	(separator?: string | undefined) => string
slice	(start?: number | undefined, end?: number | undefined) => T[]

BranchShortUrlProperties

Prop	Type
$desktop_url	string
$android_url	string
$ios_url	string
$ipad_url	string
$match_duration	number
custom_string	string
custom_integer	number
custom_boolean	boolean

BranchShowShareSheetParams

Prop	Type
shareText	string

BranchTrackingResponse

Prop	Type
is_enabled	boolean

BranchReferringParamsResponse

Prop	Type
referringParams	BranchReferringParams

BranchReferringParams

Prop	Type
'+clicked_branch_link'	boolean
'+is_first_session'	boolean

BranchLoggedOutResponse

Prop	Type
logged_out	boolean

BranchQRCodeResponse

Prop	Type
qrCode	String

String

Allows manipulation and formatting of text strings and determination and location of substrings within strings.

Prop	Type	Description
length	number	Returns the length of a String object.

Method	Signature	Description
toString	() => string	Returns a string representation of a string.
charAt	(pos: number) => string	Returns the character at the specified index.
charCodeAt	(index: number) => number	Returns the Unicode value of the character at the specified location.
concat	(...strings: string[]) => string	Returns a string that contains the concatenation of two or more strings.
indexOf	(searchString: string, position?: number | undefined) => number	Returns the position of the first occurrence of a substring.
lastIndexOf	(searchString: string, position?: number | undefined) => number	Returns the last occurrence of a substring in the string.
localeCompare	(that: string) => number	Determines whether two strings are equivalent in the current locale.
match	(regexp: string | RegExp) => RegExpMatchArray | null	Matches a string with a regular expression, and returns an array containing the results of that search.
replace	(searchValue: string | RegExp, replaceValue: string) => string	Replaces text in a string, using a regular expression or search string.
replace	(searchValue: string | RegExp, replacer: (substring: string, ...args: any[]) => string) => string	Replaces text in a string, using a regular expression or search string.
search	(regexp: string | RegExp) => number	Finds the first substring match in a regular expression search.
slice	(start?: number | undefined, end?: number | undefined) => string	Returns a section of a string.
split	(separator: string | RegExp, limit?: number | undefined) => string[]	Split a string into substrings using the specified separator and return them as an array.
substring	(start: number, end?: number | undefined) => string	Returns the substring at the specified location within a String object.
toLowerCase	() => string	Converts all the alphabetic characters in a string to lowercase.
toLocaleLowerCase	(locales?: string | string[] | undefined) => string	Converts all alphabetic characters to lowercase, taking into account the host environment's current locale.
toUpperCase	() => string	Converts all the alphabetic characters in a string to uppercase.
toLocaleUpperCase	(locales?: string | string[] | undefined) => string	Returns a string where all alphabetic characters have been converted to uppercase, taking into account the host environment's current locale.
trim	() => string	Removes the leading and trailing white space and line terminator characters from a string.
substr	(from: number, length?: number | undefined) => string	Gets a substring beginning at the specified location and having the specified length.
valueOf	() => string	Returns the primitive value of the specified object.

RegExpMatchArray

Prop	Type
index	number
input	string

RegExp

Prop	Type	Description
source	string	Returns a copy of the text of the regular expression pattern. Read-only. The regExp argument is a Regular expression object. It can be a variable name or a literal.
global	boolean	Returns a Boolean value indicating the state of the global flag (g) used with a regular expression. Default is false. Read-only.
ignoreCase	boolean	Returns a Boolean value indicating the state of the ignoreCase flag (i) used with a regular expression. Default is false. Read-only.
multiline	boolean	Returns a Boolean value indicating the state of the multiline flag (m) used with a regular expression. Default is false. Read-only.
lastIndex	number

Method	Signature	Description
exec	(string: string) => RegExpExecArray | null	Executes a search on a string using a regular expression pattern, and returns an array containing the results of that search.
test	(string: string) => boolean	Returns a Boolean value that indicates whether or not a pattern exists in a searched string.
compile	() => this

RegExpExecArray

Prop	Type
index	number
input	string

BranchQRCodeParams

Prop	Type
analytics	BranchShortUrlAnalytics
properties	BranchShortUrlProperties
settings	BranchQRCodeSettings

BranchQRCodeSettings

Prop	Type
codeColor	string
backgroundColor	string
centerLogo	string
width	number
margin	number
imageFormat	string