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) |
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) |
