* 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 javascript code.
* @since 11
*/
* @file native_interface_arkweb.h
*
* @brief Declares the APIs to use javascript proxy and run javascript code.
* @library libohweb.so
* @syscap SystemCapability.Web.Webview.Core
* @since 11
*/
#ifndef NATIVE_INTERFACE_ARKWEB_H
#define NATIVE_INTERFACE_ARKWEB_H
#include <cstdint>
#include "arkweb_error_code.h"
#include "arkweb_type.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 Defines the callback of save cookie.
* @param errorCode {@link ARKWEB_SUCCESS} Save cookie success.
* {@link ARKWEB_COOKIE_MANAGER_INITIALIZE_FAILED} Cookie manager initialize failed.
* {@link ARKWEB_COOKIE_SAVE_FAILED} Save cookie failed.
* @since 20
*/
typedef void (*OH_ArkWeb_OnCookieSaveCallback)(ArkWeb_ErrorCode errorCode);
* @brief Defines the blankless information.
*
* @since 20
*/
typedef struct {
ArkWeb_BlanklessErrorCode errCode;
double similarity;
int32_t loadingTime;
} ArkWeb_BlanklessInfo;
* @brief ArkWeb Engine Version.
*
* @syscap SystemCapability.Web.Webview.Core
* @since 20
*/
typedef enum {
* ArkWeb version SYSTEM_DEFAULT.
* @since 20
*/
SYSTEM_DEFAULT = 0,
* ArkWeb M114 version.
* @since 20
*/
ARKWEB_M114 = 1,
* ArkWeb M132 version.
* @since 20
*/
ARKWEB_M132 = 2,
* ArkWeb M144 version.
* @since 26
*/
ARKWEB_M144 = 3,
* ArkWeb Evergreen Web Engine, always use the new ArkWeb Engine.
* Evergreen Web Engine.
* @since 23
*/
ARKWEB_EVERGREEN = 99999,
} ArkWebEngineVersion;
* @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 isNeedRefresh);
* @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.
*
* @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.
*
* @syscap SystemCapability.Web.Webview.Core
* @since 11
*/
NativeArkWeb_OnDestroyCallback OH_NativeArkWeb_GetDestroyCallback(const char* webTag);
* @brief Loads the data or URL.
* This function should be called on main thread.
*
* @param webTag The name of the web component.
* @param data A string encoded according to "Base64" or "URL", should not be NULL.
* @param mimeType Media type. For example: "text/html", should not be NULL.
* @param encoding Encoding type. For example: "UTF-8", should not be NULL.
* @param baseUrl A specified URL path ("http"/"https"/"data" protocol),
* which is assigned to window.origin by the Web component.
* @param historyUrl History URL. When it is not empty, it can be managed by
* history records to realize the back and forth function.
* @return LoadData result code.
* {@link ARKWEB_SUCCESS} load data success.
* {@link ARKWEB_INVALID_PARAM} Mandatory parameters are left unspecified or
* Incorrect parameter types or Parameter verification failed.
* {@link ARKWEB_INIT_ERROR} Initialization error, can't get a valid Web for the webTag.
* {@link ARKWEB_LIBRARY_OPEN_FAILURE} Failed to open the library.
* {@link ARKWEB_LIBRARY_SYMBOL_NOT_FOUND} The required symbol was not found in the library.
*
* @syscap SystemCapability.Web.Webview.Core
* @since 15
*/
ArkWeb_ErrorCode OH_NativeArkWeb_LoadData(const char* webTag,
const char* data,
const char* mimeType,
const char* encoding,
const char* baseUrl,
const char* historyUrl);
* @brief Registers a JavaScript object with callback methods, which may return values. This object will be injected
* into all frames of the current page, including all iframes, and will be accessible using the specified
* name in ArkWeb_ProxyObjectWithResult. The object will only be available in JavaScript after the next
* load or reload.
* These methods will be executed in the ArkWeb worker thread.
*
* @param webTag Name of the web component.
* @param proxyObject JavaScript object to register, the object has callback functions with return value.
* @param permission Optional JSON string(default is null) for JSBridge permission control,
* allowing URL whitelist configuration at object-level and method-level.
* @syscap SystemCapability.Web.Webview.Core
* @since 20
*/
void OH_NativeArkWeb_RegisterAsyncThreadJavaScriptProxy(const char* webTag,
const ArkWeb_ProxyObjectWithResult* proxyObject, const char* permission);
* @brief Obtains the prediction information about the blankless loading solution and enables the generation
* of the transition frame for the current loading. The application determines whether to enable the blankless
* loading solution based on the information.
* This API applies to pages in an applet or web application whose URLs are not fixed or cannot be uniquely
* identified.
*
* @param webTag webTag used when the webviewController is created.
* Default value: N/A.
* The value cannot be empty.
* When an invalid value is set, the error code is returned, and the API does not take effect.
* @param key Key value that uniquely identifies the current page.
* @return Return value of the ArkWeb_BlanklessInfo type.
* @since 20
*/
ArkWeb_BlanklessInfo OH_NativeArkWeb_GetBlanklessInfoWithKey(const char* webTag, const char* key);
* @brief Sets whether to enable blankless page loading. This API must be used in pair with the
* OH_NativeArkWeb_GetBlanklessInfoWithKey API.
*
* @param webTag webTag used when the webviewController is created.
* @param key Key value that uniquely identifies the current page. It must be the same as the key value of the
* OH_NativeArkWeb_GetBlanklessInfoWithKey API.
* @param isStarted Whether to enable frame interpolation. The value true indicates to enable frame
* interpolation, and the value false indicates the opposite.
* The default value is false.
* The value can be true or false.
* Action for setting an invalid value: N/A.
* @return Whether the API is successfully called. For details, see ArkWeb_BlanklessErrorCode.
* @since 20
*/
ArkWeb_BlanklessErrorCode OH_NativeArkWeb_SetBlanklessLoadingWithKey(const char* webTag,
const char* key,
bool isStarted);
* @brief Clears the blankless loading cache of the page with a specified key value.
*
* @param key The list of key values of pages cached in the blankless loading solution. These key values are
* specified in OH_NativeArkWeb_GetBlanklessInfoWithKey.
* The default value is the list of key values of all pages cached in the blankless loading solution.
* The key length cannot exceed 2048 characters, and the number of keys must be less than or equal to 100. The
* URL is the same as that input to the Web component during page loading.
* When the key length exceeds 2048 characters, the key does not take effect. When the number of keys exceeds
* 100, the first 100 keys are used. If this parameter is set to NULL, the default value is used.
* @param size Size of the key list.
* @since 20
*/
void OH_NativeArkWeb_ClearBlanklessLoadingCache(const char* key[], uint32_t size);
* @brief Sets the cache capacity of the blankless loading solution and returns the value that takes effect.
*
* @param capacity Cache capacity, in MB. The maximum value is 100 MB.
* The default value is 30 MB.
* The value ranges from 0 to 100. If this parameter is set to 0, no cache capacity is available and the
* functionality is disabled globally.
* When the value is set to a number smaller than 0, the value 0 takes effect. When the value is set to a
* number greater than 100, the value 100 takes effect.
* @return The effective value that ranges from 0 MB to 100 MB.
* @since 20
*/
uint32_t OH_NativeArkWeb_SetBlanklessLoadingCacheCapacity(uint32_t capacity);
* @brief Ensure that all cookies currently accessible via the CookieManager API have been persisted to disk.
* If you want to use this interface in a non-UI thread, you need to initialize the CookieManager interface
* using OH_ArkWeb_GetNativeAPI first.
* @return Save cookie result code.
* {@link ARKWEB_SUCCESS} Save cookie success.
* {@link ARKWEB_COOKIE_SAVE_FAILED} Save cookie failed.
* {@link ARKWEB_COOKIE_MANAGER_INITIALIZE_FAILED} The CookieManager initialize failed.
* {@link ARKWEB_COOKIE_MANAGER_NOT_INITIALIZED} It is not allowed to call on a non-UI thread without
* initializing the CookieManager interface. please
* initialize the CookieManager interface using
* OH_ArkWeb_GetNativeAPI first.
* @since 20
*/
ArkWeb_ErrorCode OH_ArkWebCookieManager_SaveCookieSync();
* @brief Ensure that all cookies currently accessible via the CookieManager API have been persisted to disk.
* Without initializing the CookieManager interface, this call will automatically be executed on the UI thread.
* @param callback Callback execute when save cookie done.
* @since 20
*/
void OH_ArkWebCookieManager_SaveCookieAsync(OH_ArkWeb_OnCookieSaveCallback callback);
* Set active ArkWeb engine version.
* If the system does not support the specified version, it will not take effect.
*
* This is a global static API that must be called before initializeWebEngine, and it will have no effect if any
* Web components are loaded.
* @param { ArkWebEngineVersion } webEngineVersion - the WebEngineVersion
* @since 20
*/
void OH_NativeArkWeb_SetActiveWebEngineVersion(ArkWebEngineVersion webEngineVersion);
* Get currently active ArkWeb engine version.
* @returns { ArkWebEngineVersion } Active ArkWeb Engine version as defined by WebEngineVersion
* @since 20
*/
ArkWebEngineVersion OH_NativeArkWeb_GetActiveWebEngineVersion();
* Delays the initialization of the web engine. By default, the web engine is initialized when the CookieManager
* interface is called. By setting the 'lazy' parameter to true, the web engine will not be initialized when the
* CookieManager interface is called. Instead, the web engine will be initialized either when the web component is
* created or when initializeWebEngine is called.
* @param { bool } lazy - Controls whether to delay the initialization of the web engine.
* @since 22
*/
void OH_NativeArkWeb_LazyInitializeWebEngineInCookieManager(bool lazy);
* Check if the currently active ArkWeb engine is Evergreen.
* @returns { bool } true means the application is using the Evergreen Web Engine, false means not.
* @since 23
*/
bool OH_NativeArkWeb_IsActiveWebEngineEvergreen();
#ifdef __cplusplus
};
#endif
#endif
