You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-4
Original file line number
Diff line number
Diff line change
@@ -58,6 +58,8 @@ Below are the methods this SDK exposes. See [Iterable's API Docs](https://api.it
58
58
|[`updateUser`](#updateUser)| Change data on a user's profile or create a user if none exists |
59
59
|[`updateUserEmail`](#updateUserEmail)| Change a user's email and reauthenticate user with the new email address (in other words, the SDK will call `setEmail` for you) |
60
60
61
+
The SDK does not track `inAppDelete` events.
62
+
61
63
:rotating_light: Due to a limitation in Safari browsers, web in-app messages displayed in Safari can't automatically fire `trackInAppClick` events when a link has been clicked. This will impact analytics for Safari users.
62
64
63
65
# Usage
@@ -871,12 +873,15 @@ https://hello.com
871
873
872
874
## Reserved Keyword Links
873
875
874
-
Upon normal links, Iterable reserves the `iterable://` and `action://` schemas for custom actions that are performed when a link is clicked. The following are links that you can add to your in-app messages for enhanced functionality:
876
+
Iterable reserves the `iterable://` and `action://` URL schemas to define custom link click actions:
877
+
878
+
1.`iterable://dismiss` - Removes the in-app message from the screen, grabs the next one to display, and invokes both [trackInAppClose](#trackInAppClose) and [trackInAppClick](#trackInAppClick).
879
+
880
+
2.`action://{anything}` - Makes a [`Window.prototype.postMessage`](https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage) call with payload `{ type: 'iterable-action-link', data: '{anything}' }`, to be consumed by the parent website as needed. These links also dismiss the message and invoke [trackInAppClose](#trackInAppClose) and [trackInAppClick](#trackInAppClick).
875
881
876
-
1.`iterable://dismiss` - Removes the in-app message from the screen, queues the next one for presentation, and invokes both [trackInAppClose](#trackInAppClose) and [trackInAppClick](#trackInAppClick)
877
-
2.`action://{anything}` - Makes a [`Window.prototype.postMessage`](https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage) call with the payload `{ type: 'iterable-action-link', data: '{anything}' }` that can be consumed by the parent website. It also dismisses the message and invokes both [trackInAppClose](#trackInAppClose) and [trackInAppClick](#trackInAppClick)
882
+
The SDK may reserve more keywords in the future.
878
883
879
-
Upon those, the SDK may reserve more keywords in the future.
884
+
:rotating_light:`iterable://` and `action://` links are not supported in the Safari web browser. In Safari, users can close an in-app message by clicking away from the message.
0 commit comments