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 packageAPI Reference

All exports

ExportKindPurpose
ChatProviderComponentSession, socket, push, theme, toast, safe area, gesture root
ChatNavigatorComponentWhole chat stack + CallProvider
AppScreen, ChatStackParamList, RootStackParamList, ChatScreenProps, ChatRoomParams, ChatInfoParams, CreateGroupParams, SelectGroupMembersParams, CanvasListParams, CanvasEditorParams, CallsHistoryParamsConstants / typesRoute names and params
configureChat, updateChatUiConfig, getUiConfig, getUiConfigPartial, resolveChatUiConfig, mergeChatUiStyles, mergeChatInfoPartial, DEFAULT_CHAT_UI, DEFAULT_CHAT_FONTS, getFonts, getThemeConfig, getCallUri, getAccentHex, getCustomAccent, resolveAccentOption, applyColorOverrides, getConfiguredAppearanceDefaults, applyEnvChatConfigFallback, isChatConfigured, ChatConfig, resolveApiUrl, resolveSocketUrlFunctionsConfig
ConfigureChatOptions, ChatUiConfig, ChatUiComponents, ChatUiStyles, ChatThemeConfig, ChatFonts, ChatInfoUiConfig, …TypesConfig shapes
ChatCustomizationProvider, useChatCustomization, Render* / *RenderProps typesComponent / hook / typesRender props
ConversationListScreen (ConversationList, ChatConversationList), ChatRoomScreen (ChatRoom), ChatInfoScreen, CreateGroupScreen, SelectUserScreen, SelectGroupMembersScreen, GlobalMessageSearchScreen, NotificationSettingsScreen, MentionsScreen, CanvasListScreen, CanvasEditorScreen, ProfileScreen, ActiveCallScreen, CallsHistoryScreenScreensCustom navigators
ChatRoomHeader, ConversationListItem, MessageBubble, MessageComposer, ThreadDrawer, MentionRowComponentsWrap / reuse built-ins
Icon, Assets, getIconXml, isIconName, ThemeIcon, tintSvgXml, AppFontsComponents / utilsIcons, fonts
useChat, useChatSession, useChatSocket, useConversations, useMessages, useAdminFeatureGate, useEffectiveSettings, useEffectiveSettingsOptional, useAppThemeHooksHooks & store
getFeatureGate, getCallGate, getCallsPlatformGate, getCallRecordingGate, getWhiteboardGate, isGroupPermissionLocked, gate messages, AdminFeatureKey, FeatureGate, CallFeatureGate, IEffectiveChatSettingsFunctions / typesPermissions
ensureChatSession, bootstrapChatSession, connectChatSocket, logoutChatSession, resetChatSession, BootstrapChatSessionOptionsFunctionsSession
onChatSessionEnd, clearChatSessionEnd, sessionEndReasonForCode, sessionEndMessage, ChatSessionEnd* typesFunctions / typesServer-ended sessions
socketService, SOCKET_EVENTSObject / constantsSocket
selectOnlineUsers, selectSocketAppError, selectSocketError, selectSocketStatus, authActions, selectIsAuthenticate, selectIsSessionReady, selectSdkChatToken, selectLoggedUserId, SocketStatusInternal store helpersPrefer the hooks
CHAT_API_KEYS, setChatQueryParams, setChatQueryParamApis, setChatQueryParamsByApi, getChatQueryParamState, resolveParamsForRequest, resolveChatApiKey, ChatApiKey, ChatQueryParamsFunctions / typesAPI query params
fetchMentionedMessages, MentionedMessageFunction / typeMentions view
useAppTheme, getColors, getThemeAccent, THEME_ACCENT_OPTIONS, DEFAULT_THEME_ACCENT, createAccentFromHex, resolveAccent, normalizeHexColor, isHexColor, DEFAULT_APPEARANCE, AVATAR_SHAPE_OPTIONS, MESSAGE_STYLE_OPTIONS, getAvatarBorderRadius, getMessageBubbleRadii, Spacing, FontSize, FontWeight, Typography, getTypographyHook / functions / constantsTheme
configureCalling, getCallingConfig, isCallingEnabled, callManager, CallProvider, useCallStore, useCallExtrasStore, useLiveCallsStore, resetCallExtras, CALL_MODES, CALL_SOCKET_EVENTS, apiFetchCallHistory, apiFetchActiveCalls, apiJoinCall, FloatingReactions, CallChatPanel, JoinCallBanner, CallMode, CallPeer, CallUiStatus, StartOutgoingCallParams, ActiveCallSummary, CallHistoryEntryFunctions / components / typesCalling
configurePushNotifications, registerRealtimexBackgroundHandler, handleRealtimexBackgroundMessage, handleRealtimexNotifeeEvent, handleRealtimexForegroundMessage, extractPushData, isRealtimexPush, openRealtimexNotification, registerPushForSession, unregisterPushForSession, startRealtimexNotifications, startRealtimexVoip, subscribeNotificationPrefs, NotificationsApiError, apiGetPushConfig, apiGetNotificationPreferences, apiPatchNotificationPreferences, apiGetConversationNotifications, apiPutConversationNotifications, push typesFunctions / typesPush
PreviousAPI query paramsNextProduction integration pattern (Fieldr)