docs(calls): correct v5 Calling SDK API references and enhance guides#407
docs(calls): correct v5 Calling SDK API references and enhance guides#407honey-cometchat wants to merge 4 commits into
Conversation
- Delete picture-in-picture.mdx page - Remove PiP actions from actions.mdx - Drop PiP method renames and layout events from v5 migration guide - Remove PiP entry from docs.json navigation Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
- Rename unMuteAudio() to unmuteAudio() across all integration guides - Replace login() with loginWithAuthToken() in v5 migration guide - Rename showSwitchModeButton() to showModeButton() in builder/mapping - Replace onRecordingToggled with onRecordingStarted/onRecordingStopped events - Remove onAudioModeChanged listener and hideSwitchLayoutButton setting - Drop the join-by-session-ID option, leaving token-based joinSession - Update idleTimeoutPeriodAfterPrompt default from 120000 to 180000 - Update hideRecordingButton and hideNetworkIndicator example defaults - Use onParticipantJoined in troubleshooting guidance - Unpin @cometchat/calls-sdk-react-native version in setup install steps Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
- Document setAudioMode() and participant-list panel methods - Fix onAudioModeChanged payload as a string, not an object - Correct Android foreground-service class, types, and permissions - Add onConnectionFailed event listener - Fix idle-timeout default values and descriptions - Update migration guide: loginWithAuthToken(), setCallEventListener(), showSwitchCameraButton(), recording/audio-mode listener renames, switchToVideoCall() now a deprecated no-op - Document header, status-indicator, identity, and behavior session settings - Clarify join flow uses component rendering, not joinSession() Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
- Add Install Required Dependencies section to RN Calls setup guide - List async-storage, background-timer, performance, svg, url-polyfill, and webrtc with pinned versions - Provide npm and Yarn install commands Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Docs review — 🟠 Request changes (one redirect)A large, genuinely corrective PR across the JS + RN Calling SDK v5 docs (22 files, +177/-230). I verified the API renames against the installed 🟠 P1 — must-fix before merge: deleted page, no redirect (404)
✅ API corrections — verified correct against SDK 5.0.1 type definitionsJavaScript: React Native: 🟡 P2 — worth an author double-check (couldn't fully verify from type defs)
Notes (pre-existing, out of scope)The analyzer flagged the orphan Otherwise an excellent, accurate cleanup. The only thing standing between it and approval is the one PiP redirect — happy to generate the 🤖 Automated docs review (Mintlify link/redirect/content checks + API verification against @cometchat/calls-sdk-javascript & calls-sdk-react-native 5.0.1 type definitions). |
Description
Corrects v5 Calling SDK API references and enhances the JavaScript and React Native call documentation to match the actual v5 SDK surface. Removes the unsupported Picture-in-Picture documentation, fixes renamed methods, updates default values, and documents previously missing APIs.
Related Issue(s)
Type of Change
Summary of Changes
JavaScript
picture-in-picture.mdx, drop PiP methods/events fromactions.mdxandmigration-guide-v5.mdx, and remove the nav entry fromdocs.json.unMuteAudio()→unmuteAudio()across actions, custom control panel, idle-timeout, and the Angular/Ionic/Next.js/React/Vue integration guides.login(authToken)→loginWithAuthToken(authToken)in the migration guide.session-settings.mdxdefaults:idleTimeoutPeriodAfterPromptto 180000ms,hideRecordingButtondefault, and remove the obsoletehideSwitchLayoutButtonoption.React Native
setAudioMode()and clarify thatonAudioModeChangeddelivers the active mode as a plain string ('SPEAKER' | 'EARPIECE' | 'BLUETOOTH' | 'HEADPHONES').showParticipantList(),hideParticipantList(), andtoggleParticipantList()inactions.mdx.onConnectionFailedevent inevents.mdx.CometChatOngoingCallServiceitself, so manual declaration is usually unnecessary.setup.mdxand remove the pinned@5.0.0install version.login(uid, authKey)vsloginWithAuthToken(authToken)in the migration guide.Checklist
Additional Information