Flutter API reference

All methods are static on ClarioDesk. Reads are exposed as Streams that auto-prime and then live-update.

Lifecycle

`init`

Future<void> ClarioDesk.init({
  required String apiKey,
  ClarioDeskTheme? theme,
  IdentityTokenProvider? identityTokenProvider,
})

Call once at app start. Generates the hardware key + registers the device on first launch; reuses it afterward. Pass a theme only if you use the prebuilt UI.

`identify`

Future<void> ClarioDesk.identify({
  String? externalId,
  String? name,
  String? email,
  Map<String, Object?> traits,
  String? identityToken,
  IdentityMode? identityMode,
})

Without a token, attach unverified display metadata. With a token/provider, perform Verified identity. Proof failures never fall back to labels.

Future<String> get ClarioDesk.deviceThumbprint
Future<void> ClarioDesk.clearIdentity()

Use clearIdentity() before Verified-identity logout/account switch.

`reset`

Future<void> ClarioDesk.reset()

Acknowledged one-installation revoke, followed by hardware-key/cache wipe. It is not logout or customer erase. The next init() registers a fresh device.

Tickets & messages

`createTicket`

Future<Ticket> ClarioDesk.createTicket({
  required String subject,
  required String body,
  List<OutgoingAttachment> attachments,
})

`sendMessage`

Future<Message> ClarioDesk.sendMessage(
  String ticketId,
  String body, {
  List<OutgoingAttachment> attachments,
})

Optimistic: the message appears as pending immediately and settles on success.

`ticketsStream`

Stream<List<Ticket>> ClarioDesk.ticketsStream()

Reactive inbox. Auto-primes from cache, then streams live updates.

`messagesStream`

Stream<List<Message>> ClarioDesk.messagesStream(String ticketId)

Reactive thread for one ticket.

CSAT

`submitCsat`

Future<void> ClarioDesk.submitCsat(
  String ticketId, {
  required int score,   // 1 (😔) … 5 (😄)
  String? comment,
})

See CSAT.

Attachments

`attachmentUploadProgress`

ValueListenable<double> ClarioDesk.attachmentUploadProgress(String localId)

Per-upload progress, from 0.0 to 1.0.

`refreshAttachmentUrl`

Future<Attachment> ClarioDesk.refreshAttachmentUrl(String attachmentId)

Re-presign an expired GET URL. See Attachments.

Push

`handlePushPayload`

void ClarioDesk.handlePushPayload(Map<String, dynamic> payload)

Call from your push handler to deep-link to the relevant ticket. See Push notifications.

Connection

`connectionStream`

Stream<ConnectionState> ClarioDesk.connectionStream()

Observe realtime connection state: connecting, connected, reconnecting, disconnected, fatal. See Realtime.

The React Native SDK mirrors this surface 1:1 with the same method names and semantics, and the Swift SDK implements the same contract in Swift idioms. If a capability behaves differently across the SDKs, it’s a bug. See the RN API reference and the Swift API reference.

​Lifecycle

​init

​identify

​reset

​Tickets & messages

​createTicket

​sendMessage

​ticketsStream

​messagesStream

​CSAT

​submitCsat

​Attachments

​attachmentUploadProgress

​refreshAttachmentUrl

​Push

​handlePushPayload

​Connection

​connectionStream

Lifecycle

`init`

`identify`

`reset`

Tickets & messages

`createTicket`

`sendMessage`

`ticketsStream`

`messagesStream`

CSAT

`submitCsat`

Attachments

`attachmentUploadProgress`

`refreshAttachmentUrl`

Push

`handlePushPayload`

Connection

`connectionStream`