Descriptive reference of the main models used across SDK modules.
Table of Contents
Push
Package: indigitall-react-native-plugin · File: src/models/modelType.tsx
Represents a push notification received from the Indigitall platform. Used as the message field inside InboxNotifications and delivered via the OnPushSuccessType callback.
| Property | Type | Required | Description |
|---|---|---|---|
title | string | No | Title of the push notification displayed to the user |
body | string | No | Main text body of the push notification |
image | string | No | URL of the image to display in the notification |
data | string | No | Custom payload string to pass arbitrary data to the app |
securedData | string | No | Decrypted secured payload attached to the notification |
action | PushAction | No | Action to execute when the user taps the notification |
buttons | [PushButton] | No | Tuple of action buttons displayed in the expanded notification |
Related models
PushAction — Defines the action executed when a push notification or button is tapped.
| Property | Type | Description |
|---|---|---|
url | string | null | URL to open |
app | string | null | Deep-link or activity class name to open |
market | string | null | Market URL or package name to open |
share | string | null | Text content to share |
call | string | null | Phone number to dial |
noAction | string | null | Marker for no-action behaviour |
clickedButton | number | null | Index of the button clicked (-1 if notification body was tapped) |
PushButton — An action button shown in the expanded notification.
| Property | Type | Description |
|---|---|---|
label | string | Text label displayed on the button |
action | PushAction | Action executed when the button is tapped |
Device
Package: indigitall-react-native-plugin · File: src/models/modelType.tsx
Represents the registered device in the Indigitall platform. Returned on SDK initialisation and device enable/disable callbacks via OnDeviceSuccessType.
| Property | Type | Required | Description |
|---|---|---|---|
enable | boolean | Yes | Whether the device is currently enabled for push delivery |
deviceId | string | Yes | Unique Indigitall device identifier |
pushToken | string | Yes | Platform push token (FCM / APNs) |
platform | string | Yes | Platform identifier (e.g. android, ios) |
productName | string | Yes | SDK product name (e.g. reactnative) |
productVersion | string | Yes | SDK product version (e.g. 2.19.0) |
osName | string | Yes | Operating system name |
osVersion | string | Yes | Operating system version |
deviceBrand | string | Yes | Device manufacturer brand |
deviceModel | string | Yes | Device hardware model |
operator | string | Yes | Mobile carrier / operator name |
deviceType | string | Yes | Form factor type (e.g. phone, tablet) |
appVersion | string | Yes | Host application version |
locale | string | Yes | Device locale (e.g. en_US) |
timeZone | string | Yes | Device time zone identifier (e.g. Europe/Madrid) |
timeOffset | string | Yes | UTC offset of the device time zone |
externalApps | [ExternalApps] | Yes | Tuple of external applications registered on the device |
Related models
ExternalApps — Represents an external app linked to the device.
| Property | Type | Description |
|---|---|---|
id | number | Internal identifier of the external application |
name | string | Display name of the external application |
code | string | Code identifier of the external application |
LADeviceis a variant ofDeviceused exclusively for Live Activity sessions. It has the same fields asDeviceexcept it omitspushTokenandexternalApps.
Customer
Package: indigitall-react-native-plugin · File: src/models/modelType.tsx · Class: Customer (src/Customer.tsx)
Represents the customer (end user) profile in the Indigitall platform. Returned via OnCustomerSuccessType.
| Property | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Internal Indigitall customer identifier |
customerId | string | Yes | External customer identifier provided by the app |
applicationId | string | Yes | Indigitall application identifier |
createdAt | string | Yes | ISO 8601 timestamp of customer profile creation |
updatedAt | string | Yes | ISO 8601 timestamp of the last profile update |
Inbox
Package: indigitall-react-native-plugin · File: src/models/modelType.tsx · Class: Inbox (src/Inbox.tsx)
Represents the paginated inbox returned by the Indigitall platform. Delivered via OnInboxSuccessType.
| Property | Type | Required | Description |
|---|---|---|---|
lastAccess | string | Yes | ISO 8601 timestamp of the last inbox access |
notifications | [InboxNotifications] | Yes | Tuple of all notifications in the current page |
newNotifications | [InboxNotifications] | null | No | Notifications received since the last access |
count | number | Yes | Total number of notifications across all pages |
pagesize | number | Yes | Number of notifications per page |
numPage | number | Yes | Current page index (zero-based) |
Related models
InboxNotifications — A single notification entry inside the inbox.
| Property | Type | Description |
|---|---|---|
id | string | Unique identifier of the inbox notification record |
externalId | string | External identifier associated with the notification |
sentAt | string | ISO 8601 timestamp of when the notification was sent |
status | string | Current status of the notification (e.g. read, unread) |
sendingId | number | Identifier of the sending campaign instance |
campaign | number | Identifier of the campaign this notification belongs to |
message | Push | The push notification content (see Push) |
read | boolean | Whether the notification has been read by the user |
category | InboxCategory | Category to which this notification belongs |
InboxCategory — Category associated with an inbox notification.
| Property | Type | Description |
|---|---|---|
id | number | Internal identifier of the category |
code | string | null | Code identifier of the category |
name | string | null | Display name of the category |
MessageCount — Summary counters for inbox messages. Returned via OnInboxMessageCountSuccessType.
| Property | Type | Description |
|---|---|---|
click | number | Number of clicked notifications |
sent | number | Number of sent notifications |
deleted | number | Number of deleted notifications |
lastAccess | number | Unix timestamp of the last inbox access |
count | number | Total number of notifications in the inbox |
InApp
Package: indigitall-react-native-plugin · File: src/models/modelType.tsx · Class: InApp (src/InApp.tsx)
Represents an in-app message retrieved from the Indigitall platform. Delivered via OnInAppOnSuccessType.
| Property | Type | Required | Description |
|---|---|---|---|
inAppId | string | Yes | Unique identifier of the in-app message |
lastVersionId | string | Yes | Identifier of the latest version of this in-app message |
showOnce | string | No | Flag indicating whether the in-app should only be shown once |
numberOfShows | string | No | Maximum number of times the in-app may be shown |
creationDate | string | Yes | ISO 8601 timestamp of when the in-app was created |
expiredDate | string | No | ISO 8601 timestamp after which the in-app should no longer be shown |
properties | InAppProperties | Yes | Display and interaction properties of the in-app |
renewalTime | string | No | Duration after which the in-app can be shown again |
schema | InAppSchema | Yes | Schema defining the code and dimensions of the in-app |
version | number | Yes | Version number of this in-app message |
Related models
InAppSchema — Defines the template and dimensions of the in-app.
| Property | Type | Description |
|---|---|---|
code | string | Template code identifying the in-app schema |
width | number | Width of the in-app container in pixels |
height | number | Height of the in-app container in pixels |
InAppProperties — Display and interaction properties for the in-app.
| Property | Type | Description |
|---|---|---|
contentUrl | string | URL of the HTML content to render inside the in-app |
showTime | string | Duration (in seconds) the in-app remains visible |
layout | InAppLayout | Layout styling options |
action | InAppAction | Default action when the in-app content is tapped |
InAppLayout — Styling options for the in-app container.
| Property | Type | Description |
|---|---|---|
borderRadius | string | CSS border-radius value for the container |
InAppAction — Action triggered when the in-app content is tapped.
| Property | Type | Description |
|---|---|---|
url | string | URL to open on tap |
LiveActivity
Package: indigitall-react-native-plugin · File: src/models/modelType.tsx · Class: LiveActivity (src/LiveActivity.tsx)
Represents a Live Activity session registered in the Indigitall platform (iOS only). Returned via OnEnabledLASuccessType.
| Property | Type | Required | Description |
|---|---|---|---|
liveActivityId | string | Yes | Unique Indigitall identifier for the Live Activity |
createdAt | string | Yes | ISO 8601 timestamp of when the Live Activity was registered |
updatedAt | string | Yes | ISO 8601 timestamp of the last update |
applicationId | number | Yes | Indigitall application identifier |
liveActivityExternalId | string | Yes | External identifier for the Live Activity provided by the app |
status | string | Yes | Current status of the Live Activity (e.g. active, dismissed) |
androidTopicId | string | No | Associated Android topic ID (used for cross-platform campaigns) |
Related models
LADevice — Variant of Device used during Live Activity sessions. Contains all Device fields except pushToken and externalApps. Returned via OnLADeviceSuccessType.
PushToStartToken — Token used to start a Live Activity via push (iOS 17.2+).
| Property | Type | Description |
|---|---|---|
token | string | The push-to-start token string |
iosAttributesType | string | null | iOS attributes type associated with the Live Activity |
liveActivityExternalId | string | null | External identifier of the associated Live Activity |
Topic
Package: indigitall-react-native-plugin · File: src/models/modelType.tsx
Represents a segmentation topic in the Indigitall platform. Used to group devices for targeted push and Live Activity campaigns. Returned via OnTopicSuccessType.
| Property | Type | Required | Description |
|---|---|---|---|
code | string | Yes | Unique code identifier for the topic |
name | string | Yes | Human-readable display name of the topic |
parentCode | string | No | Code of the parent topic, enabling hierarchical topic structures |
visible | boolean | Yes | Whether the topic is visible and available for subscription in the app UI |
subscribed | boolean | Yes | Whether the current device is subscribed to this topic |