React Native API reference

All methods live on the ClarioDesk singleton. subscribe* methods return an unsubscribe function; the React hooks mirror each subscription.

import { ClarioDesk } from '@clariodesk/react-native';

Lifecycle

ClarioDesk.init({ apiKey, identityTokenProvider?, pushTokenProvider?, attachments? }): Promise<void>
ClarioDesk.identify({ externalId?, name?, email?, traits?, identityToken?, identityMode? }): Promise<void>
ClarioDesk.deviceThumbprint(): Promise<string>
ClarioDesk.clearIdentity(): Promise<void>
ClarioDesk.reset(): Promise<void>
ClarioDesk.isInitialized(): boolean
ClarioDesk.isIdentified(): boolean

Without a token, identify writes unverified display labels. With a token or provider it performs Verified identity. Use clearIdentity() before verified logout/switch; reset() deprovisions only this installation. externalId is your auth system’s stable user id (Firebase user.uid, Clerk user.id, Auth0 user.sub) — never an auth token, never an email; full table.

Tickets & messages

ClarioDesk.createTicket({ subject, body, attachments? }): Promise<{ ticket: Ticket }>
ClarioDesk.sendMessage(ticketId, body, { attachments? }?): Promise<Message>
ClarioDesk.retryMessage(message): Promise<Message>   // for failed optimistic sends
ClarioDesk.markRead(ticketId): Promise<void>
ClarioDesk.setTyping(ticketId, isTyping): void
ClarioDesk.fetchTickets(): Promise<Ticket[]>          // one-shot
ClarioDesk.fetchTicket(ticketId): Promise<Ticket>     // one-shot

A message with pending: true is optimistic; failed: true means rejected, so render tap-to-retry with retryMessage. Offline sends stay pending and auto-flush on reconnect.

Live subscriptions

Each returns an unsubscribe function.

ClarioDesk.subscribeTickets(cb): () => void
ClarioDesk.subscribeMessages(ticketId, cb): () => void
ClarioDesk.subscribeTyping(ticketId, cb): () => void
ClarioDesk.subscribeAgentPresence(cb): () => void
ClarioDesk.subscribeConnection(cb): () => void   // connecting | connected | reconnecting | disconnected | fatal
ClarioDesk.subscribeSync(cb): () => void
ClarioDesk.subscribeState(cb): () => void
ClarioDesk.subscribePushOpened(cb): () => void

Hooks

The same data, idiomatic for React (separate entry, no React dep in core):

import {
  useTickets, useMessages, useTyping, useAgentPresence,
  useConnection, useSync, usePushOpened,
} from '@clariodesk/react-native/hooks';

CSAT

ClarioDesk.submitCsat(ticketId, { score, comment? }): Promise<void>
// score: 1 (😔) … 5 (😄)

Push

ClarioDesk.registerPushToken(token): Promise<void>
ClarioDesk.isClarioMessage(data): boolean
ClarioDesk.parsePushPayload(data): ParsedPush | null
ClarioDesk.openTicketFromPush(data): ClarioPushPayload | null
ClarioDesk.resolvePushTarget(data): Promise<ClarioPushTarget | null>
ClarioDesk.setVisibleSupportSurface({ kind: 'inbox' | 'ticket', ticketId? }): Promise<void>
ClarioDesk.clearVisibleSupportSurface(): Promise<void>
ClarioDesk.getNotificationPreferences(): Promise<NotificationPreferences>
ClarioDesk.setNotificationPreferences(prefs): Promise<void>

In 0.3.0+, the raw payload remains target-free and carries only an opaque deliveryId. resolvePushTarget returns the authorized ticket/inbox after a signed check. Custom screens can use useVisibleSupportSurface from the hooks entry point; prebuilt UI manages visibility automatically. See the push guide.

Attachments

ClarioDesk.attachmentUploadProgress(stubId): Subscribable<number>
ClarioDesk.refreshAttachmentUrl(attachmentId): Promise<Attachment>

Types

All types are exported: Ticket, Message, Attachment, OutgoingAttachment, readStateOf, ClarioDeskError, and the enums above.

This surface mirrors the Flutter SDK 1:1. Same method names, same semantics. The Swift SDK implements the same contract in Swift idioms. If a capability behaves differently across the SDKs, it’s a bug.

​Lifecycle

​Tickets & messages

​Live subscriptions

​Hooks

​CSAT

​Push

​Attachments

​Types

Lifecycle

Tickets & messages

Live subscriptions

Hooks

CSAT

Push

Attachments

Types