Sync: add note on starting Admin before server.

greenrobot-team · greenrobot-team · commit fbc68c7e9aa1 · 2024-09-09T16:01:23.000+02:00
diff --git a/objectbox-java/src/main/java/io/objectbox/sync/Sync.java b/objectbox-java/src/main/java/io/objectbox/sync/Sync.java
@@ -52,6 +52,8 @@ public static SyncBuilder client(BoxStore boxStore, String url, SyncCredentials
 
     /**
      * Starts building a {@link SyncServer}. Once done, complete with {@link SyncServerBuilder#build() build()}.
+     * <p>
+     * Note: when also using Admin, make sure it is started before the server.
      *
      * @param boxStore The {@link BoxStore} the server should use.
      * @param url The URL of the Sync server on which the Sync protocol is exposed. This is typically a WebSockets URL

Original file line number	Diff line number	Diff line change
`@@ -52,6 +52,8 @@ public static SyncBuilder client(BoxStore boxStore, String url, SyncCredentials`
`52`	`52`
`53`	`53`	`/**`
`54`	`54`	`* Starts building a {@link SyncServer}. Once done, complete with {@link SyncServerBuilder#build() build()}.`
	`55`	`+ * <p>`
	`56`	`+ * Note: when also using Admin, make sure it is started before the server.`
`55`	`57`	`*`
`56`	`58`	`* @param boxStore The {@link BoxStore} the server should use.`
`57`	`59`	`* @param url The URL of the Sync server on which the Sync protocol is exposed. This is typically a WebSockets URL`