当前位置:   article > 正文

鸿蒙Harmony应用开发—ArkTS声明式开发(基础手势:Web)中篇_鸿蒙artks的function怎么用

鸿蒙artks的function怎么用

onBeforeUnload

onBeforeUnload(callback: (event?: { url: string; message: string; result: JsResult }) => boolean)

刷新或关闭场景下,在即将离开当前页面时触发此回调。刷新或关闭当前页面应先通过点击等方式获取焦点,才会触发此回调。

参数:

参数名参数类型参数描述
urlstring当前显示弹窗所在网页的URL。
messagestring弹窗中显示的信息。
resultJsResult通知Web组件用户操作行为。

返回值:

类型说明
boolean当回调返回true时,应用可以调用系统弹窗能力(包括确认和取消),并且需要根据用户的确认或取消操作调用JsResult通知Web组件最终是否离开当前页面。当回调返回false时,函数中绘制的自定义弹窗无效。

示例:

  1. // xxx.ets
  2. import web_webview from '@ohos.web.webview'
  3. @Entry
  4. @Component
  5. struct WebComponent {
  6. controller: web_webview.WebviewController = new web_webview.WebviewController()
  7. build() {
  8. Column() {
  9. Web({ src: $rawfile("index.html"), controller: this.controller })
  10. .onBeforeUnload((event) => {
  11. if (event) {
  12. console.log("event.url:" + event.url)
  13. console.log("event.message:" + event.message)
  14. AlertDialog.show({
  15. title: 'onBeforeUnload',
  16. message: 'text',
  17. primaryButton: {
  18. value: 'cancel',
  19. action: () => {
  20. event.result.handleCancel()
  21. }
  22. },
  23. secondaryButton: {
  24. value: 'ok',
  25. action: () => {
  26. event.result.handleConfirm()
  27. }
  28. },
  29. cancel: () => {
  30. event.result.handleCancel()
  31. }
  32. })
  33. }
  34. return true
  35. })
  36. }
  37. }
  38. }

加载的html文件。

  1. <!--index.html-->
  2. <!DOCTYPE html>
  3. <html>
  4. <head>
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0" charset="utf-8">
  6. </head>
  7. <body onbeforeunload="return myFunction()">
  8. <h1>WebView onBeforeUnload Demo</h1>
  9. <a href="https://www.example.com">Click here</a>
  10. <script>
  11. function myFunction() {
  12. return "onBeforeUnload Event";
  13. }
  14. </script>
  15. </body>
  16. </html>

onConfirm

onConfirm(callback: (event?: { url: string; message: string; result: JsResult }) => boolean)

网页调用confirm()告警时触发此回调。

参数:

参数名参数类型参数描述
urlstring当前显示弹窗所在网页的URL。
messagestring弹窗中显示的信息。
resultJsResult通知Web组件用户操作行为。

返回值:

类型说明
boolean当回调返回true时,应用可以调用系统弹窗能力(包括确认和取消),并且需要根据用户的确认或取消操作调用JsResult通知Web组件。当回调返回false时,函数中绘制的自定义弹窗无效。

示例:

  1. // xxx.ets
  2. import web_webview from '@ohos.web.webview'
  3. @Entry
  4. @Component
  5. struct WebComponent {
  6. controller: web_webview.WebviewController = new web_webview.WebviewController()
  7. build() {
  8. Column() {
  9. Web({ src: $rawfile("index.html"), controller: this.controller })
  10. .onConfirm((event) => {
  11. if (event) {
  12. console.log("event.url:" + event.url)
  13. console.log("event.message:" + event.message)
  14. AlertDialog.show({
  15. title: 'onConfirm',
  16. message: 'text',
  17. primaryButton: {
  18. value: 'cancel',
  19. action: () => {
  20. event.result.handleCancel()
  21. }
  22. },
  23. secondaryButton: {
  24. value: 'ok',
  25. action: () => {
  26. event.result.handleConfirm()
  27. }
  28. },
  29. cancel: () => {
  30. event.result.handleCancel()
  31. }
  32. })
  33. }
  34. return true
  35. })
  36. }
  37. }
  38. }

加载的html文件。

  1. <!--index.html-->
  2. <!DOCTYPE html>
  3. <html>
  4. <head>
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0" charset="utf-8">
  6. </head>
  7. <body>
  8. <h1>WebView onConfirm Demo</h1>
  9. <button onclick="myFunction()">Click here</button>
  10. <p id="demo"></p>
  11. <script>
  12. function myFunction() {
  13. let x;
  14. let r = confirm("click button!");
  15. if (r == true) {
  16. x = "ok";
  17. } else {
  18. x = "cancel";
  19. }
  20. document.getElementById("demo").innerHTML = x;
  21. }
  22. </script>
  23. </body>
  24. </html>

onPrompt9+

onPrompt(callback: (event?: { url: string; message: string; value: string; result: JsResult }) => boolean)

网页调用prompt()告警时触发此回调。

参数:

参数名参数类型参数描述
urlstring当前显示弹窗所在网页的URL。
messagestring弹窗中显示的信息。
resultJsResult通知Web组件用户操作行为。

返回值:

类型说明
boolean当回调返回true时,应用可以调用系统弹窗能力(包括确认和取消),并且需要根据用户的确认或取消操作调用JsResult通知Web组件。当回调返回false时,函数中绘制的自定义弹窗无效。

示例:

  1. // xxx.ets
  2. import web_webview from '@ohos.web.webview'
  3. @Entry
  4. @Component
  5. struct WebComponent {
  6. controller: web_webview.WebviewController = new web_webview.WebviewController()
  7. build() {
  8. Column() {
  9. Web({ src: $rawfile("index.html"), controller: this.controller })
  10. .onPrompt((event) => {
  11. if (event) {
  12. console.log("url:" + event.url)
  13. console.log("message:" + event.message)
  14. console.log("value:" + event.value)
  15. AlertDialog.show({
  16. title: 'onPrompt',
  17. message: 'text',
  18. primaryButton: {
  19. value: 'cancel',
  20. action: () => {
  21. event.result.handleCancel()
  22. }
  23. },
  24. secondaryButton: {
  25. value: 'ok',
  26. action: () => {
  27. event.result.handlePromptConfirm(event.value)
  28. }
  29. },
  30. cancel: () => {
  31. event.result.handleCancel()
  32. }
  33. })
  34. }
  35. return true
  36. })
  37. }
  38. }
  39. }

加载的html文件。

  1. <!--index.html-->
  2. <!DOCTYPE html>
  3. <html>
  4. <head>
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0" charset="utf-8">
  6. </head>
  7. <body>
  8. <h1>WebView onPrompt Demo</h1>
  9. <button onclick="myFunction()">Click here</button>
  10. <p id="demo"></p>
  11. <script>
  12. function myFunction() {
  13. let message = prompt("Message info", "Hello World");
  14. if (message != null && message != "") {
  15. document.getElementById("demo").innerHTML = message;
  16. }
  17. }
  18. </script>
  19. </body>
  20. </html>

onConsole

onConsole(callback: (event?: { message: ConsoleMessage }) => boolean)

通知宿主应用JavaScript console消息。

参数:

参数名参数类型参数描述
messageConsoleMessage触发的控制台信息。

返回值:

类型说明
boolean当返回true时,该条消息将不会再打印至控制台,反之仍会打印至控制台。

示例:

  1. // xxx.ets
  2. import web_webview from '@ohos.web.webview'
  3. @Entry
  4. @Component
  5. struct WebComponent {
  6. controller: web_webview.WebviewController = new web_webview.WebviewController()
  7. build() {
  8. Column() {
  9. Web({ src: 'www.example.com', controller: this.controller })
  10. .onConsole((event) => {
  11. if (event) {
  12. console.log('getMessage:' + event.message.getMessage())
  13. console.log('getSourceId:' + event.message.getSourceId())
  14. console.log('getLineNumber:' + event.message.getLineNumber())
  15. console.log('getMessageLevel:' + event.message.getMessageLevel())
  16. }
  17. return false
  18. })
  19. }
  20. }
  21. }

onDownloadStart

onDownloadStart(callback: (event?: { url: string, userAgent: string, contentDisposition: string, mimetype: string, contentLength: number }) => void)

通知主应用开始下载一个文件。

参数:

参数名参数类型参数描述
urlstring文件下载的URL。
userAgentstring用于下载的用户代理。
contentDispositionstring服务器返回的 Content-Disposition响应头,可能为空。
mimetypestring服务器返回内容媒体类型(MIME)信息。
contentLengthnumber服务器返回文件的长度。

示例:

  1. // xxx.ets
  2. import web_webview from '@ohos.web.webview'
  3. @Entry
  4. @Component
  5. struct WebComponent {
  6. controller: web_webview.WebviewController = new web_webview.WebviewController()
  7. build() {
  8. Column() {
  9. Web({ src: 'www.example.com', controller: this.controller })
  10. .onDownloadStart((event) => {
  11. if (event) {
  12. console.log('url:' + event.url)
  13. console.log('userAgent:' + event.userAgent)
  14. console.log('contentDisposition:' + event.contentDisposition)
  15. console.log('contentLength:' + event.contentLength)
  16. console.log('mimetype:' + event.mimetype)
  17. }
  18. })
  19. }
  20. }
  21. }

onErrorReceive

onErrorReceive(callback: (event?: { request: WebResourceRequest, error: WebResourceError }) => void)

网页加载遇到错误时触发该回调。出于性能考虑,建议此回调中尽量执行简单逻辑。在无网络的情况下,触发此回调。

参数:

参数名参数类型参数描述
requestWebResourceRequest网页请求的封装信息。
errorWebResourceError网页加载资源错误的封装信息 。

示例:

  1. // xxx.ets
  2. import web_webview from '@ohos.web.webview'
  3. @Entry
  4. @Component
  5. struct WebComponent {
  6. controller: web_webview.WebviewController = new web_webview.WebviewController()
  7. build() {
  8. Column() {
  9. Web({ src: 'www.example.com', controller: this.controller })
  10. .onErrorReceive((event) => {
  11. if (event) {
  12. console.log('getErrorInfo:' + event.error.getErrorInfo())
  13. console.log('getErrorCode:' + event.error.getErrorCode())
  14. console.log('url:' + event.request.getRequestUrl())
  15. console.log('isMainFrame:' + event.request.isMainFrame())
  16. console.log('isRedirect:' + event.request.isRedirect())
  17. console.log('isRequestGesture:' + event.request.isRequestGesture())
  18. console.log('getRequestHeader_headerKey:' + event.request.getRequestHeader().toString())
  19. let result = event.request.getRequestHeader()
  20. console.log('The request header result size is ' + result.length)
  21. for (let i of result) {
  22. console.log('The request header key is : ' + i.headerKey + ', value is : ' + i.headerValue)
  23. }
  24. }
  25. })
  26. }
  27. }
  28. }

onHttpErrorReceive

onHttpErrorReceive(callback: (event?: { request: WebResourceRequest, response: WebResourceResponse }) => void)

网页加载资源遇到的HTTP错误(响应码>=400)时触发该回调。

参数:

参数名参数类型参数描述
requestWebResourceRequest网页请求的封装信息。
responseWebResourceResponse资源响应的封装信息。

示例:

  1. // xxx.ets
  2. import web_webview from '@ohos.web.webview'
  3. @Entry
  4. @Component
  5. struct WebComponent {
  6. controller: web_webview.WebviewController = new web_webview.WebviewController()
  7. build() {
  8. Column() {
  9. Web({ src: 'www.example.com', controller: this.controller })
  10. .onHttpErrorReceive((event) => {
  11. if (event) {
  12. console.log('url:' + event.request.getRequestUrl())
  13. console.log('isMainFrame:' + event.request.isMainFrame())
  14. console.log('isRedirect:' + event.request.isRedirect())
  15. console.log('isRequestGesture:' + event.request.isRequestGesture())
  16. console.log('getResponseData:' + event.response.getResponseData())
  17. console.log('getResponseEncoding:' + event.response.getResponseEncoding())
  18. console.log('getResponseMimeType:' + event.response.getResponseMimeType())
  19. console.log('getResponseCode:' + event.response.getResponseCode())
  20. console.log('getReasonMessage:' + event.response.getReasonMessage())
  21. let result = event.request.getRequestHeader()
  22. console.log('The request header result size is ' + result.length)
  23. for (let i of result) {
  24. console.log('The request header key is : ' + i.headerKey + ' , value is : ' + i.headerValue)
  25. }
  26. let resph = event.response.getResponseHeader()
  27. console.log('The response header result size is ' + resph.length)
  28. for (let i of resph) {
  29. console.log('The response header key is : ' + i.headerKey + ' , value is : ' + i.headerValue)
  30. }
  31. }
  32. })
  33. }
  34. }
  35. }

onPageBegin

onPageBegin(callback: (event?: { url: string }) => void)

网页开始加载时触发该回调,且只在主frame触发,iframe或者frameset的内容加载时不会触发此回调。

参数:

参数名参数类型参数描述
urlstring页面的URL地址。

示例:

  1. // xxx.ets
  2. import web_webview from '@ohos.web.webview'
  3. @Entry
  4. @Component
  5. struct WebComponent {
  6. controller: web_webview.WebviewController = new web_webview.WebviewController()
  7. build() {
  8. Column() {
  9. Web({ src: 'www.example.com', controller: this.controller })
  10. .onPageBegin((event) => {
  11. if (event) {
  12. console.log('url:' + event.url)
  13. }
  14. })
  15. }
  16. }
  17. }

onPageEnd

onPageEnd(callback: (event?: { url: string }) => void)

网页加载完成时触发该回调,且只在主frame触发。

参数:

参数名参数类型参数描述
urlstring页面的URL地址。

示例:

  1. // xxx.ets
  2. import web_webview from '@ohos.web.webview'
  3. @Entry
  4. @Component
  5. struct WebComponent {
  6. controller: web_webview.WebviewController = new web_webview.WebviewController()
  7. build() {
  8. Column() {
  9. Web({ src: 'www.example.com', controller: this.controller })
  10. .onPageEnd((event) => {
  11. if (event) {
  12. console.log('url:' + event.url)
  13. }
  14. })
  15. }
  16. }
  17. }

onProgressChange

onProgressChange(callback: (event?: { newProgress: number }) => void)

网页加载进度变化时触发该回调。

参数:

参数名参数类型参数描述
newProgressnumber新的加载进度,取值范围为0到100的整数。

示例:

  1. // xxx.ets
  2. import web_webview from '@ohos.web.webview'
  3. @Entry
  4. @Component
  5. struct WebComponent {
  6. controller: web_webview.WebviewController = new web_webview.WebviewController()
  7. build() {
  8. Column() {
  9. Web({ src: 'www.example.com', controller: this.controller })
  10. .onProgressChange((event) => {
  11. if (event) {
  12. console.log('newProgress:' + event.newProgress)
  13. }
  14. })
  15. }
  16. }
  17. }

onTitleReceive

onTitleReceive(callback: (event?: { title: string }) => void)

网页document标题更改时触发该回调。

参数:

参数名参数类型参数描述
titlestringdocument标题内容。

示例:

  1. // xxx.ets
  2. import web_webview from '@ohos.web.webview'
  3. @Entry
  4. @Component
  5. struct WebComponent {
  6. controller: web_webview.WebviewController = new web_webview.WebviewController()
  7. build() {
  8. Column() {
  9. Web({ src: 'www.example.com', controller: this.controller })
  10. .onTitleReceive((event) => {
  11. if (event) {
  12. console.log('title:' + event.title)
  13. }
  14. })
  15. }
  16. }
  17. }

onRefreshAccessedHistory

onRefreshAccessedHistory(callback: (event?: { url: string, isRefreshed: boolean }) => void)

加载网页页面完成时触发该回调,用于应用更新其访问的历史链接。

参数:

参数名参数类型参数描述
urlstring访问的url。
isRefreshedbooleantrue表示该页面是被重新加载的(调用refresh9+接口),false表示该页面是新加载的。

示例:

  1. // xxx.ets
  2. import web_webview from '@ohos.web.webview'
  3. @Entry
  4. @Component
  5. struct WebComponent {
  6. controller: web_webview.WebviewController = new web_webview.WebviewController()
  7. build() {
  8. Column() {
  9. Web({ src: 'www.example.com', controller: this.controller })
  10. .onRefreshAccessedHistory((event) => {
  11. if (event) {
  12. console.log('url:' + event.url + ' isReload:' + event.isRefreshed)
  13. }
  14. })
  15. }
  16. }
  17. }

onSslErrorReceive(deprecated)

onSslErrorReceive(callback: (event?: { handler: Function, error: object }) => void)

通知用户加载资源时发生SSL错误。

说明:

从API version 8开始支持,从API version 9开始废弃。建议使用onSslErrorEventReceive9+替代。

onFileSelectorShow(deprecated)

onFileSelectorShow(callback: (event?: { callback: Function, fileSelector: object }) => void)

调用此函数以处理具有“文件”输入类型的HTML表单,以响应用户按下的“选择文件”按钮。

说明:

从API version 8开始支持,从API version 9开始废弃。建议使用onShowFileSelector9+替代。

onRenderExited9+

onRenderExited(callback: (event?: { renderExitReason: RenderExitReason }) => void)

应用渲染进程异常退出时触发该回调。

参数:

参数名参数类型参数描述
renderExitReasonRenderExitReason渲染进程异常退出的具体原因。

示例:

  1. // xxx.ets
  2. import web_webview from '@ohos.web.webview'
  3. @Entry
  4. @Component
  5. struct WebComponent {
  6. controller: web_webview.WebviewController = new web_webview.WebviewController()
  7. build() {
  8. Column() {
  9. Web({ src: 'chrome://crash/', controller: this.controller })
  10. .onRenderExited((event) => {
  11. if (event) {
  12. console.log('reason:' + event.renderExitReason)
  13. }
  14. })
  15. }
  16. }
  17. }

onShowFileSelector9+

onShowFileSelector(callback: (event?: { result: FileSelectorResult, fileSelector: FileSelectorParam }) => boolean)

调用此函数以处理具有“文件”输入类型的HTML表单,以响应用户按下的“选择文件”按钮。

参数:

参数名参数类型参数描述
resultFileSelectorResult用于通知Web组件文件选择的结果。
fileSelectorFileSelectorParam文件选择器的相关信息。

返回值:

类型说明
boolean当返回值为true时,用户可以调用系统提供的弹窗能力。当回调返回false时,函数中绘制的自定义弹窗无效。

示例:

  1. // xxx.ets
  2. import web_webview from '@ohos.web.webview';
  3. import picker from '@ohos.file.picker';
  4. import { BusinessError } from '@ohos.base';
  5. @Entry
  6. @Component
  7. struct WebComponent {
  8. controller: web_webview.WebviewController = new web_webview.WebviewController()
  9. build() {
  10. Column() {
  11. Web({ src: $rawfile('index.html'), controller: this.controller })
  12. .onShowFileSelector((event) => {
  13. console.log('MyFileUploader onShowFileSelector invoked')
  14. const documentSelectOptions = new picker.DocumentSelectOptions();
  15. let uri: string | null = null;
  16. const documentViewPicker = new picker.DocumentViewPicker();
  17. documentViewPicker.select(documentSelectOptions).then((documentSelectResult) => {
  18. uri = documentSelectResult[0];
  19. console.info('documentViewPicker.select to file succeed and uri is:' + uri);
  20. if (event) {
  21. event.result.handleFileList([uri]);
  22. }
  23. }).catch((err: BusinessError) => {
  24. console.error(`Invoke documentViewPicker.select failed, code is ${err.code}, message is ${err.message}`);
  25. })
  26. return true
  27. })
  28. }
  29. }
  30. }

加载的html文件。

  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta name="viewport" content="width=device-width, initial-scale=1.0" charset="utf-8">
  5. </head>
  6. <body>
  7. <form id="upload-form" enctype="multipart/form-data">
  8. <input type="file" id="upload" name="upload"/>
  9. </form>
  10. </body>
  11. </html>

onResourceLoad9+

onResourceLoad(callback: (event: {url: string}) => void)

通知Web组件所加载的资源文件url信息。

参数:

参数名参数类型参数描述
urlstring所加载的资源文件url信息。

示例:

  1. // xxx.ets
  2. import web_webview from '@ohos.web.webview'
  3. @Entry
  4. @Component
  5. struct WebComponent {
  6. controller: web_webview.WebviewController = new web_webview.WebviewController()
  7. build() {
  8. Column() {
  9. Web({ src: 'www.example.com', controller: this.controller })
  10. .onResourceLoad((event) => {
  11. console.log('onResourceLoad: ' + event.url)
  12. })
  13. }
  14. }
  15. }

onScaleChange9+

onScaleChange(callback: (event: {oldScale: number, newScale: number}) => void)

当前页面显示比例的变化时触发该回调。

参数:

参数名参数类型参数描述
oldScalenumber变化前的显示比例百分比。
newScalenumber变化后的显示比例百分比。

示例:

  1. // xxx.ets
  2. import web_webview from '@ohos.web.webview'
  3. @Entry
  4. @Component
  5. struct WebComponent {
  6. controller: web_webview.WebviewController = new web_webview.WebviewController()
  7. build() {
  8. Column() {
  9. Web({ src: 'www.example.com', controller: this.controller })
  10. .onScaleChange((event) => {
  11. console.log('onScaleChange changed from ' + event.oldScale + ' to ' + event.newScale)
  12. })
  13. }
  14. }
  15. }

onUrlLoadIntercept(deprecated)

onUrlLoadIntercept(callback: (event?: { data:string | WebResourceRequest }) => boolean)

当Web组件加载url之前触发该回调,用于判断是否阻止此次访问。默认允许加载。 从API version 10开始不再维护,建议使用onLoadIntercept10+代替。

参数:

参数名参数类型参数描述
datastring | WebResourceRequesturl的相关信息。

返回值:

类型说明
boolean返回true表示阻止此次加载,否则允许此次加载。

示例:

  1. // xxx.ets
  2. import web_webview from '@ohos.web.webview'
  3. @Entry
  4. @Component
  5. struct WebComponent {
  6. controller: web_webview.WebviewController = new web_webview.WebviewController()
  7. build() {
  8. Column() {
  9. Web({ src: 'www.example.com', controller: this.controller })
  10. .onUrlLoadIntercept((event) => {
  11. if (event) {
  12. console.log('onUrlLoadIntercept ' + event.data.toString())
  13. }
  14. return true
  15. })
  16. }
  17. }
  18. }

onInterceptRequest9+

onInterceptRequest(callback: (event?: { request: WebResourceRequest}) => WebResourceResponse)

当Web组件加载url之前触发该回调,用于拦截url并返回响应数据。

参数:

参数名参数类型参数描述
requestWebResourceRequesturl请求的相关信息。

返回值:

类型说明
WebResourceResponse返回响应数据则按照响应数据加载,无响应数据则返回null表示按照原来的方式加载。

示例:

  1. // xxx.ets
  2. import web_webview from '@ohos.web.webview'
  3. @Entry
  4. @Component
  5. struct WebComponent {
  6. controller: web_webview.WebviewController = new web_webview.WebviewController()
  7. responseweb: WebResourceResponse = new WebResourceResponse()
  8. heads:Header[] = new Array()
  9. @State webdata: string = "<!DOCTYPE html>\n" +
  10. "<html>\n"+
  11. "<head>\n"+
  12. "<title>intercept test</title>\n"+
  13. "</head>\n"+
  14. "<body>\n"+
  15. "<h1>intercept test</h1>\n"+
  16. "</body>\n"+
  17. "</html>"
  18. build() {
  19. Column() {
  20. Web({ src: 'www.example.com', controller: this.controller })
  21. .onInterceptRequest((event) => {
  22. if (event) {
  23. console.log('url:' + event.request.getRequestUrl())
  24. }
  25. let head1:Header = {
  26. headerKey:"Connection",
  27. headerValue:"keep-alive"
  28. }
  29. let head2:Header = {
  30. headerKey:"Cache-Control",
  31. headerValue:"no-cache"
  32. }
  33. let length = this.heads.push(head1)
  34. length = this.heads.push(head2)
  35. this.responseweb.setResponseHeader(this.heads)
  36. this.responseweb.setResponseData(this.webdata)
  37. this.responseweb.setResponseEncoding('utf-8')
  38. this.responseweb.setResponseMimeType('text/html')
  39. this.responseweb.setResponseCode(200)
  40. this.responseweb.setReasonMessage('OK')
  41. return this.responseweb
  42. })
  43. }
  44. }
  45. }

onHttpAuthRequest9+

onHttpAuthRequest(callback: (event?: { handler: HttpAuthHandler, host: string, realm: string}) => boolean)

通知收到http auth认证请求。

参数:

参数名参数类型参数描述
handlerHttpAuthHandler通知Web组件用户操作行为。
hoststringHTTP身份验证凭据应用的主机。
realmstringHTTP身份验证凭据应用的域。

返回值:

类型说明
boolean返回false表示此次认证失败,否则成功。

示例:

  1. // xxx.ets
  2. import web_webview from '@ohos.web.webview'
  3. @Entry
  4. @Component
  5. struct WebComponent {
  6. controller: web_webview.WebviewController = new web_webview.WebviewController()
  7. httpAuth: boolean = false
  8. build() {
  9. Column() {
  10. Web({ src: 'www.example.com', controller: this.controller })
  11. .onHttpAuthRequest((event) => {
  12. if (event) {
  13. AlertDialog.show({
  14. title: 'onHttpAuthRequest',
  15. message: 'text',
  16. primaryButton: {
  17. value: 'cancel',
  18. action: () => {
  19. event.handler.cancel()
  20. }
  21. },
  22. secondaryButton: {
  23. value: 'ok',
  24. action: () => {
  25. this.httpAuth = event.handler.isHttpAuthInfoSaved()
  26. if (this.httpAuth == false) {
  27. web_webview.WebDataBase.saveHttpAuthCredentials(
  28. event.host,
  29. event.realm,
  30. "2222",
  31. "2222"
  32. )
  33. event.handler.cancel()
  34. }
  35. }
  36. },
  37. cancel: () => {
  38. event.handler.cancel()
  39. }
  40. })
  41. }
  42. return true
  43. })
  44. }
  45. }
  46. }

onSslErrorEventReceive9+

onSslErrorEventReceive(callback: (event: { handler: SslErrorHandler, error: SslError }) => void)

通知用户加载资源时发生SSL错误。

参数:

参数名参数类型参数描述
handlerSslErrorHandler通知Web组件用户操作行为。
errorSslError错误码。

示例:

  1. // xxx.ets
  2. import web_webview from '@ohos.web.webview'
  3. @Entry
  4. @Component
  5. struct WebComponent {
  6. controller: web_webview.WebviewController = new web_webview.WebviewController()
  7. httpAuth: boolean = false
  8. build() {
  9. Column() {
  10. Web({ src: 'www.example.com', controller: this.controller })
  11. .onHttpAuthRequest((event) => {
  12. if (event) {
  13. AlertDialog.show({
  14. title: 'onHttpAuthRequest',
  15. message: 'text',
  16. primaryButton: {
  17. value: 'cancel',
  18. action: () => {
  19. event.handler.cancel()
  20. }
  21. },
  22. secondaryButton: {
  23. value: 'ok',
  24. action: () => {
  25. this.httpAuth = event.handler.isHttpAuthInfoSaved()
  26. if (this.httpAuth == false) {
  27. web_webview.WebDataBase.saveHttpAuthCredentials(
  28. event.host,
  29. event.realm,
  30. "2222",
  31. "2222"
  32. )
  33. event.handler.cancel()
  34. }
  35. }
  36. },
  37. cancel: () => {
  38. event.handler.cancel()
  39. }
  40. })
  41. }
  42. return true
  43. })
  44. }
  45. }
  46. }

onClientAuthenticationRequest9+

onClientAuthenticationRequest(callback: (event: {handler : ClientAuthenticationHandler, host : string, port : number, keyTypes : Array<string>, issuers : Array<string>}) => void)

通知用户收到SSL客户端证书请求事件。

参数:

参数名参数类型参数描述
handlerClientAuthenticationHandler通知Web组件用户操作行为。
hoststring请求证书服务器的主机名。
portnumber请求证书服务器的端口号。
keyTypesArray<string>可接受的非对称秘钥类型。
issuersArray<string>与私钥匹配的证书可接受颁发者。

示例:

未对接证书管理的双向认证。

  1. // xxx.ets API9
  2. import web_webview from '@ohos.web.webview'
  3. @Entry
  4. @Component
  5. struct WebComponent {
  6. controller: web_webview.WebviewController = new web_webview.WebviewController()
  7. build() {
  8. Column() {
  9. Web({ src: 'www.example.com', controller: this.controller })
  10. .onClientAuthenticationRequest((event) => {
  11. AlertDialog.show({
  12. title: 'onClientAuthenticationRequest',
  13. message: 'text',
  14. primaryButton: {
  15. value: 'confirm',
  16. action: () => {
  17. event.handler.confirm("/system/etc/user.pk8", "/system/etc/chain-user.pem")
  18. }
  19. },
  20. secondaryButton: {
  21. value: 'cancel',
  22. action: () => {
  23. event.handler.cancel()
  24. }
  25. },
  26. cancel: () => {
  27. event.handler.ignore()
  28. }
  29. })
  30. })
  31. }
  32. }
  33. }

对接证书管理的双向认证。

  1. 构造单例对象GlobalContext。

    1. // GlobalContext.ts
    2. export class GlobalContext {
    3. private constructor() {}
    4. private static instance: GlobalContext;
    5. private _objects = new Map<string, Object>();
    6. public static getContext(): GlobalContext {
    7. if (!GlobalContext.instance) {
    8. GlobalContext.instance = new GlobalContext();
    9. }
    10. return GlobalContext.instance;
    11. }
    12. getObject(value: string): Object | undefined {
    13. return this._objects.get(value);
    14. }
    15. setObject(key: string, objectClass: Object): void {
    16. this._objects.set(key, objectClass);
    17. }
    18. }

  2. 实现双向认证。

    1. // xxx.ets API10
    2. import common from '@ohos.app.ability.common';
    3. import Want from '@ohos.app.ability.Want';
    4. import web_webview from '@ohos.web.webview'
    5. import { BusinessError } from '@ohos.base';
    6. import bundleManager from '@ohos.bundle.bundleManager'
    7. import { GlobalContext } from '../GlobalContext'
    8. let uri = "";
    9. export default class CertManagerService {
    10. private static sInstance: CertManagerService;
    11. private authUri = "";
    12. private appUid = "";
    13. public static getInstance(): CertManagerService {
    14. if (CertManagerService.sInstance == null) {
    15. CertManagerService.sInstance = new CertManagerService();
    16. }
    17. return CertManagerService.sInstance;
    18. }
    19. async grantAppPm(callback: (message: string) => void) {
    20. let message = '';
    21. let bundleFlags = bundleManager.BundleFlag.GET_BUNDLE_INFO_DEFAULT | bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_APPLICATION;
    22. //注:com.example.myapplication需要写实际应用名称
    23. try {
    24. bundleManager.getBundleInfoForSelf(bundleFlags).then((data) => {
    25. console.info('getBundleInfoForSelf successfully. Data: %{public}s', JSON.stringify(data));
    26. this.appUid = data.appInfo.uid.toString();
    27. }).catch((err: BusinessError) => {
    28. console.error('getBundleInfoForSelf failed. Cause: %{public}s', err.message);
    29. });
    30. } catch (err) {
    31. let message = (err as BusinessError).message;
    32. console.error('getBundleInfoForSelf failed: %{public}s', message);
    33. }
    34. //注:需要在MainAbility.ts文件的onCreate函数里添加GlobalContext.getContext().setObject("AbilityContext", this.context)
    35. let abilityContext = GlobalContext.getContext().getObject("AbilityContext") as common.UIAbilityContext
    36. await abilityContext.startAbilityForResult(
    37. {
    38. bundleName: "com.ohos.certmanager",
    39. abilityName: "MainAbility",
    40. uri: "requestAuthorize",
    41. parameters: {
    42. appUid: this.appUid, //传入申请应用的appUid
    43. }
    44. } as Want)
    45. .then((data: common.AbilityResult) => {
    46. if (!data.resultCode && data.want) {
    47. if (data.want.parameters) {
    48. this.authUri = data.want.parameters.authUri as string; //授权成功后获取返回的authUri
    49. }
    50. }
    51. })
    52. message += "after grantAppPm authUri: " + this.authUri;
    53. uri = this.authUri;
    54. callback(message)
    55. }
    56. }
    57. @Entry
    58. @Component
    59. struct WebComponent {
    60. controller: web_webview.WebviewController = new web_webview.WebviewController();
    61. @State message: string = 'Hello World' //message主要是调试观察使用
    62. certManager = CertManagerService.getInstance();
    63. build() {
    64. Row() {
    65. Column() {
    66. Row() {
    67. //第一步:需要先进行授权,获取到uri
    68. Button('GrantApp')
    69. .onClick(() => {
    70. this.certManager.grantAppPm((data) => {
    71. this.message = data;
    72. });
    73. })
    74. //第二步:授权后,双向认证会通过onClientAuthenticationRequest回调将uri传给web进行认证
    75. Button("ClientCertAuth")
    76. .onClick(() => {
    77. this.controller.loadUrl('https://www.example2.com'); //支持双向认证的服务器网站
    78. })
    79. }
    80. Web({ src: 'https://www.example1.com', controller: this.controller })
    81. .fileAccess(true)
    82. .javaScriptAccess(true)
    83. .domStorageAccess(true)
    84. .onlineImageAccess(true)
    85. .onClientAuthenticationRequest((event) => {
    86. AlertDialog.show({
    87. title: 'ClientAuth',
    88. message: 'Text',
    89. confirm: {
    90. value: 'Confirm',
    91. action: () => {
    92. event.handler.confirm(uri);
    93. }
    94. },
    95. cancel: () => {
    96. event.handler.cancel();
    97. }
    98. })
    99. })
    100. }
    101. }
    102. .width('100%')
    103. .height('100%')
    104. }
    105. }

onPermissionRequest9+

onPermissionRequest(callback: (event?: { request: PermissionRequest }) => void)

通知收到获取权限请求。

参数:

参数名参数类型参数描述
requestPermissionRequest通知Web组件用户操作行为。

示例:

  1. // xxx.ets
  2. import web_webview from '@ohos.web.webview'
  3. @Entry
  4. @Component
  5. struct WebComponent {
  6. controller: web_webview.WebviewController = new web_webview.WebviewController()
  7. build() {
  8. Column() {
  9. Web({ src: $rawfile('index.html'), controller: this.controller })
  10. .onPermissionRequest((event) => {
  11. if (event) {
  12. AlertDialog.show({
  13. title: 'title',
  14. message: 'text',
  15. primaryButton: {
  16. value: 'deny',
  17. action: () => {
  18. event.request.deny()
  19. }
  20. },
  21. secondaryButton: {
  22. value: 'onConfirm',
  23. action: () => {
  24. event.request.grant(event.request.getAccessibleResource())
  25. }
  26. },
  27. cancel: () => {
  28. event.request.deny()
  29. }
  30. })
  31. }
  32. })
  33. }
  34. }
  35. }

加载的html文件。

  1. <!-- index.html -->
  2. <!DOCTYPE html>
  3. <html>
  4. <head>
  5. <meta charset="UTF-8">
  6. </head>
  7. <body>
  8. <video id="video" width="500px" height="500px" autoplay="autoplay"></video>
  9. <canvas id="canvas" width="500px" height="500px"></canvas>
  10. <br>
  11. <input type="button" title="HTML5摄像头" value="开启摄像头" onclick="getMedia()"/>
  12. <script>
  13. function getMedia()
  14. {
  15. let constraints = {
  16. video: {width: 500, height: 500},
  17. audio: true
  18. };
  19. //获取video摄像头区域
  20. let video = document.getElementByld("video");
  21. //返回的Promise对象
  22. let promise = navigator.mediaDevices.getUserMedia(constraints);
  23. //then()异步,调用MediaStream对象作为参数
  24. promise.then(function (MediaStream) {
  25. video.srcObject = MediaStream;
  26. video.play();
  27. });
  28. }
  29. </script>
  30. </body>
  31. </html>

onContextMenuShow9+

onContextMenuShow(callback: (event?: { param: WebContextMenuParam, result: WebContextMenuResult }) => boolean)

长按特定元素(例如图片,链接)或鼠标右键,跳出菜单。

参数:

参数名参数类型参数描述
paramWebContextMenuParam菜单相关参数。
resultWebContextMenuResult菜单相应事件传入内核。

返回值:

类型说明
boolean自定义菜单返回true,触发的自定义菜单无效返回false。

示例:

  1. // xxx.ets
  2. import web_webview from '@ohos.web.webview'
  3. import pasteboard from '@ohos.pasteboard'
  4. const TAG = 'ContextMenu';
  5. @Entry
  6. @Component
  7. struct WebComponent {
  8. controller: web_webview.WebviewController = new web_webview.WebviewController()
  9. private result: WebContextMenuResult | undefined = undefined;
  10. @State linkUrl: string = '';
  11. @State offsetX: number = 0;
  12. @State offsetY: number = 0;
  13. @State showMenu: boolean = false;
  14. @Builder
  15. //构建自定义菜单及触发功能接口
  16. MenuBuilder(){
  17. //以垂直列表形式显示的菜单。
  18. Menu(){
  19. //展示菜单Menu中具体的item菜单项。
  20. MenuItem({
  21. content: '复制图片',
  22. })
  23. .width(100)
  24. .height(50)
  25. .onClick(() => {
  26. this.result?.copyImage();
  27. this.showMenu = false;
  28. })
  29. MenuItem({
  30. content: '剪切',
  31. })
  32. .width(100)
  33. .height(50)
  34. .onClick(() => {
  35. this.result?.cut();
  36. this.showMenu = false;
  37. })
  38. MenuItem({
  39. content: '复制',
  40. })
  41. .width(100)
  42. .height(50)
  43. .onClick(() => {
  44. this.result?.copy();
  45. this.showMenu = false;
  46. })
  47. MenuItem({
  48. content: '粘贴',
  49. })
  50. .width(100)
  51. .height(50)
  52. .onClick(() => {
  53. this.result?.paste();
  54. this.showMenu = false;
  55. })
  56. MenuItem({
  57. content: '复制链接',
  58. })
  59. .width(100)
  60. .height(50)
  61. .onClick(() => {
  62. let pasteData = pasteboard.createData('text/plain', this.linkUrl);
  63. pasteboard.getSystemPasteboard().setData(pasteData, (error)=>{
  64. if(error){
  65. return;
  66. }
  67. })
  68. this.showMenu = false;
  69. })
  70. MenuItem({
  71. content: '全选',
  72. })
  73. .width(100)
  74. .height(50)
  75. .onClick(() => {
  76. this.result?.selectAll();
  77. this.showMenu = false;
  78. })
  79. }
  80. .width(150)
  81. .height(300)
  82. }
  83. build() {
  84. Column() {
  85. Web({ src: $rawfile("index.html"), controller: this.controller })
  86. //触发自定义弹窗
  87. .onContextMenuShow((event) => {
  88. if (event) {
  89. this.result = event.result
  90. console.info("x coord = " + event.param.x())
  91. console.info("link url = " + event.param.getLinkUrl())
  92. this.linkUrl = event.param.getLinkUrl()
  93. }
  94. console.info(TAG, `x: ${this.offsetX}, y: ${this.offsetY}`);
  95. this.showMenu = true;
  96. this.offsetX = 250;
  97. this.offsetY = Math.max(px2vp(event?.param.y() ?? 0) - 0, 0);
  98. return true
  99. })
  100. .bindPopup(this.showMenu,
  101. {
  102. builder: this.MenuBuilder(),
  103. enableArrow: false,
  104. placement: Placement.LeftTop,
  105. offset: { x: this.offsetX, y: this.offsetY},
  106. mask: false,
  107. onStateChange: (e) => {
  108. if(!e.isVisible){
  109. this.showMenu = false;
  110. this.result!.closeContextMenu();
  111. }
  112. }
  113. })
  114. }
  115. }
  116. }

加载的html文件。

  1. <!-- index.html -->
  2. <!DOCTYPE html>
  3. <html lang="en">
  4. <body>
  5. <h1>onContextMenuShow</h1>
  6. <a href="http://www.example.com" style="font-size:27px">链接www.example.com</a>
  7. //rawfile下放任意一张图片命名为example.png
  8. <div><img src="example.png"></div>
  9. <p>选中文字鼠标右键弹出菜单</p>
  10. </body>
  11. </html>

onContextMenuHide11+

onContextMenuHide(callback: OnContextMenuHideCallback)

长按特定元素(例如图片,链接)或鼠标右键,隐藏菜单。

参数:

参数名参数类型参数描述
callbackOnContextMenuHideCallback菜单相关参数。

示例:

  1. // xxx.ets
  2. import web_webview from '@ohos.web.webview'
  3. @Entry
  4. @Component
  5. struct WebComponent {
  6. controller: web_webview.WebviewController = new web_webview.WebviewController()
  7. build() {
  8. Column() {
  9. Web({ src: 'www.example.com', controller: this.controller })
  10. .onContextMenuHide(() => {
  11. console.log("onContextMenuHide callback")
  12. })
  13. }
  14. }
  15. }

onScroll9+

onScroll(callback: (event: {xOffset: number, yOffset: number}) => void)

通知网页滚动条滚动位置。

参数:

参数名参数类型参数描述
xOffsetnumber以网页最左端为基准,水平滚动条滚动所在位置。
yOffsetnumber以网页最上端为基准,竖直滚动条滚动所在位置。

示例:

  1. // xxx.ets
  2. import web_webview from '@ohos.web.webview'
  3. @Entry
  4. @Component
  5. struct WebComponent {
  6. controller: web_webview.WebviewController = new web_webview.WebviewController()
  7. build() {
  8. Column() {
  9. Web({ src: 'www.example.com', controller: this.controller })
  10. .onScroll((event) => {
  11. console.info("x = " + event.xOffset)
  12. console.info("y = " + event.yOffset)
  13. })
  14. }
  15. }
  16. }

onGeolocationShow

onGeolocationShow(callback: (event?: { origin: string, geolocation: JsGeolocation }) => void)

通知用户收到地理位置信息获取请求。

参数:

参数名参数类型参数描述
originstring指定源的字符串索引。
geolocationJsGeolocation通知Web组件用户操作行为。

示例:

  1. // xxx.ets
  2. import web_webview from '@ohos.web.webview'
  3. @Entry
  4. @Component
  5. struct WebComponent {
  6. controller: web_webview.WebviewController = new web_webview.WebviewController()
  7. build() {
  8. Column() {
  9. Web({ src:$rawfile('index.html'), controller:this.controller })
  10. .geolocationAccess(true)
  11. .onGeolocationShow((event) => {
  12. if (event) {
  13. AlertDialog.show({
  14. title: 'title',
  15. message: 'text',
  16. confirm: {
  17. value: 'onConfirm',
  18. action: () => {
  19. event.geolocation.invoke(event.origin, true, true)
  20. }
  21. },
  22. cancel: () => {
  23. event.geolocation.invoke(event.origin, false, true)
  24. }
  25. })
  26. }
  27. })
  28. }
  29. }
  30. }

加载的html文件。

  1. <!DOCTYPE html>
  2. <html>
  3. <body>
  4. <p id="locationInfo">位置信息</p>
  5. <button onclick="getLocation()">获取位置</button>
  6. <script>
  7. var locationInfo=document.getElementById("locationInfo");
  8. function getLocation(){
  9. if (navigator.geolocation) {
  10. <!-- 前端页面访问设备地理位置 -->
  11. navigator.geolocation.getCurrentPosition(showPosition);
  12. }
  13. }
  14. function showPosition(position){
  15. locationInfo.innerHTML="Latitude: " + position.coords.latitude + "<br />Longitude: " + position.coords.longitude;
  16. }
  17. </script>
  18. </body>
  19. </html>

onGeolocationHide

onGeolocationHide(callback: () => void)

通知用户先前被调用onGeolocationShow时收到地理位置信息获取请求已被取消。

参数:

参数名参数类型参数描述
callback() => void地理位置信息获取请求已被取消的回调函数。

示例:

  1. // xxx.ets
  2. import web_webview from '@ohos.web.webview'
  3. @Entry
  4. @Component
  5. struct WebComponent {
  6. controller: web_webview.WebviewController = new web_webview.WebviewController()
  7. build() {
  8. Column() {
  9. Web({ src:'www.example.com', controller:this.controller })
  10. .geolocationAccess(true)
  11. .onGeolocationHide(() => {
  12. console.log("onGeolocationHide...")
  13. })
  14. }
  15. }
  16. }

onFullScreenEnter9+

onFullScreenEnter(callback: (event: { handler: FullScreenExitHandler }) => void)

通知开发者web组件进入全屏模式。

参数:

参数名参数类型参数描述
handlerFullScreenExitHandler用于退出全屏模式的函数句柄。

示例:

  1. // xxx.ets
  2. import web_webview from '@ohos.web.webview'
  3. @Entry
  4. @Component
  5. struct WebComponent {
  6. controller: web_webview.WebviewController = new web_webview.WebviewController()
  7. handler: FullScreenExitHandler | null = null
  8. build() {
  9. Column() {
  10. Web({ src:'www.example.com', controller:this.controller })
  11. .onFullScreenEnter((event) => {
  12. console.log("onFullScreenEnter...")
  13. this.handler = event.handler
  14. })
  15. }
  16. }
  17. }

onFullScreenExit9+

onFullScreenExit(callback: () => void)

通知开发者web组件退出全屏模式。

参数:

参数名参数类型参数描述
callback() => void退出全屏模式时的回调函数。

示例:

  1. // xxx.ets
  2. import web_webview from '@ohos.web.webview'
  3. @Entry
  4. @Component
  5. struct WebComponent {
  6. controller: web_webview.WebviewController = new web_webview.WebviewController()
  7. handler: FullScreenExitHandler | null = null
  8. build() {
  9. Column() {
  10. Web({ src:'www.example.com', controller:this.controller })
  11. .onFullScreenExit(() => {
  12. console.log("onFullScreenExit...")
  13. if (this.handler) {
  14. this.handler.exitFullScreen()
  15. }
  16. })
  17. .onFullScreenEnter((event) => {
  18. this.handler = event.handler
  19. })
  20. }
  21. }
  22. }

onWindowNew9+

onWindowNew(callback: (event: {isAlert: boolean, isUserTrigger: boolean, targetUrl: string, handler: ControllerHandler}) => void)

使能multiWindowAccess情况下,通知用户新建窗口请求。 若不调用event.handler.setWebController接口,会造成render进程阻塞。 如果不需要打开新窗口,在调用event.handler.setWebController接口时须设置成null。

参数:

参数名参数类型参数描述
isAlertbooleantrue代表请求创建对话框,false代表新标签页。
isUserTriggerbooleantrue代表用户触发,false代表非用户触发。
targetUrlstring目标url。
handlerControllerHandler用于设置新建窗口的WebviewController实例。

示例:

  1. // xxx.ets
  2. import web_webview from '@ohos.web.webview'
  3. //在同一page页有两个web组件。在WebComponent新开窗口时,会跳转到NewWebViewComp。
  4. @CustomDialog
  5. struct NewWebViewComp {
  6. controller?: CustomDialogController
  7. webviewController1: web_webview.WebviewController = new web_webview.WebviewController()
  8. build() {
  9. Column() {
  10. Web({ src: "", controller: this.webviewController1 })
  11. .javaScriptAccess(true)
  12. .multiWindowAccess(false)
  13. .onWindowExit(()=> {
  14. console.info("NewWebViewComp onWindowExit")
  15. if (this.controller) {
  16. this.controller.close()
  17. }
  18. })
  19. }
  20. }
  21. }
  22. @Entry
  23. @Component
  24. struct WebComponent {
  25. controller: web_webview.WebviewController = new web_webview.WebviewController()
  26. dialogController: CustomDialogController | null = null
  27. build() {
  28. Column() {
  29. Web({ src: 'www.example.com', controller: this.controller })
  30. .javaScriptAccess(true)
  31. //需要使能multiWindowAccess
  32. .multiWindowAccess(true)
  33. .allowWindowOpenMethod(true)
  34. .onWindowNew((event) => {
  35. if (this.dialogController) {
  36. this.dialogController.close()
  37. }
  38. let popController:web_webview.WebviewController = new web_webview.WebviewController()
  39. this.dialogController = new CustomDialogController({
  40. builder: NewWebViewComp({webviewController1: popController})
  41. })
  42. this.dialogController.open()
  43. //将新窗口对应WebviewController返回给Web内核。
  44. //如果不需要打开新窗口请调用event.handler.setWebController接口设置成null
  45. //若不调用event.handler.setWebController接口,会造成render进程阻塞。
  46. event.handler.setWebController(popController)
  47. })
  48. }
  49. }
  50. }

onWindowExit9+

onWindowExit(callback: () => void)

通知用户窗口关闭请求。

参数:

参数名参数类型参数描述
callback() => void窗口请求关闭的回调函数。

示例:

  1. // xxx.ets
  2. import web_webview from '@ohos.web.webview'
  3. @Entry
  4. @Component
  5. struct WebComponent {
  6. controller: web_webview.WebviewController = new web_webview.WebviewController()
  7. build() {
  8. Column() {
  9. Web({ src:'www.example.com', controller: this.controller })
  10. .onWindowExit(() => {
  11. console.log("onWindowExit...")
  12. })
  13. }
  14. }
  15. }

onSearchResultReceive9+

onSearchResultReceive(callback: (event?: {activeMatchOrdinal: number, numberOfMatches: number, isDoneCounting: boolean}) => void): WebAttribute

回调通知调用方网页页内查找的结果。

参数:

参数名参数类型参数描述
activeMatchOrdinalnumber当前匹配的查找项的序号(从0开始)。
numberOfMatchesnumber所有匹配到的关键词的个数。
isDoneCountingboolean当次页内查找操作是否结束。该方法可能会回调多次,直到isDoneCounting为true为止。

示例:

  1. // xxx.ets
  2. import web_webview from '@ohos.web.webview'
  3. @Entry
  4. @Component
  5. struct WebComponent {
  6. controller: web_webview.WebviewController = new web_webview.WebviewController()
  7. build() {
  8. Column() {
  9. Web({ src: 'www.example.com', controller: this.controller })
  10. .onSearchResultReceive(ret => {
  11. if (ret) {
  12. console.log("on search result receive:" + "[cur]" + ret.activeMatchOrdinal +
  13. "[total]" + ret.numberOfMatches + "[isDone]"+ ret.isDoneCounting)
  14. }
  15. })
  16. }
  17. }
  18. }

onDataResubmitted9+

onDataResubmitted(callback: (event: {handler: DataResubmissionHandler}) => void)

设置网页表单可以重新提交时触发的回调函数。

参数:

参数名参数类型参数描述
handlerDataResubmissionHandler表单数据重新提交句柄。

示例:

  1. // xxx.ets
  2. import web_webview from '@ohos.web.webview'
  3. import business_error from '@ohos.base';
  4. @Entry
  5. @Component
  6. struct WebComponent {
  7. controller: web_webview.WebviewController = new web_webview.WebviewController()
  8. build() {
  9. Column() {
  10. //在网页中点击提交之后,点击refresh按钮可以重新提交时的触发函数。
  11. Button('refresh')
  12. .onClick(() => {
  13. try {
  14. this.controller.refresh();
  15. } catch (error) {
  16. let e: business_error.BusinessError = error as business_error.BusinessError;
  17. console.error(`ErrorCode: ${e.code}, Message: ${e.message}`);
  18. }
  19. })
  20. Web({ src:$rawfile('index.html'), controller: this.controller })
  21. .onDataResubmitted((event) => {
  22. console.log('onDataResubmitted')
  23. event.handler.resend();
  24. })
  25. }
  26. }
  27. }

加载的html文件。

  1. <!-- index.html -->
  2. <!DOCTYPE html>
  3. <html>
  4. <head>
  5. <meta charset="utf-8">
  6. </head>
  7. <body>
  8. <form action="http://httpbin.org/post" method="post">
  9. <input type="text" name="username">
  10. <input type="submit" name="提交">
  11. </form>
  12. </body>
  13. </html>

onPageVisible9+

onPageVisible(callback: (event: {url: string}) => void)

设置旧页面不再呈现,新页面即将可见时触发的回调函数。

参数:

参数名参数类型参数描述
urlstring旧页面不再呈现,新页面即将可见时新页面的url地址。

示例:

  1. // xxx.ets
  2. import web_webview from '@ohos.web.webview'
  3. @Entry
  4. @Component
  5. struct WebComponent {
  6. controller: web_webview.WebviewController = new web_webview.WebviewController()
  7. build() {
  8. Column() {
  9. Web({ src:'www.example.com', controller: this.controller })
  10. .onPageVisible((event) => {
  11. console.log('onPageVisible url:' + event.url)
  12. })
  13. }
  14. }
  15. }

onInterceptKeyEvent9+

onInterceptKeyEvent(callback: (event: KeyEvent) => boolean)

设置键盘事件的回调函数,该回调在被Webview使用前触发。

参数:

参数名参数类型参数描述
eventKeyEvent触发的KeyEvent事件。

返回值:

类型说明
boolean回调函数通过返回boolean类型值来决定是否继续将该KeyEvent传入Webview内核。

示例:

  1. // xxx.ets
  2. import web_webview from '@ohos.web.webview'
  3. @Entry
  4. @Component
  5. struct WebComponent {
  6. controller: web_webview.WebviewController = new web_webview.WebviewController()
  7. build() {
  8. Column() {
  9. Web({ src:'www.example.com', controller: this.controller })
  10. .onInterceptKeyEvent((event) => {
  11. if (event.keyCode == 2017 || event.keyCode == 2018) {
  12. console.info(`onInterceptKeyEvent get event.keyCode ${event.keyCode}`)
  13. return true;
  14. }
  15. return false;
  16. })
  17. }
  18. }
  19. }

onTouchIconUrlReceived9+

onTouchIconUrlReceived(callback: (event: {url: string, precomposed: boolean}) => void)

设置接收到apple-touch-icon url地址时的回调函数。

参数:

参数名参数类型参数描述
urlstring接收到的apple-touch-icon url地址。
precomposedboolean对应apple-touch-icon是否为预合成。

示例:

  1. // xxx.ets
  2. import web_webview from '@ohos.web.webview'
  3. @Entry
  4. @Component
  5. struct WebComponent {
  6. controller: web_webview.WebviewController = new web_webview.WebviewController()
  7. build() {
  8. Column() {
  9. Web({ src:'www.baidu.com', controller: this.controller })
  10. .onTouchIconUrlReceived((event) => {
  11. console.log('onTouchIconUrlReceived:' + JSON.stringify(event))
  12. })
  13. }
  14. }
  15. }

onFaviconReceived9+

onFaviconReceived(callback: (event: { favicon: PixelMap }) => void)

设置应用为当前页面接收到新的favicon时的回调函数。

参数:

参数名参数类型参数描述
faviconPixelMap接收到的favicon图标的PixelMap对象。

示例:

  1. // xxx.ets
  2. import web_webview from '@ohos.web.webview'
  3. import image from "@ohos.multimedia.image"
  4. @Entry
  5. @Component
  6. struct WebComponent {
  7. controller: web_webview.WebviewController = new web_webview.WebviewController()
  8. @State icon: image.PixelMap | undefined = undefined;
  9. build() {
  10. Column() {
  11. Web({ src:'www.example.com', controller: this.controller })
  12. .onFaviconReceived((event) => {
  13. console.log('onFaviconReceived');
  14. this.icon = event.favicon;
  15. })
  16. }
  17. }
  18. }

onAudioStateChanged10+

onAudioStateChanged(callback: (event: { playing: boolean }) => void)

设置网页上的音频播放状态发生改变时的回调函数。

参数:

参数名参数类型参数描述
playingboolean当前页面的音频播放状态,true表示正在播放,false表示未播放。

示例:

  1. // xxx.ets
  2. import web_webview from '@ohos.web.webview'
  3. @Entry
  4. @Component
  5. struct WebComponent {
  6. controller: web_webview.WebviewController = new web_webview.WebviewController()
  7. @State playing: boolean = false
  8. build() {
  9. Column() {
  10. Web({ src:'www.example.com', controller: this.controller })
  11. .onAudioStateChanged(event => {
  12. this.playing = event.playing
  13. console.debug('onAudioStateChanged playing: ' + this.playing)
  14. })
  15. }
  16. }
  17. }

onFirstContentfulPaint10+

onFirstContentfulPaint(callback: (event?: { navigationStartTick: number, firstContentfulPaintMs: number }) => void)

设置网页首次内容绘制回调函数。

参数:

参数名参数类型参数描述
navigationStartTicknumbernavigation开始的时间,单位以微秒表示。
firstContentfulPaintMsnumber从navigation开始第一次绘制内容的时间,单位是以毫秒表示。

示例:

  1. // xxx.ets
  2. import web_webview from '@ohos.web.webview'
  3. @Entry
  4. @Component
  5. struct WebComponent {
  6. controller: web_webview.WebviewController = new web_webview.WebviewController()
  7. build() {
  8. Column() {
  9. Web({ src:'www.example.com', controller: this.controller })
  10. .onFirstContentfulPaint(event => {
  11. if (event) {
  12. console.log("onFirstContentfulPaint:" + "[navigationStartTick]:" +
  13. event.navigationStartTick + ", [firstContentfulPaintMs]:" +
  14. event.firstContentfulPaintMs)
  15. }
  16. })
  17. }
  18. }
  19. }

onLoadIntercept10+

onLoadIntercept(callback: (event: { data: WebResourceRequest }) => boolean)

当Web组件加载url之前触发该回调,用于判断是否阻止此次访问。默认允许加载。

参数:

参数名参数类型参数描述
dataWebResourceRequesturl请求的相关信息。

返回值:

类型说明
boolean返回true表示阻止此次加载,否则允许此次加载。

示例:

  1. // xxx.ets
  2. import web_webview from '@ohos.web.webview'
  3. @Entry
  4. @Component
  5. struct WebComponent {
  6. controller: web_webview.WebviewController = new web_webview.WebviewController()
  7. build() {
  8. Column() {
  9. Web({ src: 'www.example.com', controller: this.controller })
  10. .onLoadIntercept((event) => {
  11. console.log('url:' + event.data.getRequestUrl())
  12. console.log('isMainFrame:' + event.data.isMainFrame())
  13. console.log('isRedirect:' + event.data.isRedirect())
  14. console.log('isRequestGesture:' + event.data.isRequestGesture())
  15. return true
  16. })
  17. }
  18. }
  19. }

最后,有很多小伙伴不知道学习哪些鸿蒙开发技术?不知道需要重点掌握哪些鸿蒙应用开发知识点?而且学习时频繁踩坑,最终浪费大量时间。所以有一份实用的鸿蒙(Harmony NEXT)资料用来跟着学习是非常有必要的。 

这份鸿蒙(Harmony NEXT)资料包含了鸿蒙开发必掌握的核心知识要点,内容包含了ArkTS、ArkUI开发组件、Stage模型、多端部署、分布式应用开发、音频、视频、WebGL、OpenHarmony多媒体技术、Napi组件、OpenHarmony内核、Harmony南向开发、鸿蒙项目实战等等)鸿蒙(Harmony NEXT)技术知识点。

希望这一份鸿蒙学习资料能够给大家带来帮助,有需要的小伙伴自行领取,限时开源,先到先得~无套路领取!!

获取这份完整版高清学习路线,请点击→纯血版全套鸿蒙HarmonyOS学习资料

鸿蒙(Harmony NEXT)最新学习路线

  •  HarmonOS基础技能

  • HarmonOS就业必备技能 
  •  HarmonOS多媒体技术

  • 鸿蒙NaPi组件进阶

  • HarmonOS高级技能

  • 初识HarmonOS内核 
  • 实战就业级设备开发

有了路线图,怎么能没有学习资料呢,小编也准备了一份联合鸿蒙官方发布笔记整理收纳的一套系统性的鸿蒙(OpenHarmony )学习手册(共计1236页)鸿蒙(OpenHarmony )开发入门教学视频,内容包含:ArkTS、ArkUI、Web开发、应用模型、资源分类…等知识点。

获取以上完整版高清学习路线,请点击→纯血版全套鸿蒙HarmonyOS学习资料

《鸿蒙 (OpenHarmony)开发入门教学视频》

《鸿蒙生态应用开发V2.0白皮书》

图片

《鸿蒙 (OpenHarmony)开发基础到实战手册》

OpenHarmony北向、南向开发环境搭建

图片

 《鸿蒙开发基础》

  • ArkTS语言
  • 安装DevEco Studio
  • 运用你的第一个ArkTS应用
  • ArkUI声明式UI开发
  • .……

图片

 《鸿蒙开发进阶》

  • Stage模型入门
  • 网络管理
  • 数据管理
  • 电话服务
  • 分布式应用开发
  • 通知与窗口管理
  • 多媒体技术
  • 安全技能
  • 任务管理
  • WebGL
  • 国际化开发
  • 应用测试
  • DFX面向未来设计
  • 鸿蒙系统移植和裁剪定制
  • ……

图片

《鸿蒙进阶实战》

  • ArkTS实践
  • UIAbility应用
  • 网络案例
  • ……

图片

 获取以上完整鸿蒙HarmonyOS学习资料,请点击→纯血版全套鸿蒙HarmonyOS学习资料

总结

总的来说,华为鸿蒙不再兼容安卓,对中年程序员来说是一个挑战,也是一个机会。只有积极应对变化,不断学习和提升自己,他们才能在这个变革的时代中立于不败之地。 

声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/Cpp五条/article/detail/291866
推荐阅读
相关标签
  

闽ICP备14008679号