Callbacks reference

Every callback the package calls in your code, in one place.

Callback	Where you pass it	Signature	When it runs
`onSessionEnd`	`configureChat` / `ChatProvider config`	`(event: ChatSessionEndEvent) => void`	The server ended the session (force logout, deactivated, banned, deleted, workspace deleted, revoked)
`onChatSessionEnd(listener)`	Function call	`(listener: ChatSessionEndHandler) => () => void`	Same as `onSessionEnd`; returns an unsubscribe function
`onNotificationOpened`	`configurePushNotifications`	`(target: NotificationOpenTarget) => void`	Every notification tap, before the package navigates
`onForegroundNotification`	`configurePushNotifications`	`(notification: ForegroundNotification) => boolean`	Before a foreground notification is shown; return `true` to show it yourself
`onVideoCallPress`, `onVoiceCallPress`	`ui.chatRoom.header`	`(ctx: ChatRoomActionContext) => boolean \| void`	Room header call buttons; return `true` to skip the built-in call
`onAudioPress`, `onVideoPress`	`ui.chatInfo`	`(ctx: ChatRoomActionContext) => boolean \| void`	Chat info quick actions; return `true` if you handled it
`onReady`	`ChatNavigator`	`() => void`	The internal `NavigationContainer` is ready (only with `withContainer`)
`socketService.on(event, handler)`	Function call	returns `() => void`	Every time the socket receives `event`
Render props	`ChatProvider`	see Render props	When that area renders

ChatSessionEndEvent: { reason, message, code?, source } — reason is 'force_logout' | 'deactivated' | 'banned' | 'deleted' | 'workspace_deleted' | 'session_revoked', source is 'socket' | 'handshake' | 'rest', message is the short text also shown as a toast.

NotificationOpenTarget: {type: 'conversation', conversationId, isGroup?} | {type: 'thread', conversationId, threadRootId, isGroup?} | {type: 'call', callId, conversationId?}.

ForegroundNotification: the RealtimeX push data plus plain-text title and body.

ChatRoomActionContext: { conversationId, isGroup, receiverId?, title }.

typescriptsrc/configs/chat.config.ts

1// src/configs/chat.config.ts — wiring the main callbacks2import {configurePushNotifications, onChatSessionEnd} from '@realtimexsco/live-chat-react-native';3 4export const chatConfig = {5  // …credentials6  onSessionEnd: ({reason, message}) => {7    console.log('Chat session ended', reason, message);8  },9  ui: {10    chatRoom: {11      header: {12        onVideoCallPress: ({conversationId}) => {13          console.log('video call in', conversationId);14          return false; // false / undefined → the built-in call runs15        },16      },17    },18  },19};20 21const unsubscribe = onChatSessionEnd(event => console.log(event.source));

Callbacks reference

Every callback the package calls in your code, in one place.

Callback	Where you pass it	Signature	When it runs
`onSessionEnd`	`configureChat` / `ChatProvider config`	`(event: ChatSessionEndEvent) => void`	The server ended the session (force logout, deactivated, banned, deleted, workspace deleted, revoked)
`onChatSessionEnd(listener)`	Function call	`(listener: ChatSessionEndHandler) => () => void`	Same as `onSessionEnd`; returns an unsubscribe function
`onNotificationOpened`	`configurePushNotifications`	`(target: NotificationOpenTarget) => void`	Every notification tap, before the package navigates
`onForegroundNotification`	`configurePushNotifications`	`(notification: ForegroundNotification) => boolean`	Before a foreground notification is shown; return `true` to show it yourself
`onVideoCallPress`, `onVoiceCallPress`	`ui.chatRoom.header`	`(ctx: ChatRoomActionContext) => boolean \| void`	Room header call buttons; return `true` to skip the built-in call
`onAudioPress`, `onVideoPress`	`ui.chatInfo`	`(ctx: ChatRoomActionContext) => boolean \| void`	Chat info quick actions; return `true` if you handled it
`onReady`	`ChatNavigator`	`() => void`	The internal `NavigationContainer` is ready (only with `withContainer`)
`socketService.on(event, handler)`	Function call	returns `() => void`	Every time the socket receives `event`
Render props	`ChatProvider`	see Render props	When that area renders

NotificationOpenTarget: {type: 'conversation', conversationId, isGroup?} | {type: 'thread', conversationId, threadRootId, isGroup?} | {type: 'call', callId, conversationId?}.

ForegroundNotification: the RealtimeX push data plus plain-text title and body.

ChatRoomActionContext: { conversationId, isGroup, receiverId?, title }.

typescriptsrc/configs/chat.config.ts

1// src/configs/chat.config.ts — wiring the main callbacks2import {configurePushNotifications, onChatSessionEnd} from '@realtimexsco/live-chat-react-native';3 4export const chatConfig = {5  // …credentials6  onSessionEnd: ({reason, message}) => {7    console.log('Chat session ended', reason, message);8  },9  ui: {10    chatRoom: {11      header: {12        onVideoCallPress: ({conversationId}) => {13          console.log('video call in', conversationId);14          return false; // false / undefined → the built-in call runs15        },16      },17    },18  },19};20 21const unsubscribe = onChatSessionEnd(event => console.log(event.source));