10.1.68 基線
本文檔介紹 10.1.68 基線下關(guān)于 H5 容器和離線包的 Android SDK 的接口詳情。
公共函數(shù)
H5TitleView
getTitle
聲明:
String getTitle();
說(shuō)明:獲取主標(biāo)題文本。
參數(shù):無(wú)。
返回值:String,主標(biāo)題。
setTitle
聲明:
void setTitle(String title);
說(shuō)明:設(shè)置主標(biāo)題文本。
參數(shù):
參數(shù)
類型
說(shuō)明
title
String
標(biāo)題文本
返回值:無(wú)。
setSubTitle
聲明:
void setSubTitle(String subTitle);
說(shuō)明:設(shè)置副標(biāo)題。
參數(shù):
參數(shù)
類型
說(shuō)明
subTitle
String
副標(biāo)題文本
返回值:無(wú)。
setImgTitle
聲明:
void setImgTitle(Bitmap imgTitle);
說(shuō)明:設(shè)置圖像圖標(biāo)。
參數(shù):
參數(shù)
類型
說(shuō)明
imgTitle
Bitmap
圖像信息
返回值:無(wú)。
setImgTitle
聲明:
void setImgTitle(Bitmap imgTitle,String contentDescription);
說(shuō)明:設(shè)置圖像圖標(biāo)和 contentDescription。
參數(shù):
參數(shù)
類型
說(shuō)明
imgTitle
Bitmap
圖像信息
contentDescription
String
contentDescription 的內(nèi)容
返回值:無(wú)。
showCloseButton
聲明:
void showCloseButton(boolean visible);
說(shuō)明:是否顯示關(guān)閉按鈕。
參數(shù):
參數(shù)
類型
說(shuō)明
visible
boolean
是否顯示關(guān)閉按鈕:
為 true 時(shí),顯示關(guān)閉按鈕
為 false 時(shí),不顯示關(guān)閉按鈕
返回值:無(wú)。
getContentView
聲明:
View getContentView();
說(shuō)明:容器獲取標(biāo)題欄 View。
參數(shù):無(wú)。
返回值:View,標(biāo)題欄 View。
getContentBgView
聲明:
ColorDrawable getContentBgView();
說(shuō)明:容器獲取標(biāo)題欄背景。
參數(shù):無(wú)。
返回值:ColorDrawable,標(biāo)題欄背景。
getMainTitleView
聲明:
TextView getMainTitleView();
說(shuō)明:容器獲取主標(biāo)題 View。
參數(shù):無(wú)。
返回值:TextView,主標(biāo)題 View。
getSubTitleView
聲明:
TextView getSubTitleView();
說(shuō)明:容器獲取副標(biāo)題 View。
參數(shù):無(wú)。
返回值:TextView,副標(biāo)題 View。
showBackButton
聲明:
void showBackButton(boolean visible);
說(shuō)明:設(shè)置是否展示返回按鈕。
參數(shù):
參數(shù)
類型
說(shuō)明
visible
boolean
是否展示返回按鈕:
為 true 時(shí),顯示返回按鈕
為 false 時(shí),不顯示返回按鈕
返回值:無(wú)。
showBackHome
聲明:
void showBackHome(boolean visible);
說(shuō)明:設(shè)置首頁(yè)按鈕可見(jiàn)性。
參數(shù):
參數(shù)
類型
說(shuō)明
visible
boolean
是否顯示首頁(yè)按鈕:
為 true 時(shí),顯示返回首頁(yè)按鈕
為 false 時(shí),不顯示返回首頁(yè)按鈕
返回值:無(wú)。
showOptionMenu
聲明:
void showOptionMenu(boolean visible);
說(shuō)明:設(shè)置是否顯示右上角菜單項(xiàng)。
參數(shù):
參數(shù)
類型
說(shuō)明
visible
boolean
是否顯示右上角菜單項(xiàng):
為 true 時(shí),顯示菜單
為 false 時(shí),不顯示菜單
返回值:無(wú)。
setOptionType
聲明:
void setOptionType(H5Param.OptionType type);
說(shuō)明:設(shè)置右上角菜單項(xiàng)展示類型。
參數(shù):
參數(shù)
類型
說(shuō)明
type
H5Param.OptionType
菜單展示類型
返回值:無(wú)。
setOptionType
聲明:
void setOptionType(H5Param.OptionType type, int num, boolean byIndex);
說(shuō)明:設(shè)置右上角菜單項(xiàng)展示類型。
參數(shù):
參數(shù)
類型
說(shuō)明
type
H5Param.OptionType
菜單展示類型
num
int
表示從右往左的第幾個(gè) icon,從 0 開(kāi)始數(shù)
byIndex
boolean
是否只對(duì)某個(gè)菜單項(xiàng)設(shè)置展示類型
返回值:無(wú)。
showTitleLoading
聲明:
void showTitleLoading(boolean visible);
說(shuō)明:設(shè)置是否在標(biāo)題欄上顯示加載狀態(tài),可根據(jù)需要選擇實(shí)現(xiàn)方式。
參數(shù):
參數(shù)
類型
說(shuō)明
visible
boolean
是否在標(biāo)題欄上顯示加載狀態(tài)
返回值:無(wú)。
setBtIcon
聲明:
void setBtIcon(Bitmap btIcon, int index);
說(shuō)明:設(shè)置右上角按鈕圖標(biāo)。
參數(shù):
參數(shù)
類型
說(shuō)明
btIcon
Bitmap
圖標(biāo)
index
int
表示從右往左的第幾個(gè) icon,從 0 開(kāi)始數(shù)
返回值:無(wú)。
setH5Page
聲明:
void setH5Page(H5Page h5Page);
說(shuō)明:設(shè)置容器的 H5 頁(yè)面。
參數(shù):
參數(shù)
類型
說(shuō)明
h5Page
H5Page
H5 頁(yè)面
返回值:無(wú)。
setOptionMenu
聲明:
void setOptionMenu(JSONObject params);
說(shuō)明:根據(jù) JS 傳遞過(guò)來(lái)的參數(shù)設(shè)置右上角菜單。
參數(shù):
參數(shù)
類型
說(shuō)明
params
JSONObject
JS 參數(shù)
返回值:無(wú)。
getDivider
聲明:
View getDivider();
說(shuō)明:容器獲取返回按鈕和標(biāo)題內(nèi)容之間的分割線,可返回空。
參數(shù):無(wú)。
返回值:View,分割線 View。
getHdividerInTitle
聲明:
View getHdividerInTitle();
說(shuō)明:容器獲取標(biāo)題欄和 Web 頁(yè)面間的分割線,不可為空。
參數(shù):無(wú)。
返回值:View,分割線 View。
getPopAnchor
聲明:
View getPopAnchor();
說(shuō)明:容器獲取下拉菜單彈出位置的錨點(diǎn) View。
參數(shù):無(wú)。
返回值:View,下拉菜單彈出位置的錨點(diǎn) View。
resetTitleColor
聲明:
void resetTitleColor(int color);
說(shuō)明:容器重置標(biāo)題欄背景色。
參數(shù):
參數(shù)
類型
說(shuō)明
color
int
顏色值
返回值:無(wú)。
releaseViewList
聲明:
void releaseViewList();
說(shuō)明:釋放被引用的 View,容器頁(yè)面銷毀時(shí)觸發(fā)此方法。
參數(shù):無(wú)。
返回值:無(wú)。
openTranslucentStatusBarSupport
聲明:
void openTranslucentStatusBarSupport(int color);
說(shuō)明:容器設(shè)置沉浸式標(biāo)題欄顏色。
參數(shù):
參數(shù)
類型
說(shuō)明
color
int
顏色值
返回值:無(wú)。
setTitleTxtColor
聲明:
void setTitleTxtColor(int color);
說(shuō)明:設(shè)置標(biāo)題欄字體顏色。
參數(shù):
參數(shù)
類型
說(shuō)明
color
int
顏色值
返回值:無(wú)。
getOptionMenuContainer
聲明:
View getOptionMenuContainer();
說(shuō)明:容器獲取右上角菜單 View, 必須是 ViewGroup 及子類。
參數(shù):無(wú)。
返回值:View,右上角菜單 View。
getOptionMenuContainer
聲明:
View getOptionMenuContainer(int index);
說(shuō)明:容器根據(jù)位置獲取右上角菜單 View,必須是 ViewGroup 及子類。
參數(shù):
參數(shù)
類型
說(shuō)明
index
int
從右向左的第幾個(gè) icon 的位置,從 0 開(kāi)始數(shù)
返回值:View,右上角菜單 View。
setBackgroundAlphaValue
聲明:
void setBackgroundAlphaValue(int alpha);
說(shuō)明:設(shè)置背景透明度。
參數(shù):
參數(shù)
類型
說(shuō)明
alpha
int
透明度值
返回值:無(wú)。
setBackgroundColor
聲明:
void setBackgroundColor(int color);
說(shuō)明:設(shè)置背景色。
參數(shù):
參數(shù)
類型
說(shuō)明
color
int
背景色的值
返回值:無(wú)。
H5AppCenterPresetProvider
getCommonResourceAppList
聲明:
Set<String> getCommonResourceAppList();
說(shuō)明:獲取全局資源包。
參數(shù):無(wú)。
返回值:
Set<String>
,全局資源包集合。
getH5PresetPkg
聲明:
H5PresetPkg getH5PresetPkg();
說(shuō)明:獲取預(yù)置資源包。
參數(shù):無(wú)。
返回值:H5PresetPkg,H5 預(yù)置資源包。
getTinyCommonApp
聲明:
String getTinyCommonApp();
說(shuō)明:獲取 tinyApp 的公告資源包的 appId。
參數(shù):無(wú)。
返回值:String,tinyApp 的公告資源包的 appId。
H5Plugin
onPrepare
聲明:
void onPrepare(H5EventFilter filter);
說(shuō)明:預(yù)準(zhǔn)備階段注冊(cè) H5 插件過(guò)濾器。
參數(shù):
參數(shù)
類型
說(shuō)明
filter
H5EventFilter
H5 插件過(guò)濾器
返回值:無(wú)。
interceptEvent
聲明:
boolean interceptEvent(final H5Event event, final H5BridgeContext context);
說(shuō)明:攔截事件。
參數(shù):
參數(shù)
類型
說(shuō)明
event
H5Event
H5 事件
context
H5BridgeContext
上下文
返回值:boolean,若成功返回 true,否則返回 false。
handleEvent
聲明:
boolean handleEvent(final H5Event event, final H5BridgeContext context);
說(shuō)明:是否處理事件。
參數(shù):
參數(shù)
類型
說(shuō)明
event
H5Event
可處理的只讀事件
context
H5BridgeContext
用于處理一些 JSAPI 相關(guān)事件的橋接上下文
返回值:boolean,true 表示插件已經(jīng)處理了它,否則返回 false。
MPNebula
downloadApp
聲明:
public static void downloadApp(final String appId, final MpaasNebulaDownloadCallback mpaasNebulaDownloadCallback)
說(shuō)明:下載離線包。
參數(shù):
參數(shù)
類型
說(shuō)明
appId
String
離線包 ID
mpaasNebulaDownloadCallback
MpaasNebulaDownloadCallback
下載回調(diào)
返回值:無(wú)。
installApp
聲明:
public static void installApp(final String appId, final MpaasNebulaInstallCallback mpaasNebulaInstallCallback)
說(shuō)明:安裝離線包。
參數(shù):
參數(shù)
類型
說(shuō)明
appId
String
離線包 ID
mpaasNebulaInstallCallback
MpaasNebulaInstallCallback
安裝回調(diào)
返回值:無(wú)。
loadOfflineNebula
聲明:
public static void loadOfflineNebula(String jsonFileName, MPNebulaOfflineInfo… mpNebulaOfflineInfos)
說(shuō)明:加載預(yù)置離線包。
參數(shù):
參數(shù)
類型
說(shuō)明
jsonFileName
String
預(yù)置離線包 JSON,可從控制臺(tái)下載
mpNebulaOfflineInfos
MPNebulaOfflineInfo
預(yù)置離線包信息
返回值:無(wú)。
registerH5Plugin
聲明:
public static void registerH5Plugin(String className, String bundleName, String scope, String[] events)
說(shuō)明:注冊(cè)自定義 H5 插件(JSAPI)。
參數(shù):
參數(shù)
類型
說(shuō)明
className
String
插件類名,需要全路徑(package + class)
bundleName
String
bundle 名(bundle 名可在主 module/build/intermediates/bundle/META-INF/BUNDLE.MF 中查看)
scope
String
范圍,通常為 “page”
events
String[]
注冊(cè)的事件
返回值:無(wú)。
enableAppVerification
聲明:
public static void enableAppVerification(final String publicKey)
說(shuō)明:開(kāi)啟離線包驗(yàn)簽。必須在首次打開(kāi)離線包之前開(kāi)啟離線包驗(yàn)簽,否則無(wú)法正確設(shè)置公鑰。
參數(shù):
參數(shù)
類型
說(shuō)明
publicKey
String
驗(yàn)簽公鑰
返回值:無(wú)。
setCustomViewProvider
聲明:
public static void setCustomViewProvider(H5ViewProvider viewProvider)
說(shuō)明:設(shè)置容器相關(guān)的自定義 View,如標(biāo)題欄、菜單欄、Web Layout、下拉刷新 View 等。
參數(shù):
參數(shù)
類型
說(shuō)明
viewProvider
H5ViewProvider
自定義 view provider
返回值:無(wú)。
getH5View
聲明:
public static View getH5View(Activity activity, Bundle param)
說(shuō)明:獲取 H5 容器的視圖(view)。
參數(shù):
參數(shù)
類型
說(shuō)明
activity
Activity
頁(yè)面上下文
param
Bundle
啟動(dòng)參數(shù),內(nèi)部可包含 appid 或是 URL
返回值View,H5 容器的視圖(view)
getH5ViewAsync
聲明:
public static void getH5ViewAsync(Activity activity, Bundle param, H5PageReadyListener h5PageReadyListener)
說(shuō)明:異步獲取 H5 容器的視圖(view)。
參數(shù):
參數(shù)
類型
說(shuō)明
activity
Activity
頁(yè)面上下文
param
Bundle
啟動(dòng)參數(shù),內(nèi)部可包含 appid 或是 URL
h5PageReadyListener
H5PageReadyListener
異步回調(diào)
返回值:無(wú)。
AbsTitleView
resetTitle
聲明:
public abstract void resetTitle();
說(shuō)明:重置導(dǎo)航欄。
參數(shù):無(wú)。
返回值:無(wú)。
H5ViewProvider
全屏 H5 自定義 View 切點(diǎn)。
createTitleView
聲明:
H5TitleView createTitleView(Context context);
說(shuō)明:創(chuàng)建自定義標(biāo)題欄的標(biāo)題。
參數(shù):
參數(shù)
類型
說(shuō)明
context
Context
上下文
返回值:H5TitleView,自定義標(biāo)題欄的標(biāo)題。
createNavMenu
聲明:
public H5NavMenuView createNavMenu()
說(shuō)明:創(chuàng)建自定義導(dǎo)航菜單。
參數(shù):無(wú)。
返回值:H5NavMenuView,自定義的導(dǎo)航菜單。
createPullHeaderView
聲明:
H5PullHeaderView createPullHeaderView(Context context, ViewGroup viewGroup);
說(shuō)明:創(chuàng)建自定義下拉刷新的頭部樣式。
參數(shù):
參數(shù)
類型
說(shuō)明
context
Context
上下文
viewGroup
ViewGroup
ViewGroup 控件
返回值:H5PullHeaderView,自定義下拉刷新的頭部
createWebContentView
聲明:
H5WebContentView createWebContentView(Context context);
說(shuō)明:創(chuàng)建 WebView 的承載布局。
參數(shù):
參數(shù)
類型
說(shuō)明
context
Context
上下文
返回值:H5WebContentView,自定義 WebView 的承載布局。
ITinyOptionMenuView
getView
聲明:
View getView();
說(shuō)明:獲取當(dāng)前 View。
參數(shù):無(wú)。
返回值:View,當(dāng)前界面 View。
setH5Page
聲明:
void setH5Page(H5Page h5Page);
說(shuō)明:設(shè)置容器的 H5 頁(yè)面。
參數(shù):
參數(shù)
類型
說(shuō)明
h5Page
H5Page
H5 頁(yè)面
返回值:無(wú)。
setOptionMenuOnClickListener
聲明:
void setOptionMenuOnClickListener(View.OnClickListener listener);
說(shuō)明:設(shè)置選項(xiàng)菜單的監(jiān)聽(tīng)事件。
參數(shù):
參數(shù)
類型
說(shuō)明
listener
View.OnClickListener
View 的監(jiān)聽(tīng)事件
返回值:無(wú)。
setCloseButtonOnClickListener
聲明:
void setCloseButtonOnClickListener(View.OnClickListener listener);
說(shuō)明:設(shè)置關(guān)閉按鈕的監(jiān)聽(tīng)事件。
參數(shù):
參數(shù)
類型
說(shuō)明
listener
View.OnClickListener
View 的監(jiān)聽(tīng)事件
返回值:無(wú)。
setCloseButtonOnLongClickListener
聲明:
void setCloseButtonOnLongClickListener(View.OnLongClickListener listener);
說(shuō)明:長(zhǎng)按關(guān)閉按鈕的監(jiān)聽(tīng)事件。
參數(shù):
參數(shù)
類型
說(shuō)明
listener
View.OnLongClickListener
View 的監(jiān)聽(tīng)事件
返回值:無(wú)。
H5Utils
setProvider
聲明:
void setProvider(String name, Object provider);
說(shuō)明:設(shè)置 Provider。
參數(shù):
參數(shù)
類型
說(shuō)明
name
String
Provider 的名稱
provider
Object
Provider 對(duì)象
返回值:無(wú)。
AbsTinyOptionMenuView
onTitleChange
聲明:
void onTitleChange(H5TitleView title);
說(shuō)明:響應(yīng)標(biāo)題欄變化。
參數(shù):
參數(shù)
類型
說(shuō)明
title
H5TitleView
H5 標(biāo)題欄
返回值:無(wú)。
H5ReplaceResourceProvider
自定義資源動(dòng)態(tài)加載切點(diǎn)
getReplaceResourcesBundleName
聲明:
String getReplaceResourcesBundleName();
說(shuō)明:獲取標(biāo)題欄資源的 bundle 名稱。
參數(shù):無(wú)。
返回值:String,標(biāo)題欄資源的 bundle 名稱。
H5ErrorPageView
自定義網(wǎng)絡(luò)錯(cuò)誤頁(yè)接口
enableShowErrorPage
聲明:
boolean enableShowErrorPage(H5Page h5Page, APWebView view, String errorUrl, int statusCode, String errorMsg, String subErrorMsg, Bundle extInfo, Object extObj);
說(shuō)明:是否展示自定義錯(cuò)誤頁(yè)面。
參數(shù):
參數(shù)
類型
說(shuō)明
h5Page
H5Page
Page 對(duì)象
view
APWebView
WebView 對(duì)象
errorUrl
String
錯(cuò)誤地址
statusCode
int
錯(cuò)誤碼
errorMsg
String
錯(cuò)誤描述
subErrorMsg
String
錯(cuò)誤描述 sub
extInfo
Bundle
擴(kuò)展信息
extObj
Object
擴(kuò)展類
返回值:boolean 類型,為 true 時(shí)表示需要展示自定義頁(yè)面,會(huì)執(zhí)行 errorPageCallback 方法。
H5BridgeContext
H5 插件返回結(jié)果給 Jsapi 請(qǐng)求接口類
sendBridgeResult
聲明:
boolean sendBridgeResult(JSONObject data);
說(shuō)明:給 JS 層返回結(jié)果。返回一次事件就被消費(fèi)掉,如需多次使用一個(gè) BridgeContext 返回,則需調(diào)用 sendBridgeResultWithCallbackKept。
參數(shù):
參數(shù)
類型
說(shuō)明
data
JSONObject
返回給 JS 層的數(shù)據(jù)
返回值:boolean 類型,若成功則返回 true,否則返回 false。
sendToWeb
聲明:
void sendToWeb(String action, JSONObject param, H5CallBack callback);
說(shuō)明:給 JS 層返回結(jié)果,支持添加回調(diào)參數(shù)。
參數(shù):
參數(shù)
類型
說(shuō)明
action
String
傳遞數(shù)據(jù)時(shí)的 action
param
JSONObject
需要傳遞給 JS 層的數(shù)據(jù)
callback
H5CallBack
-
返回值:無(wú)。
sendError
聲明:
boolean sendError(H5Event event, Error code);
說(shuō)明:發(fā)送錯(cuò)誤信息。
參數(shù):
參數(shù)
類型
說(shuō)明
event
H5Event
H5 事件
code
Error
錯(cuò)誤信息
返回值:boolean 類型,為 true 時(shí)表示傳遞成功,否則為 false。
sendSuccess
聲明:
void sendSuccess();
說(shuō)明:用于無(wú)返回值的 H5 回調(diào)。
參數(shù):無(wú)。
返回值:無(wú)。
sendError
聲明:
void sendError(int error, String errorMessage);
說(shuō)明:自定義返回錯(cuò)誤碼和返回文案。
參數(shù):
參數(shù)
類型
說(shuō)明
error
int
返回錯(cuò)誤碼
errorMessage
String
返回文案
返回值:無(wú)。
回調(diào)函數(shù)
errorPageCallback
聲明:
void errorPageCallback(H5Page h5Page, APWebView view, String errorUrl, int statusCode, String errorMsg, String subErrorMsg, Bundle extInfo, Object extObj)
說(shuō)明:錯(cuò)誤頁(yè)回調(diào)。
參數(shù):
參數(shù)
類型
說(shuō)明
h5Page
H5Page
Page 對(duì)象
view
APWebView
WebView 對(duì)象
errorUrl
String
錯(cuò)誤地址
statusCode
int
錯(cuò)誤碼
errorMsg
String
錯(cuò)誤描述
subErrorMsg
String
錯(cuò)誤描述 sub
extInfo
Bundle
擴(kuò)展信息
extObj
Object
擴(kuò)展類
返回值:無(wú)。