-
Notifications
You must be signed in to change notification settings - Fork 416
Add code snippets for native-api-access-jsbridge #1066
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.
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
sushantsikka
wants to merge
1
commit into
main
Choose a base branch
from
sushantsikka/native-api-access-jsbridge-snippets
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
112 changes: 112 additions & 0 deletions
112
views/src/main/java/com/example/example/snippet/views/webapps/NativeApiAccessJsbridge.kt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,112 @@ | ||
| /* | ||
| * Copyright 2026 The Android Open Source Project | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package com.example.example.snippet.views.webapps | ||
|
|
||
| import android.content.Context | ||
| import android.webkit.WebResourceRequest | ||
| import android.webkit.WebResourceResponse | ||
| import android.webkit.WebView | ||
| import android.webkit.WebViewClient | ||
| import androidx.webkit.WebMessageCompat | ||
| import androidx.webkit.WebViewCompat | ||
| import androidx.webkit.WebViewFeature | ||
| import java.io.InputStream | ||
|
|
||
| private fun webMessageListenerSnippet(webView: WebView) { | ||
| // [START android_views_webapps_web_message_listener] | ||
| val myListener = WebViewCompat.WebMessageListener { _, _, _, _, replyProxy -> | ||
| // Handle the message from JS | ||
| replyProxy.postMessage("Acknowledged!") | ||
| } | ||
|
|
||
| // Check whether the WebView version supports the feature. | ||
| if (WebViewFeature.isFeatureSupported(WebViewFeature.WEB_MESSAGE_LISTENER)) { | ||
| val allowedOrigins = setOf("https://www.example.com") | ||
| WebViewCompat.addWebMessageListener(webView, "myObject", allowedOrigins, myListener) | ||
| } | ||
| // [END android_views_webapps_web_message_listener] | ||
| } | ||
|
|
||
| // [START android_views_webapps_web_message_binary] | ||
| fun setupWebView(webView: WebView) { | ||
| if (WebViewFeature.isFeatureSupported(WebViewFeature.WEB_MESSAGE_LISTENER)) { | ||
| val listener = WebViewCompat.WebMessageListener { view, message, sourceOrigin, isMainFrame, replyProxy -> | ||
|
|
||
| // Check if the received message is an ArrayBuffer | ||
| if (message.type == WebMessageCompat.TYPE_ARRAY_BUFFER) { | ||
| val binaryData: ByteArray = message.arrayBuffer | ||
| // Process your binary data (image, audio, etc.) | ||
| println("Received bytes: ${binaryData.size}") | ||
|
|
||
| // Optional: Send a binary reply back to JavaScript. | ||
| // This example sends a 3-byte array for simplicity. | ||
| if (WebViewFeature.isFeatureSupported(WebViewFeature.WEB_MESSAGE_ARRAY_BUFFER)) { | ||
| val replyBytes = byteArrayOf(0x01, 0x02, 0x03) | ||
| replyProxy.postMessage(replyBytes) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // "myBridge" matches the window.myBridge in JavaScript | ||
| WebViewCompat.addWebMessageListener( | ||
| webView, | ||
| "myBridge", | ||
| setOf("https://example.com"), // Security: restrict origins | ||
| listener | ||
| ) | ||
| } | ||
| } | ||
| // [END android_views_webapps_web_message_binary] | ||
|
|
||
| private fun shouldInterceptRequestSnippet(context: Context, webView: WebView) { | ||
| // [START android_views_webapps_intercept_request] | ||
| webView.webViewClient = object : WebViewClient() { | ||
| override fun shouldInterceptRequest( | ||
| view: WebView?, | ||
| request: WebResourceRequest? | ||
| ): WebResourceResponse? { | ||
| val url = request?.url ?: return null | ||
|
|
||
| // Check if this is our custom placeholder URL | ||
| if (url.host == "app.local" && url.path == "/data/large-file.bin") { | ||
| try { | ||
| // 1. Get your data as an InputStream | ||
| // (from Assets, Files, or a generated byte stream) | ||
| val inputStream: InputStream = context.assets.open("my_data.pb") | ||
|
|
||
| // 2. Define Response Headers (Crucial for CORS/Fetch) | ||
| val headers = mutableMapOf<String, String>() | ||
| headers["Access-Control-Allow-Origin"] = "*" // Allow fetch from any origin | ||
|
|
||
| // 3. Return the response | ||
| return WebResourceResponse( | ||
| "application/octet-stream", // MIME type (for example, image/jpeg) | ||
| "UTF-8", // Encoding | ||
| 200, // Status Code | ||
| "OK", // Reason Phrase | ||
| headers, // Custom Headers | ||
| inputStream // The actual data stream | ||
| ) | ||
| } catch (e: Exception) { | ||
| // Handle exception | ||
| } | ||
| } | ||
| return super.shouldInterceptRequest(view, request) | ||
| } | ||
| } | ||
| // [END android_views_webapps_intercept_request] | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would start this with
privatetoo for consistency.