Skip to content

Commit 4b672b2

Browse files
mtrezzaJawnnypoo
authored andcommitted
added warning to update server URL docs (#992)
* added warning to update server URL docs * fixed typo
1 parent a933a3e commit 4b672b2

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

parse/src/main/java/com/parse/Parse.java

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -196,8 +196,16 @@ public Void then(Task<Void> task) {
196196
//region Server URL
197197

198198
/**
199-
* Sets the server URL. This can be used to update the server URL after this client has been
200-
* initialized, without having to {@link Parse#destroy()} this client.
199+
* Sets the server URL. The local client cache is not cleared.
200+
* <p/>
201+
* This can be used to update the server URL after this client has been initialized, without
202+
* having to {@link Parse#destroy()} this client. An example use case is server connection failover, where the
203+
* clients connects to another URL if the server becomes unreachable at the current URL.
204+
* <p/>
205+
* <b>Warning:</b><br/>
206+
* The new server URL must point to a Parse Server that connects to the same database.
207+
* Otherwise, issues may arise related to locally cached data or delayed methods such as
208+
* {@link ParseObject#saveEventually()}.
201209
* @param server The server URL to set.
202210
*/
203211
public static void setServer(@NonNull String server) {

0 commit comments

Comments
 (0)