summaryrefslogtreecommitdiffstats
path: root/mobile/android/android-components/components/feature/syncedtabs/README.md
blob: 433b7a96de85216fb6043175733fd23a04a31b9a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
# [Android Components](../../../README.md) > Feature > Synced Tabs

Feature component for viewing tabs from other devices with a registered Fx Account.

## Usage

### Setting up the dependency

Use Gradle to download the library from [maven.mozilla.org](https://maven.mozilla.org/) ([Setup repository](../../../README.md#maven-repository)):

```Groovy
implementation "org.mozilla.components:feature-syncedtabs:{latest-version}"
```

## Usage

In order to make use of the synced tab feature here, it's required to have an an FxA Account setup and Sync enabled.
See the [service-firefox-accounts](../../service/firefox-accounts/README.md) for more information how to set this up.

```kotlin
  // The feature will start listening to local tabs changes.
  val syncedTabsFeature = SyncedTabsFeature(
    accountManager = accountManager,
    store = browserStore,
    tabsStorage = tabsStorage
  )
  // Grab the list of opened tabs on other devices.
  val otherDevicesTabs: Map<Device, List<Tab>> = syncedTabsFeature.getSyncedTabs()

```

## 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/