Repository navigation
docs(ENG-57593): offline support for the iOS UI Kit - #612
Draft
raj-dubey1 wants to merge 6 commits into
Draft
raj-dubey1 wants to merge 6 commits into
raj-dubey1 wants to merge 6 commits into
Conversation
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WEaVigCRBjkftm78T25MQA
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
raj-dubey1
marked this pull request as draft
November 16, 2026 14:02
…5.3.0 Files picked in the attachment tray upload at once and are not queued; only text, voice notes and single-file sends queue. Failed edits, reactions and deletes now show a notice; the compact composer leaves edit mode on Send. Adds "Not sent yet" under queued messages, Retry and Delete removing a message the SDK no longer holds, the reaction list's tabs, the avatar cache, the logout cache wipe, the media-link and cc_media change, and corrects the notices table, presence, the event wording and the catch-up delay (10 s in the SDK). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Methods documents UIKitSettings.setOfflineConfig(_:) with an example, and what logout and the send methods do with offline on. Integration, events, localize, search, message list, conversations, both composers, the thread header and bubble styling get one line each with a link to the offline page. Search no longer says it has no onError. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Photos, videos, audio files and documents are to be sent while connected; the pages no longer say a picked file is queued. The methods note now covers sendTextMessage and sendCustomMessage only and links to the send-completions section for form, card and scheduler messages. The threaded-messages guide's offline row now matches the offline page: the composer stays enabled, text replies and voice notes queue, and edits, deletes and reactions need a connection. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Co-authored-by: multica-agent <github@multica.ai>
…every queuing send method The offline page, methods, core features and integration now say that UI Kit 5.3.0, the first version with offline support, needs Chat SDK 4.2.1 or later, so they no longer disagree with the 5.2.x numbers on the other pages. The integration quick reference marks its offline row as applying from 5.3.0. The offline page and methods now list sendFormMessage, sendCardMessage and sendSchedulerMessage beside sendTextMessage and sendCustomMessage as sends that queue offline. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Co-authored-by: multica-agent <github@multica.ai>
Checked against the iOS UI Kit at temp-release-offline-v5 d4d643870: - Only files picked in the attachment tray (enableMultipleAttachments, the default) need a connection. With enableMultipleAttachments = false a pick is sent through sendSingleMedia -> MessageComposerBuilder .mediaMessage -> OfflineSend.send and is queued like a voice note (MessageComposerBuilder.swift:50-53; same in the compact composer). - CometChatUIKit.sendMediaMessage also queues offline (CometChatUIKit .swift:579), so methods.mdx lists it and drops "send media while connected". - initFromSettings(offlineConfig:...) is used by the kit's own initFromSettings, not by every init: reworded. - "Saved rows show first" read as the Saved Messages component's rows: now "Rows cached on the device show first". Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01XbguTt1cqFxTDQyroF6wHx
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
Adds the iOS UI Kit Offline Support page and brings the rest of the iOS UI Kit v5 docs in line with it. The page was first written against an earlier UI Kit build. ENG-57593 rechecked every claim against the final offline sources, fixed what had changed, and added offline notes to the reference and component pages that never mentioned offline.
Ticket: ENG-57593
Parent: none
AI-DLC path: light (docs)
Base:
mainChanges
First commit (
8df54dac, 16 Nov)ui-kit/ios/offline-support.mdx.core-features.mdx: an Offline Support section.docs.json: nav entry under iOS v5 → Features → Chat.llms-ios-v5.mdx: link to the new page.ENG-57593 update (19 Nov:
405c8ca2,a258495c,525fef74,3c7a6be7)offline-support.mdx, corrected against the final UI Kit and Chat SDK sources:CometChatUIKit.sendTextMessage,sendCustomMessage,sendFormMessage,sendCardMessageandsendSchedulerMessage.onError. The standard composer keeps the edit; the compact composer leaves edit mode when you tap Send.file://or absolute-path link in another user's message is never opened, shown or shared, and bubble downloads move toDocuments/cc_media/.methods.mdx:setOfflineConfig(_:)row in the UIKitSettings table.ERROR_OFFLINE_MESSAGE_DISCARDED).Other pages:
getting-started.mdx: an offline row in the quick reference, scoped to UI Kit 5.3.0+, and a tip in Step 4.search.mdx: with offline on,CometChatSearchhasset(onError:). The page used to say it had noonError.events.mdx:ccMessageSendStateChangedandccOfflineCacheReset.localize.mdx: a link to the offline texts table.message-list.mdxandconversations.mdx: thehideOfflineNoticesproperty.message-composer.mdxandcompact-message-composer.mdx: "Sending while offline".threaded-messages-header.mdx,message-bubble-styling.mdxandcore-features.mdx: one line each.guide-threaded-messages.mdx: the "Offline mode" edge-case row now matches the offline page.Checks run
node -e "JSON.parse(require('fs').readFileSync('docs.json'))"mint broken-links, compared with the same run on the branch before this updatemainremain:/llms.txtand/llms-full.txtindesign-system.mdxandllms-index.mdx2162bd47) and Chat SDK (c158761a) sourcesTests
Risk and rollback
Release notes
Version: n/a (docs)
QA notes
mint devand open/ui-kit/ios/offline-support,/ui-kit/ios/methods#enable-offline-supportand/ui-kit/ios/search.Provenance
Agent-built with Claude Code for Raj Dubey. A human review is still needed before merge.
Needs confirmation / known gaps
Package.swiftstill declaresfrom: "4.2.0", but the UI Kit callsinitFromSettings(offlineConfig:), which 4.2.0 doesn't have. Confirm the final UI Kit and Chat SDK versions before merge. Other pages still describe 5.2.x with Chat SDK 4.1.10+; that is a release-day update.sendMediaMessage. In the source it goes through the offline queue, but the docs deliberately don't promise queued media (no platform queues media picked offline). Confirm this wording.docs/uikit-offline-ios(the existing PR branch), notdocs/ENG-57593-…. The first commit (8df54dac) has no ticket ID. It was not rewritten, to avoid a force-push.podline).notSentYetTextColorandnotSentYetTextFontare now used for the "Not sent yet" text (CometChatMessageList+Offline.swift:116-117), so they stay on the page.CometChatUIKit.initFromSettings(offlineConfig:completion:)stays undocumented (:nodoc:).search.mdxdocumentsonBack, whichCometChatSearchdoesn't have.localize.mdxsays 17 languages; the UI Kit ships 19.methods.mdxUIKitSettings table uses method names that don't match the UI Kit (setAIFeatures,setExtensions,setAutoEstablishSocketConnection).core-features.mdx→message-bubble-styling#file-bubble, andsearch.mdx→message-list#itemview.Update 20 Nov: checked against the iOS UI Kit (
140b048f)Every claim on the changed pages was checked against the iOS UI Kit at
temp-release-offline-v5d4d643870(about 100 claims: APIs, settings, strings in all 19 locales, list states, events, styles, snippets and links). One gap was fixed: "media picked offline is not queued" is true only for the attachment tray (the default). WithenableMultipleAttachments = false, or throughCometChatUIKit.sendMediaMessage, a media message is queued like a voice note (MessageComposerBuilder.swift:50-53,CometChatUIKit.swift:579). The pages now say so. Two wordings were also tightened: theinitFromSettings(offlineConfig:…)sentence, and "Saved rows show first" became "Rows cached on the device show first".🤖 Generated with Claude Code