Skip to content

Latest commit

 

History

History
81 lines (55 loc) · 2.3 KB

File metadata and controls

81 lines (55 loc) · 2.3 KB

@chinchilla-software/firebase-app-tester-feedback

This add the basics for bringing Firebase's AppTester Feedback feature to capacitor. It doesn't include the web code you need authorise Push Notifications (see https://firebase.google.com/docs/app-distribution/collect-feedback-from-testers#notification-trigger) use the capacitor plugin for handling enabling push notifications (https://capacitorjs.com/docs/apis/push-notifications#example).

Install

npm install @chinchilla-software/firebase-app-tester-feedback
npx cap sync

Setup

Project

Use the example documentation from https://capacitorjs.com/docs/apis/push-notifications#example modify the "registration" event handler to include:

  console.info('Registration token: ', token.value);

  const { state } = await FirebaseAppTesterFeeback.activate();
  console.log('Activating AppTesterFeedback:', state);

and add the following include:

import { FirebaseAppTesterFeeback } from '@chinchilla-software/firebase-app-tester-feedback';

Android

for Android add the following to your MainActivity class:

    @Override
    public void onCreate(Bundle savedInstanceState) {
        registerPlugin(FirebaseAppTesterFeebackPlugin.class);
        super.onCreate(savedInstanceState);
    }

and all the following import:

import nz.co.chinchillasoftware.firebase.apptester.feedback.FirebaseAppTesterFeebackPlugin;

IOS

Not currently implemented.

Important notes

Really that's it.

Be sure to read the details from Google. They've indicated this Firebase feature using their SDK may not pass app store verification, so it sounds like it's a feature best kept for internal/test builds. If it is rejected for a published app, modify your build CI/CD systems to remove the plugin, re-sync and push/publish to the store.

API

activate()

activate() => Promise<{ state: string; }>

Calls the firebaseAppDistribution.showFeedbackNotification method see https://firebase.google.com/docs/app-distribution/collect-feedback-from-testers#notification-trigger

Returns: Promise<{ state: string; }>