Skip to content

Commit 0179df9

Browse files
committed
Revised changelog
1 parent ec066e3 commit 0179df9

File tree

1 file changed

+42
-12
lines changed

1 file changed

+42
-12
lines changed

CHANGELOG.md

+42-12
Original file line numberDiff line numberDiff line change
@@ -16,23 +16,53 @@ This project adheres to [Semantic Versioning](http://semver.org/).
1616
- nothing yet
1717

1818
## [3.4.11](https://github.com/Iterable/iterable-android-sdk/releases/tag/3.4.11)
19+
1920
#### Added
20-
- Custom Push Notification Sounds!
21-
You can now customize the sound that plays when users receive push notifications.
22-
To use a custom sound, simply add a sound file to your app's `res` folder and use the same filename when sending the push notification.
23-
- `getEmail()`, `getUserId()`, and `getAuthToken()` methods are now available to access email, userId, and authToken associated with a user account, respectively.
21+
22+
- Custom push notification sounds! To play a custom sound for a push notification, add a sound file
23+
to your app's `res/raw` folder and specify that same filename when setting up a template in
24+
Iterable.
25+
26+
Some important notes about custom sounds and notification channels:
27+
28+
- Android API level 26
29+
introduced [notification channels](https://developer.android.com/develop/ui/views/notifications/channels)
30+
. Every notification must be assigned to a channel.
31+
- Each custom sound you add to an Iterable template creates a new Android notification channel.
32+
The notification channel's name matches the filename of the sound (without its extension).
33+
- To ensure sensible notification channel names for end users, give friendly names to your sound
34+
files. For example, a custom sound file with name `Paid.mp3` creates a notification channel
35+
called `Paid`. The end user can see this notification channel name in their device's
36+
notification channel settings.
37+
- Be sure to place the corresponding sound file in your app's `res/raw` directory.
38+
39+
- To help you access a user's `email` address, `userId`, and `authToken`, the SDK now provides
40+
convenience methods: `getEmail()`, `getUserId()`, and `getAuthToken()`.
2441

2542
#### Changed
26-
- Updated Security Crypto Library and Improved EncryptedSharedPreference Handling
27-
The androidx security crypto library has been updated from version `1.0.0` to `1.1.0-alpha04` to address a known issue causing crashes when creating `EncryptedSharedPreference`.
28-
To prevent these crashes, the SDK now uses unencrypted `SharedPreference` as a fallback if `EncryptedSharedPreference` cannot be created.
29-
However, if your app requires stronger encryption, you can set the `encryptionEnforced` configuration flag to true to enforce encryption and prevent the fallback mechanism from being used.
30-
Please note that enabling this flag will throw an exception if `EncryptedSharedPreference` cannot be created. This enhancement ensures better data security for your users.
31-
- Improved the JWT token management to address issues where null values could prevent the token from being refreshed.
43+
44+
- Updated the [Security library](https://developer.android.com/topic/security/data) and
45+
improved `EncryptedSharedPreferences` handling.
46+
47+
To work around a [known Android issue](https://issuetracker.google.com/issues/164901843) that can
48+
cause crashes when creating `EncryptedSharedPreferences`, we've
49+
upgraded `androidx.security.crypto` from version `1.0.0` to `1.1.0-alpha04`.
50+
When `EncryptedSharedPreferences` cannot be created, the SDK now uses `SharedPreferences` (
51+
unencrypted).
52+
53+
If your app requires encryption, you can prevent this fallback to `SharedPreferences` by setting
54+
the `encryptionEnforced` configuration flag to `true`. However, if you enable this flag
55+
and `EncryptedSharedPreferences` cannot be created, an exception will be thrown.
56+
57+
- Improved JWT token management. This change addresses an issue where `null` values could prevent
58+
the refresh of a JWT token.
3259

3360
#### Fixed
34-
- In-apps with larger HTMLs don't shrink and appear more consistent across platforms.
35-
- Fixed crashes occurring due to in-app animation transitions.
61+
62+
- Fixed an issue which could prevent in-app messages from respecting the **Position** value selected
63+
when setting up the template (top / center / bottom / full).
64+
65+
- Fixed crashes that sometimes happened during in-app message animations.
3666

3767
## [3.4.10](https://github.com/Iterable/iterable-android-sdk/releases/tag/3.4.10)
3868
This release includes support for encrypting some data at rest, and an option to

0 commit comments

Comments
 (0)