Model Reference

Descriptive reference of the main models used across SDK modules.


Table of Contents

  1. INPush
  2. INDevice
  3. INInApp
  4. INTopic
  5. INInbox
  6. INInboxCounters
  7. INCustomer
  8. INLiveActivity
  9. Error reference

INPush

File: push/src/models/INPush.h

Represents a push notification received or sent through the Indigitall platform.

PropertyTypeDescription
pushIdlongIndigitall internal identifier for the push notification
appKeyNSString *Public application identifier in Indigitall
titleNSString *Title of the push notification
bodyNSString *Body/content of the push notification
imageNSString *URL of the image attached to the notification
gifNSString *URL of the GIF attached to the notification
dataNSString *Extra information added from the Indigitall panel
actionINPushAction *Action executed when the user interacts with the notification
buttonsNSArray<INPushButton *> *Array of action buttons available in the notification
securedDataNSString *Encrypted/secured additional data
sendingIdNSString *Sending identifier
campaignIdNSString *Campaign identifier
contentStateNSDictionary *Content state as JSON (used for Live Activities)
clickedButtonintIndex of the button or notification tapped by the user
journeyStateIdintJourney state identifier
sendEventAckBOOLWhether the ACK event should be sent
applicationIdintApplication identifier
jsonPushNSDictionary *Full JSON representation of the push
eventAtNSString *Date/time of the event

Related models

INPushAction — Action associated with the push. Extends INCoreAction.

PropertyTypeDescription
typeActionTypeAction type: app, url, webview, call, market, share, noAction, wallet
destroyBOOLWhether the action is destructive
urlNSString *URL value for url type actions
webviewNSString *URL value for webview type actions
callNSString *Phone number for call type actions
marketNSString *App Store link for market type actions
shareNSString *Message to share for share type actions
walletNSString *Pass URL for wallet type actions
topicsNSArray *Topics the user will be subscribed to on action

INPushButton — Action button within a push notification.

PropertyTypeDescription
labelNSString *Button display text
actionINPushAction *Action triggered when the button is tapped
topicsNSArray *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

PropertyTypeDescription
deviceIDNSString *Unique Indigitall device identifier
externalCodeNSString *External code assigned to the device
platformNSString *Platform (e.g. iOS)
osNameNSString *Operating system name
osVersionNSString *Operating system version
deviceBrandNSString *Device brand
deviceModelNSString *Device model
deviceTypeNSString *Device type (mobile or tablet)
appVersionNSString *Current application version
sdkVersionNSString *SDK version
localeNSString *Device preferred language
timeZoneNSString *Current time zone
timeOffsetlongTime offset in hours
carrierNSString *Mobile network carrier
enabledNSNumber *Whether push notifications are enabled
configEnabledBOOLEnabled configuration state
externalApplicationsNSArray<INCoreExternalApp *> *Linked external applications
productNameNSString *Third-party product name (integrations)
productVersionNSString *Third-party product version

Own properties of INDevice

PropertyTypeDescription
pushTokenNSString *Device APNs push notification token

INInApp

File: inApp/src/models/INInApp.h

Represents an In-App message from the Indigitall platform.

PropertyTypeDescription
inAppIdintUnique In-App identifier
inAppWidthintIn-App width in points
inAppHeightintIn-App height in points
lastVersionIdintLast version identifier
codeNSString *In-App code identifier
nameNSString *In-App name
profileNSString *Associated profile (nullable)
propertiesINInAppProperties *Visual and behavioral properties of the In-App
showOnceintHow many times it will be shown (0 = unlimited)
expiredDateNSString *Expiration date
creationDateNSString *Creation date
cacheTtldoubleCache time-to-live in seconds
inAppShowINInAppShow *Display state of the In-App
customDataNSDictionary *Additional custom data
versionintObject version
inAppVersionintIn-App version
filtersINInAppFilters *Segmentation filters for the In-App

Related models

INInAppProperties — Visual and display properties.

PropertyTypeDescription
InAppContentUrlNSURL *URL of the In-App content
numberOfShowsintMaximum number of times to display
numberOfClicksintNumber of clicks registered
dismissForeverBOOLWhether it is permanently dismissed after closing
layoutINInAppLayout *Layout configuration
actionINInAppAction *Action triggered on interaction
showTimeintTime the In-App is displayed (in seconds)

INInAppShow — Display history for the In-App.

PropertyTypeDescription
timesShowedintNumber of times the In-App has been shown
timesClickedintNumber of times the In-App has been clicked
wasDismissedBOOLWhether the In-App was dismissed by the user

INInAppFilters — Segmentation and targeting filters.

PropertyTypeDescription
platformsNSArray *Target platforms
areasNSArray<NSNumber *> *Target geographic areas
audienceNSDictionary *Audience definition
topicsINInAppFiltersTopic *Topic-based filters
externalAppsNSArray<INCoreExternalApp *> *External app filters
deviceCodesNSArray *Specific target device codes
deviceCodesActiveBOOLWhether device code filtering is active
deviceTypesNSArray *Target device types
browserTypesNSArray *Target browser types
activePushDevicesBOOLWhether 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.

PropertyTypeDescription
codeNSString *Unique topic code identifier
nameNSString *Visible topic name
parentCodeNSString *Parent topic code (for hierarchies)
visibleBOOLWhether the topic is visible to the user
subscribedBOOLWhether the device is subscribed to this topic
channelINChannelChannel the topic belongs to

INChannel enum

ValueDescription
PUSHPush notification channel
INAPPIn-App message channel
CHATChat channel
CHANNEL_NONENo channel

INInbox

File: inbox/src/INInbox.h

Represents the user's notification inbox (message center).

PropertyTypeDescription
domainInboxNSString *Inbox domain (read-only)
lastAccessNSString *Date/time of last inbox access
notificationsNSArray<INInboxNotification *> *List of notifications in the inbox
countintTotal number of notifications
pageSizeNSNumber *Page size for pagination
pageNSNumber *Current page number
totalPagesfloatTotal number of pages

Related model: INInboxNotification

Individual notification stored in the inbox.

PropertyTypeDescription
idInboxNotificationNSString *Unique notification identifier
externalIdNSString *External notification identifier
sentAtNSString *Date/time the notification was sent
inboxStatusINInboxStatus *Current status of the notification
sendingIdNSNumber *Sending identifier
campaignIdNSNumber *Campaign identifier
messageINInboxPush *Push message content
replacementsNSString *Template replacements
readBooleanWhether the notification has been read
categoryINInboxCategory *Notification category

INInboxMessageStatus enum

ValueDescription
SENTNotification was delivered
CLICKNotification was clicked
DELETEDNotification was deleted

INInboxCounters

File: inbox/src/models/INInboxCounters.h

Represents statistical counters for the user's inbox.

PropertyTypeDescription
clickintNumber of notifications that have been clicked
sentintNumber of notifications sent
deletedintNumber of notifications deleted
unreadINInboxUnread *Unread messages information

Related model: INInboxUnread

File: inbox/src/models/INInboxUnread.h

PropertyTypeDescription
countintNumber of unread messages
lastAccessNSString *Date/time of last access

INCustomer

File: customer/src/models/INCustomer.h

Represents the customer profile linked to a device in the Indigitall platform.

PropertyTypeDescription
_idNSString *Internal database record identifier
customerIdNSString *Customer identifier (external/business-side)
applicationIdNSString *Application identifier
createdAtNSString *Record creation date/time
updatedAtNSString *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.

PropertyTypeDescription
liveActivityIdNSString *Unique Live Activity identifier in Indigitall
createdAtNSString *Creation date/time
updatedAtNSString *Last update date/time
applicationIdintApplication identifier
liveActivityExternalIdNSString *External identifier provided by the iOS system
statusNSString *Current Live Activity status
iOSChannelIdNSString *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

CodeValuemessageWhen it is used in the SDK
GENERAL_ERROR600General ErrorGeneric internal failures, including setup and Push operations; also used for In-App topic response failures.
DEVICE_FIELD_MISSING601PUT /device: Response device field is missingThe device update response does not contain its device field.
DEVICE_NOT_REGISTERED602Device is not registered yetA device check, including the tag-based registration check, finds no registered device.
DEVICE_ID_FIELD_MISSING603POST /device: Response deviceID field is missingDevice registration succeeds without a deviceID in the response.
TIMEOUT_REQUEST605The request timed out before a response was receivedA network request times out.
UNKNOWN_ERROR606Unknown errorFallback for an unclassified network error or exception.
EXTERNAL_CODE_ERROR607External code not linkedLinking an external code fails.
API_SERVER_ERROR500Error server responseServer HTTP status 500 passed through the shared response/callback handling.
API_PARAMETER_MISSING400Api parameter missingHTTP 400/API parameter failures; also logged when core topic processing throws.
API_APPKEY_NOT_VALID401appKey is not validHTTP 401 passed through shared callbacks. Inbox also treats 401 as an expired inbox-auth token and retries after generating a token.
API_FORBIDDEN_REQUEST403forbidden requestHTTP 403 passed through shared response/callback handling.
API_DEVICE_NOT_FOUND404device not foundHTTP 404 passed through shared response/callback handling.
API_TOPICS_ARE_INSERTED409topics are insertedHTTP 409 passed through shared response/callback handling.
BAD_REQUEST_SERVER_ERROR4800bad requestBackend-specific bad-request status passed through shared callbacks; no direct local constructor found.
DISABLED_CHANNEL4404Disabled channelBackend disabled-channel status passed through shared callbacks. Customer's local CHANNEL_NONE guard uses CUSTOMER_DISABLED_CHANNEL (4603) instead.
INBOX_GET_ERROR3001get Inbox errorDeclared and mapped, but no direct local constructor was found in the current Inbox implementation.
INBOX_EXTERNAL_ID_NO_REGISTERED3003External Id not registeredInbox operations requiring an external ID reject a missing/invalid ID (auth token, inbox, counters and related operations).
INBOX_IS_REQUESTING_PAGE3006Wait. Is Requesting new pageAnother Inbox page request is already in progress.
INBOX_GET_PAGE_ERROR3011There are no more messages on InboxInbox pagination returns no messages / has no further page.
INBOX_GENERAL_ERROR3600inbox general errorDeclared and mapped, but no direct local constructor was found in the current Inbox implementation.
INBOX_BAD_REQUEST3604AppKey or deviceId null or emptyInbox public operations fail local request validation for the app key or device ID.
INAPP_AUDIENCES_BAD_REQUEST4803Audience bad requestAudience retrieval is missing the required deviceId or externalCode.

INPushErrorCode — Push

CodeValuemessageWhen it is used in the SDK
PUSH_RECEPTION_ERROR1200reception push errorAn exception occurs while processing a received notification.
PUSH_CONFIGURATION_ERROR1300Push configuration errorAn exception occurs while loading Push configuration in the background.
PUSH_TOPICS_ERROR1400topics errorDeclared and mapped; no direct local constructor was found in the current Push source.
PUSH_DEVICE_ERROR1500device errorUsed as descriptive text for device-operation exceptions; those cases currently emit GENERAL_ERROR or PUSH_TOKEN_ERROR as the actual code.
PUSH_EVENT_ERROR1600event errorDeclared and mapped; no direct local constructor was found in the current Push source.
PUSH_TOKEN_ERROR1700token errorPush-token operation failure.
PUSH_FCM_REGISTRATION1701Fetching FCM registration token failedDeclared and mapped; no direct local constructor was found in the current Push source.
PUSH_FCM_GET_INSTANCE1702get Instance token errorDeclared and mapped; no direct local constructor was found in the current Push source.
PUSH_BAD_REQUEST1704AppKey or deviceId null or emptyPush API methods reject invalid/missing app key or device ID input.
PUSH_PERMISSIONS_ERROR1800Error with permissionsAn exception or error occurs while requesting notification permissions.
PUSH_PERMISSIONS_DECLINED1801Push notifications permissions are declinedThe user has declined push-notification permissions.
PUSH_EXTERNAL_APPS1802Error with external appsAn exception occurs while initializing/parsing linked external applications.

INInAppErrorCode — In-App

CodeValuemessageWhen it is used in the SDK
INAPP_ERROR2000inApp errorGeneral In-App failures, including topic operations, loading and presentation exceptions.
INAPP_NOT_APPKEY2002AppKey was not configuratedAn In-App API operation is called without a configured app key.
INAPP_CONTENT_MESSAGE2003InApp error with contentThe In-App content response is missing/invalid.
INAPP_TOPIC_EMPTY2004There is no inApp topics subscribiptionDeclared and mapped; no direct local constructor was found in the current In-App source.
INAPP_TOPIC_LIST_NO_MORE_PAGES2005No more pages for inApp topicsThe In-App topic-list model has no further page.
INAPP_CAMPAIGN_NOT_EXIST2403Campaign doesn't exist with the codeThe In-App callback receives no campaign data for the requested code.
INAPP_SHOW_INAPP_ERROR2100show inApp errorDeclared and mapped; no direct local constructor was found in the current In-App source.
INAPP_WAS_EXPIRED2101InApp cache has timed outThe cached In-App has expired before it is shown.
INAPP_WAS_SHOWN_MANY_TIMES2102InApp was shown many timesThe configured maximum number of displays has been reached.
INAPP_WAS_CLICKED_MANY_TIMES2103InApp was clicked many timesThe configured maximum number of clicks has been reached.
INAPP_FORM_TYPE_NOT_CORRECT2120Input type is not correctA required text/number form input has a value of the wrong type.
INAPP_FORM_FIELD_IS_EMPTY2121Field is emptyA required form input is missing or empty.
INAPP_SHOW_POPUP_ERROR2300show popup errorA permanently dismissed In-App is filtered from display and routed to the dismiss-forever callback.
INAPP_POPUP_ERROR2200popup errorA popup presentation/load failure.
POPUP_WAS_EXPIRED2301Popup cache has timed outDeclared and mapped; no direct local constructor was found in the current In-App source.
POPUP_WAS_SHOWN_MANY_TIMES2302Popup was shown many timesDeclared and mapped; no direct local constructor was found in the current In-App source.
POPUP_WAS_CLICKED_MANY_TIMES2303Popup was clicked many timesDeclared and mapped; no direct local constructor was found in the current In-App source.
POPUP_DISMISSED_FOREVER2304Popup was dismissed foreverReturned to the failure callback when a popup has been dismissed forever.
INAPP_NOT_ENABLED4801InApp is not enabled on V2 in this projectThe application callback reports that In-App is not enabled for the project.
INAPP_BAD_REQUEST4802Invalid request parametersBackend status passed through the In-App callback; no direct local constructor was found.

INCustomerErrorCode — Customer

CodeValuemessageWhen it is used in the SDK
CUSTOMER_GENERAL_ERROR4600customer general errorDeclared and mapped; no direct local constructor was found in the current Customer source.
CUSTOMER_NO_EXTERNAL_CODE4601no external codeDeclared and mapped; no direct local constructor was found in the current Customer source.
CUSTOMER_BAD_REQUEST4602Invalid request parametersCustomer field, link/unlink and custom-event API methods reject invalid request input.
CUSTOMER_DISABLED_CHANNEL4603Channel disabledLinking or unlinking a customer with CHANNEL_NONE is rejected locally.

INLAErrorCode — Live Activity

CodeValuemessageWhen it is used in the SDK
LIVE_ACTIVITY_GENERAL_ERROR5000Live Activity general errorGeneric Live Activity callback errors are wrapped as this code.
EXTERNAL_CODE_GENERATING_ERROR5001Failed generating error codeAn 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

ModelModulePodspec
INPush, INDevice, INTopicpush/indigitall-ios-push.podspec
INInAppinApp/indigitall-ios-inapp.podspec
INInbox, INInboxCountersinbox/indigitall-ios-inbox.podspec
INCustomercustomer/indigitall-ios-customer.podspec
INLiveActivityliveActivity/(liveActivity module)