RealTimeX
Sign inStart for free
RealTimeXMobile Package
Introduction5-minute overviewFeaturesHow the package worksGlossary
Requirements & dependenciesBackend credentialsInstallation step by stepTutorial — your first chat appProject config fileApp entry — index.jsQuick start — minimum working chatComplete ChatScreen example
Native configuration (iOS & Android)Firebase, APNs & backend setup
Navigation — embedding the chatSession, auth & Socket.IOPermissions & access controlAudio & video callingPush notificationsMentions viewRich-text messages (WebView editor)Total unread count
Customization — four waysDefault component fallback (important)Which slots are wiredCustomization examples (Case 1–4)UI feature flags & copy (ui)Chat info (group + DM)Style overrides (ui.styles)Render props (ChatProvider)Theme, fonts & appearance
ChatProvider props referenceconfigureChat options referenceHooks & storeCallbacks referenceAPI query paramsAll exports
Production integration pattern (Fieldr)Host app integration — providers, toasts, tab bars & navigationEnvironment variablesLocal package / monorepo (Metro)
TroubleshootingSetup checklistArchitectureDocumentation & file mapPackage development (maintainers)License
Mobile packageTroubleshooting & Reference

Documentation & file map

The documents this guide was built from, and where each native file lives in the package.

DocumentContentsPublished to npm
README.mdShort overview, install, quick startYes
MOBILE_FULL_GUIDE.mdThe Markdown version of this guideNo (repository)
host-setup/NATIVE_SETUP.mdNative checklist: Android, iOS, push, VoIP, common issuesYes
host-setup/ios/snippets/Info.plist.snippet.xmlUsage strings, RTC keys, background modesYes
host-setup/ios/snippets/Entitlements.snippet.plistApp Group, aps-environment, optional multitasking-camera entitlementYes
host-setup/ios/snippets/Podfile.snippet.rbsetup_permissions, Broadcast targetYes
host-setup/ios/snippets/AppDelegate.pushkit.snippet.swiftOnly for apps that keep their own PushKit codeYes
host-setup/ios/screen-share/Broadcast/SampleHandler.swift, Info.plist, Broadcast.entitlements templatesYes
host-setup/android/AndroidManifest.snippet.xmlManifest entries, only if Android autolinking is disabledYes
host-setup/android/snippets/MainApplication.note.ktWhy MainApplication needs no chat codeYes
host-setup/patches/WebRTC and CallKeep patches (patch-package)Yes
ios/SCREEN_SHARE_HOST_SETUP.mdScreen-share setup for both platformsYes
*_HANDOFF.mdBackend contracts (push, mentions, receipts, limits, session revocation, screen-share requests)No (repository)
CHANGELOG.mdRelease notes (semantic-release)No
text
1android-screenshare/                AUTOLINKED Android library (permissions, FGS, CallPipModule, RtxNotifications, RtxCallPushReceiver)2RealtimexLiveChat.podspec           AUTOLINKED iOS pod (CallPipModule, VideosdkRPK, RealtimexVoip)3RealtimexLiveChatBroadcast.podspec  Screen-share extension pod (add to your Broadcast target in the Podfile)4ios/RealTimeXChat/                  Main pod sources5ios/RealtimexBroadcast/             Extension pod sources6react-native.config.js              Autolinking declaration for both
PreviousArchitectureNextPackage development (maintainers)