Skip to content

docs(android): ringing through the Calls SDK and Push Notifications SDK - #561

Open
hritika-cometchat wants to merge 7 commits into
mainfrom
feature/android-ringing-push-sdk
Open

hritika-cometchat wants to merge 7 commits into
mainfrom
feature/android-ringing-push-sdk

Conversation

@hritika-cometchat

@hritika-cometchat hritika-cometchat commented Oct 14, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Android calling no longer signals through the Chat SDK. The Calls SDK 5.1 creates, joins and ends calls; the Push Notifications SDK 2.0 calls module rings the device in every app state (foreground, background, killed); the UI Kit hosts the screens. This PR updates every Android page that described the old flow and adds the two pages the new flow needs.

Consumer-facing wording is "ringing" and "legacy ringing"; the pages never say v1 or v2.

Calls SDK (calls/android/)

  • ringing.mdx rewritten: Calls SDK-only flow with a sequence diagram, CometChatCalls.initiateCall, prepared-session events ("ringing…" / answered), addIncomingCallListener with the reason table, answer from the answer activity, decline, cancel, ring timeout, end with leave(), call waiting, group calls, logout, status values.
  • voip-calling.mdx rewritten as Push Ringing (slug kept, no redirect): dependencies, PNConfiguration setter table, three-line FCM service, answer activity, permissions and ensureRingReady / getDiagnostics / verifyPushSetup, how a ring ends, call during a call, missed calls, killed-app behaviour, staging hosts, tokens, own incoming-call screen, theming resources, MANUAL mode, troubleshooting.
  • migrating-from-legacy-ringing.mdx (new, in the Migration Guide nav group): before/after diagrams, seven migration steps, a 16-row method mapping table, caller and callee screens before/after, checklist.
  • setup: 5.1 version, overrideAdminHost / overrideClientHost / overrideCallsHost, push dependencies, one-shot init warning. events: getActiveSession, onParticipantConnected, prepared-session semantics, Incoming Call and Login listener sections. actions, overview, custom-control-panel: leave(). migration-guide-v5: 5.0 → 5.1 section. troubleshooting: six ringing rows.

UI Kit (ui-kit/android/)

  • calling-integration.mdx rewritten: five steps (dependencies, setEnableCalling, push config with setAnswerActivity(CometChatOngoingCallActivity), permissions, logout), what the kit does from there, own-screen calls, ring-screen colours, upgrade pointer.
  • ongoing-call.mdx (new, in the Components nav): the in-call screen and Push SDK answer activity.
  • call-features, incoming-call (deprecated, kept for setIncomingCallActivity), outgoing-call (call states, endReason, ViewModel members), call-buttons, call-logs updated for the new flow.
  • Smaller edits: getting-started, getting-started-kotlin/-jetpack (no extra dependency, 6.1.0), methods (new settings, logout behaviour), sound-manager, troubleshooting (16 calling rows), llms-android-v6, upgrading-from-v5 (Ringing table), color-resources (six cometchat_pn_call_* resources).

Notifications and Chat SDK

  • notifications/android-push-notifications.mdx rewritten for Push SDK 2.0: automatic tokens, PNConfiguration, inline reply and tap listener, badge count kept app-side; VoIP/ConnectionService and manual-token sections removed.
  • sdk/android/v5/calling-overview and v5/real-time-listeners: notes that the Chat SDK calling APIs and CallListener are superseded by the Calls SDK (deprecation lands with a coming Chat SDK release).

Before merging

  • Versions are placeholders for the public releases: calls-sdk-android:5.1.0, push-notifications-android / push-notifications-calls-android:2.0.0, UI Kit 6.1.0. Do not merge before they are published.
  • Confirm the published UI Kit POM exposes the Calls and Push SDKs as api (Getting Started and Calling Integration say no extra dependency is needed).
  • Confirm the public path of sample-app-kotlin-push / sample-app-compose-push; the notifications page links to the repository root.
  • The pages say the Chat SDK calling APIs are "superseded; a coming Chat SDK release marks them deprecated". Once the Chat SDK release with the @Deprecated annotations ships, change that wording to "deprecated".
  • The new Ongoing Call page has no screenshot yet.
  • Rendered pass with mint dev (links verified by file existence only).

Related: ENG-39907.

🤖 Generated with Claude Code

…cations SDK

Android calling no longer signals through the Chat SDK. The Calls SDK 5.1
creates, joins and ends calls; the Push Notifications SDK 2.0 calls module
rings the device in every app state; the UI Kit hosts the screens.

Calls SDK
- Rewrite ringing.mdx for the Calls SDK-only flow (initiateCall, prepared
  session events, IncomingCallListener, answer/decline/cancel/end, group calls)
- Rewrite voip-calling.mdx as "Push Ringing" (PNConfiguration, FCM service,
  answer activity, readiness, busy, missed calls, own ring screen, MANUAL)
- Add migrating-from-legacy-ringing.mdx with the method-by-method mapping
- setup: 5.1 version, host overrides, push dependencies, one-shot init
- events: getActiveSession, onParticipantConnected, incoming-call and login
  listeners; actions/overview/custom-control-panel: leave(); migration guide:
  5.0 to 5.1 section; troubleshooting rows

UI Kit
- Rewrite calling-integration.mdx; add ongoing-call.mdx (answer activity)
- call-features, incoming-call (deprecated), outgoing-call, call-buttons,
  call-logs updated for the new flow
- getting-started, methods, sound-manager, troubleshooting, llms, upgrading
  and color-resources edits (no extra dependency, logout, ring-screen colours)

Notifications: rewrite android-push-notifications.mdx for Push SDK 2.0.
Chat SDK v5: deprecation notes on calling-overview and the Call Listener.
docs.json: two new nav entries.

Versions are the planned public releases (calls 5.1.0, push 2.0.0,
UI Kit 6.1.0); hold the merge until they are published.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@mintlify

mintlify Bot commented Oct 14, 2026 •

Copy link
Copy Markdown

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

Project Status Preview Updated
cometchat 🟢 Ready View Preview Oct 16, 2026, 12:56 PM

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

… from Ringing

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
… SDK calling is superseded not deprecated, real call event names, getting-started parity
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…DK internals

The UI Kit has no Push SDK dependency, so the answer activity is a small app class
that builds the call with CallRingingUtils.buildIncomingCall and opens
CometChatOngoingCallActivity. Fix incoming-call to use real APIs. Remove MANUAL mode,
token registrar options, diagnostics, decline-queue and identifier details.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…omingCallTheme)

The Push SDK's incoming-call screen can now be themed in code, light and
dark, and the UI Kit can pass its own theme to it. The docs still said
there was no runtime theme API and listed six colour resources.

- Push Ringing: setIncomingCallTheme in the setter table; the theming
  section now covers CometChatPNIncomingCallTheme (Mode, Colors, Kotlin
  and Java), saving across a killed process, the theme -> resource ->
  default order, and all eleven colour resources with their setters.
  Notes that the class is not the @style/CometChatPNIncomingCallTheme
  window style.
- Push Notifications: setIncomingCallTheme row.
- UI Kit calling integration: CometChatTheme.getIncomingCallTheme() and
  Compose incomingCallTheme(), the app's mapping function, the one-line
  setIncomingCallTheme, and which UI Kit colour feeds each field.
- Color resources: eleven colours with the UI Kit colour, light and dark.
- Incoming Call (deprecated): CometChatIncomingCallStyle -> theme field
  map, including what has no equivalent.
- Call features: incoming call paragraph.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

This branch was successfully deployed

1 active deployment
staging — e4e881f5 Deployed Oct 16, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant