Descriptive reference of the main models used across SDK modules.
Table of Contents
Push
Module: push · Package: com.indigitall.android.push.models · File: Push.kt · Extends: CorePush
Represents a push notification received from the Indigitall platform. Contains all the data needed to display and handle a notification.
| Property | Type | Required | Description |
|---|---|---|---|
id | Int | No | Internal push notification identifier |
appKey | String | Yes | Application key used to identify the app in the Indigitall platform |
title | String | No | Title of the push notification displayed to the user |
body | String | No | Main text body of the push notification |
icon | String | No | URL of the icon image to display in the notification |
image | String | No | URL of the large image to display in the expanded notification |
gif | ArrayList<String> | No | List of URLs for GIF frames to display in the notification |
layout | Layout (enum) | No | Display layout of the notification. Values: layout_native, half_width, full_width, custom. Default: layout_native |
data | String | No | Custom payload string to pass arbitrary data to the app when the notification is handled |
silent | Boolean | No | If true, the notification is delivered silently without showing any UI. Default: false |
securedData | String | No | Decrypted secured payload attached to the notification. Populated automatically from securedData/securedKey fields |
isDisposable | Boolean | No | If true, the notification will be dismissed after being displayed. Default: true |
sendingId | String | No | Identifier of the sending campaign instance |
campaignId | String | No | Identifier of the campaign this push belongs to |
pushId | Int | No | Identifier of the push template |
journeyStateId | Int | No | Identifier of the journey state associated with this push |
journeyExecution | Int | No | Journey execution counter |
cjCurrentStateId | Int | No | Current state ID in the customer journey |
sendEventAck | Boolean | No | If true, an acknowledgement event should be sent back to the server upon reception. Default: false |
applicationId | Int | No | Indigitall application identifier |
action | PushAction | No | Action to execute when the user taps the notification |
buttons | ArrayList<PushButton> | No | List of action buttons displayed in the expanded notification |
Related models
PushAction — Defines the action executed when a push notification (or button) is tapped. Extends CoreAction.
| Property | Type | Description |
|---|---|---|
type | Type (enum) | Type of action to perform. Values: app, url, webview, call, market, share, no_action, wallet |
url | String | URL to open when type is url or webview |
app | String | Deep-link or activity class name to open when type is app |
call | String | Phone number to dial when type is call |
market | String | Market URL or package name to open when type is market |
share | String | Text content to share when type is share |
wallet | String | Wallet pass URL when type is wallet |
topics | Array<String> | Topic codes to subscribe/unsubscribe when the action is executed |
clickedButton | Int | Index of the button clicked (-1 if the notification body was tapped). Default: -1 |
PushButton — Represents an action button displayed in an expanded push notification. Extends CorePushButton.
| Property | Type | Description |
|---|---|---|
label | String | Text label displayed on the button |
action | PushAction | Action to execute when the button is tapped |
topics | Array<String> | Topic codes associated with the button action |
Device
Module: push · Package: com.indigitall.android.push.models · File: Device.kt · Extends: CoreDevice
Represents the Android device registered in the Indigitall platform. Contains hardware, OS, app and push token information used for device registration and targeting.
| Property | Type | Description |
|---|---|---|
deviceId | String | Unique device identifier assigned by Indigitall |
pushToken | String | Firebase Cloud Messaging (FCM) token used to send push notifications to this device |
enabled | Boolean | Whether the device has push notifications enabled. Default: false |
platform | String | Platform identifier. Values: android, harmony |
version | String | Indigitall SDK version name |
productName | String | Name of the product/app as configured in Indigitall |
productVersion | String | Version of the product/app as configured in Indigitall |
osName | String | Operating system name. Always "Android" |
osVersion | String | Android OS version including SDK level (e.g. "13 (SDK:33)") |
deviceBrand | String | Device manufacturer brand in uppercase (e.g. "SAMSUNG") |
deviceModel | String | Device model name in uppercase (e.g. "SM-G991B") |
operator | String | Mobile network operator name. Default: "unknown" |
deviceType | String | Form factor of the device. Values: mobile, tablet |
appVersion | String | Version name of the host application |
locale | String | Device locale string (e.g. "es_ES") |
timeZone | String | Device time zone ID (e.g. "Europe/Madrid") |
timeOffset | Int | UTC offset of the device time zone in minutes |
externalCode | String | HMAC-SHA256 hashed external user identifier used to link the device to a user in external systems |
externalApps | Array<ExternalApp> | List of external apps linked to this device |
Related models
ExternalApp — Represents an external application associated with the device.
| Property | Type | Description |
|---|---|---|
id | Int | Unique identifier of the external application |
name | String | Display name of the external application |
androidCode | String | Android package name or code of the external application |
DeviceStatus — Integer annotation defining the device enabled/disabled status.
| Constant | Value | Description |
|---|---|---|
STATUS_DEFAULT | -1 | No status change requested |
STATUS_ENABLE | 1 | Device notifications enabled |
STATUS_DISABLE | 0 | Device notifications disabled |
Customer
Module: customer · Package: com.indigitall.android.customer.models · File: Customer.kt
Represents a customer/user profile registered in the Indigitall platform. Used to link a device to a specific user identity.
| Property | Type | Description |
|---|---|---|
id | String | Internal Indigitall identifier for the customer record |
customerId | String | External user identifier provided by the host application (e.g. user ID from your backend) |
applicationId | String | Indigitall application identifier associated with this customer |
createdAt | String | ISO 8601 timestamp of when the customer record was created |
updatedAt | String | ISO 8601 timestamp of the last update to the customer record |
Related model
CustomerField — Represents a single custom attribute key-value pair for a customer profile.
| Property | Type | Description |
|---|---|---|
customerFieldKey | String | Name/key of the custom attribute |
customerFieldValue | String | Value of the custom attribute |
InboxNotification
Module: inbox · Package: com.indigitall.android.inbox.models · File: InboxNotification.kt
Represents a single notification entry stored in the user's inbox. Contains the notification content, metadata, category and read status.
| Property | Type | Description |
|---|---|---|
id | String | Unique identifier of the inbox notification entry. Default: "" |
sentAt | String? | ISO 8601 timestamp of when the notification was sent; may be null |
status | String? | Current interaction status. Values: sent, click, deleted; may be null |
sendingId | Int | Identifier of the sending instance |
campaignId | Int | Identifier of the campaign this notification belongs to |
message | InboxPush? | Push notification content associated with this inbox entry; may be null |
category | InboxCategory? | Category this notification belongs to; may be null |
read | Boolean | true if the notification was sent before the user's last inbox access (considered read). Default: false |
Related models
InboxPush — Push notification content stored in the inbox. Extends CorePush, inheriting all base push fields (id, appKey, title, body, icon, image, gif, layout, data, silent, securedData, isDisposable, sendingId, campaignId, pushId, journeyStateId, journeyExecution, cjCurrentStateId, sendEventAck, applicationId), plus:
| Property | Type | Description |
|---|---|---|
action | InboxPushAction? | Action to execute when the notification is tapped (same structure as PushAction); may be null |
buttons | ArrayList<InboxPushButton>? | Action buttons for the inbox notification entry (same structure as PushButton); may be null |
InboxCategory — Category used to group and filter inbox notifications.
| Property | Type | Description |
|---|---|---|
id | Int? | Unique identifier of the category; may be null |
code | String? | Alphanumeric code of the category; may be null |
name | String? | Display name of the category; may be null |
InboxStatus — Enum representing the interaction status of an inbox notification.
| Value | Description |
|---|---|
SENT | Notification was sent but not yet interacted with |
CLICK | Notification was clicked/opened by the user |
DELETED | Notification was deleted by the user |
InApp
Module: inapp · Package: com.indigitall.android.inapp.models · File: InApp.java
Represents an in-app message served by the Indigitall platform. Contains display configuration, filtering rules, schema layout and custom data.
| Property | Type | Description |
|---|---|---|
inAppId | Int | Unique identifier of the in-app message |
lastVersionId | Int | Identifier of the last active version of this in-app message |
version | Int | Version number of the in-app message content |
inAppVersion | Int | Version of the in-app message (falls back to version if not explicitly set) |
name | String | Display name or identifier of the in-app message |
showOnce | Boolean | (Deprecated) If true, the message is shown only once per user. Use InAppShow configuration instead |
creationDate | String | ISO 8601 timestamp of when the in-app message was created |
expiredDate | String | ISO 8601 timestamp of when the in-app message expires and should no longer be shown |
cacheTtl | String | Time-to-live for caching the in-app content on the device |
silent | Boolean | If true, the in-app is processed silently without displaying any UI. Default: false |
profile | String | User profile segment identifier associated with this in-app message |
properties | InAppProperties | Visual and behavioral properties of the in-app message (colors, position, size, etc.) |
schema | InAppSchema | Layout schema definition of the in-app message content |
inAppShow | InAppShow | Configuration controlling when and how often the in-app message is displayed |
filters | InAppFilters | Targeting filters determining which users or sessions should see this in-app message |
customData | HashMap<String, String> | Free-form key-value map with custom data attached to the in-app message |
LiveActivity
Module: liveactivity · Package: com.indigitall.android.liveactivity.models · File: LiveActivity.kt
Represents a Live Activity session registered in the Indigitall platform. On Android, Live Activities are implemented via dynamic FCM topics to enable real-time push updates.
| Property | Type | Description |
|---|---|---|
liveActivityId | String | Unique identifier of the Live Activity record in Indigitall |
liveActivityExternalId | String | External identifier provided by the host application to identify the Live Activity session |
applicationId | Int | Indigitall application identifier this Live Activity belongs to |
androidTopicId | String | FCM topic ID used to deliver real-time updates to this Live Activity on Android |
status | String | Current status of the Live Activity session (e.g. active, ended) |
createdAt | String | ISO 8601 timestamp of when the Live Activity was registered |
updatedAt | String | ISO 8601 timestamp of the last update to the Live Activity record |
Topic
Module: push · Package: com.indigitall.android.push.models · File: Topic.java · Extends: CoreTopic
Represents a push notification topic (category) that a device can subscribe to or unsubscribe from. Used to segment users by areas of interest.
| Property | Type | Required | Description |
|---|---|---|---|
code | String | Yes | Unique alphanumeric code identifying the topic |
name | String | No | Human-readable display name of the topic |
visible | Boolean | No | If true, the topic is shown in the topic preference UI to the user. Default: false |
subscribed | Boolean | No | Whether the current device is subscribed to this topic. Default: false |
parentCode | String | No | Code of the parent topic, used to build hierarchical topic trees |
channel | Channel (enum) | No | Channel this topic belongs to. Values: PUSH. Default: PUSH |
Error Codes
The SDK reports errors through operation callbacks and logs, depending on the operation. Each entry below lists its numeric identifier, the default human-readable message, and the situation in which it is used. A runtime description may provide additional server, provider, or exception details.
The catalogs are grouped by SDK area. Common API status entries are identified separately because they represent HTTP/API outcomes rather than locally generated SDK errors. An entry marked as catalogued without an active production use is available in the catalog, but is not currently emitted by a production path identified in this reference.
Common SDK and API errors
| ID | Code | Default message | When it is used |
|---|---|---|---|
| 600 | GENERAL_ERROR | general error | Generic SDK failure used by shared request/response handling and as a general error in some module operations. |
| 601 | DEVICE_FIELD_MISSING | PUT /device: Response deviceID field is missing | Device update response is missing its device identifier; also available when mapping a matching API status. |
| 602 | DEVICE_NOT_REGISTERED | Device is not registered yet | An operation requires a registered device but no device is available. |
| 603 | DEVICE_ID_FIELD_MISSING | POST /device: Response deviceID field is missing | Device creation response is missing its device identifier; also available when mapping a matching API status. |
| 604 | APPKEY_BAD_REQUEST | AppKey null or empty | A request cannot proceed because the application key is missing or empty. |
| 605 | CALL_TIME_OUT | connection timeout | A network request times out. |
| 606 | UNKNOWN_ERROR | Unknown error | A shared API call fails for an unclassified reason or an unrecognized common error identifier is received. |
| 500 | API_SERVER_ERROR | server error | API/server status indicating an internal server error. This is a response status, not a local SDK-generated error. |
| 401 | API_APPKEY_NOT_VALID | appKey not valid | API status indicating invalid application credentials. Inbox authentication may refresh credentials and retry on this status. |
| 403 | API_FORBIDDEN_REQUEST | forbidden request | API status indicating that the request is not permitted. |
| 404 | API_NOT_FOUND | not found | API status indicating that the requested resource was not found. |
| 409 | API_TOPICS_ARE_INSERTED | topics are inserted | API status indicating that topics have already been inserted. |
| 4800 | BAD_REQUEST_SERVER_ERROR | not subscribe to topic | Used for invalid customer-linking input, such as a missing external identifier or application key. The current default message is affected by the positional mapping noted below. |
| 4801 | IN_APP_NOT_ENABLED | bad request server error | In-App configuration indicates that the feature is not enabled. The current default message is affected by the positional mapping noted below. |
| 4404 | DISABLED_CHANNEL | InApp is not enabled on V2 in this project | A requested channel is disabled, including attempts to link a customer with no enabled channel. The current default message is affected by the positional mapping noted below. |
| 4803 | INAPP_AUDIENCES_BAD_REQUEST | Audience bad request | An audience request cannot be made because it has neither a valid device identifier nor an external identifier. |
| 304 | INAPP_AUDIENCE_NO_CHANGE | Audience no changes | In-App audience endpoint reports that there are no changes. This is handled as a successful no-change response, not as a failure. |
Push errors
| ID | Code | Default message | When it is used |
|---|---|---|---|
| 1000 | PUSH_INITIALIZATION_ERROR | initialization error | Push initialization fails, for example because push is unavailable or a required provider integration cannot be initialized. |
| 1200 | PUSH_RECEPTION_ERROR | reception push error | An exception occurs while receiving or rendering a push, including notification, image, intent, or GIF processing. This identifier is commonly used in logs. |
| 1400 | PUSH_TOPICS_ERROR | topics error | An exception occurs while handling topic data or subscribing to or unsubscribing from topics. |
| 1500 | PUSH_DEVICE_ERROR | device error | An exception occurs during device login/logout or custom-event handling. |
| 1600 | PUSH_EVENT_ERROR | event error | Catalogued; no active production emission is currently identified. |
| 1700 | PUSH_TOKEN_ERROR | token error | An unexpected exception occurs while obtaining an FCM token. |
| 1701 | PUSH_FCM_REGISTRATION | Fetching FCM registration token failed | FCM token registration fails. |
| 1702 | PUSH_FCM_GET_INSTANCE | get Instance token error | The provider instance or token cannot be obtained. |
| 1704 | PUSH_BAD_REQUEST | AppKey or deviceId null or empty | Catalogued; no active production emission is currently identified. Push request validation may instead report the common APPKEY_BAD_REQUEST error. |
| 4404 | PUSH_DISABLED_CHANNEL | Channel disabled | Push is disabled for the application when push initialization or login is attempted. |
| 1802 | PUSH_EXTERNAL_APPS | Push notifications permissions are declined | Catalogued; no active production emission is currently identified. |
In-App errors
| ID | Code | Default message | When it is used |
|---|---|---|---|
| 2000 | INAPP_ERROR | inApp error | General In-App operation failure, including errors reported by topic or device-related operations. |
| 2002 | INAPP_NOT_APPKEY | AppKey was not configurated | Catalogued; no active production emission is currently identified. |
| 2003 | INAPP_CONTENT_MESSAGE | InApp error with content | Describes an In-App content-processing error; the message is used in logging, but no numeric production emission is currently identified. |
| 2004 | INAPP_TOPIC_EMPTY | There is no inApp topic subscription | Catalogued; no active production emission is currently identified. |
| 2005 | INAPP_TOPIC_LIST_NO_MORE_PAGES | No more pages for inApp topics | The In-App topic list has no further page. |
| 2403 | INAPP_CAMPAIGN_NOT_EXIST | Campaign doesn't exist with the code | A campaign lookup returns no matching campaign. |
| 2100 | INAPP_SHOW_INAPP_ERROR | show inApp error | Catalogued; no active production emission is currently identified. |
| 2200 | INAPP_POPUP_ERROR | popup error | Catalogued; no active production emission is currently identified. |
| 2300 | INAPP_SHOW_POPUP_ERROR | show popup error | Catalogued; no active production emission is currently identified. |
| 2101 | INAPP_WAS_EXPIRED | InApp cache has timed out | Cached In-App content has expired. |
| 2102 | INAPP_WAS_SHOWN_MANY_TIMES | InApp was shown many times | The In-App display limit has been reached. |
| 2103 | INAPP_WAS_CLICKED_MANY_TIMES | InApp was clicked many times | The In-App click limit has been reached. |
| 2120 | INAPP_FORM_TYPE_NOT_CORRECT | Input type is not correct | A required form value has an unsupported type or cannot be parsed as the expected type. |
| 2121 | INAPP_FORM_FIELD_IS_EMPTY | Field is empty | A required In-App form field is absent or empty. |
| 2301 | POPUP_WAS_EXPIRED | Popup cache has timed out | Catalogued; no active production emission is currently identified. |
| 2302 | POPUP_WAS_SHOWN_MANY_TIMES | Popup was shown many times | The popup display limit has been reached. |
| 2303 | POPUP_WAS_CLICKED_MANY_TIMES | Popup was clicked many times | The popup click limit has been reached. |
| 2304 | POPUP_DISMISSED_FOREVER | Popup was dismissed forever | The popup's dismiss-forever condition has been met. |
Inbox errors
| ID | Code | Default message | When it is used |
|---|---|---|---|
| 3001 | INBOX_GET_ERROR | get Inbox error | Catalogued; no active production emission is currently identified. |
| 3003 | INBOX_EXTERNAL_ID_NO_REGISTERED | External Id not registered | The external user identifier required for an Inbox operation is missing or invalid. |
| 3006 | INBOX_IS_REQUESTING_PAGE | Wait. Is Requesting new page | Another page request is already in progress. The condition is logged; the numeric ID is not currently returned by that path. |
| 3011 | INBOX_GET_PAGE_ERROR | There are no more messages on Inbox | The Inbox has no messages to return or there is no next page. |
| 3600 | INBOX_GENERAL_ERROR | inbox general error | An exception occurs during Inbox authentication, retrieval, paging, editing, counters, or notification operations. |
| 3604 | INBOX_BAD_REQUEST | AppKey or deviceId null or empty | An Inbox request is invalid because the application key or device identifier is missing or empty. |
Customer errors
| ID | Code | Default message | When it is used |
|---|---|---|---|
| 4600 | CUSTOMER_GENERAL_ERROR | customer general error | General customer error catalog entry; no direct production emission is currently identified. |
| 4601 | CUSTOMER_NO_EXTERNAL_CODE | no external code | Customer external-code error catalog entry; no direct production emission is currently identified. Customer request validation currently uses the common BAD_REQUEST_SERVER_ERROR identifier. |
Live Activity errors
| ID | Code | Default message | When it is used |
|---|---|---|---|
| 5000 | LA_ERROR | Live activity error | Generic Live Activity error catalog entry; no direct production emission is currently identified. Current Live Activity failures use the common GENERAL_ERROR identifier. |
HMS errors
| ID | Code | Default message | When it is used |
|---|---|---|---|
| 1000 | PUSH_INITIALIZATION_ERROR | initialization error | Catalogued; no active production emission is currently identified. |
| 1200 | PUSH_RECEPTION_ERROR | reception push error | An exception occurs while displaying or processing a push, image, or GIF. This identifier is commonly used in logs. |
| 1400 | PUSH_TOPICS_ERROR | topics error | Catalogued; no active production emission is currently identified. |
| 1500 | PUSH_DEVICE_ERROR | device error | Catalogued; no active production emission is currently identified. |
| 1600 | PUSH_EVENT_ERROR | event error | Catalogued; no active production emission is currently identified. |
| 1700 | PUSH_TOKEN_ERROR | token error | Catalogued; no active production emission is currently identified. |
| 1701 | PUSH_FCM_REGISTRATION | Fetching FCM registration token failed | The HMS provider instance or application ID is missing during token registration. |
| 1702 | PUSH_FCM_GET_INSTANCE | get Instance token error | The HMS context is missing or an exception occurs while retrieving a token. |
| 1704 | PUSH_BAD_REQUEST | AppKey or deviceId null or empty | Catalogued; no active production emission is currently identified. |
Error catalog notes
- The common SDK messages are currently paired with common error IDs by their position in the catalog. As a result, IDs 4800, 4801, and 4404 resolve to the messages shown in the table, which do not match the wording implied by their code names. The other module catalogs also pair IDs and messages by position; for In-App, ID 2005 is named
INAPP_TOPIC_LIST_NO_MORE_PAGESwhile its paired message entry is namedINAPP_TOPIC_NO_MORE_PAGES. - The common IDs 500, 401, 403, 404, 409, and 304 represent API response statuses. In particular, 304 is a successful “no audience changes” result. The SDK-specific IDs are not necessarily HTTP status codes.
- Callback errors may include a separate diagnostic description in addition to the default message. The description can contain server/provider response details or exception context.
- The error-message catalogs contain default human-readable strings; they are not additional numeric error IDs.
Relationships
Push
├── PushAction (extends CoreAction)
│ └── Type {app, url, webview, call, market, share, no_action, wallet}
└── PushButton[] (extends CorePushButton)
└── PushAction
Device (extends CoreDevice)
├── ExternalApp[]
└── DeviceStatus {STATUS_DEFAULT=-1, STATUS_ENABLE=1, STATUS_DISABLE=0}
InApp
├── InAppProperties
├── InAppSchema
├── InAppShow
└── InAppFilters
InboxNotification
├── InboxPush (extends CorePush)
│ ├── InboxPushAction
│ └── InboxPushButton[]
├── InboxCategory
└── InboxStatus {SENT, CLICK, DELETED}
Customer
└── CustomerField
LiveActivity
Topic (extends CoreTopic)
└── Channel {PUSH}
SDK Modules
| Model | Module | Package |
|---|---|---|
Push, Device, Topic | push | com.indigitall.android.push.models |
InApp | inapp | com.indigitall.android.inapp.models |
InboxNotification | inbox | com.indigitall.android.inbox.models |
Customer | customer | com.indigitall.android.customer.models |
LiveActivity | liveactivity | com.indigitall.android.liveactivity.models |
