Descriptive reference of the main models used across SDK modules.
Table of Contents
INPush
File: push/src/models/INPush.h
Represents a push notification received or sent through the Indigitall platform.
| Property | Type | Description |
|---|---|---|
pushId | long | Indigitall internal identifier for the push notification |
appKey | NSString * | Public application identifier in Indigitall |
title | NSString * | Title of the push notification |
body | NSString * | Body/content of the push notification |
image | NSString * | URL of the image attached to the notification |
gif | NSString * | URL of the GIF attached to the notification |
data | NSString * | Extra information added from the Indigitall panel |
action | INPushAction * | Action executed when the user interacts with the notification |
buttons | NSArray<INPushButton *> * | Array of action buttons available in the notification |
securedData | NSString * | Encrypted/secured additional data |
sendingId | NSString * | Sending identifier |
campaignId | NSString * | Campaign identifier |
contentState | NSDictionary * | Content state as JSON (used for Live Activities) |
clickedButton | int | Index of the button or notification tapped by the user |
journeyStateId | int | Journey state identifier |
sendEventAck | BOOL | Whether the ACK event should be sent |
applicationId | int | Application identifier |
jsonPush | NSDictionary * | Full JSON representation of the push |
eventAt | NSString * | Date/time of the event |
Related models
INPushAction — Action associated with the push. Extends INCoreAction.
| Property | Type | Description |
|---|---|---|
type | ActionType | Action type: app, url, webview, call, market, share, noAction, wallet |
destroy | BOOL | Whether the action is destructive |
url | NSString * | URL value for url type actions |
webview | NSString * | URL value for webview type actions |
call | NSString * | Phone number for call type actions |
market | NSString * | App Store link for market type actions |
share | NSString * | Message to share for share type actions |
wallet | NSString * | Pass URL for wallet type actions |
topics | NSArray * | Topics the user will be subscribed to on action |
INPushButton — Action button within a push notification.
| Property | Type | Description |
|---|---|---|
label | NSString * | Button display text |
action | INPushAction * | Action triggered when the button is tapped |
topics | NSArray * | Topics associated with the button |
INDevice
File: push/src/models/INDevice.h
Extends: INCoreDevice
Represents the user's device registered in the Indigitall platform. Extends INCoreDevice with iOS-specific push token support.
Properties from INCoreDevice
INCoreDevice| Property | Type | Description |
|---|---|---|
deviceID | NSString * | Unique Indigitall device identifier |
externalCode | NSString * | External code assigned to the device |
platform | NSString * | Platform (e.g. iOS) |
osName | NSString * | Operating system name |
osVersion | NSString * | Operating system version |
deviceBrand | NSString * | Device brand |
deviceModel | NSString * | Device model |
deviceType | NSString * | Device type (mobile or tablet) |
appVersion | NSString * | Current application version |
sdkVersion | NSString * | SDK version |
locale | NSString * | Device preferred language |
timeZone | NSString * | Current time zone |
timeOffset | long | Time offset in hours |
carrier | NSString * | Mobile network carrier |
enabled | NSNumber * | Whether push notifications are enabled |
configEnabled | BOOL | Enabled configuration state |
externalApplications | NSArray<INCoreExternalApp *> * | Linked external applications |
productName | NSString * | Third-party product name (integrations) |
productVersion | NSString * | Third-party product version |
Own properties of INDevice
INDevice| Property | Type | Description |
|---|---|---|
pushToken | NSString * | Device APNs push notification token |
INInApp
File: inApp/src/models/INInApp.h
Represents an In-App message from the Indigitall platform.
| Property | Type | Description |
|---|---|---|
inAppId | int | Unique In-App identifier |
inAppWidth | int | In-App width in points |
inAppHeight | int | In-App height in points |
lastVersionId | int | Last version identifier |
code | NSString * | In-App code identifier |
name | NSString * | In-App name |
profile | NSString * | Associated profile (nullable) |
properties | INInAppProperties * | Visual and behavioral properties of the In-App |
showOnce | int | How many times it will be shown (0 = unlimited) |
expiredDate | NSString * | Expiration date |
creationDate | NSString * | Creation date |
cacheTtl | double | Cache time-to-live in seconds |
inAppShow | INInAppShow * | Display state of the In-App |
customData | NSDictionary * | Additional custom data |
version | int | Object version |
inAppVersion | int | In-App version |
filters | INInAppFilters * | Segmentation filters for the In-App |
Related models
INInAppProperties — Visual and display properties.
| Property | Type | Description |
|---|---|---|
InAppContentUrl | NSURL * | URL of the In-App content |
numberOfShows | int | Maximum number of times to display |
numberOfClicks | int | Number of clicks registered |
dismissForever | BOOL | Whether it is permanently dismissed after closing |
layout | INInAppLayout * | Layout configuration |
action | INInAppAction * | Action triggered on interaction |
showTime | int | Time the In-App is displayed (in seconds) |
INInAppShow — Display history for the In-App.
| Property | Type | Description |
|---|---|---|
timesShowed | int | Number of times the In-App has been shown |
timesClicked | int | Number of times the In-App has been clicked |
wasDismissed | BOOL | Whether the In-App was dismissed by the user |
INInAppFilters — Segmentation and targeting filters.
| Property | Type | Description |
|---|---|---|
platforms | NSArray * | Target platforms |
areas | NSArray<NSNumber *> * | Target geographic areas |
audience | NSDictionary * | Audience definition |
topics | INInAppFiltersTopic * | Topic-based filters |
externalApps | NSArray<INCoreExternalApp *> * | External app filters |
deviceCodes | NSArray * | Specific target device codes |
deviceCodesActive | BOOL | Whether device code filtering is active |
deviceTypes | NSArray * | Target device types |
browserTypes | NSArray * | Target browser types |
activePushDevices | BOOL | Whether to target only push-enabled devices |
INTopic
File: push/src/models/INTopic.h
Extends: INCoreTopic
Represents a topic (segment/category) that a device can subscribe to within the Indigitall platform.
| Property | Type | Description |
|---|---|---|
code | NSString * | Unique topic code identifier |
name | NSString * | Visible topic name |
parentCode | NSString * | Parent topic code (for hierarchies) |
visible | BOOL | Whether the topic is visible to the user |
subscribed | BOOL | Whether the device is subscribed to this topic |
channel | INChannel | Channel the topic belongs to |
INChannel enum
INChannel enum| Value | Description |
|---|---|
PUSH | Push notification channel |
INAPP | In-App message channel |
CHAT | Chat channel |
CHANNEL_NONE | No channel |
INInbox
File: inbox/src/INInbox.h
Represents the user's notification inbox (message center).
| Property | Type | Description |
|---|---|---|
domainInbox | NSString * | Inbox domain (read-only) |
lastAccess | NSString * | Date/time of last inbox access |
notifications | NSArray<INInboxNotification *> * | List of notifications in the inbox |
count | int | Total number of notifications |
pageSize | NSNumber * | Page size for pagination |
page | NSNumber * | Current page number |
totalPages | float | Total number of pages |
Related model: INInboxNotification
INInboxNotificationIndividual notification stored in the inbox.
| Property | Type | Description |
|---|---|---|
idInboxNotification | NSString * | Unique notification identifier |
externalId | NSString * | External notification identifier |
sentAt | NSString * | Date/time the notification was sent |
inboxStatus | INInboxStatus * | Current status of the notification |
sendingId | NSNumber * | Sending identifier |
campaignId | NSNumber * | Campaign identifier |
message | INInboxPush * | Push message content |
replacements | NSString * | Template replacements |
read | Boolean | Whether the notification has been read |
category | INInboxCategory * | Notification category |
INInboxMessageStatus enum
INInboxMessageStatus enum| Value | Description |
|---|---|
SENT | Notification was delivered |
CLICK | Notification was clicked |
DELETED | Notification was deleted |
INInboxCounters
File: inbox/src/models/INInboxCounters.h
Represents statistical counters for the user's inbox.
| Property | Type | Description |
|---|---|---|
click | int | Number of notifications that have been clicked |
sent | int | Number of notifications sent |
deleted | int | Number of notifications deleted |
unread | INInboxUnread * | Unread messages information |
Related model: INInboxUnread
INInboxUnreadFile: inbox/src/models/INInboxUnread.h
| Property | Type | Description |
|---|---|---|
count | int | Number of unread messages |
lastAccess | NSString * | Date/time of last access |
INCustomer
File: customer/src/models/INCustomer.h
Represents the customer profile linked to a device in the Indigitall platform.
| Property | Type | Description |
|---|---|---|
_id | NSString * | Internal database record identifier |
customerId | NSString * | Customer identifier (external/business-side) |
applicationId | NSString * | Application identifier |
createdAt | NSString * | Record creation date/time |
updatedAt | NSString * | Last update date/time |
INLiveActivity
File: liveActivity/src/models/INLiveActivity.h
Represents a Live Activity registered in the Indigitall platform. Live Activities display real-time information on the iOS Lock Screen and Dynamic Island.
| Property | Type | Description |
|---|---|---|
liveActivityId | NSString * | Unique Live Activity identifier in Indigitall |
createdAt | NSString * | Creation date/time |
updatedAt | NSString * | Last update date/time |
applicationId | int | Application identifier |
liveActivityExternalId | NSString * | External identifier provided by the iOS system |
status | NSString * | Current Live Activity status |
iOSChannelId | NSString * | iOS channel identifier (Live Activity push token) |
Error reference
SDK errors expose an errorCode (numeric code), a message (the default text for that code), and an optional descriptionMessage (context from the failed operation, such as request or exception details). Some callbacks replace message with text returned by the server, so the table shows default messages rather than every possible runtime value.
Inbox-specific codes are part of INErrorCode; there is no separate INInboxErrorCode enum.
INErrorCode — Core, Push and Inbox
INErrorCode — Core, Push and Inbox| Code | Value | message | When it is used in the SDK |
|---|---|---|---|
GENERAL_ERROR | 600 | General Error | Generic internal failures, including setup and Push operations; also used for In-App topic response failures. |
DEVICE_FIELD_MISSING | 601 | PUT /device: Response device field is missing | The device update response does not contain its device field. |
DEVICE_NOT_REGISTERED | 602 | Device is not registered yet | A device check, including the tag-based registration check, finds no registered device. |
DEVICE_ID_FIELD_MISSING | 603 | POST /device: Response deviceID field is missing | Device registration succeeds without a deviceID in the response. |
TIMEOUT_REQUEST | 605 | The request timed out before a response was received | A network request times out. |
UNKNOWN_ERROR | 606 | Unknown error | Fallback for an unclassified network error or exception. |
EXTERNAL_CODE_ERROR | 607 | External code not linked | Linking an external code fails. |
API_SERVER_ERROR | 500 | Error server response | Server HTTP status 500 passed through the shared response/callback handling. |
API_PARAMETER_MISSING | 400 | Api parameter missing | HTTP 400/API parameter failures; also logged when core topic processing throws. |
API_APPKEY_NOT_VALID | 401 | appKey is not valid | HTTP 401 passed through shared callbacks. Inbox also treats 401 as an expired inbox-auth token and retries after generating a token. |
API_FORBIDDEN_REQUEST | 403 | forbidden request | HTTP 403 passed through shared response/callback handling. |
API_DEVICE_NOT_FOUND | 404 | device not found | HTTP 404 passed through shared response/callback handling. |
API_TOPICS_ARE_INSERTED | 409 | topics are inserted | HTTP 409 passed through shared response/callback handling. |
BAD_REQUEST_SERVER_ERROR | 4800 | bad request | Backend-specific bad-request status passed through shared callbacks; no direct local constructor found. |
DISABLED_CHANNEL | 4404 | Disabled channel | Backend disabled-channel status passed through shared callbacks. Customer's local CHANNEL_NONE guard uses CUSTOMER_DISABLED_CHANNEL (4603) instead. |
INBOX_GET_ERROR | 3001 | get Inbox error | Declared and mapped, but no direct local constructor was found in the current Inbox implementation. |
INBOX_EXTERNAL_ID_NO_REGISTERED | 3003 | External Id not registered | Inbox operations requiring an external ID reject a missing/invalid ID (auth token, inbox, counters and related operations). |
INBOX_IS_REQUESTING_PAGE | 3006 | Wait. Is Requesting new page | Another Inbox page request is already in progress. |
INBOX_GET_PAGE_ERROR | 3011 | There are no more messages on Inbox | Inbox pagination returns no messages / has no further page. |
INBOX_GENERAL_ERROR | 3600 | inbox general error | Declared and mapped, but no direct local constructor was found in the current Inbox implementation. |
INBOX_BAD_REQUEST | 3604 | AppKey or deviceId null or empty | Inbox public operations fail local request validation for the app key or device ID. |
INAPP_AUDIENCES_BAD_REQUEST | 4803 | Audience bad request | Audience retrieval is missing the required deviceId or externalCode. |
INPushErrorCode — Push
INPushErrorCode — Push| Code | Value | message | When it is used in the SDK |
|---|---|---|---|
PUSH_RECEPTION_ERROR | 1200 | reception push error | An exception occurs while processing a received notification. |
PUSH_CONFIGURATION_ERROR | 1300 | Push configuration error | An exception occurs while loading Push configuration in the background. |
PUSH_TOPICS_ERROR | 1400 | topics error | Declared and mapped; no direct local constructor was found in the current Push source. |
PUSH_DEVICE_ERROR | 1500 | device error | Used as descriptive text for device-operation exceptions; those cases currently emit GENERAL_ERROR or PUSH_TOKEN_ERROR as the actual code. |
PUSH_EVENT_ERROR | 1600 | event error | Declared and mapped; no direct local constructor was found in the current Push source. |
PUSH_TOKEN_ERROR | 1700 | token error | Push-token operation failure. |
PUSH_FCM_REGISTRATION | 1701 | Fetching FCM registration token failed | Declared and mapped; no direct local constructor was found in the current Push source. |
PUSH_FCM_GET_INSTANCE | 1702 | get Instance token error | Declared and mapped; no direct local constructor was found in the current Push source. |
PUSH_BAD_REQUEST | 1704 | AppKey or deviceId null or empty | Push API methods reject invalid/missing app key or device ID input. |
PUSH_PERMISSIONS_ERROR | 1800 | Error with permissions | An exception or error occurs while requesting notification permissions. |
PUSH_PERMISSIONS_DECLINED | 1801 | Push notifications permissions are declined | The user has declined push-notification permissions. |
PUSH_EXTERNAL_APPS | 1802 | Error with external apps | An exception occurs while initializing/parsing linked external applications. |
INInAppErrorCode — In-App
INInAppErrorCode — In-App| Code | Value | message | When it is used in the SDK |
|---|---|---|---|
INAPP_ERROR | 2000 | inApp error | General In-App failures, including topic operations, loading and presentation exceptions. |
INAPP_NOT_APPKEY | 2002 | AppKey was not configurated | An In-App API operation is called without a configured app key. |
INAPP_CONTENT_MESSAGE | 2003 | InApp error with content | The In-App content response is missing/invalid. |
INAPP_TOPIC_EMPTY | 2004 | There is no inApp topics subscribiption | Declared and mapped; no direct local constructor was found in the current In-App source. |
INAPP_TOPIC_LIST_NO_MORE_PAGES | 2005 | No more pages for inApp topics | The In-App topic-list model has no further page. |
INAPP_CAMPAIGN_NOT_EXIST | 2403 | Campaign doesn't exist with the code | The In-App callback receives no campaign data for the requested code. |
INAPP_SHOW_INAPP_ERROR | 2100 | show inApp error | Declared and mapped; no direct local constructor was found in the current In-App source. |
INAPP_WAS_EXPIRED | 2101 | InApp cache has timed out | The cached In-App has expired before it is shown. |
INAPP_WAS_SHOWN_MANY_TIMES | 2102 | InApp was shown many times | The configured maximum number of displays has been reached. |
INAPP_WAS_CLICKED_MANY_TIMES | 2103 | InApp was clicked many times | The configured maximum number of clicks has been reached. |
INAPP_FORM_TYPE_NOT_CORRECT | 2120 | Input type is not correct | A required text/number form input has a value of the wrong type. |
INAPP_FORM_FIELD_IS_EMPTY | 2121 | Field is empty | A required form input is missing or empty. |
INAPP_SHOW_POPUP_ERROR | 2300 | show popup error | A permanently dismissed In-App is filtered from display and routed to the dismiss-forever callback. |
INAPP_POPUP_ERROR | 2200 | popup error | A popup presentation/load failure. |
POPUP_WAS_EXPIRED | 2301 | Popup cache has timed out | Declared and mapped; no direct local constructor was found in the current In-App source. |
POPUP_WAS_SHOWN_MANY_TIMES | 2302 | Popup was shown many times | Declared and mapped; no direct local constructor was found in the current In-App source. |
POPUP_WAS_CLICKED_MANY_TIMES | 2303 | Popup was clicked many times | Declared and mapped; no direct local constructor was found in the current In-App source. |
POPUP_DISMISSED_FOREVER | 2304 | Popup was dismissed forever | Returned to the failure callback when a popup has been dismissed forever. |
INAPP_NOT_ENABLED | 4801 | InApp is not enabled on V2 in this project | The application callback reports that In-App is not enabled for the project. |
INAPP_BAD_REQUEST | 4802 | Invalid request parameters | Backend status passed through the In-App callback; no direct local constructor was found. |
INCustomerErrorCode — Customer
INCustomerErrorCode — Customer| Code | Value | message | When it is used in the SDK |
|---|---|---|---|
CUSTOMER_GENERAL_ERROR | 4600 | customer general error | Declared and mapped; no direct local constructor was found in the current Customer source. |
CUSTOMER_NO_EXTERNAL_CODE | 4601 | no external code | Declared and mapped; no direct local constructor was found in the current Customer source. |
CUSTOMER_BAD_REQUEST | 4602 | Invalid request parameters | Customer field, link/unlink and custom-event API methods reject invalid request input. |
CUSTOMER_DISABLED_CHANNEL | 4603 | Channel disabled | Linking or unlinking a customer with CHANNEL_NONE is rejected locally. |
INLAErrorCode — Live Activity
INLAErrorCode — Live Activity| Code | Value | message | When it is used in the SDK |
|---|---|---|---|
LIVE_ACTIVITY_GENERAL_ERROR | 5000 | Live Activity general error | Generic Live Activity callback errors are wrapped as this code. |
EXTERNAL_CODE_GENERATING_ERROR | 5001 | Failed generating error code | An exception occurs while generating the hashed external code. |
Relationships
INPush
├── INPushAction (extends INCoreAction)
│ └── ActionType {app, url, webview, call, market, share, noAction, wallet}
└── INPushButton[]
└── INPushAction
INDevice (extends INCoreDevice)
└── INCoreExternalApp[]
INInApp
├── INInAppProperties
│ ├── INInAppLayout
│ └── INInAppAction
├── INInAppShow
└── INInAppFilters
├── INInAppFiltersTopic
└── INCoreExternalApp[]
INTopic (extends INCoreTopic)
└── INChannel {PUSH, INAPP, CHAT, CHANNEL_NONE}
INInbox
└── INInboxNotification[]
├── INInboxPush
├── INInboxStatus {SENT, CLICK, DELETED}
└── INInboxCategory
INInboxCounters
└── INInboxUnread
INCustomer
INLiveActivity
SDK Modules
| Model | Module | Podspec |
|---|---|---|
INPush, INDevice, INTopic | push/ | indigitall-ios-push.podspec |
INInApp | inApp/ | indigitall-ios-inapp.podspec |
INInbox, INInboxCounters | inbox/ | indigitall-ios-inbox.podspec |
INCustomer | customer/ | indigitall-ios-customer.podspec |
INLiveActivity | liveActivity/ | (liveActivity module) |
