Skip to content

Data Synchronization

Jump to bottom
Kaustubh Patange edited this page Nov 25, 2020 · 32 revisions

You must first install XClipper for Windows in order to continue!

In this guide we will learn how to synchronize desktop's clipboard data across mobile in XClipper.

Synchronization is purely based on the Firebase's Real-time database storage. Read why XClipper is not using Firestore instead, in this FAQ.

XClipper currently supports text-related data to be synchronized. To enable image synchronization, read this guide after completing the below steps.

Steps

These are the steps we are going to follow, if you have any questions check the FAQs.

Creating your own data storage on Firebase

Firebase is a suite of tools provided by Google which makes a lot of things smoother, one of them is Real-time database.

This is where all your clipboard data will be stored by the XClipper.

If you want to know why I don't host my own storage for this service, read this FAQ answer.

  • Go to firebase.google.com & click on "Go to console" button from the top right of the page (You might need to sign-in with your Google account).

  • Click on the "Add" project card, give your project a name & click continue.

  • There, disable "Enable Google Analytics" option & proceed to "Create project".

  • Once done you will see something like a dashboard screen.

<>

  • Here click on "Realtime Database" > "Create database" > "Enable".

<>

<>

  • Now go to "Rules", update the text as shown above & then click on the "Publish" button.

Get all the required credential for setup

In these steps we will note down some of the credentials that you will need to connect your XClipper desktop application to the database.

I would recommend writing these information in a notepad file.

  • Go to "Realtime database" > "Data" & note the database location url as shown below.

<>

  • Click on "Gear icon" > "Project Settings" & note down the Web API Key as shown below.

<>

<>

  • To get the last credential we need to set up our Android app, this step is a bit complex to explain so you need to watch a video for it (check the video description for Client ID). You will get "App Id" after completing it.

<>

Setting up the credential in the desktop app

In this step we will add the credentials in the XClipper application, I assume you were taking notes of them.

  • At the end, your notepad file should look like this (this may vary from yours).
Firebase Endpoint: https://test-project-9e017.firebaseio.com/

Firebase API Key: AIzaSyC05g-9MkJbFhnxE2137MDeTT07wNHncfs

Firebase App Id: 1:1057025207873:android:c7004aea2af70512b220c0
  • Now in the XClipper application from system tray, right-click > "Firebase configuration" & add those value. Click "Save" when done.

<>

Note: If you need authentication & want to secure your database even more, check this guide.

Enabling required settings for sync

Here we will turn on the setting that will enable the syncing of the clipboard to the database.

  • In XClipper application from system tray, right-click > "Settings" & enable Database binding.

<>

  • That's it now your clipboard item should be added to the database.

Note: You can also enable Bind Deletion option which will delete items from your local storage if deleted from an online database.

Tip: Hover on each item to see what they do.

Connecting mobile device to the storage

You first need to download the XClipper application on a mobile device.

  • In the app go to "Settings" > "Account" > "Connect to database" & scan the QR code shown in the Settings window of XClipper desktop application.

Testing if clipboard data is syncing?

In most cases restarting the application solves the problem. But there might be a case if this does not work & you want to know if your clipboard data is properly syncing.

This can be used to determine the source of the problem. Is the desktop application not syncing properly or the mobile app not receiving it?

After all, it leads to this FAQs section.

  • You can check if the online database receives updates or not by going to firebase.google.com selecting your project which we created & going to the real-time database. It should update automatically when changes are made by XClipper. If this is not the case create a GitHub issue.
  • If your application is crashed or reported any issues. There is a log file that XClipper creates on every new instance located in %appdata%\XClipper\logs. You must upload the proper log file if you are reporting an issue.
Clone this wiki locally