android-components/components/feature/accounts-push

Android Components > Feature > Accounts-Push

Feature component for sending tabs to other devices with a registered FxA Account.

Usage

Setting up the dependency

Use Gradle to download the library from maven.mozilla.org (Setup repository):

implementation "org.mozilla.components:feature-accounts-push:{latest-version}"

Usage

In order to make use of the send tab features here, it's required to have an an FxA Account setup. See the service-firefox-accounts for more information how to set this up.

val sendTabUseCases = SendTabUseCases(fxaAccountManager)

// Send to a particular device
sendTabUseCases.sendToDeviceAsync("1234", TabData("Mozilla", "https://mozilla.org"))

// Send to all devices
sendTabUseCases.sendToAllAsync(TabData("Mozilla", "https://mozilla.org"))

// Send multiple tabs to devices works too..
sendTabUseCases.sendToDeviceAsync("1234", listof(tab1, tab2))
sendTabUseCases.sendToAllAsync(listof(tab1, tab2))

To receive tabs:

SendTabFeature(fxaAccountManager) { device, tabs ->
  // handle tab data here.
}

Push Support

Over time, push registration information can become stale on an FxA server in various ways, (e.g. registration expires from long intervals of no use).

To counter this, the FxA server can notify us on the next sync to force registration to occur in order to fix the problem. Therefore, if FxA and Push are used together, include the support feature as well:

val feature = FxaPushSupportFeature(context, fxaAccountManager, autoPushFeature)

// initialize the feature; this can be done immediately if needed.
feature.initalize()

License

This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this
file, You can obtain one at http://mozilla.org/MPL/2.0/