chat_rf library

Classes

AddGroupMemberPageRF
Directory of users not already in a group, for adding one.
AnimatedBubble
ApiPage<T>
A page of typed rows plus the envelope they came from.
ApiRequest
The request envelope every endpoint accepts.
ApiResult
Parsed response envelope shared by /api/Fetch/SendPacket and /api/Sync/SendPacket.
ChatApi
Typed wrapper over the new .NET chat API.
ChatApiClient
Transport for the new .NET API.
ChatApiCommand
Command values the server dispatches on.
ChatApiTable
Operation names carried in the envelope's TableName field.
ChatAttachmentUpload
A local file queued for SendMessageWithAttachments.
ChatAvatarRF
A user or conversation avatar: photo when one is available, initials otherwise.
ChatbotMessageRF
ChatbotSettingRF
ChatFcmEventNames
Maps a chat push's data payload onto ChatRealtimeEventType.
ChatGroup
A conversation row from GetChats.
ChatGroupMember
ChatGroupRF
The conversation list, backed by GetChats and refreshed by hub events.
ChatLibsRF
Composition root: builds the API client, realtime connection and controllers for one of the package's two modes.
ChatMessage
ChatMessageAttachment
ChatMessageReaction
ChatMessageRF
The chat page, for both of the package's modes.
ChatNotification
A notification carrying "something changed, update the UI".
ChatPageStyleRF
ChatPresence
A user's presence, as broadcast by the hub.
ChatPresenceRF
Presence and profile photos for everyone the hub has mentioned.
ChatRealtime
A source of realtime chat events.
ChatRealtimeEvent
One event delivered by the hub.
ChatRealtimeEventNames
Maps server event names onto ChatRealtimeEventType.
ChatRF
The conversation list.
ChatSeenUser
ChatSettingRF
Everything the package needs to talk to the chat server.
ChatUser
A directory user returned by GetChatUsers.
ChatUserRF
The user directory, backed by GetChatUsers.
CircleBubble
CompositeChatRealtime
Merges several ChatRealtime sources into one.
ConversationPageRF
A server-backed conversation: history over REST, live updates over the hub.
EmojiPickerRF
A curated, dependency-free emoji grid for the composer.
FakeMessage
FcmChatRealtime
A ChatRealtime source backed by Firebase Cloud Messaging.
FlashingCircle
GroupMembersPageRF
Group membership: view members, add, remove, leave, delete.
IChatMessageRF
IChatSettingRF
NewChatPageRF
The user directory (GetChatUsers), for starting a conversation.
NoopChatRealtime
A ChatRealtime that never connects and emits nothing.
SignalRChatRealtime
ChatRealtime backed by an ASP.NET Core SignalR hub.
SRChatMessageController
Drives one conversation: history from ChatApi, live updates from ChatRealtime.
StatusBubble
TextRF
TypingIndicator

Enums

ChatNotificationKind
What a notification is for, once the transport-specific wrapper is stripped.
ChatRealtimeEventType
What a realtime event means, independent of what the server calls it.
ChatRealtimeStatus
Connection state of a realtime source.

Functions

ChatFcmBackgroundHandler(RemoteMessage message) → Future<void>
Handles a push delivered while the app is backgrounded or terminated.

Typedefs

ChatApiHeaders = Future<Map<String, String>> Function()
Supplies headers on every request — the hook for auth, since the envelope carries UserGuid but no token. Called per request so a rotating token is picked up without rebuilding the client.
ChatFcmToken = void Function(String token)
Called with a fresh FCM registration token, on first obtaining one and again on every refresh, so the host app can hand it to its backend. The package has no opinion on that endpoint — it does not exist yet on the server this was built against — so this is a callback rather than a call.
ChatRealtimeToken = Future<String> Function()
Supplies a bearer token for the realtime handshake, re-read on every reconnect so a refreshed token is picked up without rebuilding the connection.
ChatRFBuilder = Widget Function(BuildContext context, String Name, String message, String sendAt, Widget? icon)
PickAttachments = Future<List<ChatAttachmentUpload>> Function(BuildContext context)
Lets the host app supply files without the package depending on a picker plugin — ConversationPageRF shows the attach button only when this resolves non-null (either passed directly, or via ChatSettingRF.OnPickAttachments). The context is handed through so the host can show its own picker UI (a bottom sheet, a dialog, …) anchored to the conversation screen.