Skip to content

docs: mark onNativeMessageReady as not invoked since 7.12.0 #887

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bschmalb-ksta wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

docs: mark onNativeMessageReady as not invoked since 7.12.0 #887

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions NATIVEMESSAGE_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,18 @@
# The Nativemessage

> **Note: this feature is currently not functional on Android.**
>
> Since **7.12.0**, when the SDK's internals moved to `mobile-core`, nothing in the library
> invokes `SpClient.onNativeMessageReady`. `SpConsentLibImpl` — the only class that called it —
> was removed, and `SpConsentLibMobileCore` renders every message through `SPConsentWebView`.
> `MessageType` has no native variant, so a property configured with a native message is
> rendered as a web message instead, with no callback and no error.
>
> The last release in which the callback was invoked is **7.11.2**. The equivalent iOS API,
> `onSPNativeMessageReady`, is unaffected.
>
> The rest of this guide is kept for reference and for anyone on 7.11.2 or earlier.

## Table of Contents
- [Intro](#intro)
- [Configure a property to use with the Nativemessage](#configure-a-property-to-use-with-the-nativemessage)
Expand Down
7 changes: 6 additions & 1 deletion cmplibrary/src/main/java/com/sourcepoint/cmplibrary/SpClient.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,13 @@ interface SpClient {
fun onUIReady(view: View)

/**
* It is invoked when the message is available to the client App
* It is invoked when the message is available to the client App.
*
* Currently this callback is disabled. Since 7.12.0 every message is rendered through
* `SPConsentWebView`, and no code path in the library reaches this callback. See
* NATIVEMESSAGE_GUIDE.md.
*/
@Deprecated("Currently this callback is disabled. Since 7.12.0 the SDK renders every message through SPConsentWebView and no code path reaches this callback. See NATIVEMESSAGE_GUIDE.md.")
fun onNativeMessageReady(message: MessageStructure, messageController: NativeMessageController) {}

@Deprecated("onMessageReady callback will be removed in favor of onMessageReady(message: MessageStructure, messageController: NativeMessageController). Currently this callback is disabled.")
Expand Down