API Reference
A feature-grouped index of the public JavaScript/TypeScript surface the React Native SDK exposes. Each entry links to the page where the symbol is used in context.
Everything is imported from the zetakit_reactnative package. ZetaClient is the default export; enums, ZTLogger, ZetaCoreEvents, and the model/interface types are named exports.
Client & configuration
| Symbol | Description |
|---|---|
ZetaClient | Default-export entry point. Exposes accessors (.user, .events, .inbox, .inapp, .push) and static methods (initialize, setClientSecret, optInForTracking, optOutFromTracking, getCachedBSIN, log, sdkVersion). |
ZTConfig | Configuration object passed to ZetaClient.initialize(config, callback?). Fields: clientSiteId, clientSecret?, region, optIn, appEnvironment?, appGroupId? (iOS). |
ZTRegion | Enum of supported ZMP regions (US, EU). |
ZTAppEnvironment | Enum for the APNs environment on iOS (PRODUCTION, SANDBOX). |
See Getting Started.
User & contacts
| Symbol | Description |
|---|---|
ZetaClient.user | ZTUserManagable accessor for user operations. |
ZTUserManagable | Interface: updateUser, build, clear, setIdentifierForAdvertiser, setIdentifierForVendor, setUniqueClientId, setIdentityDelegate, resetIdentifiers (iOS), updateLocation, updateDeviceToken. |
ZTUser | User model passed to updateUser() or built via build(). |
ZTUserEmailContact | Email contact with optional ZTContactAdditionalInfo. |
ZTUserPhoneContact | Phone contact with optional ZTContactAdditionalInfo. |
ZTContactAdditionalInfo | Preferences, subscription status, and custom properties for a contact. |
ZTLocation | Latitude/longitude plus foreground flag attached to events. |
See Contact Management.
Events
| Symbol | Description |
|---|---|
ZetaClient.events | ZTEventsManagable accessor for event tracking. |
ZTEventsManagable | Interface: send(name, properties?), trackScreenName(screen, deeplink?, properties?). |
ZTEventData | Event model (name, optional properties). |
ZTTrackScreenNameData | Screen-tracking model (screen, optional deeplink, properties). |
See Contact Management / Track custom and screen events.
Push notifications
| Symbol | Description |
|---|---|
ZetaClient.push | ZTPushManagable accessor for push operations. |
ZTPushManagable | Interface: getInitialIntent() (Android), notifyReactNativeNavigationReady() (iOS), setDeeplinkDelegate() (iOS), fetchToken() (Android), handleNotificationsMessage(response, actionIdentifier?), requestNotificationPermissions(). |
IntentData | Android intent payload returned by getInitialIntent() / intent events (action, type, data, scheme, extras). |
ZTNotificationResponse | Notification payload passed to handleNotificationsMessage(). |
See Push Notifications.
In-app messaging
| Symbol | Description |
|---|---|
ZetaClient.inapp | ZTInAppMessageManagable accessor. |
ZTInAppMessageManagable | Interface: setDelegate(), getStatus(callback), start(), stop(). |
ZTInAppMessage | Message model delivered to the InAppMessageDelegate event. |
See In-App Messaging.
App Inbox
| Symbol | Description |
|---|---|
ZetaClient.inbox | ZTInboxManagable accessor. |
ZTInboxManagable | Interface (all Promise-based): fetchMessages, getMessageCount, getUnreadMessageCount, getReadMessageCount, getMessage, getUnreadMessages, getReadMessages, markMessageAsRead, markAllMessagesAsRead, markMessageAsDeleted, markAllMessagesAsDeleted, onMessageClicked, clearAll. |
ZTAppInboxMessage | A single inbox entry (messageId, title, body, mediaUrl, status, expirationTimestamp, actionList, templateId, additionalData). |
ZTAppInboxAction | A call-to-action attached to an inbox message (type, text, value, link, actionType?). |
ZTAppInboxMessageStatus | Enum: READ, UNREAD, DELETED. |
See App Inbox.
Events & delegates
| Symbol | Description |
|---|---|
ZetaCoreEvents | Enum of native event names used with NativeEventEmitter (iOS) / DeviceEventEmitter (Android): DeeplinkDelegate, InAppMessageDelegate, DeviceTokenDelegate, IdentityDelegate, SdkVersionDelegate, AndroidInitialIntent, AndroidNewIntent. |
See Push Notifications, In-App Messaging, and Contact Management / Listen for identity updates.
Logging
| Symbol | Description |
|---|---|
ZTLogger | Static namespace: setLogLevel(level), setLogPrivacy(privacy) (iOS). |
ZTLogLevel | Enum: NONE, VERBOSE, DEBUG, INFO, WARNING, ERROR. |
ZTLogPrivacy | Enum: PRIVATE, PUBLIC (iOS). |
See Advanced / Logging.
See also
- Changelog — complete Added / Changed / Removed log for every version.
- Migration Guide — breaking changes between versions.
- Platform support — feature availability by platform and SDK version.
Updated 20 days ago
Did this page help you?