help_scout_beacon 0.0.1-dev.2

Streamline customer communications in your app with the Help Scout Beacon SDK for Flutter.

Help Scout Beacon SDK for Flutter

Configure the beacon with your Beacon ID and launch the beacon UI by calling open.

final settings = HSBeaconSettings(beaconId: 'YOUR_BEACON_ID');
HelpScoutBeacon.open(settings: settings);

Identify User

Optionally you can prefill the beacon with user meta data:

final user = HSBeaconUser(email: "[e-mail]", name: "John Doe");
HelpScoutBeacon.identify(beaconUser: user);

HelpScoutBeacon.open(settings: HSBeaconSettings(beaconId: 'YOUR_BEACON_ID'));

Navigate

Open a desired page in the Help Scout beacon UI:

HelpScoutBeacon.open(settings: settings, route: HSBeaconRoute.ask));
HelpScoutBeacon.open(settings: settings, route: HSBeaconRoute.chat));
HelpScoutBeacon.open(settings: settings, route: HSBeaconRoute.docs));
HelpScoutBeacon.open(settings: settings, route: HSBeaconRoute.docs, parameter: 'search term'));
HelpScoutBeacon.open(settings: settings, route: HSBeaconRoute.contactForm));
HelpScoutBeacon.open(settings: settings, route: HSBeaconRoute.previousMessages));
HelpScoutBeacon.open(settings: settings, route: HSBeaconRoute.article, paramter: 'article id'));

Cleanup / Logout

Once done you can remove all data:

HelpScoutBeacon.clear()