tickki_chat_flutter library
Tickki Chat SDK for Flutter — headless surface.
Import this file to get the API client + realtime primitives without pulling in any widgets. Use this when you're building your own chat UI on top of Tickki.
import 'package:tickki_chat_flutter/tickki_chat_flutter.dart';
final tickki = TickkiChat(publishableKey: 'pk_live_…');
final session = await tickki.startSession(visitorId: 'user_8432');
session.messages.listen((m) => print('${m.direction}: ${m.content}'));
await session.send('Hello!');
For the pre-built chat screen instead, import
package:tickki_chat_flutter/widget.dart.
Classes
- BrandingInfo
- BusinessInfo
- ChatConfig
-
Branding + feature flags + presence returned by
GET /chat/config. - ChatMessage
-
One message in a conversation.
direction == 'inbound'was sent by the visitor (your user);'outbound'was sent by an agent. - ChatSession
- A live chat session bound to one conversation. Returned from TickkiChat.startSession. Holds the session token internally and exposes the REST + realtime primitives the SDK consumer needs.
- FeaturesInfo
- LimitsInfo
- MessageAttachment
- MessagePage
-
A paginated slice of messages — what
GET /sessions/{id}/messagesreturns. nextCursor is null when there is no older page. - RealtimeConfig
- Server-issued realtime config returned alongside a newly-started session. Hand straight to the Pusher / Reverb client.
- StartSessionResponse
-
What
POST /chat/sessionsreturns. The sessionToken field is shown to the caller exactly once — persist it in memory for the lifetime of the chat. - TickkiAnalytics
- Analytics surface for the Tickki Chat SDK.
- TickkiChat
- Entry point for the Tickki Chat SDK.
Enums
Exceptions / Errors
- TickkiChatException
- Exception thrown by every Tickki Chat SDK call. All HTTP and realtime failures surface as one of these — branch on code for programmatic handling and use message for logs / dev tools.