[DhruvKushvaha2004]

Description

Restores the Flutter UI Kit ringing docs from #564. Those pages were held back in 08306dc until the UI Kit release, and #586 brought back only the Calls SDK and push pages. UI Kit 6.3.0 now ships ringing through cometchat_voip, so this puts the UI Kit side back.

New page

• ui-kit/flutter/calling-integration.mdx, Calling Integration: the full setup for ringing in the UI Kit. It covers dependencies, initializing the Calls SDK and cometchat_voip, the CometChatCallPushBridge class, enableCalls / callPushBridge in UIKitSettings, handing call pushes to cometchat_voip, the push token, permissions and ring readiness, logout, styling the ring screen with the UI Kit theme, what the UI Kit handles from there, and upgrading from CometChat.addCallListener.
• Sidebar entry in docs.json under UI Kit > Flutter > Getting Started.

Updated UI Kit pages

• Call Features: rewritten for push ringing. Quick reference, a "How a call works" diagram, and the call components.
• Incoming Call: marked deprecated and web only. Adds a table mapping CometChatIncomingCallStyle to CometChatVoipIncomingCallColors.
• Outgoing Call: call states (Calling…, Ringing…, accepted, ended), the 45-second unanswered timeout, End/cancel behaviour, and the corrected events (ccOutgoingCall, ccCallRejected).
• Events: which call events fire at each moment on Android and iOS.
• Methods: enableCalls, callingConfiguration and callPushBridge in UIKitSettings, and what logout() does with calls enabled.
• Color Resources: a new "Ring Screen Colors" section mapping ring screen fields to palette colours, with light and dark defaults.
• Getting Started: a calling callout and an "Add Voice and Video Calling" next step.
• Theme Introduction: a note on the ring screen theme.
• Troubleshooting: 8 calling rows replace the old 2.
• Upgrading from v5: a new "6. Calling and ringing" section with a before/now table.

Chat SDK

• sdk/flutter/real-time-listeners.mdx: restores the warning that CallListener / CometChat.addCallListener() are superseded by CometChatCalls.addIncomingCallListener, and are deprecated since Chat SDK 5.1.1.

Checked against the released packages: UI Kit v6.3.0, cometchat_voip 2.0.0, Calls SDK 5.1.0 and Chat SDK 5.1.1.

• Every API on the pages exists with the documented signature: the bridge, the cometchat_voip calls, the UI Kit settings, the theme and its colour defaults, and the events table.
• Removed the TODO(RC) release placeholders.
• Changed "a UI Kit newer than 6.2.0" to "UI Kit 6.3.0 or later".

Related Issue(s)

• docs(flutter): ringing on Calls SDK 5.1 + cometchat_voip, chat-only push, UI Kit calling #564: the original ringing docs PR. Its UI Kit pages were held in 08306dc.
• docs: Calls SDK 5.1 ringing for Android, iOS, JavaScript, Flutter and React Native #586: restored the Calls SDK and push ringing pages, with the UI Kit pages still held.

Type of Change

• Documentation correction/update
• New documentation
• Improvement to existing documentation
• Typo fix
• Other (please specify)

Checklist

• I have read the CONTRIBUTING document
• My branch name follows the naming convention
• My changes follow the documentation style guide
• I have checked for spelling and grammar errors
• All links in my changes are valid and working
• My changes are accurately described in this pull request

Additional Information

• The UI Kit pages are restored as they were in docs(flutter): ringing on Calls SDK 5.1 + cometchat_voip, chat-only push, UI Kit calling #564. None of them changed on main since they were held, so nothing newer is overwritten.
• Not included:
  • The "Rolling out" section of Migrating from Legacy Ringing. docs: Calls SDK 5.1 ringing for Android, iOS, JavaScript, Flutter and React Native #586 already covers it under "While some users are still on legacy ringing".
  • The UI Kit link in voip-calling.mdx's ring screen theme section, left out on purpose.
• Setup covered on the Calls SDK pages (the OngoingCallService manifest entry, Swift Package Manager on iOS) isn't repeated here. See Calls > Background Handling and Setup.

Screenshots (if applicable)

N/A. Text and table changes only. The one image, the Message Header call buttons on Calling Integration, already exists in /images.

[mintlify]

Preview deployment for your docs. Learn more about Mintlify Previews.

Project	Status	Preview	Updated
cometchat	🟢 Ready	View Preview	Nov 11, 2026, 3:12 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

[jitvarpatil]

🤖 Review Buddy (review-docs-pr)

Recommendation: approve. Automated review; the final decision stays with a maintainer.

TL;DR: The PR is structurally safe. No files are removed or renamed, so no redirects are needed. All navigation refs resolve, there are no broken internal links, and every cross-page anchor and image exists. I checked the content against the released packages: UI Kit v6.3.0 tag, cometchat_voip v2.0.0 tag, Chat SDK v5.1.1 tag, and pub.dev (cometchat_chat_uikit 6.3.0 and cometchat_voip 2.0.0 are both live). The documented APIs and colour defaults match the source. There are no P0 or P1 findings. Three P2 items concern the copy-paste snippets: they leave out guards that the UI Kit master app has.

P0: none

P1: none

P2: worth fixing

1. The logout snippet can stop logout from running. See ui-kit/flutter/calling-integration.mdx:260, and the same advice at methods.mdx:99, troubleshooting.mdx:70 and upgrading-from-v5.mdx:128. CometChatVoip.unregisterPushToken() throws when the device is offline, when no token was registered, or on web (unsupportedPlatform). The snippet awaits it with no try/catch, so in those cases CometChatUIKit.logout never runs and the user stays logged in. The v6.3.0 master app wraps the call (master_app/lib/screens/home_screen.dart:266-270, login_screen.dart:64-71) in if (!kIsWeb) plus try { … } catch (_) {} before logout. Mirror that.
2. The setup snippets have no web guard. See calling-integration.mdx:63-86 (Step 2), :203-239 (Steps 5–6) and :259 (Step 8). The page says web keeps Chat SDK ringing and doesn't use callPushBridge. But the init, token and logout snippets call cometchat_voip without a guard, and on web those calls throw. A Flutter app that also targets web needs if (!kIsWeb), as the master app has. One sentence or a guard in each snippet is enough. Minor point in the same snippet: the Step 2 onError swallows a Calls SDK init failure silently. The master app logs it.
3. The diagram label is ambiguous. See calling-integration.mdx:21 and call-features.mdx:31. Call button → initiateCall sits on the same page that lists the Chat SDK initiateCall as superseded (call-features.mdx:15). Label it CometChatCalls.initiateCall so readers don't reach for the deprecated Chat SDK method.

Verified ✅

• Redirects: 0 removed or renamed files, so 0 new 404s and 0 chained redirects.
• Build: 0 dangling nav refs. The new ui-kit/flutter/calling-integration entry resolves.
• Links: 0 broken internal links across 62 scanned files. The anchors /calls/flutter/voip-calling#step-2-initialize, #theming-the-ring-screen, #your-own-ring-screen, /ui-kit/flutter/events#call-events, the in-page #styling-the-ring-screen and #step-2-… anchors, /calls/flutter/ringing and /calls/flutter/migrating-from-legacy-ringing all resolve.
• Images: the 3 referenced images exist on the branch.
• API accuracy:
  • The VoipCallPushBridge snippet is identical to master_app/lib/notifications/services/voip_call_push_bridge.dart @ v6.3.0.
  • CometChatCallPushBridge, CometChatPushCall and CometChatPushCallEnded are exported from cometchat_calls_uikit.dart. The report* members have default bodies, so the "extend, don't implement" note is accurate.
  • CometChatIncomingCallTheme.of/.from(light:, dark:, mode:) match the source. The dark-set fallback to the light palette is documented correctly.
  • All 11 ring screen fields and the light/dark default hex values in color-resources.mdx match _colors() exactly.
  • The cometchat_voip 2.0.0 calls exist with the documented signatures: init, fromCallAppSettings(providerId:), handlePushNotification(sentTime:), registerPushToken(token:), handleTokenRefresh, checkRingReadiness/openSettings, setIncomingCallTheme, isInitialized, onCallAnswered/onCallEnded, and reason.wireName.
• Behaviour claims:
  • The 45 s outgoing timeout is in active_call_tracker.dart:180.
  • ccOutgoingCall fires on place, and ccCallRejected fires on cancel, timeout and logout.
  • ccCallAccepted fires only from the incoming-call bloc.
  • The barrels hide CallListener/CallListener2.
  • Chat SDK 5.1.1 marks addCallListener, initiateCall, acceptCall, rejectCall and endCall @Deprecated.
• Version consistency: every install snippet now pins ^6.3.0, with no 6.2.0 left in the changed pages.
• Placeholders: the TODO(RC) placeholders are gone.
• Pre-existing, not from this PR: ui-kit/flutter/llms-flutter-v6.mdx is not in navigation.

Skipped: I didn't render-check the Mintlify preview by hand. The bot reports the preview as 🟢 Ready.

[jitvarpatil]

✅ Approved via Review Buddy after an automated review (P0: 0 · P1: 0 · P2: 3).

Findings: #606 (review)