mirror of
https://gitee.com/openharmony/interface_sdk_c
synced 2024-11-27 00:41:01 +00:00
159 lines
4.7 KiB
C
159 lines
4.7 KiB
C
/*
|
|
* Copyright (c) 2023 Huawei Device Co., Ltd.
|
|
* 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
|
|
*
|
|
* http://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.
|
|
*/
|
|
|
|
/**
|
|
* @addtogroup Web
|
|
* @{
|
|
*
|
|
* @brief Provides APIs to use javascript proxy and run javascirpt code.
|
|
* @since 11
|
|
*/
|
|
/**
|
|
* @file native_interface_arkweb.h
|
|
*
|
|
* @brief Declares the APIs to use javascript proxy and run javascirpt code.
|
|
* @kit ArkWeb
|
|
* @library libohweb.so
|
|
* @syscap SystemCapability.Web.Webview.Core
|
|
* @since 11
|
|
*/
|
|
#ifndef NATIVE_INTERFACE_ARKWEB_H
|
|
#define NATIVE_INTERFACE_ARKWEB_H
|
|
|
|
#include <stdbool.h>
|
|
#include <stdint.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @brief Defines the javascript callback of the web component.
|
|
*
|
|
* @since 11
|
|
*/
|
|
typedef void (*NativeArkWeb_OnJavaScriptCallback)(const char*);
|
|
|
|
/**
|
|
* @brief Defines the javascript proxy callback of the web component.
|
|
*
|
|
* @since 11
|
|
*/
|
|
typedef char* (*NativeArkWeb_OnJavaScriptProxyCallback)(const char** argv, int32_t argc);
|
|
|
|
/**
|
|
* @brief Defines the valid callback of the web component.
|
|
*
|
|
* @since 11
|
|
*/
|
|
typedef void (*NativeArkWeb_OnValidCallback)(const char*);
|
|
|
|
/**
|
|
* @brief Defines the destroy callback of the web component.
|
|
*
|
|
* @since 11
|
|
*/
|
|
typedef void (*NativeArkWeb_OnDestroyCallback)(const char*);
|
|
|
|
/*
|
|
* @brief Loads a piece of code and execute JS code in the context of the currently displayed page.
|
|
*
|
|
* @param webTag The name of the web component.
|
|
* @param jsCode a piece of javascript code.
|
|
* @param callback Callbacks execute JavaScript script results.
|
|
*
|
|
* @syscap SystemCapability.Web.Webview.Core
|
|
* @since 11
|
|
*/
|
|
void OH_NativeArkWeb_RunJavaScript(const char* webTag, const char* jsCode, NativeArkWeb_OnJavaScriptCallback callback);
|
|
|
|
/*
|
|
* @brief Registers the JavaScript object and method list.
|
|
*
|
|
* @param webTag The name of the web component.
|
|
* @param objName The name of the registered object.
|
|
* @param methodList The method of the application side JavaScript object participating in the registration.
|
|
* @param callback The callback function registered by developer is called back when HTML side uses.
|
|
* @param size The size of the callback.
|
|
* @param needRefresh if web need refresh.
|
|
*
|
|
* @syscap SystemCapability.Web.Webview.Core
|
|
* @since 11
|
|
*/
|
|
void OH_NativeArkWeb_RegisterJavaScriptProxy(const char* webTag, const char* objName, const char** methodList,
|
|
NativeArkWeb_OnJavaScriptProxyCallback* callback, int32_t size, bool needRefresh);
|
|
|
|
/*
|
|
* @brief Deletes the registered object which th given name.
|
|
*
|
|
* @param webTag The name of the web component.
|
|
* @param objName The name of the registered object.
|
|
*
|
|
* @syscap SystemCapability.Web.Webview.Core
|
|
* @since 11
|
|
*/
|
|
void OH_NativeArkWeb_UnregisterJavaScriptProxy(const char* webTag, const char* objName);
|
|
|
|
/*
|
|
* @brief Registers the valid callback.
|
|
*
|
|
* @param webTag The name of the web component.
|
|
* @param callback The callback in which we can register object.
|
|
*
|
|
* @syscap SystemCapability.Web.Webview.Core
|
|
* @since 11
|
|
*/
|
|
void OH_NativeArkWeb_SetJavaScriptProxyValidCallback(const char* webTag, NativeArkWeb_OnValidCallback callback);
|
|
|
|
/*
|
|
* @brief Get the valid callback.
|
|
*
|
|
* @param webTag The name of the web component.
|
|
* @return Return the valid callback function registered. If the valid callback function
|
|
* specified by the parameter webTag is not set, a null pointer is returned.
|
|
*
|
|
* @syscap SystemCapability.Web.Webview.Core
|
|
* @since 11
|
|
*/
|
|
NativeArkWeb_OnValidCallback OH_NativeArkWeb_GetJavaScriptProxyValidCallback(const char* webTag);
|
|
|
|
/*
|
|
* @brief Registers the destroy callback.
|
|
*
|
|
* @param webTag The name of the web component.
|
|
* @param callback the destroy callback.
|
|
*
|
|
* @syscap SystemCapability.Web.Webview.Core
|
|
* @since 11
|
|
*/
|
|
void OH_NativeArkWeb_SetDestroyCallback(const char* webTag, NativeArkWeb_OnDestroyCallback callback);
|
|
|
|
/*
|
|
* @brief Get the destroy callback.
|
|
*
|
|
* @param webTag The name of the web component.
|
|
* @return Return the destroy callback function registered. If the destroy callback
|
|
* function specified by the parameter webTag is not set,
|
|
* a null pointer is returned.
|
|
*
|
|
* @syscap SystemCapability.Web.Webview.Core
|
|
* @since 11
|
|
*/
|
|
NativeArkWeb_OnDestroyCallback OH_NativeArkWeb_GetDestroyCallback(const char* webTag);
|
|
|
|
#ifdef __cplusplus
|
|
};
|
|
#endif
|
|
#endif // NATIVE_INTERFACE_ARKWEB_H
|