SDK

Device Registration

In this guide we will dive deeper into how you should handle the device registration. By default, when you launch() Notificare, the device will be registered as a non-push device.

When a successful device registration takes place, we will emit an event. You can receive those events by listening to the Notificare.onDeviceRegistered stream.

Notificare.onDeviceRegistered.listen((device) {

});

You can also check the details of the currently registered device.

final device = await Notificare.deviceManager.currentDevice;

The onReady stream will also be called when all Notificare modules has been launched, including a successful device registration.

Additionally, you can verify whether Notificare is ready at any point by calling Notificare.isReady.

Register as a user

By default, a device is registered as an anonymous user. However, there will be situations where simply registering an anonymous device is not what you want. For example if you authenticate your users you will not want to register an anonymous device whenever the app launches. When that is the case, you will need to tell the library you want to register as a specific user.

await Notificare.deviceManager.register('7f42bedc-d74b-4c64-a5cf-76bcc5130b05', 'John Doe');

After that, the device will remain registered with that userId / userName until you explicitly register it as anonymous. Depending on the way you authenticate users, you might want to check the logged in state on launch (in the onReady) and change it if necessary. Forcing registration as anonymous can be best achieved by setting userId and userName to null.

await Notificare.deviceManager.register(null, null);

Override Device Language

By default, we will automatically collect the language and region of a device based on the Locale of the device. For most cases this will be enough but for those cases where you would like to override the device language and region combination to a strict selection of languages, you can do so by invoking the following method:

await Notificare.deviceManager.updatePreferredLanguage('en-US');

Eventually, you can always retrieve the preferred language by calling the following method:

final language = await Notificare.deviceManager.preferredLanguage;

User Data Fields

There are use cases where simply associating an userID and userName will not suffice. For those cases you can make use of User Data Fields where you can create key-value pairs for your application and then use them to extend your device registration. Before you can implement them you will need to first create them in your application via our dashboard. This is described here.

Once you have created one or more fields, you can implement this functionality in your app. To retrieve the list of fields allowed in your app you should use the following method:

final userData = await Notificare.deviceManager.fetchUserData();

Whenever you want to update those fields with new values you should use the following method:

final userData = {
  /* your properties here */
};

await Notificare.deviceManager.updateUserData(userData);

If you are using our inbox functionality, these fields will also be available as placeholders when sending notifications by simply including {{userData.key}} in your messages.

Do Not Disturb

Each device registered with Notificare can be configured to specify a period of time during the day when it should not receive notifications. You can use this functionality in your app settings to allow the user to provide a time range where messages will not be displayed in the lock screen or notification center. Please note that if you are using our inbox functionality these message will still be there.

To retrieve a device's DnD preferences use the following method:

final dnd = await Notificare.deviceManager.fetchDoNotDisturb();

You can update the DnD values for a device, using the following method:

await Notificare.deviceManager.updateDoNotDisturb(dnd);

Test Devices

It is possible to enable devices to be registered as test devices. This allows you to perform a wide range of tests in our dashboard by simply scanning a QR Code. In order to enable this functionality, the following steps are mandatory.

You need to add the following URL scheme to your app's AndroidManifest.xml:

<activity android:name=".MainActivity">

  <!-- ... existing intent filters    -->

  <intent-filter>
    <action android:name="android.intent.action.VIEW" />

    <category android:name="android.intent.category.DEFAULT" />
    <category android:name="android.intent.category.BROWSABLE" />

    <!-- ... existing schemes   -->

    <data android:scheme="test.nc${notificareAppId}" />

  </intent-filter>

</activity>

Where ${notificareAppId} must be replaced by your own app identifier (you can find that in Settings > Configure App).

When dealing with a multi-environment application, you may want to consider using your build.gradle to configure the manifestPlaceholders.

You need to add the following URL scheme to your app's Info.plist:

<key>CFBundleURLTypes</key>
<array>
  <dict>
    <key>CFBundleURLSchemes</key>
    <array>
      <string>test.nc$(NOTIFICARE_APPLICATION_ID)</string>
    </array>
  </dict>
</array>

Where $(NOTIFICARE_APPLICATION_ID) must be replaced by your own app identifier (you can find that in Settings > Configure App).

When dealing with a multi-environment application, you may want to consider using your Build Setting to create a User-Defined Setting.

The plugin will take care of the deep link and register your device as a test device. It should only take a moment for the changes to become visible in the Dashboard.