1# arkweb_interface.h 2<!--Kit: ArkWeb--> 3<!--Subsystem: Web--> 4<!--Owner: @aohui; @zourongchun--> 5<!--Designer: @yaomingliu; @zhufenghao--> 6<!--Tester: @ghiker--> 7<!--Adviser: @HelloCrease--> 8 9## 概述 10 11提供ArkWeb在Native侧获取API的接口，及基础Native API类型。 12 13**库：** libohweb.so 14 15**系统能力：** SystemCapability.Web.Webview.Core 16 17**起始版本：** 12 18 19**相关模块：** [Web](capi-web.md) 20 21## 汇总 22 23### 结构体 24 25| 名称 | typedef关键字 | 描述 | 26| -- | -- | -- | 27| [ArkWeb_AnyNativeAPI](capi-web-arkweb-anynativeapi.md) | ArkWeb_AnyNativeAPI | 定义基础Native API类型。 | 28 29### 枚举 30 31| 名称 | typedef关键字 | 描述 | 32| -- | -- | -- | 33| [ArkWeb_NativeAPIVariantKind](#arkweb_nativeapivariantkind) | ArkWeb_NativeAPIVariantKind | 定义Native API的类型枚举。 | 34 35### 函数 36 37| 名称 | 描述 | 38| -- | -- | 39| [ArkWeb_AnyNativeAPI* OH_ArkWeb_GetNativeAPI(ArkWeb_NativeAPIVariantKind type)](#oh_arkweb_getnativeapi) | 根据传入的API类型，获取对应的Native API结构体。 | 40| [bool OH_ArkWeb_RegisterScrollCallback(const char* webTag, ArkWeb_OnScrollCallback callback, void* userData)](#oh_arkweb_registerscrollcallback) | 注册滚动事件回调。 | 41 42## 枚举类型说明 43 44### ArkWeb_NativeAPIVariantKind 45 46``` 47enum ArkWeb_NativeAPIVariantKind 48``` 49 50**描述：** 51 52定义Native API的类型枚举。 53 54**起始版本：** 12 55 56| 枚举项 | 描述 | 57| -- | -- | 58| ARKWEB_NATIVE_COMPONENT | component相关API类型。 | 59| ARKWEB_NATIVE_CONTROLLER | controller相关API类型。 | 60| ARKWEB_NATIVE_WEB_MESSAGE_PORT | webMessagePort相关API类型。 | 61| ARKWEB_NATIVE_WEB_MESSAGE | webMessage相关API类型。 | 62| ARKWEB_NATIVE_COOKIE_MANAGER | cookieManager相关API类型。 | 63| ARKWEB_NATIVE_JAVASCRIPT_VALUE | JavaScriptValue相关接口类型。<br>**起始版本：** 18 | 64 65 66## 函数说明 67 68### OH_ArkWeb_GetNativeAPI() 69 70``` 71ArkWeb_AnyNativeAPI* OH_ArkWeb_GetNativeAPI(ArkWeb_NativeAPIVariantKind type) 72``` 73 74**描述：** 75 76根据传入的API类型，获取对应的Native API结构体。 77 78**系统能力：** SystemCapability.Web.Webview.Core 79 80**起始版本：** 12 81 82**参数：** 83 84| 参数项 | 描述 | 85| -- | -- | 86| [ArkWeb_NativeAPIVariantKind](#arkweb_nativeapivariantkind) type | ArkWeb支持的Native API类型。 | 87 88**返回：** 89 90| 类型 | 说明 | 91|----------------------------------------------| -- | 92| [ArkWeb_AnyNativeAPI](capi-web-arkweb-anynativeapi.md)* | 根据传入的API类型，返回对应的Native API结构体指针，结构体第一个成员为当前结构体的大小。 | 93 94### OH_ArkWeb_RegisterScrollCallback() 95 96``` 97bool OH_ArkWeb_RegisterScrollCallback(const char* webTag, ArkWeb_OnScrollCallback callback, void* userData) 98``` 99 100**描述** 101 102设置组件滚动时的回调函数。 103 104**系统能力：** SystemCapability.Web.Webview.Core 105 106**起始版本：** 18 107 108 109**参数：** 110 111| 参数项 | 描述 | 112| -- | -- | 113| const char* webTag | Web组件的名称。 | 114| [ArkWeb_OnScrollCallback](capi-arkweb-type-h.md#arkweb_onscrollcallback) callback | 页面滚动时的回调函数。 | 115| void* userData | 用户自定义的数据。 | 116 117**返回：** 118 119| 类型 | 说明 | 120| -- | -- | 121| bool | 如果回调设置成功，则返回true，否则返回false。 | 122 123 124