README.md

GetFeedback for Apps - Capacitor

GetFeedback for Apps allows you to collect feedback from your users with great ease and flexibility. This Capacitor bridge to the Native GetFeedback / Usabilla SDK allows you to load passive feedback forms or campaigns and submit results from an Ionic Capcitor app. This release uses the GetFeedback / Usabilla SDK for ios v6.10+ and android v7.+.

• GetFeedback for Apps - Capacitor
  • Installation
  • Native SDK
  • API
  • Support

Installation

Note : We have introducing a new feature Standard Events from v1.1.0 onwards Click here to read more about Standard Events.

The installation of this SDK consists of two parts, one part for your projects a whole and the second part for iOS(#ios) and Android(#android) specifically. To install the GetFeedback SDK into your Ionic Application: Installation

In a terminal window, navigate to the root directory of your project and run :

npm i -S https://github.com/GetFeedback/getfeedback-g4a-capacitor.git

or

npm install getfeedback-capacitor
npx cap sync

Native SDK

To read in detail about all the features for the SDK

• iOS SDK
• Android SDK

API

• initialize(...)
• standardEvents(...)
• setDebugEnabled(...)
• setCustomVariables(...)
• loadFeedbackForm(...)
• loadFeedbackFormWithCurrentViewScreenshot(...)
• sendEvent(...)
• resetCampaignData()
• dismiss()
• loadLocalizedStringFile(...)
• preloadFeedbackForms(...)
• removeCachedForms()
• setDataMasking(...)
• getDefaultDataMasks()
• Type Aliases

initialize(...)

initialize(options: { appID: string; }) => void

Param	Type
options	{ appID: string; }

---

standardEvents(...)

standardEvents(callback: standardEventsCallback) => Promise<CallbackID>

Param	Type
callback	standardEventsCallback

Returns: Promise<string>

---

setDebugEnabled(...)

setDebugEnabled(options: { debugEnabled: boolean; }) => void

Param	Type
options	{ debugEnabled: boolean; }

---

setCustomVariables(...)

setCustomVariables(options: { customVariables: any; }) => void

Param	Type
options	{ customVariables: any; }

---

loadFeedbackForm(...)

loadFeedbackForm(options: { formID: string; }) => Promise<any>

Param	Type
options	{ formID: string; }

Returns: Promise<any>

---

loadFeedbackFormWithCurrentViewScreenshot(...)

loadFeedbackFormWithCurrentViewScreenshot(options: { formID: string; }) => Promise<any>

Param	Type
options	{ formID: string; }

Returns: Promise<any>

---

sendEvent(...)

sendEvent(options: { eventName: string; }) => Promise<any>

Param	Type
options	{ eventName: string; }

Returns: Promise<any>

---

resetCampaignData()

resetCampaignData() => void

---

dismiss()

dismiss() => void

---

loadLocalizedStringFile(...)

loadLocalizedStringFile(options: { localizedStringFile: string; }) => void

Param	Type
options	{ localizedStringFile: string; }

---

preloadFeedbackForms(...)

preloadFeedbackForms(options: { formIDs: string[]; }) => void

Param	Type
options	{ formIDs: string[]; }

---

removeCachedForms()

removeCachedForms() => void

---

setDataMasking(...)

setDataMasking(options?: { masks?: string[] | undefined; character?: string | undefined; } | undefined) => void

Param	Type
options	{ masks?: string[]; character?: string; }

---

getDefaultDataMasks()

getDefaultDataMasks() => Promise<any>

Returns: Promise<any>

---

Type Aliases

standardEventsCallback

(response: any, error?: any): void

CallbackID

string

Support

If you need help, want to report an issue, or have a question please reach out to the support team via our Help Center or email [email protected]