Descriptive reference of the main models used across SDK modules.
Table of Contents
Push
Module: push · Package: indigitall-capacitor-plugin · File: InPush.ts
Represents a push notification received from the Indigitall platform. Contains all the data needed to display and handle a notification.
| Property | Type | Required | Description |
|---|---|---|---|
title | string | Yes | Title of the push notification displayed to the user |
body | string | Yes | Main text body of the push notification |
image | string | Yes | URL of the image to display in the notification |
data | string | Yes | Custom payload string to pass arbitrary data to the app when the notification is handled |
securedData | string | Yes | Decrypted secured payload attached to the notification |
action | PushAction | Yes | Action to execute when the user taps the notification |
buttons | [PushButton] | Yes | List of action buttons displayed in the expanded notification |
Related models
PushAction — Defines the action executed when a push notification (or button) is tapped.
| Property | Type | Description |
|---|---|---|
url | string | null | URL to open when the action is of URL type |
app | string | null | Deep-link or activity identifier to open when the action targets the app |
market | string | null | Market URL or package name to open when the action targets the store |
share | string | null | Text content to share |
call | string | null | Phone number to dial |
noAction | string | null | Indicates no action should be performed |
clickedButton | number | null | Index of the button clicked (null if the notification body was tapped) |
PushButton — Represents an action button displayed in an expanded push notification.
| Property | Type | Description |
|---|---|---|
label | string | Text label displayed on the button |
action | PushAction | Action to execute when the button is tapped |
Device
Module: push · Package: indigitall-capacitor-plugin · File: InDevice.ts
Represents the device registered in the Indigitall platform. Contains all identification, platform, and configuration data associated with a device.
| Property | Type | Required | Description |
|---|---|---|---|
enable | boolean | Yes | Whether push notifications are enabled for this device |
deviceId | string | Yes | Unique identifier assigned to the device by the Indigitall platform |
pushToken | string | Yes | Push token used to send notifications to this device |
platform | string | Yes | Platform identifier (e.g. android, ios) |
productName | string | Yes | Name of the application product |
productVersion | string | Yes | Version of the application product |
osName | string | Yes | Name of the operating system (e.g. Android, iOS) |
osVersion | string | Yes | Version of the operating system |
deviceBrand | string | Yes | Brand/manufacturer of the device (e.g. Samsung, Apple) |
deviceModel | string | Yes | Model name or identifier of the device |
operator | string | Yes | Mobile network operator name |
deviceType | string | Yes | Type of the device (e.g. phone, tablet) |
appVersion | string | Yes | Version of the host application |
locale | string | Yes | Locale configured on the device (e.g. en-US) |
timeZone | string | Yes | Time zone identifier of the device (e.g. Europe/Madrid) |
timeOffset | string | Yes | UTC offset of the device time zone |
externalApps | [ExternalApps] | Yes | List of external applications linked to this device |
externalCode | string | Yes | External identifier used to link the device to a user account |
Related models
ExternalApps — Represents an external application linked to a device.
| Property | Type | Description |
|---|---|---|
id | number | Internal identifier of the external app |
name | string | Display name of the external app |
code | string | Code used to identify the external app |
Topic
Module: push · Package: indigitall-capacitor-plugin · File: InDevice.ts
Represents a notification topic that a device can subscribe to or unsubscribe from.
| Property | Type | Required | Description |
|---|---|---|---|
code | string | Yes | Unique code identifying the topic |
name | string | Yes | Human-readable display name of the topic |
parentCode | string | Yes | Code of the parent topic, if this topic is nested |
visible | boolean | Yes | Whether this topic is visible to the user in the UI |
subscribed | boolean | Yes | Whether the current device is subscribed to this topic |
InApp
Module: inapp · Package: indigitall-capacitor-plugin · File: InInApp.ts
Represents an in-app message received from the Indigitall platform. Contains display configuration, scheduling, and interaction data.
| Property | Type | Required | Description |
|---|---|---|---|
inAppId | number | Yes | Unique identifier of the in-app message |
lastVersionId | number | Yes | Identifier of the last version of this in-app message |
showOnce | boolean | Yes | If true, the in-app message will only be shown once to the user |
creationDate | string | Yes | ISO date string representing when the in-app message was created |
expiredDate | string | Yes | ISO date string representing when the in-app message expires |
properties | InAppProperties | Yes | Display and interaction properties of the in-app message |
renewalTime | string | Yes | ISO date string representing the renewal time of the in-app message |
schema | InAppSchema | Yes | Schema defining the code and dimensions of the in-app message |
Related models
InAppSchema — Defines the template code and size of the in-app message.
| Property | Type | Description |
|---|---|---|
code | string | Code identifying the in-app schema template |
width | number | Width of the in-app message display area |
height | number | Height of the in-app message display area |
InAppProperties — Contains the display and interaction configuration of the in-app message.
| Property | Type | Description |
|---|---|---|
contentUrl | string | URL of the content to display inside the in-app message |
showTime | number | Duration in seconds the in-app message is shown before being auto-dismissed |
layout | InAppLayout | Layout styling configuration for the in-app message |
action | InAppAction | Action to execute when the user interacts with the in-app message |
numberOfShows | number | Number of times this in-app message has been shown |
numberOfClicks | number | Number of times the user has clicked this in-app message |
dismissForever | boolean | If true, the message has been permanently dismissed by the user |
InAppLayout — Defines layout styling for the in-app message container.
| Property | Type | Description |
|---|---|---|
borderRadius | string | CSS border-radius value applied to the container |
InAppAction — Defines the action to execute when the user interacts with an in-app message.
| Property | Type | Description |
|---|---|---|
url | string | URL to open when the action is of URL type |
app | string | Deep-link or identifier to open within the application |
actionId | number | Identifier of the predefined action to execute |
type | string | Type of action to perform (e.g. url, app, no_action) |
Inbox
Module: inbox · Package: indigitall-capacitor-plugin · File: InInbox.ts
Represents the user's inbox containing a paginated list of received push notifications and their read/unread state.
| Property | Type | Required | Description |
|---|---|---|---|
lastAccess | string | Yes | ISO date string of the last time the inbox was accessed |
notifications | [InboxNotifications] | Yes | Complete list of notifications in the current page |
newNotifications | [InboxNotifications] | null | Yes | List of notifications received since the last access, or null if none |
count | number | Yes | Total number of notifications available in the inbox |
pagesize | number | Yes | Number of notifications returned per page |
numPage | number | Yes | Current page number (zero-based) |
Related models
InboxNotifications — Represents a single notification stored in the inbox.
| Property | Type | Description |
|---|---|---|
id | string | Unique identifier of the inbox notification |
externalCode | string | External code linking the notification to a user or device |
sentAt | string | ISO date string of when the notification was sent |
status | string | Current status of the notification. Values: sent, click, deleted |
sendingId | number | Identifier of the sending campaign instance |
campaign | number | Identifier of the campaign this notification belongs to |
message | Push | The push notification message payload |
read | boolean | Whether the notification has been read by the user |
category | InboxCategory | Category the notification belongs to |
InboxCategory — Represents the category of an inbox notification.
| Property | Type | Description |
|---|---|---|
id | number | Internal identifier of the category |
code | string | null | Code identifying the category |
name | string | null | Human-readable display name of the category |
InboxStatus (enum) — Possible status values for an inbox notification.
| Value | String value | Description |
|---|---|---|
sent | "sent" | Notification has been delivered but not yet clicked |
click | "click" | Notification has been clicked by the user |
deleted | "deleted" | Notification has been deleted |
MessageCount
Module: inbox · Package: indigitall-capacitor-plugin · File: InInbox.ts
Represents aggregated counts of inbox notification interactions for the current device.
| Property | Type | Required | Description |
|---|---|---|---|
click | number | Yes | Total number of clicked notifications |
sent | number | Yes | Total number of delivered notifications |
deleted | number | Yes | Total number of deleted notifications |
lastAccess | number | Yes | Timestamp of the last time the inbox was accessed |
count | number | Yes | Total number of notifications in the inbox |
Customer
Module: customer · Package: indigitall-capacitor-plugin · File: InCustomer.ts
Represents a customer profile linked to the Indigitall platform. Contains identification and lifecycle metadata for the customer entity.
| Property | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Internal identifier assigned to the customer by the platform |
customerId | string | Yes | External customer identifier used to link the profile to your system |
applicationId | string | Yes | Indigitall application identifier this customer belongs to |
createdAt | string | Yes | ISO date string of when the customer profile was created |
updatedAt | string | Yes | ISO date string of the last update to the customer profile |
Related models
CustomerField — Represents a custom key-value field associated with a customer profile.
| Property | Type | Description |
|---|---|---|
key | string | Name of the custom field |
value | string | null | Value of the custom field, or null if not set |
Channel (enum) — Identifies the communication channel used by the customer.
| Value | String value | Description |
|---|---|---|
Push | "push" | Push notification channel |
InApp | "inapp" | In-app messaging channel |
Chat | "chat" | Chat messaging channel |
LiveActivity
Module: liveactivity · Package: indigitall-capacitor-plugin · File: InDevice.ts
Represents an iOS Live Activity registered and managed through the Indigitall platform.
| Property | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Internal identifier of the Live Activity record |
createdAt | string | Yes | ISO date string of when the Live Activity was created |
updatedAt | string | Yes | ISO date string of the last update to the Live Activity |
applicationId | string | Yes | Indigitall application identifier this Live Activity belongs to |
liveActivityExternalId | string | Yes | External identifier used to reference the Live Activity from your system |
status | string | Yes | Current status of the Live Activity (e.g. active, ended) |
androidTopicId | string | Yes | Topic identifier used on Android to route Live Activity updates |