Model Reference

Descriptive reference of the main models used across SDK modules.


Table of Contents

  1. Push
  2. Device
  3. Customer
  4. InboxNotification
  5. InApp
  6. LiveActivity
  7. Topic
  8. Error Codes

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.

PropertyTypeRequiredDescription
idIntNoInternal push notification identifier
appKeyStringYesApplication key used to identify the app in the Indigitall platform
titleStringNoTitle of the push notification displayed to the user
bodyStringNoMain text body of the push notification
iconStringNoURL of the icon image to display in the notification
imageStringNoURL of the large image to display in the expanded notification
gifArrayList<String>NoList of URLs for GIF frames to display in the notification
layoutLayout (enum)NoDisplay layout of the notification. Values: layout_native, half_width, full_width, custom. Default: layout_native
dataStringNoCustom payload string to pass arbitrary data to the app when the notification is handled
silentBooleanNoIf true, the notification is delivered silently without showing any UI. Default: false
securedDataStringNoDecrypted secured payload attached to the notification. Populated automatically from securedData/securedKey fields
isDisposableBooleanNoIf true, the notification will be dismissed after being displayed. Default: true
sendingIdStringNoIdentifier of the sending campaign instance
campaignIdStringNoIdentifier of the campaign this push belongs to
pushIdIntNoIdentifier of the push template
journeyStateIdIntNoIdentifier of the journey state associated with this push
journeyExecutionIntNoJourney execution counter
cjCurrentStateIdIntNoCurrent state ID in the customer journey
sendEventAckBooleanNoIf true, an acknowledgement event should be sent back to the server upon reception. Default: false
applicationIdIntNoIndigitall application identifier
actionPushActionNoAction to execute when the user taps the notification
buttonsArrayList<PushButton>NoList 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.

PropertyTypeDescription
typeType (enum)Type of action to perform. Values: app, url, webview, call, market, share, no_action, wallet
urlStringURL to open when type is url or webview
appStringDeep-link or activity class name to open when type is app
callStringPhone number to dial when type is call
marketStringMarket URL or package name to open when type is market
shareStringText content to share when type is share
walletStringWallet pass URL when type is wallet
topicsArray<String>Topic codes to subscribe/unsubscribe when the action is executed
clickedButtonIntIndex 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.

PropertyTypeDescription
labelStringText label displayed on the button
actionPushActionAction to execute when the button is tapped
topicsArray<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.

PropertyTypeDescription
deviceIdStringUnique device identifier assigned by Indigitall
pushTokenStringFirebase Cloud Messaging (FCM) token used to send push notifications to this device
enabledBooleanWhether the device has push notifications enabled. Default: false
platformStringPlatform identifier. Values: android, harmony
versionStringIndigitall SDK version name
productNameStringName of the product/app as configured in Indigitall
productVersionStringVersion of the product/app as configured in Indigitall
osNameStringOperating system name. Always "Android"
osVersionStringAndroid OS version including SDK level (e.g. "13 (SDK:33)")
deviceBrandStringDevice manufacturer brand in uppercase (e.g. "SAMSUNG")
deviceModelStringDevice model name in uppercase (e.g. "SM-G991B")
operatorStringMobile network operator name. Default: "unknown"
deviceTypeStringForm factor of the device. Values: mobile, tablet
appVersionStringVersion name of the host application
localeStringDevice locale string (e.g. "es_ES")
timeZoneStringDevice time zone ID (e.g. "Europe/Madrid")
timeOffsetIntUTC offset of the device time zone in minutes
externalCodeStringHMAC-SHA256 hashed external user identifier used to link the device to a user in external systems
externalAppsArray<ExternalApp>List of external apps linked to this device

Related models

ExternalApp — Represents an external application associated with the device.

PropertyTypeDescription
idIntUnique identifier of the external application
nameStringDisplay name of the external application
androidCodeStringAndroid package name or code of the external application

DeviceStatus — Integer annotation defining the device enabled/disabled status.

ConstantValueDescription
STATUS_DEFAULT-1No status change requested
STATUS_ENABLE1Device notifications enabled
STATUS_DISABLE0Device 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.

PropertyTypeDescription
idStringInternal Indigitall identifier for the customer record
customerIdStringExternal user identifier provided by the host application (e.g. user ID from your backend)
applicationIdStringIndigitall application identifier associated with this customer
createdAtStringISO 8601 timestamp of when the customer record was created
updatedAtStringISO 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.

PropertyTypeDescription
customerFieldKeyStringName/key of the custom attribute
customerFieldValueStringValue 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.

PropertyTypeDescription
idStringUnique identifier of the inbox notification entry. Default: ""
sentAtString?ISO 8601 timestamp of when the notification was sent; may be null
statusString?Current interaction status. Values: sent, click, deleted; may be null
sendingIdIntIdentifier of the sending instance
campaignIdIntIdentifier of the campaign this notification belongs to
messageInboxPush?Push notification content associated with this inbox entry; may be null
categoryInboxCategory?Category this notification belongs to; may be null
readBooleantrue 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:

PropertyTypeDescription
actionInboxPushAction?Action to execute when the notification is tapped (same structure as PushAction); may be null
buttonsArrayList<InboxPushButton>?Action buttons for the inbox notification entry (same structure as PushButton); may be null

InboxCategory — Category used to group and filter inbox notifications.

PropertyTypeDescription
idInt?Unique identifier of the category; may be null
codeString?Alphanumeric code of the category; may be null
nameString?Display name of the category; may be null

InboxStatus — Enum representing the interaction status of an inbox notification.

ValueDescription
SENTNotification was sent but not yet interacted with
CLICKNotification was clicked/opened by the user
DELETEDNotification 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.

PropertyTypeDescription
inAppIdIntUnique identifier of the in-app message
lastVersionIdIntIdentifier of the last active version of this in-app message
versionIntVersion number of the in-app message content
inAppVersionIntVersion of the in-app message (falls back to version if not explicitly set)
nameStringDisplay name or identifier of the in-app message
showOnceBoolean(Deprecated) If true, the message is shown only once per user. Use InAppShow configuration instead
creationDateStringISO 8601 timestamp of when the in-app message was created
expiredDateStringISO 8601 timestamp of when the in-app message expires and should no longer be shown
cacheTtlStringTime-to-live for caching the in-app content on the device
silentBooleanIf true, the in-app is processed silently without displaying any UI. Default: false
profileStringUser profile segment identifier associated with this in-app message
propertiesInAppPropertiesVisual and behavioral properties of the in-app message (colors, position, size, etc.)
schemaInAppSchemaLayout schema definition of the in-app message content
inAppShowInAppShowConfiguration controlling when and how often the in-app message is displayed
filtersInAppFiltersTargeting filters determining which users or sessions should see this in-app message
customDataHashMap<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.

PropertyTypeDescription
liveActivityIdStringUnique identifier of the Live Activity record in Indigitall
liveActivityExternalIdStringExternal identifier provided by the host application to identify the Live Activity session
applicationIdIntIndigitall application identifier this Live Activity belongs to
androidTopicIdStringFCM topic ID used to deliver real-time updates to this Live Activity on Android
statusStringCurrent status of the Live Activity session (e.g. active, ended)
createdAtStringISO 8601 timestamp of when the Live Activity was registered
updatedAtStringISO 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.

PropertyTypeRequiredDescription
codeStringYesUnique alphanumeric code identifying the topic
nameStringNoHuman-readable display name of the topic
visibleBooleanNoIf true, the topic is shown in the topic preference UI to the user. Default: false
subscribedBooleanNoWhether the current device is subscribed to this topic. Default: false
parentCodeStringNoCode of the parent topic, used to build hierarchical topic trees
channelChannel (enum)NoChannel 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

IDCodeDefault messageWhen it is used
600GENERAL_ERRORgeneral errorGeneric SDK failure used by shared request/response handling and as a general error in some module operations.
601DEVICE_FIELD_MISSINGPUT /device: Response deviceID field is missingDevice update response is missing its device identifier; also available when mapping a matching API status.
602DEVICE_NOT_REGISTEREDDevice is not registered yetAn operation requires a registered device but no device is available.
603DEVICE_ID_FIELD_MISSINGPOST /device: Response deviceID field is missingDevice creation response is missing its device identifier; also available when mapping a matching API status.
604APPKEY_BAD_REQUESTAppKey null or emptyA request cannot proceed because the application key is missing or empty.
605CALL_TIME_OUTconnection timeoutA network request times out.
606UNKNOWN_ERRORUnknown errorA shared API call fails for an unclassified reason or an unrecognized common error identifier is received.
500API_SERVER_ERRORserver errorAPI/server status indicating an internal server error. This is a response status, not a local SDK-generated error.
401API_APPKEY_NOT_VALIDappKey not validAPI status indicating invalid application credentials. Inbox authentication may refresh credentials and retry on this status.
403API_FORBIDDEN_REQUESTforbidden requestAPI status indicating that the request is not permitted.
404API_NOT_FOUNDnot foundAPI status indicating that the requested resource was not found.
409API_TOPICS_ARE_INSERTEDtopics are insertedAPI status indicating that topics have already been inserted.
4800BAD_REQUEST_SERVER_ERRORnot subscribe to topicUsed 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.
4801IN_APP_NOT_ENABLEDbad request server errorIn-App configuration indicates that the feature is not enabled. The current default message is affected by the positional mapping noted below.
4404DISABLED_CHANNELInApp is not enabled on V2 in this projectA 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.
4803INAPP_AUDIENCES_BAD_REQUESTAudience bad requestAn audience request cannot be made because it has neither a valid device identifier nor an external identifier.
304INAPP_AUDIENCE_NO_CHANGEAudience no changesIn-App audience endpoint reports that there are no changes. This is handled as a successful no-change response, not as a failure.

Push errors

IDCodeDefault messageWhen it is used
1000PUSH_INITIALIZATION_ERRORinitialization errorPush initialization fails, for example because push is unavailable or a required provider integration cannot be initialized.
1200PUSH_RECEPTION_ERRORreception push errorAn exception occurs while receiving or rendering a push, including notification, image, intent, or GIF processing. This identifier is commonly used in logs.
1400PUSH_TOPICS_ERRORtopics errorAn exception occurs while handling topic data or subscribing to or unsubscribing from topics.
1500PUSH_DEVICE_ERRORdevice errorAn exception occurs during device login/logout or custom-event handling.
1600PUSH_EVENT_ERRORevent errorCatalogued; no active production emission is currently identified.
1700PUSH_TOKEN_ERRORtoken errorAn unexpected exception occurs while obtaining an FCM token.
1701PUSH_FCM_REGISTRATIONFetching FCM registration token failedFCM token registration fails.
1702PUSH_FCM_GET_INSTANCEget Instance token errorThe provider instance or token cannot be obtained.
1704PUSH_BAD_REQUESTAppKey or deviceId null or emptyCatalogued; no active production emission is currently identified. Push request validation may instead report the common APPKEY_BAD_REQUEST error.
4404PUSH_DISABLED_CHANNELChannel disabledPush is disabled for the application when push initialization or login is attempted.
1802PUSH_EXTERNAL_APPSPush notifications permissions are declinedCatalogued; no active production emission is currently identified.

In-App errors

IDCodeDefault messageWhen it is used
2000INAPP_ERRORinApp errorGeneral In-App operation failure, including errors reported by topic or device-related operations.
2002INAPP_NOT_APPKEYAppKey was not configuratedCatalogued; no active production emission is currently identified.
2003INAPP_CONTENT_MESSAGEInApp error with contentDescribes an In-App content-processing error; the message is used in logging, but no numeric production emission is currently identified.
2004INAPP_TOPIC_EMPTYThere is no inApp topic subscriptionCatalogued; no active production emission is currently identified.
2005INAPP_TOPIC_LIST_NO_MORE_PAGESNo more pages for inApp topicsThe In-App topic list has no further page.
2403INAPP_CAMPAIGN_NOT_EXISTCampaign doesn't exist with the codeA campaign lookup returns no matching campaign.
2100INAPP_SHOW_INAPP_ERRORshow inApp errorCatalogued; no active production emission is currently identified.
2200INAPP_POPUP_ERRORpopup errorCatalogued; no active production emission is currently identified.
2300INAPP_SHOW_POPUP_ERRORshow popup errorCatalogued; no active production emission is currently identified.
2101INAPP_WAS_EXPIREDInApp cache has timed outCached In-App content has expired.
2102INAPP_WAS_SHOWN_MANY_TIMESInApp was shown many timesThe In-App display limit has been reached.
2103INAPP_WAS_CLICKED_MANY_TIMESInApp was clicked many timesThe In-App click limit has been reached.
2120INAPP_FORM_TYPE_NOT_CORRECTInput type is not correctA required form value has an unsupported type or cannot be parsed as the expected type.
2121INAPP_FORM_FIELD_IS_EMPTYField is emptyA required In-App form field is absent or empty.
2301POPUP_WAS_EXPIREDPopup cache has timed outCatalogued; no active production emission is currently identified.
2302POPUP_WAS_SHOWN_MANY_TIMESPopup was shown many timesThe popup display limit has been reached.
2303POPUP_WAS_CLICKED_MANY_TIMESPopup was clicked many timesThe popup click limit has been reached.
2304POPUP_DISMISSED_FOREVERPopup was dismissed foreverThe popup's dismiss-forever condition has been met.

Inbox errors

IDCodeDefault messageWhen it is used
3001INBOX_GET_ERRORget Inbox errorCatalogued; no active production emission is currently identified.
3003INBOX_EXTERNAL_ID_NO_REGISTEREDExternal Id not registeredThe external user identifier required for an Inbox operation is missing or invalid.
3006INBOX_IS_REQUESTING_PAGEWait. Is Requesting new pageAnother page request is already in progress. The condition is logged; the numeric ID is not currently returned by that path.
3011INBOX_GET_PAGE_ERRORThere are no more messages on InboxThe Inbox has no messages to return or there is no next page.
3600INBOX_GENERAL_ERRORinbox general errorAn exception occurs during Inbox authentication, retrieval, paging, editing, counters, or notification operations.
3604INBOX_BAD_REQUESTAppKey or deviceId null or emptyAn Inbox request is invalid because the application key or device identifier is missing or empty.

Customer errors

IDCodeDefault messageWhen it is used
4600CUSTOMER_GENERAL_ERRORcustomer general errorGeneral customer error catalog entry; no direct production emission is currently identified.
4601CUSTOMER_NO_EXTERNAL_CODEno external codeCustomer 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

IDCodeDefault messageWhen it is used
5000LA_ERRORLive activity errorGeneric Live Activity error catalog entry; no direct production emission is currently identified. Current Live Activity failures use the common GENERAL_ERROR identifier.

HMS errors

IDCodeDefault messageWhen it is used
1000PUSH_INITIALIZATION_ERRORinitialization errorCatalogued; no active production emission is currently identified.
1200PUSH_RECEPTION_ERRORreception push errorAn exception occurs while displaying or processing a push, image, or GIF. This identifier is commonly used in logs.
1400PUSH_TOPICS_ERRORtopics errorCatalogued; no active production emission is currently identified.
1500PUSH_DEVICE_ERRORdevice errorCatalogued; no active production emission is currently identified.
1600PUSH_EVENT_ERRORevent errorCatalogued; no active production emission is currently identified.
1700PUSH_TOKEN_ERRORtoken errorCatalogued; no active production emission is currently identified.
1701PUSH_FCM_REGISTRATIONFetching FCM registration token failedThe HMS provider instance or application ID is missing during token registration.
1702PUSH_FCM_GET_INSTANCEget Instance token errorThe HMS context is missing or an exception occurs while retrieving a token.
1704PUSH_BAD_REQUESTAppKey or deviceId null or emptyCatalogued; 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_PAGES while its paired message entry is named INAPP_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

ModelModulePackage
Push, Device, Topicpushcom.indigitall.android.push.models
InAppinappcom.indigitall.android.inapp.models
InboxNotificationinboxcom.indigitall.android.inbox.models
Customercustomercom.indigitall.android.customer.models
LiveActivityliveactivitycom.indigitall.android.liveactivity.models