Skip to content

Commit 98d80aa

Browse files
author
Brad Umbaugh
authored
README updates: Safari + custom links, inAppDelete events, closing message on Safari (#176)
* Safari * A few clarifications * Note about deletes * Fixing incorrect language about Safari
1 parent 221a5b1 commit 98d80aa

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

README.md

+9-4
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,8 @@ Below are the methods this SDK exposes. See [Iterable's API Docs](https://api.it
5858
| [`updateUser`](#updateUser) | Change data on a user's profile or create a user if none exists |
5959
| [`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) |
6060

61+
The SDK does not track `inAppDelete` events.
62+
6163
: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.
6264

6365
# Usage
@@ -871,12 +873,15 @@ https://hello.com
871873

872874
## Reserved Keyword Links
873875

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

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.
878883

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.
880885

881886
## Routing in Single-Page Apps
882887

0 commit comments

Comments
 (0)