Skip to content

Commit

Permalink
Prepare for 3.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
vbabenkoru committed Jun 10, 2019
1 parent adfce7d commit 65f009a
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 35 deletions.
49 changes: 17 additions & 32 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,20 @@ This project adheres to [Semantic Versioning](http://semver.org/).
#### Fixed
- nothing yet

## [3.1.0-beta4](https://github.com/Iterable/iterable-android-sdk/releases/tag/3.1.0-beta4)
## [3.1.0](https://github.com/Iterable/iterable-android-sdk/releases/tag/3.1.0)

#### Changed
- The scheme for actions handled by the SDK is now `iterable://`. `itbl://` links will keep working as custom actions (similar to `action://` URLs) for backwards compatibility, but `itbl://` namespace is deprecated in favor of `action://`.
#### Added
**BREAKING CHANGES**

## [3.1.0-beta3](https://github.com/Iterable/iterable-android-sdk/releases/tag/3.1.0-beta3)
The in-app messaging implementation has been significantly improved:

#### Changed
- Increased the number of in-app messages fetched from the server to 100
- Changed the visibility of `syncInApp` to package-private
* The SDK now maintains a local queue and keep it in sync with the server-side queue automatically
* Iterable servers now notify apps via silent push messages whenever the in-app message queue is updated
* In-app messages are shown by default whenever they arrive

Check the [In-app messages documentation](https://github.com/Iterable/iterable-android-sdk#in-app-messages) for more details.

## [3.1.0-beta2](https://github.com/Iterable/iterable-android-sdk/releases/tag/3.1.0-beta2)
Please refer to the [Migration guide](https://github.com/Iterable/iterable-android-sdk#migrating-in-app-messages-from-the-previous-version-of-the-sdk) if you've been using in-app messages in your app and updating a newer version of the SDK.

#### Changed
- **BREAKING CHANGE:** Added `IterableContext` argument to `IterableCustomActionHandler`
Expand All @@ -36,38 +38,21 @@ This project adheres to [Semantic Versioning](http://semver.org/).
boolean handleIterableCustomAction(IterableAction action, IterableActionContext actionContext)
```
`actionContext` can be used to determine where the call is calling from - push message, in-app message, or a deep link.
- Custom in-app JSON payload has been moved from `IterableInAppMessage.Content.payload` to `IterableInAppMessage.customPayload`
- The SDK now sets `notificationsEnabled` flag on the device to indicate whether notifications are enabled for the app
- Changes to in-app links:
- `action://` URL scheme is now reserved for app-specific custom actions.
When a user clicks on a link with `href` = `action://myCustomAction`, the SDK calls `IterableCustomActionHandler.handleIterableCustomAction` with action type set to `myCustomAction`.
- `itbl://` URL scheme is now reserved for actions handled by the SDK (i.e. future versions of the SDK may define `itbl://delete` as an action to delete the in-app message)
- `iterable://` URL scheme is now reserved for actions handled by the SDK (i.e. future versions of the SDK may define `iterable://delete` as an action to delete the in-app message)
- `itbl://` links will keep working as custom actions (similar to `action://` URLs) for backwards compatibility, but `itbl://` namespace is deprecated in favor of `action://`.
- **Migration:** if you've been using `itbl://` links in the past, please update your templates with `action://` instead
- Connect timeout for deeplink resolution is now 3 seconds

#### Fixed
- Fixed the URL parameter in `inAppClick` event

## [3.1.0-beta1](https://github.com/Iterable/iterable-android-sdk/releases/tag/3.1.0-beta1)

#### Added
**BREAKING CHANGES**

The in-app messaging implementation has been significantly improved:

* The SDK now maintains a local queue and keep it in sync with the server-side queue automatically
* Iterable servers now notify apps via silent push messages whenever the in-app message queue is updated
* In-app messages are shown by default whenever they arrive

Check the [In-app messages documentation](https://github.com/Iterable/iterable-android-sdk#in-app-messages) for more details.

Please refer to the [Migration guide](https://github.com/Iterable/iterable-android-sdk#migrating-in-app-messages-from-the-previous-version-of-the-sdk) if you've been using in-app messages in your app and updating a newer version of the SDK.

#### Changed
- The SDK now sets `notificationsEnabled` flag on the device to indicate whether notifications are enabled for the app
- Connect timeout for deeplink resolution is now 3 seconds

#### Removed
- `spawnInAppNotification` has been removed. Please refer to the in-app migration guide (above)

#### Fixed
- Fixed the URL parameter in `inAppClick` event

## [3.0.9](https://github.com/Iterable/iterable-android-sdk/releases/tag/3.0.9)
#### Changed
- The SDK now passes `preferUserId` flag to create a user by userId if it does not exist when using userId to identify the user
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Congratulations, you've configured your mobile application to receive push notif
Add the following dependencies to your application's **build.gradle**:

```groovy
compile 'com.iterable:iterableapi:3.0.9'
compile 'com.iterable:iterableapi:3.1.0'
compile 'com.google.firebase:firebase-messaging:X.X.X' // Min version 9.0.0
```

Expand Down
4 changes: 2 additions & 2 deletions iterableapi/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ android {
minSdkVersion 15
targetSdkVersion 27

buildConfigField "String", "ITERABLE_SDK_VERSION", "\"3.1.0-beta4\""
buildConfigField "String", "ITERABLE_SDK_VERSION", "\"3.1.0\""

testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
}
Expand Down Expand Up @@ -66,7 +66,7 @@ ext {
siteUrl = 'https://github.com/Iterable/iterable-android-sdk'
gitUrl = 'https://github.com/Iterable/iterable-android-sdk.git'

libraryVersion = '3.1.0-beta4'
libraryVersion = '3.1.0'

developerId = 'davidtruong'
developerName = 'David Truong'
Expand Down

0 comments on commit 65f009a

Please sign in to comment.