【轉】app之YdbOnline說明文檔

時間 2019-11-06

標籤 app ydbonline 說明文檔简体版

原文原文鏈接

概述

YdbOnline是面向網頁開發者提供的網頁開發工具包。javascript

經過使用YdbOnline，網頁開發者可藉助YdbOnline高效地使用語音、位置等手機系統的能力，同時能夠直接使用清除緩存、掃一掃等App特有的能力，爲用戶提供更優質的網頁體驗。html

此文檔面向網頁開發者介紹YdbOnline如何使用及相關注意事項。java

JSSDK使用步驟

步驟一：引入JS文件

在須要調用JS接口的頁面引入以下JS文件，（支持https）：http://static.ydbimg.com/API/YdbOnline.js
舊的接口(不建議使用)：http://static.ydbimg.com/API/YdbOnlineBig.js jquery

                    例如，頁面head部分插入代碼：＜script src="http://static.ydbimg.com/API/YdbOnline.js" type="text/javascript"＞＜／script＞

步驟二：初始化YDB對象

                初始化方法：var YDB = new YDBOBJ();
                //初始化以後才能夠調用相應SDK方法，

步驟三：調用YDB的相關方法

                例如：YDB.SetHeadBar(0);
                //設置隱藏頭部標題欄的所有屬性
                //特別說明：YDB的調用要放到頁面尾部，或者放入頁面加載完事件中
                //方法一：jquery 中：$(function(){} 括號內寫你的內容
                //方法二：使用body的onload屬性，onload='someFunctionsWithJssdk()'
                //方法三：window.onload=function(){//someFunctionsDoWithJssdk}//用window的onload事件，窗體加載完畢的時候

接口調用說明

全部接口經過實例YDB來調用，影響頁面設置的優先級以下：頁面內功能>全局設置>Url配置web

全局定義

初始化全局定義

                YDB.SetGlobal(參數1,參數2,參數3,參數4,參數5,參數6,參數7,參數8,參數9,參數10,參數11);
                //參數1（HeadBar） 是否顯示標題欄，0爲隱藏，1爲顯示
                //參數2（DragRefresh） 是否開啓下拉刷新，0爲關閉，1爲開啓
                //參數3（HeadBarExceptionList） 標識爲隱藏頂部導航的例外（相反與HeadBar設置）名單（顯示標題欄,參數爲URL的字符串，多個URL以逗號分隔）頁面列表
                //參數4（DragRefreshExceptionList） 下拉刷新例外(相反與DragRefresh
                //設置)名單（頁面執行下拉刷新,參數爲URL的字符串，多個URL以逗號分隔）   
                //參數5 (CashTime) 緩存時長,0爲不緩存，其餘整形數值配合CasgTimeUnit組成緩存時長
                //參數6 (CashTimeUnit) 緩存時間單位,小寫字母，m/h/d  分別表明分鐘/小時/天 ,字串類型   
                //參數7 (BackKeyUseType) 安卓手機返回鍵功能，0點擊返回上級頁面，1點擊返回頂級頁面
                //參數8 (ShowCloseButton) 是否顯示關閉按鈕，0隱藏，1顯示
                //參數9 (CloseText) 自定義關閉按鈕顯示文字，''空字串則使用默認的「關閉」
                //參數10(ClearCookie) 關閉應用是否清除cookie，0不清除，1清除
                //參數11(BgColor) 設置App原生底色（App默認底色爲#efefef），使用16進制顏色值設置，好比：#ffcc00

備註：全局屬性優先級低於局部頁面的優先級，全部多狀態參數爲int類型json

APP界面控制類

隱藏/顯示頂部標題欄

                    YDB.SetHeadBar(0);
                   //參數說明：顯示隱藏當前頁的頂部導航菜單，0爲隱藏，1爲顯示

隱藏底部菜單欄

                    YDB.SetMenuBar(0);
                   // 參數說明：顯示隱藏底部菜單欄，0爲隱藏，1爲顯示

適用模板：有導航模板數組

備註：瀏覽器

開啓關閉下拉刷新

                    YDB.SetDragRefresh(0);
                    // 參數說明：設置開啓關閉下拉刷新功能，0爲關閉，1爲開啓

備註：緩存

隱藏/顯示右側菜單

                    YDB.SetMoreButton(0);
                   // 參數說明：設置是否顯示右側菜單按鈕，0爲關閉右側菜單並隱藏右側菜單按鈕，1爲顯示右側菜單按鈕

備註：安全

導航菜單動態隱藏

                    YDB.MenuBarAutoHide(0);
                    // 參數說明：設置是否開啓菜單動態隱藏，0關閉，1開啓
                    // 若是開啓此功能，滑動屏幕動態隱藏顯示菜單、標題欄

適用模板：有導航模板

備註：

返回前一頁面

                    YDB.GoBack();
                    // 返回前一頁面

備註：

返回前一頁面時執行的操做

                    YDB.IsReloadPreviousPage(operation);
                   //參數說明，  執行返回前一頁面時的操做，operation當傳值爲1時，刷新前一頁面，傳值爲前一頁面的js方法名時，執行js方法。
                   //示例： 
                   //function gobackprevious() { var YDB = new YDBOBJ();  YDB.IsReloadPreviousPage('javascript:get_user_status();'); YDB.GoBack(); }
                   //其中get_user_status()是您前一個頁面的js方法名,返回前一頁面時會執行您前一頁面中的get_user_status()方法。
            <divonclick="gobackprevious();">返回前一頁面</div>

備註：此功能僅適用於開啓雲開發插件的應用。

進入下一頁面執行的操做

                    YDB.IsReloadNextPage(operation);
                   //參數說明， 進入到下一頁面時， operation當傳值爲1時，刷新下一頁面，傳值爲下一頁面的js方法名時，執行js方法。
                   //示例 ：var YDB = new YDBOBJ();  YDB.IsReloadNextPage('reload_page();');
                   //其中reload_page()是您下一個頁面的js方法名,進入下一頁面時會執行您下一頁面中的reload_page()方法。

備註：此功能僅適用於IOS。

關閉/開啓安卓硬件加速

                    YDB.SetHardware(state);
                   //參數說明， state 關閉/開啓安卓硬件加速，0爲關閉，1爲開啓。
                   //示例 ：var YDB = new YDBOBJ();  YDB.SetHardware(0);//關閉硬件加速

備註：此功能僅適用於安卓。

返回頂級頁面

                    YDB.GoTop();
                    // 返回頂級頁面（跳轉至此導航節點的起始頁面）

備註：

調出右側菜單

                    YDB.ShowTopRightMenu();
                    // 調出右側菜單

備註：

單頁面設置底色

                    YDB.SetBgColor(BgColor);
                    //設置App原生底色，使用16進制顏色值設置，好比：#ffcc00

備註：

顯示/隱藏返回按鈕

                    YDB.SetReturnButtonMode(showmode);
                    //參數說明，showmode  int類型，當傳值爲1時，顯示返回按鈕，傳值爲0 則隱藏返回按鈕。

備註：

打開新窗口

                     YDB.OpenNewWindow();
                    //等同於a標籤中的target="_blank"。
                    //打包以後的應用需使用YDB.OpenNewWindow()方法代替target="_blank"。                    
                    //示例： 
                    //function OpenNewWindow(){var YDB = new YDBOBJ(); YDB.OpenNewWindow();}
            <a href="new.html"onclick="OpenNewWindow();">新窗口打開</a>

備註：

新窗口動畫效果

                     YDB.AnimationWay("entranceway","exitway");
                    //參數說明：entranceway：頁面入場方式，可選參數：0 從右往左 1 從下往上 exitway：頁面出場方式，可選參數：0 從左往右 1 從上往下。
                    //當頁面中使用YDB.OpenNewWindow()打開新窗口時，默認動畫入場方式爲（0）從右往左，出場方式爲（0）從左往右。
                      僅支持YDB.AnimationWay("0","0") 和 YDB.AnimationWay("1","1")

備註：此功能需配合打開新窗口使用。

修改IOS狀態欄文字顏色

                     YDB.SetStatusBarStyle(fontcolor);
                    //參數說明：fontcolor：文字顏色，可選參數：0 白色 1 黑色 
                    //示例：YDB.SetStatusBarStyle(1);修改IOS狀態欄顏色爲黑色

備註：此功能僅適用於IOS。

是否固定底部導航

                     YDB.IsFixedBottomMenu(IntState);
                   //此功能爲全局功能，僅調用一次便可。
                    //參數說明：IntState：是否固定，可選參數：0 固定（當頁面有輸入框等調用鍵盤的操做時，底部導航不會跟隨鍵盤移動） 1 不固定（當頁面有輸入框等調用鍵盤的操做時，底部導航會跟隨鍵盤移動），默認效果爲不固定。 
                    //示例：YDB.IsFixedBottomMenu(0);設置底部導航不跟隨鍵盤移動

備註：此功能僅適用於安卓。

設置APP字體大小

                     YDB.SetFontSize();
                    //調用此方法可設置APP字體大小，能夠選大小有：小號字、中號字、標準字、大號字、特大號字，調用方法以後在APP中直接選擇便可。
                    //示例：var YDB = new YDBOBJ();YDB.SetFontSize();

備註：如調用方法沒有生效，請從新生成應用後使用。

調整屏幕亮度

                     YDB.SetBrightness(percent);
                    //調用此方法可調整屏幕亮度。
                    //參數說明：percent可選值爲0到1，其中0最暗，1最亮。
                    //示例：var YDB = new YDBOBJ();YDB.SetBrightness("0.6");設置屏幕亮度爲60%;

備註：如調用方法沒有生效，請從新生成應用後使用。

點擊全屏時是否橫屏

                     YDB.IsShowLandcape(showMode);
                    //參數說明：參數 showMode,類型 int， 0 不橫屏，1 橫屏。
                    //示例：var YDB = new YDBOBJ();YDB.IsShowLandcape(0);//點擊全屏時不橫屏

備註：

橫屏豎屏模式

                     YDB.ScreenOrientation(showMode);
                    //參數說明：參數 showMode,參數類型 int，0豎屏，1自適應，2橫屏。
                    //示例：var YDB = new YDBOBJ();YDB.ScreenOrientation(2);//開啓橫屏模式

備註：

APP系統功能類

掃一掃

無返回值方法

                    YDB.Scan();
                    // 參數說明：此方法無參數，直接調用掃一掃功能，掃描結果由App自行處理

備註：

有返回值方法

                    YDB.GetScan("你事先準備好的方法名");
                    //參數說明：web處理掃描結果，傳入返回值處理方法名，在這個方法中處理掃描字串,
                    //例如，您定義的方法爲 function DoWithScan(outValue){}; 
                    //那麼，調用SDK能夠這樣寫：YDB.GetScan("DoWithScan");

備註：

                    YDB.Share('標題','簡介','圖片路徑','連接地址','回調方法');
                    // 參數說明：分別傳入分享信息的標題、簡介、圖片路徑、URL連接地址、分享回調方法名（接收分享結果的json字串）
                    //示例：var YDB = new YDBOBJ(); YDB.Share("測試分享標題", "測試分享標題內容", "http://static.ydbimg.com/Images/frontimg/logo.png", "http://www.yundabao.cn/","Shareback");
                    //回調方法：function Shareback(state) {alert("分享結果：" + JSON.stringify(state)); } 
                    //分享結果的json數據示例：{"platform":"Wechat","state":"success"},其中platform中的Wechat表明微信好友(其餘分享平臺分別是WechatMoments(微信朋友圈)、SinaWeibo(新浪微博)、QQ(QQ)、Qzone(QQ空間)、ShortMessage(短信))，state的三種返回結果：success、fail、cancel
                    //提示：若是您使用QQ分享回調的同時開啓了QQ登陸插件，QQ登陸的插件參數APP ID需跟分享設置裏的騰訊開放平臺APP ID參數保持一致。微信分享回調需在分享設置頁面開啓微信分享回調纔可正常使用。

備註：原YdbOnline方法YDB.Share('標題','簡介','圖片路徑','連接地址')可繼續使用。

單個平臺分享

                    YDB.SingleShare('標題','簡介','圖片路徑','連接地址','要分享的平臺','回調方法');
                    // 參數說明：分別傳入分享信息的標題、簡介、圖片路徑、URL連接地址、要分享的平臺、分享回調方法名（接收分享結果的json字串）
                                         其中'要分享的平臺'可選參數：0、一、二、三、四、5   說明：0微信好友 1微信朋友圈 2新浪微博 3QQ 4QQ空間 5信息
                    //示例：var YDB = new YDBOBJ(); YDB.SingleShare("測試分享標題", "測試分享標題內容", "http://static.ydbimg.com/Images/frontimg/logo.png", "http://www.yundabao.cn/","1","SingleShare");
                    //回調方法：function SingleShareback(state) {alert("分享結果：" + JSON.stringify(state)); }
                    //分享結果的json數據示例：{"platform":"Wechat","state":"success"},其中platform中的Wechat表明微信好友(其餘分享平臺分別是WechatMoments(微信朋友圈)、SinaWeibo(新浪微博)、QQ(QQ)、Qzone(QQ空間)、ShortMessage(短信))，state的三種返回結果：success、fail、cancel
                    //提示：若是您使用QQ分享回調的同時開啓了QQ登陸插件，QQ登陸的插件參數APP ID需跟分享設置裏的騰訊開放平臺APP ID參數保持一致。微信分享回調需在分享設置頁面開啓微信分享回調纔可正常使用。

備註：

清理緩存

                    YDB.ClearCache();
                    //不須要參數，調用清理緩存的系統方法

備註：

獲取設備信息

                    YDB.GetDeviceInformation("處理返回值的函數名");
                    //參數說明：您須要定義處理返回值函數，例如 function DoWithDeviceInformation(info){/*do something with info*/};
                    //那麼，調用SDK能夠這樣寫：YDB. GetDeviceInformation ("DoWithDeviceInformation")

備註：

氣泡提醒

                    YDB.PopUp(index,count);
                    //參數說明：index 字符串類型，設定氣泡所在導航索引，從0開始，多個索引以逗號分隔; 
                    //count 字符串類型，設定氣泡中顯示數量的數字，多個數量以逗號分隔，跟索引數量要匹配。
                    //當count設置爲零，則表示當前索引不顯示氣泡！
                    //示例：YDB.PopUp("0","2");//表示在第一個導航處帶數字2的氣泡提醒

備註：

上傳圖片、拍照上傳功能

                    此功能不須要JS支持，頁面中只要包含上傳組件便可，在用戶點擊上傳的時候，App會自動啓動選取相冊中圖片文件或者調用拍照功能。

備註：

圖片預覽

                    YDB.ImageViewState(state);
                    //參數說明：若是要開啓圖片預覽功能，須要在相應頁面調用此功能，當state設置爲0時關閉圖片預覽功能；當state設置爲1時，開啓圖片預覽功能，
                    //同時，頁面中在須要預覽功能支持的圖片超連接進行以下設置：
                    //須要在圖片外層img標籤增長屬性Is9VImg="true"，當Is9vImg值爲true時，點擊圖片會啓動App的圖片瀏覽器。
                    //須要注意的是img的圖片路徑src必須是能夠直接訪問的帶http/https的網絡路徑。

備註：

退出安卓APP

                    YDB.ExitApp();          
                    //退出安卓APP

備註：此功能僅適用於安卓。

使用瀏覽器打開

                    YDB.OpenWithSafari("openurl");          
                    //參數openurl：須要在瀏覽器中打開的網址  
                    //示例：YDB.OpenWithSafari("http://m.baidu.com");;

備註：此功能適用於安卓和IOS。

獲取個推ClientID

                    YDB.GetClientIDOfGetui("doWithCIDFun");          
                    //參數說明：傳入返回值處理方法名，在這個方法中處理從個推申請到的cid
                    //例如，您定義的方法爲
                    // function doWithCIDFun (cid){/*do something with cid*/}; 
                    //那麼，調用SDK能夠這樣寫：YDB.GetClientIDOfGetui("doWithCIDFun");

備註：此功能適用於自有證書，而且在個推後臺配置過證書信息，準備自主整合個推接口的用戶，尤爲適合上傳過IOS上架證書的用戶（目前站內暫不支持IOS上架證書應用的個推推送）。

檢測IOS是否安裝微信客戶端

                     YDB.isWXAppInstalled("處理返回值的函數名");
                    //參數說明：您須要定義處理返回值函數，例如 function installstate(state){/*state返回的是微信客戶端安裝狀態：0未安裝 1已安裝*/};
                    //那麼，調用SDK能夠這樣寫：YDB.isWXAppInstalled("installstate")

備註：此插件僅適用於IOS

加強型上傳圖片

                     YDB.UploadImage(receiveUrl, showFun, UserName, Key, IsCut, Width, Height);
                    //參數說明：receiveUrl 接收並處理圖片的頁面, showFun 處理上傳圖片返回路徑的函數名, UserName 用戶惟一標識（UserName可自定義,名稱和值之間需用冒號‘：’隔開，例：User:lisi）,
                                Key 用戶密碼（Key可自定義，名稱和值之間需用冒號‘：’隔開，例：PassWd:111111）, IsCut 是否裁剪圖片（0關閉裁剪，1開啓裁剪）, Width 所需圖片寬度, Height 所需圖片高度

備註：

APP插件類

語音識別

                   YDB.SpeechRecognition("處理語音識別結果函數名");
                   //參數說明：傳入返回值處理方法名，在這個方法中處理掃描字串
                   //例如，您定義的方法爲
                   // function DoWithSpeechRecognition (outValue){/*do something with outValue*/}; 
                   //那麼，調用SDK能夠這樣寫：YDB.SpeechRecognition("DoWithSpeechRecognition");

備註：此功能需開啓語音插件以後纔可以使用。

地理位置

                   YDB.GetGPS("處理返回座標信息的方法名");
                   // 您須要定義一個處理函數
                   //例如：function DoWithGPS (la,lo){//dosomething with la,lo }; 
                   //那麼，調用SDK能夠這樣寫：YDB.GetGPS(「DoWithGPS」);

備註：開通定位插件並配置相關參數以後，纔可以使用此功能。

實時地理位置

開啓實時定位

                    YDB.OpenGPS(userid);
                    //參數說明：userid 用戶惟一身份id，用於傳遞用戶身份信息，
                    //須要在後臺系統設置中設置，提交間隔，抓取間隔，接收地址等幾項參數，
                    //接收地址用於接收來自應用post提交的數據（post參數名：gps,值示例：[{"userid":"888","time":"2015-05-06    16:10:45","lon":"113.574804","lat":"34.807128"},{"userid":"888","time":"2015-05-06    16:10:50","lon":"113.574804","lat":"34.807128"}]）

備註：開通定位插件並配置相關參數以後，纔可以使用此功能。

關閉實時定位

                    YDB.CloseGPS();
                    // 不須要參數，調用此方法中止實時定位

備註：開通定位插件並配置相關參數以後，纔可以使用此功能。

支付寶支付

                    YDB.SetAlipayInfo(ProductName, Desicript, Price, OuttradeNo);
                    //參數說明：ProductName 名稱, Desicript 描述, Price 支付金額, OuttradeNo 訂單編號(64個字符之內、可包含字母、數字、下劃線，需保證在商戶端不重複)

備註：開通支付寶支付插件並配置相關參數以後，纔可以使用此功能。

微信支付

                    YDB.SetWxpayInfo(ProductName, Desicript, Price, OuttradeNo,attach);
                    //參數說明：ProductName 名稱, Desicript 描述, Price 支付金額, OuttradeNo 訂單編號(32個字符內、可包含字母),attach 附加參數。
                    //支付結果頁面中OuttradeNo,attach將以Querstring的方式傳遞

備註：開通微信支付插件並配置相關參數以後，纔可以使用此功能。

微信登陸

                    YDB.WXLogin(returnDataType, accessUrl);                
                    //參數returnDataType： 返回值類型
                    //參數accessUrl： accessUrl（必須爲帶http或https的網絡路徑）接收返回值的url，可附加Url參數，用來判斷用戶登陸狀態以及設置用戶信息等操做
                    //參數影響：
                    //當returnDataType爲0時，accessUrl在post時接收到參數爲：token (字符類型)、openid (字符類型)、sign (Md5加密字串)，get時接收到的參數爲openid (字符類型)
                    //當returnDataType爲1時，accessUrl在post時接收到參數爲：token (Json字串)、resault (Json字串)、openid (字符類型)、sign (Md5加密字串)，get時接收到的參數爲openid (字符類型)

備註：此插件須要開通微信登陸插件並配置相關參數，微信登陸總體流程：調用js_sdk方法-->呼出微信登陸窗口-->登陸驗證經過-->手機端post數據給accessUrl（post參數：token，openid，sign等），accessUrl 處理接收到的數據，並標記用戶登陸狀態 --> App跳轉到accessUrl（get參數：openid） --> accessUrl根據先前存儲的信息處理後續跳轉等操做，其中sign爲輔助性的安全校驗參數，sign=MD5(傳遞參數&鏈{SignKey})，SignKey在「服務功能」->"其餘功能"->"安全碼設置"中配置。
舒適提示：對於iOS應用，考慮到iOS應用商店審覈指南中的相關規定，建議開發者接入微信登陸時，先檢測用戶手機是否已安裝微信客戶端（使用sdk中isWXAppInstalled函數），對未安裝的用戶隱藏微信登陸按鈕，只提供其餘登陸方式（好比手機號註冊登陸、遊客登陸等）。

獲取Wifi的ssid

                     YDB.GetWifiSsid("處理返回值的函數名");
                    //參數說明：您須要定義處理返回值函數，例如 function DoWithWifiSsid(info){/*info返回的是您當前鏈接wifi的ssid*/};
                    //那麼，調用SDK能夠這樣寫：YDB.GetWifiSsid("DoWithWifiSsid")

備註：開通獲取Wifi的ssid插件以後，纔可以使用此功能。

指紋驗證

                     YDB.UseTouchID("DoWithTouchID","LoginUrl","AccessTitle","FallbackTitle");
                    //參數說明：DoWithTouchID：您須要定義處理返回值函數，例如 function DoWithTouchID(info){/*info中返回值 0是驗證失敗，1是驗證成功*/};
                                     LoginUrl：指紋驗證失敗時，用戶提供的帶有其餘驗證方式的url地址。
                                  AccessTitle：提示文字，用來向用戶說明使用指紋驗證的目的。
                                FallbackTitle：指紋驗證失敗時，提示框的文字提示，默認提示爲「輸入密碼」。
                    //示例：YDB.UseTouchID("DoWithTouchID","http://你的驗證url地址","指紋驗證","其餘驗證方式")

備註：開通指紋驗證插件後纔可以使用此功能，此功能僅適用於IOS。

獲取健康步數

                     YDB.GetHealthStep("處理返回值的函數名");
                    //參數說明：您須要定義處理返回值函數，例如 function DoWithHealthStep(info){/*info中返回的是您當前的健康步數*/};
                    //那麼，調用SDK能夠這樣寫：YDB.GetHealthStep("DoWithHealthStep")

備註：開通獲取健康步數插件後纔可以使用此功能，此功能適用於安卓和IOS。

QQ登陸

                    YDB.QQLogin(accessUrl);          
                    //參數accessUrl： accessUrl（必須爲帶http或https的網絡路徑）接收返回值的url，可附加Url參數，用來判斷用戶登陸狀態以及設置用戶信息等操做
                    //接收參數：
                    //accessUrl接收到參數爲：openid（用戶惟一標識）字符類型、token 字符類型、userinfo（用戶暱稱、用戶頭像等基本信息） Json字串

備註：開通QQ登陸插件並配置相關參數以後，纔可以使用此功能。