Repository navigation
Docs: Offline Support for JavaScript, React Native & iOS SDKs - #587
Closed
raj-dubey1 wants to merge 1 commit into
Closed
raj-dubey1 wants to merge 1 commit into
raj-dubey1 wants to merge 1 commit into
Conversation
New Offline Support group (8 pages) under each of JavaScript, React Native and iOS (after Messaging), documenting the offline SDK as a GA release — enable, cached-then-server reads, the durable send outbox, reconnect sync, media caching, cache encryption, and a full config/API reference. Grounded in each SDK's real public offline API (not a port of Android's symbol names) and cross-checked against Android release-v5-v5.1.0 and the conformance spec. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01XbguTw81eW7rnAGv6AksM8
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
Contributor
Author
This branch was successfully deployed
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Public docs for offline support in the JavaScript, React Native, and iOS Chat SDKs, documented as a GA release (SDK only, no UI Kit). Companion to the Android PR #584; same structure, each grounded in its own SDK's real API.
New: "Offline Support" group (8 pages) under each SDK (SDKs → JavaScript / React Native / iOS, after Messaging):
offline-overview— what it does and the cached-then-server flowoffline-enable— turning it on and verifying it is activeoffline-cached-data— the two-phase (onCached…→onServer…→onError) read contract and which filters are server-onlyoffline-send— the durable outbox, pending status, and failure/retryoffline-sync— reconnect catch-up, cache resets, logoutoffline-media-caching— media cache modes and limitsoffline-encryption— the encrypted local storeoffline-reference— config, methods, listeners, enums, error codesPlus the nav entries in
docs.json(24 new page refs, 8 per SDK).Source of truth & versions
Each SDK's offline branch (merged into
temp/offline-release-2026-10-26, including the latest Android-parity fixes), cross-checked against Androidrelease-v5-v5.1.0and the offline conformance spec. Every API name and default was verified against that SDK's code — the docs are not a port of Android's names:4.3.0—setOfflineConfig({enabled:true}), handler-object listeners, Promises reject while offline (.catch()), browser (IndexedDB/OPFS) + Electron (SQLite).4.2.0—getMessageStatus(),onError(error, reason?), op-sqlite / react-native-fs / react-native-keychain, SQLCipher opt-in.4.3.0— Swift closures for reads,ConversationDetailsListenerprotocol,messageStatus, bundled SQLCipher.Version numbers reflect each repo's current
package.json/project version; confirm at release.Scope
This PR is the 8 new offline pages per SDK + nav. The existing-page two-phase-listener examples (which the Android PR #584 also included across ~24 pages) are a separate mechanical follow-up per SDK.
Review notes
Reviewing the Android PR #584 surfaced a few issues worth fixing there (not in this PR): the
offline-send"Queued, Not Failed" code sample referencesmessage.getStatus()wheremessageisn't in scope (independently caught against all three SDKs);offline-cached-datapromises a per-builder filter matrix thatoffline-referencedoesn't contain; andgetCacheSizeis described two ways. This PR's per-SDK pages address those in their own copy.🤖 Generated with Claude Code
https://claude.ai/code/session_01XbguTw81eW7rnAGv6AksM8