This repository was archived by the owner on Sep 29, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 112
Offline docs intro #330
Merged
Merged
Offline docs intro #330
Changes from 10 commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
8d78b42
Add intro text
gewenyu99 a46cc35
Update app/views/docs/offline.phtml
gewenyu99 a5cf410
Update app/views/docs/offline.phtml
gewenyu99 2cc2599
Update app/views/docs/offline.phtml
gewenyu99 284eab4
Update app/views/docs/offline.phtml
gewenyu99 c84c160
Update app/views/docs/offline.phtml
gewenyu99 4894a13
Update app/views/docs/offline.phtml
gewenyu99 69e5c82
Rewrite trade offs + existing projects
gewenyu99 ae66a2b
Update app/views/docs/offline.phtml
gewenyu99 7ca33c4
Update app/views/docs/offline.phtml
gewenyu99 8c0b39e
Update app/views/docs/offline.phtml
gewenyu99 5828b05
Update app/views/docs/offline.phtml
gewenyu99 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| <p> | ||
| The Appwrite SDKs' Offline Support allows your client apps to continue functioning without an internet connection. Your users' mobile devices frequently encounter situations where internet access becomes unstable or temporarily unavailable, like when going through tunnels, getting on airplanes and subways, or going in and out of Wi-Fi range. Offline Support helps your app gracefully handle these real-life situations and keeps your users engaged. | ||
| </p> | ||
|
|
||
| <h2>When Should I Enable Offline Support?</h2> | ||
| <p> | ||
| With Offline Support enabled, your app can continue sending requests to Appwrite APIs while offline through a cache. While offline, read requests will be fetched from the local cache data, and write requests will be queued and executed once the device is online again. | ||
| </p> | ||
| <p> | ||
| You should consider enabling Offline Support if you expect the user device running your application to experience short periods without a network connection, like going on an airplane or through a tunnel. Offline Support can't help you if the app's data needs to remain up to date with frequent updates or if write requests need to be processed immediately. If you expect your app to be offline for days or weeks at a time, you may also need to find alternative solutions. | ||
|
gewenyu99 marked this conversation as resolved.
Outdated
|
||
| </p> | ||
|
|
||
| <h3>Considerations and Tradeoffs</h3> | ||
| <p> | ||
| Offline Support adds a cache layer that takes up additional resources and adds overhead to your requests. This may not be desirable for some applications, especially if it's not expected to be used without a stable internet connection. | ||
| </p> | ||
| <h3>Offline Support for Existing Projects</h3> | ||
| <p> | ||
| Asynchronous operations may not resolve immediately when Offline Support is enabled. Existing projects will require some code to be rewritten when adopting Offline Support. <a href="TBD">Learn more about how to handle asynchronous operation</a>. | ||
| </p> | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.