summaryrefslogtreecommitdiffstats
path: root/mobile/android/android-components/components/feature/syncedtabs/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'mobile/android/android-components/components/feature/syncedtabs/README.md')
-rw-r--r--mobile/android/android-components/components/feature/syncedtabs/README.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/mobile/android/android-components/components/feature/syncedtabs/README.md b/mobile/android/android-components/components/feature/syncedtabs/README.md
new file mode 100644
index 0000000000..433b7a96de
--- /dev/null
+++ b/mobile/android/android-components/components/feature/syncedtabs/README.md
@@ -0,0 +1,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/