Changelog for PubNub Android SDK

Fixed

Added reading message type from fetch messages response.
Added random value 0.001-0.999s to delay between retries both for Linear and Exponential reconnection policies.

Fixed

Bring back compatibility with Android 6+ by removing the Jackson library dependency.

Added

Add error field to PNFileEventResult and set it in case of decryption failure.

Fixed

Handle unencrypted message in subscribe and history when crypto configured (error flag is set on message result).

Fixed

Updated the JSON lib to version 20231013.
Changed license type from MIT to PubNub Software Development Kit License.

Added	Add crypto module that allows configure SDK to encrypt and decrypt messages.
Fixed	Improved security of crypto implementation by adding enhanced AES-CBC cryptor.

Added

Added possibility to set state using heartbeat endpoint. .

Fixed

In case of error retry heartbeat call limited number of times.

Fixed

Upgraded json lib.

Fixed

Upgraded jackson-databind lib to remove security vulnerabilities.

Fixed

Remove deprecation for Grant Token methods.

Fixed

In case of an error response it checks if there's a body before reading from it.

Added	Added acceptance tests for ObjectsV2 feature. Added possibility to add status when setting ChannelMembers. Added status and type to query parameters for objectV2 REST calls. For membership and member only status.
Modified	Upgrade OkHttp lib to 4.9.3.

Added

PNFileEventResult has messageJson field with the same JsonElement type as in other events.

Added

Add support for spaces and users permissions in grantToken.
Add userId to PNConfiguration and deprecate uuid .

Fixed

Upgraded gson to 2.9.0 to make SDK working under Java 17.

Fixed

Do heartbeat and leave calls sequentially to prevent race condition between these two calls and 'phantom' join after leave.

Modified

BREAKING CHANGES: uuid is required parameter in PNConfiguration constructor.

Added

Add revoke token feature.

Fixed

Emit PNReconnectedCategory in case of successful manual reconnection.

Fixed

Eviction of OkHttp connection pool after reestablishing connection (affects transactional calls).

Fixed

Reconnect always restarts the subscription connection.

Added	Acceptance tests plugged into CI pipeline.
Fixed	Meta field exposed correctly in PNToken class.

Added

Extend grantToken method to enable control of Objects API permission. Enhance granularity of permission control to enable permissions per UUID.

Fixed

Update Jackson libraries to avoid known vulnerabilities.

Added	Method grantToken has beed added. It allows generation of signed token with permissions for channels and channel groups.
Fixed	UUID is now exposed as PNMembership field which make is accessible from PNMembershipResult argument of SubscribeCallback.membership() method.

Added	Now random initialisation vector used when encryption enabled is now default behaviour.
Fixed	There were some non daemon threads running in background preventing VM from exiting. Now they are daemon threads.

Added

New way of controlling Presence by Heartbeat calls for purpose of usage with dedicated server configuration (ACL). This feature can be used only with additional support from PubNub.

Fixed

Improved handling of random initialization vector for encrypting messages.
Restore Android compatibility for Gradle 3.X by removing Stringjoin().
Return appropriate error information when payload is too large.

Fixed

To improve security of messages, added support for random initialization vector to encrypt and decrypt messages.

Fixed

PubNubException now overrides Throwable's getMessage so the status.errorData.throwablemessage can be properly set.

Added

Objects (v2) API exposed to enable metadata management.
Enable Objects (v2) related permissions management via Grant method.

Fixed

Fix for subscription loop to prevent unexpected disconnections caused by unhandled HTTP statuses.

Added

Allows to upload files to channels, download them with optional encryption support.

Fixed

Fix typo in suppressLeaveEvents in PNConfiguration.

Added

Add "click_action" parameter to PushPayloadHelper in order to pass it to FCM.

Fixed

Fix OkHttp reconnection policy

Added	Implemented Objects Filtering API
Modified	Handled more network events to keep the client subscribed Improved interaction with classes from org.json* Made PNCallback eligible for SAM/lambda conversion Deprecated PNPushType.GCM in favor of PNPushType.FCM

Added

Add support for APNS2 Push API
Add a utility class to ease creating push payloads

Modified

Disable OkHttp reconnection policy

Modified

Made the SDK more Kotlin-friendly
Categorized cancelled requests as such
Removed the 'audit' method

Added

Implemented Message Actions API
Added 'includeMeta' to history()
Added 'includeMeta' to fetchMessages()
Added 'includeMessageActions' to fetchMessages()

Added

Add PAMv3 support
Implement TMS (Token Manager)
Upgrade PAM endpoints to v2
Introduce delete permission for grant

Added

Add Objects API support

Added

Introduce serialization class for Signals API

Added	Add Signals support
Fixed	Expose OkHttp logging interceptor library

Fixed	Enable app level grants Custom encode auth key where it's not encoded automatically
Added	Move state param from heartbeat to subscribe calls

Added

Enforce a minimum presence timeout value
Disable presence heartbeats by default

Fixed

Fix reconnection issues by allowing it solely for network issues

Added

Introduce Message Count API
Update 3rd party libraries

Added

Update 3rd party libraries

Added

Support optional query parameters for every request
Update documentation

Fixed

Fix an issue where the global-here-now response was interpreted incorrectly

Fixed

Fix an issue where end of channel history was interpreted as an error

Modified

lock down OkHttp version to support latest android version

Modified

allow SDK to only send heartbeats without subscribing to the data channel.

Modified

allow setting setMaximumConnections to open more connections to PubNub

Modified	update gson dependency
Fixed	make listeners thread safe close hanging threads on shutdown

Modified

add support to suppress leave events

Modified

do not execute subscribe on empty string channel, channel groups
stop heartbeat loop if an error shows up.

Fixed	fix worker thread unloading.
Added	prevent concurrent modification of listeners.

Fixed

fix retrofit unloading.

Added

rework the loading of services to load the classes once.

Added

patch-up to the deduping algorithm

Added

Internal deduping mechanism when devices cross regions (dedupOnSubscribe).

Added

Allow certificate pinning via setCertificatePinner on PNConfiguration
Allow disabling of heartbeat by setting the interval to 0.
GAE fixes.

Added

Allow injection of httpLoggingInterceptor for extra logging monitoring..

Fixed

adjust queue exceeded notifications to be greater or equal of.

Fixed

gracefully handle disabled history

Added

on interval events, pass hereNowRefresh to indicate if a here_now fetch is needed.

Added

set a name for Subscription Manager Consumer Thead.

Fixed	SDK crash in Android with Airplane Mode
Added	add deltas on interval action.

Added	To distinguish UUID's that were generated by our SDK, we appended `pn-` before the UUID to signal that it's a randomly generated UUID. Allow the passing of OkHttp connection spec via setConnectionSpec
Modified	Bump retrofit to 2.2.0

Added

add .toString methods to all public facing models and POJOs

Added

Add support to configure host name verifier.

Added

Add support to configure custom certificate pinning via SSLSocketFactory and X509 configuration objects.

Fixed

SDK was not sending the user metadata on Message Callback

Fixed

SDK did not honor the exhaustion of reconnections, it will now disconnect once max retries happened

Modified

Support for maximum reconnection attempts
Populate affectedChannel and affectedChannelGroups
Support for GAE
Emit pnconnected when adding / removing channels.

Modified

support for key-level grant.

Modified

JSON parser is switched to GSON, new artifact on nexus as pubnub-gson
GetState, setState return a JsonElement instead of a plain object.

Modified

Swapping out logger for SLF4J API and removing final methods

Modified

remove final identifiers from the public facing API.

Modified

include publisher UUID on incoming message
allow to set custom TTL on a publish

Modified

Signatures are generated for all requests with secret key to ensure secure transmission of data
support for alerting of queue exceeded (PNRequestMessageCountExceededCategory)
signaling to OkHttp to stop the queues on termination.

Modified

destroy now correctly forces the producer thread to shut down; stop is now deprecated for disconnect
support for sending instance id for presence detection (disabled by default)
support for sending request id to burst cache (enabled by default)
proxy support via the native proxy configurator class.

Modified

on PAM error, populate the affectedChannel or affectedChannelGroup to signal which channels are failing

Modified

populate jso with the error.

Fixed

fixing parsing of origination payload within the psv2 envelope

Modified

bumping build process for gradle 3 / merging documentation into the repo and test adjustments

Modified

adding channel / channelGroup fields when a message / presence event comes in.

Modified

adjustments for handling pn_other and decryption
retrofit version bumps.

Added

added unsubscribeAll, getSubscribedChannels, getSubscribedChannelGroups
SDK will establish secure connections by default
added support for exponential backoff reconnection policies

Modified

reduce overlap on error handling when returning exceptions.

Modified

send heartbeat presence value when subscribing

Modified

unified retrofit handling to lower amount of instances and sync'd the state methods.

Fixed

setting State for other UUID's is now supported.

Added

fire() method and no-replication options.

Fixed

fix to the version fetching.

Fixed

adjustment of the subscribe loop to alleviate duplicate dispatches.

Fixed

first GA.

Modified

reconnects and minor adjustments.

Fixed

fixing state not coming on the subscriber callback.
adjustments to URL encoding on publish, subscribe, set-state operations to avoid double encoding with retrofit.

Modified

reworking of message queue.
checkstyle, findbugs.
reworking error notifications.

Modified

initial beta1.

v6.4.5

v6.4.4

v6.4.3

v6.4.2

v6.4.1

v6.4.0

v6.3.6

v6.3.5

v6.3.4

v6.3.3

v6.3.2

v6.3.1

v6.3.0

v6.2.0

v6.1.0

v6.0.2

v6.0.1

v6.0.0

v5.3.0

v5.2.4

v5.2.3

v5.2.2

v5.2.1

v5.2.0

v5.1.1

v5.1.0

v5.0.0

v4.36.0

v4.33.3

v4.33.2

v4.33.1

v4.33.0

v4.32.1

v4.32.0

v4.31.3

v4.31.2

v4.31.1

v4.31.0

v4.30.0

v4.29.2

v4.29.1

v4.29.0

v4.28.0

v4.27.0

v4.26.1

v4.26.0

v4.25.0

v4.24.0

v4.23.0

v4.22.0

v4.22.0-beta

v4.21.0

v4.20.0

v4.19.0

v4.18.0

v4.17.0

v4.16.0

v4.15.0

v4.14.0

v4.13.0

v4.12.0

v4.11.0

v4.10.0

v4.9.1

v4.9.0

v4.8.0

v4.7.0

v4.6.5

v4.6.4

v4.6.3

v4.6.2

v4.6.1

v4.6.0

v4.5.0

v4.4.4

v4.4.3

v4.4.2

v4.4.1

v4.4.0

v4.3.1