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 packageOverview

Glossary

TermMeaning
Host appYour React Native app that installs this package
Peer dependencyA library the package needs but your app installs (so there is exactly one copy, e.g. react-native)
AutolinkingReact Native CLI links native code from node_modules automatically (pod install on iOS, Gradle on Android)
Host tokenYour app's own user access token, passed as accessToken
Chat tokenThe token the package gets from RealtimeX in exchange for the host token
Effective settingsThe workspace's resolved rules (features on/off, limits, group policy) from GET /settings/effective
Feature gateA check such as useAdminFeatureGate('videoCall') that says whether a feature is visible and enabled
Group policyWorkspace defaults and locked keys for group permissions
Owner / adminThe group creator (owner) and members with admin rights
FCMFirebase Cloud Messaging — delivers pushes to Android and iOS
APNsApple Push Notification service
PushKit / CallKitiOS frameworks for VoIP pushes and the native incoming-call screen
Notifee@notifee/react-native — draws Android full-screen call notifications
PiPPicture-in-Picture — the floating call window when the user leaves the app
Broadcast Upload ExtensionThe iOS app extension that captures the screen for screen sharing
App GroupAn iOS capability that lets the app and its extension share data
MetroThe React Native JavaScript bundler
portal:A Yarn protocol that installs a package from a local folder (Fieldr uses it during development)
SlotA replaceable built-in component in ui.components
Render propA function prop on ChatProvider that renders a whole area yourself
PreviousHow the package worksNextRequirements & dependencies