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

SymbolDescription
ZetaClientDefault-export entry point. Exposes accessors (.user, .events, .inbox, .inapp, .push) and static methods (initialize, setClientSecret, optInForTracking, optOutFromTracking, getCachedBSIN, log, sdkVersion).
ZTConfigConfiguration object passed to ZetaClient.initialize(config, callback?). Fields: clientSiteId, clientSecret?, region, optIn, appEnvironment?, appGroupId? (iOS).
ZTRegionEnum of supported ZMP regions (US, EU).
ZTAppEnvironmentEnum for the APNs environment on iOS (PRODUCTION, SANDBOX).

See Getting Started.

User & contacts

SymbolDescription
ZetaClient.userZTUserManagable accessor for user operations.
ZTUserManagableInterface: updateUser, build, clear, setIdentifierForAdvertiser, setIdentifierForVendor, setUniqueClientId, setIdentityDelegate (iOS), resetIdentifiers (iOS), updateLocation, updateDeviceToken.
ZTUserUser model passed to updateUser() or built via build().
ZTUserEmailContactEmail contact with optional ZTContactAdditionalInfo.
ZTUserPhoneContactPhone contact with optional ZTContactAdditionalInfo.
ZTContactAdditionalInfoPreferences, subscription status, and custom properties for a contact.
ZTLocationLatitude/longitude plus foreground flag attached to events.

See Contact Management.

Events

SymbolDescription
ZetaClient.eventsZTEventsManagable accessor for event tracking.
ZTEventsManagableInterface: send(name, properties?), trackScreenName(screen, deeplink?, properties?).
ZTEventDataEvent model (name, optional properties).
ZTTrackScreenNameDataScreen-tracking model (screen, optional deeplink, properties).

See Contact Management / Track custom and screen events.

Push notifications

SymbolDescription
ZetaClient.pushZTPushManagable accessor for push operations.
ZTPushManagableInterface: getInitialIntent() (Android), notifyReactNativeNavigationReady() (iOS), setDeeplinkDelegate() (iOS), fetchToken(), handleNotificationsMessage(response, actionIdentifier?) (iOS), requestNotificationPermissions().
IntentDataAndroid intent payload returned by getInitialIntent() / intent events (action, type, data, scheme, extras).
ZTNotificationResponseNotification payload passed to handleNotificationsMessage().

See Push Notifications.

In-app messaging

SymbolDescription
ZetaClient.inappZTInAppMessageManagable accessor.
ZTInAppMessageManagableInterface: setDelegate(), getStatus(callback), start(), stop().
ZTInAppMessageMessage model delivered to the InAppMessageDelegate event.

See In-App Messaging.

App Inbox

SymbolDescription
ZetaClient.inboxZTInboxManagable accessor.
ZTInboxManagableInterface (all Promise-based): fetchMessages, getMessageCount, getUnreadMessageCount, getReadMessageCount, getMessage, getUnreadMessages, getReadMessages, markMessageAsRead, markAllMessagesAsRead, markMessageAsDeleted, markAllMessagesAsDeleted, onMessageClicked, clearAll.
ZTAppInboxMessageA single inbox entry (messageId, title, body, mediaUrl, status, expirationTimestamp, actionList, templateId, additionalData).
ZTAppInboxActionA call-to-action attached to an inbox message (type, text, value, link, actionType?).
ZTAppInboxMessageStatusEnum: READ, UNREAD, DELETED.

See App Inbox.

Events & delegates

SymbolDescription
ZetaCoreEventsEnum 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

SymbolDescription
ZTLoggerStatic namespace: setLogLevel(level), setLogPrivacy(privacy) (iOS).
ZTLogLevelEnum: NONE, VERBOSE, DEBUG, INFO, WARNING, ERROR.
ZTLogPrivacyEnum: PRIVATE, PUBLIC (iOS).

See Advanced / Logging.

See also