YdbOnline說明文檔


目錄

概述

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

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

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

JSSDK使用步驟

步驟一:引入JS文件

在需要調用JS接口的頁面引入如下JS文件,(支持https):https://static.ydbimg.com/API/YdbOnline.js
舊的接口(不建議使用):https://static.ydbimg.com/API/YdbOnlineBig.js

                    例如,頁面head部分插入代碼:<script src="https://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配置

全局定義

初始化全局定義

                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類型

APP界面控制類

隱藏/顯示頂部標題欄

                    YDB.SetHeadBar(showHideType,titleColor,backColor,titleHeight);
                   //顯示隱藏當前頁的頂部導航菜單
                   //參數說明:
                   //第一個是顯示隱藏(例:"0"(隱藏)、"1"(顯示)),第二個是標題文字顏色。第三個背景顏色,第四個是標題欄高度,全是字符類型
                   //例如:var YDB = new YDBOBJ();  YDB.SetHeadBar("1","#ffffff","#2cc2fa","42");//顯示標題欄,內頁白色標題,藍底,高度42像素
            

隱藏底部菜單欄

                    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方法。
                   //示例:<div  onclick="gobackprevious();">返回前一頁面</div>
                   //function gobackprevious() { var YDB = new YDBOBJ();  YDB.IsReloadPreviousPage('javascript:get_user_status();'); YDB.GoBack(); }
                   //其中get_user_status()是您前一個頁面的js方法名,返回前一頁面時會執行您前一頁面中的get_user_status()方法。
            

備注:此功能僅適用于開啟云開發插件的應用。

進入下一頁面執行的操作

                    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.OpenByBrowser(type,url);
                   //參數說明:
                   //type 字符串類型,值為qq/baidu/uc/360/opera(IOS僅支持QQ/UC瀏覽器),任選其一,如果未安裝當前指定瀏覽器,則使用系統自帶瀏覽器
                   //url  字符串類型,值為將要打開的web地址
                   //示例 :var YDB = new YDBOBJ();  YDB.OpenByBrowser("baidu","http://www.0306253.live");//在百度瀏覽器中打開云打包官網
            

備注:

復制到剪切板

                    YDB.CopyPasteboardText(txt);
                   //參數說明:
                   //txt 字符串類型,值為將要復制的內容
                   //示例 :var YDB = new YDBOBJ();  YDB.CopyPasteboardText("將要復制的內容");
            

備注:

返回頂級頁面

                    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"。                    
                    //示例:<a href="new.html" onclick="OpenNewWindow();">新窗口打開</a>
                    //function OpenNewWindow(){var YDB = new YDBOBJ(); YDB.OpenNewWindow();}
            

備注:

新窗口動畫效果

                     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);//開啟橫屏模式
            

備注:

頂部側邊菜單顯示位置

                     YDB.isRightMenu(position);
                    //參數說明:參數 position,參數類型 字符串類型,"0" 在左邊顯示 ,"1"在右邊顯示
                    //示例:var YDB = new YDBOBJ();YDB.isRightMenu("0");//左邊顯示側邊菜單
            

備注:

APP系統功能類

掃一掃

無返回值方法

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

備注:

有返回值方法

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

備注:

分享

                    YDB.Share('標題','簡介','圖片路徑','鏈接地址','回調方法');
                    // 參數說明:分別傳入分享信息的標題、簡介、圖片路徑、URL鏈接地址、分享回調方法名(接收分享結果的json字串)
                    //示例:var YDB = new YDBOBJ(); YDB.Share("測試分享標題", "測試分享標題內容", "https://static.ydbimg.com/Images/frontimg/logo.png", "http://www.0306253.live/","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、1、2、3、4、5   說明:0微信好友 1微信朋友圈 2新浪微博 3QQ 4QQ空間 5信息
                    //示例:var YDB = new YDBOBJ(); YDB.SingleShare("測試分享標題", "測試分享標題內容", "https://static.ydbimg.com/Images/frontimg/logo.png", "http://www.0306253.live/","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 所需圖片高度
            

備注:增強型上傳圖片Demo下載

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.SetRSA2AlipayInfo(ProductName, Desicript, Price, OuttradeNo);
                    //參數說明:參數均為字符類型,ProductName 名稱, Desicript 描述, Price 支付金額, OuttradeNo 訂單編號(64個字符以內、可包含字母、數字、下劃線,需保證在商戶端不重復)
                    //備注:支付寶(支付寶通知參數)同步通知參數的 result(類型為json結構字符串)會通過‘alipayresult= ’以Querstring的形式傳遞到RETURN_URL頁面。示例:
                    alipayresult={
                    \"alipay_trade_app_pay_response\":{
                        \"code\":\"10000\",
                        \"msg\":\"Success\",
                        \"app_id\":\"2014072300007148\",
                        \"out_trade_no\":\"081622560194853\",
                        \"trade_no\":\"2016081621001004400236957647\",
                        \"total_amount\":\"0.01\",
                        \"seller_id\":\"2088702849871851\",
                        \"charset\":\"utf-8\",
                        \"timestamp\":\"2016-10-11 17:43:36\"
                    },
                    \"sign\":\"NGfStJf3i3ooWBuCDIQSumOpaGBcQz+aoAqyGh3W6EqA/gmyPYwLJ2REFijY9XPTApI9YglZyMw+ZMhd3kb0mh4RAXMrb6mekX4Zu8Nf6geOwIa9kLOnw0IMCjxi4abDIfXhxrXyj********\",
                    \"sign_type\":\"RSA2\"
                   }
            

備注:

微信支付

                    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 (字符類型),相關接口文檔參照微信官方文檔                                                                        
                   //通過接口https://api.weixin.qq.com/sns/auth?access_token=ACCESS_TOKEN&openid=OPENID獲取用戶信息
                    //當returnDataType為1時,accessUrl在post時接收到參數為:token (Json字串)、resault (Json字串)、openid (字符類型)、sign (Md5加密字串),get時接收到的參數為openid (字符類型)
                    //當returnDataType為2時,accessUrl在post時接收到參數為:code (字符類型),相關接口文檔參照微信官方文檔
            

備注:此插件需要開通微信登錄插件并配置相關參數,微信登錄整體流程:調用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、Android!

獲取健康步數

                     YDB.GetHealthStep("處理返回值的函數名");
                    //參數說明:您需要定義處理返回值函數,例如 function DoWithHealthStep(info){/*info中返回的是您當前的健康步數*/};
                    //那么,調用SDK可以這樣寫:YDB.GetHealthStep("DoWithHealthStep")
                   
            

備注:開通獲取健康步數插件后才可使用此功能,此功能適用于安卓。

QQ登錄

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

備注:開通QQ登錄插件并配置相關參數之后,才可使用此功能。

融云即時通訊

融云用戶登錄

                    YDB.RongyunLogin(userId, nickName, token, portraitUri);          
                    //參數說明:userId(字符類型) 用戶id,nickName(字符類型) 用戶昵稱,portraitUri(字符類型) 用戶頭像,token(字符類型) 用戶token(token在服務器端注冊用戶的時候獲取,可參見 Demo 或者參照融云相關服務器端開發文檔獲取token方法)。
            

備注:開通融云即時通訊插件并配置相關參數之后,才可使用此功能。

打開融云私聊界面

                    YDB.InitiateChat(otheruserId, nickName, portraitUri);          
                    //參數說明:otheruserId(字符類型) 對方用戶id,nickName(字符類型) 對方昵稱,portraitUri(字符類型)對方頭像。
            

備注:開通融云即時通訊插件并配置相關參數之后,才可使用此功能。

打開融云會話列表

                    YDB.SessionList();          
                    //參數說明:不需要傳遞參數。
            

備注:開通融云即時通訊插件并配置相關參數之后,才可使用此功能。

更新融云用戶信息

                    YDB.RefreshUserInfo(userId, nickName, portraitUri);          
                    //參數說明:userId(字符類型) 要更新的用戶id,nickName(字符類型) 要更新的用戶昵稱,portraitUri(字符類型) 要更新的用戶頭像。
            

備注:開通融云即時通訊插件并配置相關參數之后,才可使用此功能。

創建融云群組

                    YDB.CreateDiscussGroup(defaultUserId, groupName, groupIDFunction);          
                    //參數說明:defaultUserId(字符類型) 默認邀請加入群組的用戶id(非本人),groupName(字符類型)群組名,groupIDFunction 獲取groupID的回調函數。
                    //需要再web端定義回調函數:function groupIDFunction(groupID){/* 獲取并記錄App返回的群組ID */}
            

備注:開通融云即時通訊插件并配置相關參數之后,才可使用此功能。

打開融云群組

                    YDB.OpenDiscussGroup(groupId, groupName);          
                    //參數說明:groupId 要打開的群組的id,groupName 要打開的群組名。
            

備注:開通融云即時通訊插件并配置相關參數之后,才可使用此功能。

添加融云群組成員

                    YDB.AddDiscussGroup(groupId, userId, nickName, portraitUri);          
                    //參數說明:groupId 群組id,userId 要添加的用戶id,nickName 要添加的用戶昵稱,portraitUri 要添加的用戶頭像。
            

備注:開通融云即時通訊插件并配置相關參數之后,才可使用此功能。

移除融云群組成員

                    YDB.RemoveDiscussGroup(groupId, userId);          
                    //參數說明:groupId 群組id,userId 要移除的用戶id。
            

備注:開通融云即時通訊插件并配置相關參數之后,才可使用此功能。

初始化融云好友頭像信息

                    YDB.IntPortraitUri(userId, nickName, portraitUri);          
                    //參數說明:userId 要初始化的用戶id,nickName 要初始化的用戶昵稱,portraitUri 需初始化的用戶頭像。
            

備注:開通融云即時通訊插件并配置相關參數之后,才可使用此功能。

獲取手機設備信息

獲取手機基本信息

                    YDB.GetBaseInfo(callback);          
                    //參數說明:callback 回調函數。
                   //安卓端返回數據:{
                                    status:                       //操作成功狀態值
                                    brand:                          //品牌
                                    model:                          //型號
                                    manufacturer:                //制造商
                                    version:                     //系統版本
                                    sdkVersion:                  //系統SDK版本
                                    deviceid:                             //設備串號
                                    macAddress:                  //mac地址
                                    bootTime:                     //開機時間
                                    }
                   //IOS端返回數據:{
                                    "uuid":"4AD320A1-2A80-4BC7-B9B2-8228D17ED9DE", //uuid
                                    "battery":"UnKnow-100",   //電池狀態及電量                                                
                                    "device":"Simulator",  //設備版本
                                    "name":"iPhoneSimulator",//手機別名
                                    "type":"iPhone",//手機型號
                                    "version":"9.3"http://手機系統版本
                                     }
                //示例:var YDB = new YDBOBJ();YDB.GetBaseInfo("BaseInfo");   BaseInfo 是您的回調函數
                        function BaseInfo(info){ //info是手機端給您返回的json對象 }
            

備注:開通獲取手機設備信息插件之后,才可使用此功能。

獲取CPU信息

                    YDB.GetCpuInfo(callback);          
                    //參數說明:callback 回調函數。
                   //返回數據:{
                                    status:                       //操作成功狀態值
                                    architecture:                  //CPU架構
                                    coreNumber:                      //CPU核心數
                                    minFrequency:                 //CPU最低頻率
                                    maxFrequency:                 //CPU最高頻率
                                }
                //示例:var YDB = new YDBOBJ();YDB.GetCpuInfo("CpuInfo");   CpuInfo 是您的回調函數
                        function CpuInfo(info){ //info是手機端給您返回的json對象 }
            

備注:開通獲取手機設備信息插件之后,才可使用此功能,該功能僅適用于安卓。

獲取內存信息

                    YDB.GetMemoryInfo(callback);          
                    //參數說明:callback 回調函數。
                   //返回數據:{
                                    status:                       //操作成功狀態值
                                    totalMemory:                  //內存總大小
                                    availableMemory:              //可用內存大小
                                }
                //示例:var YDB = new YDBOBJ();YDB.GetMemoryInfo("MemoryInfo");   MemoryInfo 是您的回調函數
                        function MemoryInfo(info){ //info是手機端給您返回的json對象 }
            

備注:開通獲取手機設備信息插件之后,才可使用此功能,該功能僅適用于安卓。

獲取手機存儲信息

                    YDB.GetStorageInfo(callback);          
                    //參數說明:callback 回調函數。
                   //返回數據:{
                                    status:                   //操作成功狀態值
                                    sdCardStatus:              //SD卡的狀態,返回如下值:
                                                                //1001    未設置SD卡為御載,直接拔出SD卡后的狀態
                                                                //1002    手機正在檢測SD卡過程中的狀態
                                                                //1003    SD卡正常使用的狀態,并具有讀寫的權限
                                                                //1004    SD卡正常使用的狀態,但只有讀的權限
                                                                //1005    手動設置SD卡為御載之后,再拔出SD卡之后 的狀態
                                                                //1006    手機連接電腦,SD卡做為U盤使用之后的狀態
                                                                //1007    SD卡不可被安裝
                                                                //1008    手工設置SD卡為御載之后的狀態
                                                                //0        沒有獲取到SD卡的狀態
                                    sdCardPath:                  //SD卡的路徑
                                    sdCardTotalSize:          //SD卡總大小
                                    sdCardAvailableSize:    //SD卡可用大小
                                    romTotalSize:           //手機自身存儲大小
                                    romAvailableSize:        //手機自身可用存儲大小
                                    romPath:                   //手機自身存儲路徑
                                }
                //示例:var YDB = new YDBOBJ();YDB.GetStorageInfo("StorageInfo");   StorageInfo 是您的回調函數
                        function StorageInfo(info){ //info是手機端給您返回的json對象 }
            

備注:開通獲取手機設備信息插件之后,才可使用此功能,該功能僅適用于安卓。

獲取手機顯示信息

                    YDB.GetDisplayInfo(callback);          
                    //參數說明:callback 回調函數。
                   //返回數據:{
                                    status:                   //操作成功狀態值
                                    width:                      //屏幕寬度(單位為像素)
                                    height:                  //屏幕高度(單位為像素)
                                    densityDpi:                //屏幕密度(單位為dpi)
                                }
                   //示例:var YDB = new YDBOBJ();YDB.GetDisplayInfo("DisplayInfo");   DisplayInfo 是您的回調函數
                        function DisplayInfo(info){ //info是手機端給您返回的json對象 }
            

備注:開通獲取手機設備信息插件之后,才可使用此功能,該功能僅適用于安卓。

系統通訊錄

查詢所有聯系人信息

                    YDB.ContactAll(callback);          
                    //參數說明:callback 回調函數。
                   //返回數據樣例:[{"lastName":"張","contactId":18,"email":"","homeNum":"0371-12345678","firstName":"三","displayName":"張三","jobNum":"","mobile":"13523002100"},{"lastName":"張","contactId":19,"email":"","homeNum":"0371-12345678","firstName":"三","displayName":"張三","jobNum":"","mobile":"13523002100"}]

                   //示例:var YDB = new YDBOBJ();YDB.ContactAll("allcontacter");   allcontacter 是您的回調函數
                        function allcontacter(info){ //info是手機端給您返回的json對象 }   
            

備注:開通系統通訊錄插件之后,才可使用此功能。

打開系統通訊錄界面,選擇單個聯系人,返回已選的聯系人信息

                    YDB.ContactSelect(callback);          
                    //參數說明:callback 回調函數。
                   //返回數據樣例:{"lastName":"張","contactId":18,"email":"","homeNum":"0371-12345678","firstName":"三","displayName":"張三","jobNum":"","mobile":"13523002100"}

                   //示例:var YDB = new YDBOBJ();YDB.ContactSelect("contacter");   contacter 是您的回調函數
                        function contacter(info){ //info是手機端給您返回的json對象 }   
            

備注:開通系統通訊錄插件之后,才可使用此功能。

向通訊錄添加一個聯系人,所有參數不可同時為空

                    YDB.ContactAdd(lastName, firstName, homeNum, mobile, email, callback);          
                    //參數說明:lastName 聯系人姓 firstName 聯系人名字  homeNum 住宅電話 mobile手機號 email郵箱 callback回調函數。
                   //返回數據:0 添加失敗 1添加成功

                   //示例:var YDB = new YDBOBJ();YDB.ContactAdd("張","三","0371-12345678","13523002100","[email protected]","addstatus");   addstatus 是您的回調函數
                        function addstatus(info){ //info是手機端給您返回的添加狀態 }   
            

備注:開通系統通訊錄插件之后,才可使用此功能。

從通訊錄刪除一個聯系人

                    YDB.ContactDelete(contactid, callback);          
                    //參數說明:contactid 要刪除的聯系人id(從查詢所有聯系人信息選擇單個聯系人中獲取) callback 回調函數。
                   //返回數據:0 添加失敗 1添加成功

                   //示例:var YDB = new YDBOBJ();YDB.ContactDelete("18","deletestatus");   deletestatus 是您的回調函數
                        function deletestatus(info){ //info是手機端給您返回的刪除狀態 }   
            

備注:開通系統通訊錄插件之后,才可使用此功能。

根據 id 更新通訊錄的聯系人信息

                    YDB.ContactUpdate(contactid, lastName, firstName, homeNum, mobile, email, callback);          
                    //參數說明:contactid 要更新的聯系人id(從查詢所有聯系人信息選擇單個聯系人中獲取) lastName 聯系人姓 firstName 聯系人名字 homeNum 住宅電話 mobile手機號 email郵箱 callback回調函數。
                   //返回數據:0 添加失敗 1添加成功

                   //示例:var YDB = new YDBOBJ();YDB.ContactUpdate("18","張",三","0371-12345678","13523002112","[email protected]","upstatus");   upstatus 是您的回調函數
                        function upstatus(info){ //info是手機端給您返回的更新狀態 }   
            

備注:開通系統通訊錄插件之后,才可使用此功能。

網絡音頻播放

播放網絡音頻

                    YDB.StartVoice(path);          
                    //參數說明:path 音頻資源地址

                   //示例:var YDB = new YDBOBJ();YDB.StartVoice("http://music.baidutt.com/up/kwcywdkd/cmypus.mp3");  
            

備注:開通網絡音頻播放插件之后,才可使用此功能。

設置音量 音量大小,取值范圍:0-1

                    YDB.VolumeVideo(volume);          
                    //參數說明:volume 音量大小,取值范圍:0-1

                   //示例:var YDB = new YDBOBJ();YDB.VolumeVideo('0.6');  
            

備注:開通網絡音頻播放插件之后,才可使用此功能。

暫停播放

                    YDB.PauseVoice();          
                    //參數說明:該方法不需要參數。

                   //示例:var YDB = new YDBOBJ();YDB.PauseVoice();  
            

備注:開通網絡音頻播放插件之后,才可使用此功能。

繼續播放

                    YDB.PlayVoice();          
                    //參數說明:該方法不需要參數。

                   //示例:var YDB = new YDBOBJ();YDB.PlayVoice();  
            

備注:開通網絡音頻播放插件之后,才可使用此功能。

停止播放

                    YDB.StopVoice();          
                    //參數說明:該方法不需要參數。

                   //示例:var YDB = new YDBOBJ();YDB.StopVoice();  
            

備注:開通網絡音頻播放插件之后,才可使用此功能。

網絡視頻播放

                    YDB.OpenVideo(path);          
                    //參數說明:path 視頻資源地址。

                   //示例:var YDB = new YDBOBJ();YDB.OpenVideo(path);  
            

備注:開通網絡視頻播放插件之后,才可使用此功能。

設置安卓手機壁紙

                    YDB.Wallpaper(path);          
                    //參數說明:path 圖片路徑,支持http://路徑的圖片。

                   //示例:var YDB = new YDBOBJ();YDB.Wallpaper(path);  
            

備注:開通設置安卓手機壁紙插件之后,才可使用此功能,該功能僅適用于安卓。

獲取手機GPS狀態

                    YDB.GpsState(callback);          
                    //參數說明:callback 回調函數。
                   //返回數據:{ "gps":true }   //返回值為true表示當前手機gps為開啟狀態  false為關閉狀態
                   //示例:var YDB = new YDBOBJ();YDB.GpsState("State");   State 是您的回調函數
                        function State(info){ //info是手機端給您返回的json對象 }
            

備注:開通獲取手機GPS狀態插件之后,才可使用此功能。

安卓手機打開系統GPS界面

                    YDB.Opengps();          
                    //參數說明:該方法不需要參數。
                   //示例:var YDB = new YDBOBJ();YDB.Opengps();   
            

備注:開通獲取手機GPS狀態插件之后,才可使用此功能,該功能僅適用于安卓。

地圖導航

判斷當前設備是否已安裝高德、谷歌、百度地圖

                    YDB.NavigatorInfo(callback);          
                    //參數說明:callback 回調方法。
                    //返回數據樣例:{"aMap":"false","bMap":"true","gMap":"false"}
                          其中        bMap:百度地圖 aMap:高德地圖 gMap:谷歌地圖
                   //示例:var YDB = new YDBOBJ();YDB.NavigatorInfo("getnavigator");   getnavigator是您的回調方法名。
                   function getnavigator(info){ //info是手機端給您返回的json對象 }   
            

備注:開通地圖導航插件之后,才可使用此功能。

打開百度地圖

                    YDB.NavigatorBaidu();          
                    //參數說明:該方法不需要參數。
                   //示例:var YDB = new YDBOBJ();YDB.NavigatorBaidu();      
            

備注:開通地圖導航插件之后,才可使用此功能。

打開谷歌地圖

                    YDB.NavigatorGoogle();          
                    //參數說明:該方法不需要參數。
                   //示例:var YDB = new YDBOBJ();YDB.NavigatorGoogle();      
            

備注:開通地圖導航插件之后,才可使用此功能。

打開高德地圖

                    YDB.NavigatorGaode();          
                    //參數說明:該方法不需要參數。
                   //示例:var YDB = new YDBOBJ();YDB.NavigatorGaode();      
            

備注:開通地圖導航插件之后,才可使用此功能。

打開百度地圖并規劃路線

                    YDB.NavigatorBaiduPath(startlat, startlon, endlat, endlon);          
                    //參數說明:startlat 起點緯度(數字類型) startlon  起點經度(數字類型) endlat 終點緯度(數字類型) endlon  終點經度(數字類型)
                    //示例:var YDB = new YDBOBJ();YDB.NavigatorBaiduPath("34.55648","112.4772379","33.784214","112.57062599");      
            

備注:開通地圖導航插件之后,才可使用此功能。

打開高德地圖并規劃路線

                    YDB.NavigatorGaodePath(startlon, startlat, startname, endlon, endlat, endname);          
                    //參數說明:startlat 起點緯度(數字類型) startlon  起點經度(數字類型) startname 起點名稱(字符串類型)  endlat 終點緯度(數字類型) endlon  終點經度(數字類型) endname 終點名稱(字符串類型)
                    //示例:var YDB = new YDBOBJ();YDB.NavigatorGaodePath("34.55648","112.4772379","起點名稱","33.784214","112.57062599","終點名稱");      
            

備注:開通地圖導航插件之后,才可使用此功能。

打開蘋果自帶地圖并開始導航

                    YDB.appleNavigation(startlat, startlon, endlat, endlon);          
                    //參數說明:startlat 起點緯度(數字類型) startlon  起點經度(數字類型) endlat 終點緯度(數字類型) endlon  終點經度(數字類型)
                    //示例:var YDB = new YDBOBJ();YDB.appleNavigation("34.55648","112.4772379","33.784214","112.57062599");      
            

備注:開通地圖導航插件之后,才可使用此功能。

藍牙數據傳輸

                    YDB.OpenBluetooth();     
                     //參數說明:該方法不需要參數。
                     //示例:var YDB = new YDBOBJ();YDB.OpenBluetooth();     
            

備注:開通藍牙數據傳輸插件之后,才可使用此功能。此功能僅適用于安卓。

藍牙 4.0

初始化藍牙4.0管理器

                    YDB.BLinitManager(callback);     
                     //參數說明:callback 回調方法。
                     //返回數據樣例:{"state": "poweredOn" } 
                     //字符串類型;藍牙4.0設備連接狀態,取值范圍如下:
                                //poweredOn:設備開啟狀態 -- 可用狀態
                                //poweredOff:設備關閉狀態
                                //resetting:正在重置狀態
                                //unauthorized:設備未授權狀態
                                //unknown:初始的時候是未知的
                                //unsupported:設備不支持的狀態
                                     
                    //示例:var YDB = new YDBOBJ();YDB.BLinitManager("getmanagerstate");  getmanagerstate是您的回調方法名。
                   function getmanagerstate(state){ //state是手機端給您返回的json對象 }    
            

備注:開通藍牙4.0插件之后,才可使用此功能。

開始搜索藍牙4.0設備

                    YDB.BLscan(callback);
                     //開始搜索藍牙4.0設備,會不斷的掃描跟新附近的藍牙4.0設備信息,可通過 BLgetPeripheral 接口來獲取掃描到的設備信息。若要停止、清空掃描則調用 BLstopScan 接口     
                     //參數說明:callback 回調方法。
                     //返回數據樣例:{ "status": "true" }    //布爾類型;是否獲取成功,true|false                 
                                     
                    //示例:var YDB = new YDBOBJ();YDB.BLscan("getscanstate");   getscanstate是您的回調方法名。
                   function getscanstate(state){ //state是手機端給您返回的json對象 }    
            

備注:開通藍牙4.0插件之后,才可使用此功能。

獲取當前掃描到的所有外圍設備信息

                    YDB.BLgetPeripheral(callback);     
                     //參數說明:callback 回調方法。
                     //返回數據樣例:{
                                                            "peripherals":[{ //數組類型;獲取到的當前掃描到的藍牙4.0設備
                                                            "uuid": "",    //字符串類型;掃描到的藍牙設備的 UUID
                                                            "name": "",    //字符串類型;掃描到的藍牙設備的名字
                                                            "rssi": ""       //數字類型;掃描到的藍牙設備的信號強度
                                                        },...]
                                                  }      //JSON 對象          
                                     
                    //示例:var YDB = new YDBOBJ();YDB.BLgetPeripheral("getperipherals");   getperipherals是您的回調方法名。
                   function getperipherals(peripherals){ //peripherals是手機端給您返回的json對象 }    
            

備注:開通藍牙4.0插件之后,才可使用此功能。

判斷是否正在掃描

                    YDB.BLisScanning(callback);     
                     //參數說明:callback 回調方法。
                     //返回數據樣例:{ "status": "true" }    //布爾類型;是否在掃描,true|false         
                                     
                    //示例:var YDB = new YDBOBJ();YDB.BLisScanning("isScanning");   isScanning是您的回調方法名。
                   function isScanning(state){ //state是手機端給您返回的json對象 }    
            

備注:開通藍牙4.0插件之后,才可使用此功能。

停止搜索附近的藍牙設備,并清空已搜索到的記錄在本地的外圍設備信息

                    YDB.BLstopScan();     
                     //參數說明:不需要傳遞參數。      
                                     
                    //示例:var YDB = new YDBOBJ();YDB.BLstopScan();      
            

備注:開通藍牙4.0插件之后,才可使用此功能。

連接指定外圍設備

                    YDB.BLconnect(peripheralUUID,callback);     
                     //參數說明:peripheralUUID 要連接的外圍設備的 UUID(字符串)   callback 回調方法。
                     //返回數據樣例:{ "status": "true" }    //布爾類型;是否連接成功,true|false         
                                     
                    //示例:var YDB = new YDBOBJ();YDB.BLconnect('88:0F:10:86:6A:CF','connectstate');   connectstate是您的回調方法名。
                   function connectstate(state){ //state是手機端給您返回的json對象 }    
            

備注:開通藍牙4.0插件之后,才可使用此功能。

斷開與指定外圍設備的連接

                    YDB.BLdisconnect(peripheralUUID,callback);     
                     //參數說明:peripheralUUID 要斷開連接的外圍設備的 UUID(字符串)   callback 回調方法。
                     //返回數據樣例:{ "status": "true" }    //布爾類型;是否成功斷開連接,true|false         
                                     
                    //示例:var YDB = new YDBOBJ();YDB.BLdisconnect('88:0F:10:86:6A:CF','disconnectstate');   disconnectstate是您的回調方法名。
                   function disconnectstate(state){ //state是手機端給您返回的json對象 }    
            

備注:開通藍牙4.0插件之后,才可使用此功能。

判斷與指定外圍設備是否為連接狀態

                    YDB.BLisConnected(peripheralUUID,callback);     
                     //參數說明:peripheralUUID 指定外圍設備的 UUID(字符串)   callback 回調方法。
                     //返回數據樣例:{ "status": "true" }    //布爾類型;是否連接,true|false         
                                     
                    //示例:var YDB = new YDBOBJ();YDB.BLisConnected('88:0F:10:86:6A:CF','getconnectstate');   getconnectstate是您的回調方法名。
                   function getconnectstate(state){ //state是手機端給您返回的json對象 }    
            

備注:開通藍牙4.0插件之后,才可使用此功能。

根據 UUID 找到所有匹配的藍牙外圍設備信息

                    YDB.BLretrievePeripheral(peripheralUUIDs,callback);     
                     //參數說明:peripheralUUIDs 指定的藍牙外圍設備的 UUID 組成的數組(字符串)   callback 回調方法。
                     //返回數據樣例:{
                                                        "peripherals":[{ //數組類型;獲取到的藍牙外圍設備信息
                                                          "uuid": "",    //字符串類型;獲取到的藍牙設備的uuid
                                                          "name": "",    //字符串類型;獲取到的藍牙設備的名字
                                                          "rssi": "" ,     //數字類型;獲取到的藍牙設備的信號強度
                                                          "services":[]  //數組類型;獲取到的藍牙設備的所有服務 UUID 的集合
                                                        },...]
                                                  }        
                                     
                    //示例:var YDB = new YDBOBJ();YDB.BLretrievePeripheral('["88:0F:10:86:6A:CF","88:0F:10:80:6A:CF"]', 'getperipherals');   getperipherals是您的回調方法名。
                   function getperipherals(peripherals){ //peripherals是手機端給您返回的json對象 }    
            

備注:開通藍牙4.0插件之后,才可使用此功能。此功能僅適用于IOS。

根據指定的服務,找到當前系統處于連接狀態的藍牙中包含這個服務的所有藍牙外圍設備信息

                    YDB.BLretrieveConnectedPeripheral(serviceUUIDs,callback);     
                     //參數說明:serviceUUIDs 指定的藍牙4.0設備的服務(service)的 UUID(字符串) 組成的數組(字符串)   callback 回調方法。
                     //返回數據樣例:{
                                                        "peripherals":[{ //數組類型;獲取到的當前處于連接狀態的藍牙外圍設備
                                                        "uuid": "",    //字符串類型;處于連接狀態的藍牙設備的uuid
                                                        "name": "",    //字符串類型;處于連接狀態的藍牙設備的名字
                                                        "rssi":  "" ,    //數字類型;處于連接狀態的藍牙設備的信號強度
                                                        "services":[]  //數組類型;處于連接狀態的藍牙設備的所有服務 UUID 的集合
                                                    },...]
                                                }
                                     
                    //示例:var YDB = new YDBOBJ();YDB.BLretrieveConnectedPeripheral('["00002902-0000-1000-8000-00805f9b34fb","00002902-0000-5685-8000-00805f9b34fb"]', 'getperipherals');   getperipherals是您的回調方法名。
                   function getperipherals(peripherals){ //peripherals是手機端給您返回的json對象 }    
            

備注:開通藍牙4.0插件之后,才可使用此功能。此功能僅適用于IOS。

根據指定的外圍設備 UUID 獲取該外圍設備的所有服務

                    YDB.BLdiscoverService(peripheralUUID,callback);     
                     //參數說明:peripheralUUID 指定的藍牙外圍設備的 UUID(字符串)   callback 回調方法。
                     //返回數據樣例:{
                                                     "status": "true" ,   //布爾類型;是否獲取成功,true|false
                                                     "services":[]      //數組類型;獲取的所有服務號集合
                                              }
                                     
                    //示例:var YDB = new YDBOBJ();YDB.BLdiscoverService('88:0F:10:86:6A:CF', 'getservices');   getservices是您的回調方法名。
                   function getservices(services){ //services是手機端給您返回的json對象 }    
            

備注:開通藍牙4.0插件之后,才可使用此功能。

根據指定的外圍設備 UUID 及其服務 UUID 獲取該外圍設備的所有特征

                    YDB.BLdiscoverCharacteristics(peripheralUUID, serviceUUID,callback);     
                     //參數說明:peripheralUUID 指定的藍牙外圍設備的 UUID(字符串) serviceUUID 指定的服務的 UUID   callback 回調方法。
                     //返回數據樣例:{
                                            "status": "true" ,      //布爾類型;是否獲取成功,true|false
                                            "characteristics":[{  //數組類型;獲取的所有特征信息的集合
                                            "uuid": "",        //字符串類型;特征的 UUID 
                                            "serviceUUID": "", //字符串類型;服務的 UUID 
                                            "permissions": "", //字符串類型;特征的權限,取值范圍如下:
                                                             //readable:
                                                             //writeable:
                                                             //readEncryptionRequired:
                                                             //writeEncryptionRequired:
                                            "propertie": ""    //字符串類型;特征的屬性,取值范圍如下:
                                                             //broadcast:
                                                             //read:
                                                             //writeWithoutResponse:
                                                             //write:
                                                             //notify:
                                                             //indicate:
                                                             //authenticatedSignedWrites:
                                                             //extendedProperties:
                                                             //notifyEncryptionRequired:
                                                             //indicateEncryptionRequired:
                                         }]   
                                     }
                                     
                    //示例:var YDB = new YDBOBJ();YDB.BLdiscoverCharacteristics('88:0F:10:86:6A:CF','00002902-0000-1000-8000-00805f9b34fb', 'getcharacteristics');   getcharacteristics是您的回調方法名。
                   function getcharacteristics(characteristics){ //characteristics是手機端給您返回的json對象 }    
            

備注:開通藍牙4.0插件之后,才可使用此功能。

根據指定的外圍設備 UUID 及其服務 UUID 和特征 UUID 獲取該外圍設備的所有描述符

                    YDB.BLdiscoverDescriptorsForCharacteristic(peripheralUUID, serviceUUID, characteristicUUID,callback);     
                     //參數說明:peripheralUUID 指定的藍牙外圍設備的 UUID(字符串) serviceUUID 指定的服務的 UUID  characteristicUUID 指定的特征的 UUID   callback 回調方法。
                     //返回數據樣例:{
                                                "status": "true" ,      //布爾類型;是否讀取成功,true|false
                                                "descriptors":[{      //數組類型;獲取的所有描述符信息的集合
                                                "uuid": "",        //字符串類型;描述符的 UUID 
                                                "serviceUUID": "", //字符串類型;服務的 UUID 
                                                "characteristicUUID":"",//字符串類型;特征的 UUID 
                                                "decode":"" ,        //布爾類型;描述符的值是否是二進制類型數據
                                                "value":""           //字符串類型;描述符的值,若 decode 為 true,則該值為轉碼后的值
                                             }]      
                                      }
                                     
                    //示例:var YDB = new YDBOBJ();YDB.BLdiscoverDescriptorsForCharacteristic('88:0F:10:86:6A:CF', '00002902-0000-1000-8000-00805f9b34fb', '00002A43-0000-1000-8000-00805F9B34FB', 'getdescriptors');   
                           getdescriptors是您的回調方法名。
                   function getdescriptors(descriptors){ //descriptors是手機端給您返回的json對象 }    
            

備注:開通藍牙4.0插件之后,才可使用此功能。

根據指定的外圍設備 UUID 及其服務 UUID 和特征 UUID 監聽數據回發

                    YDB.BLsetNotify(peripheralUUID, serviceUUID, characteristicUUID,callback);     
                     //參數說明:peripheralUUID 指定的藍牙外圍設備的 UUID(字符串) serviceUUID 指定的服務的 UUID  characteristicUUID 指定的特征的 UUID   callback 回調方法。
                     //返回數據樣例:{
                                            "status": "true" ,      //布爾類型;是否獲取數據,true|false
                                            "characteristic":{    //JSON對象;獲取監聽的特征的信息
                                            "uuid": "",        //字符串類型;特征的 UUID 
                                            "serviceUUID": "", //字符串類型;服務的 UUID 
                                            "value": "" ,        //字符串類型;特征的值
                                            "permissions": "", //字符串類型;特征的權限,取值范圍如下:
                                                             //readable:
                                                             //writeable:
                                                             //readEncryptionRequired:
                                                             //writeEncryptionRequired:
                                            "propertie": ""    //字符串類型;特征的屬性,取值范圍如下:
                                                             //broadcast:
                                                             //read:
                                                             //writeWithoutResponse:
                                                             //write:
                                                             //notify:
                                                             //indicate:
                                                             //authenticatedSignedWrites:
                                                             //extendedProperties:
                                                             //notifyEncryptionRequired:
                                                             //indicateEncryptionRequired:
                                         }      
                                    }
                                     
                    //示例:var YDB = new YDBOBJ();YDB.BLsetNotify('88:0F:10:86:6A:CF', '00002902-0000-1000-8000-00805f9b34fb', '00002A43-0000-1000-8000-00805F9B34FB', 'getcharacteristic');  
                            getcharacteristic是您的回調方法名。
                   function getcharacteristic(characteristic){ //characteristic是手機端給您返回的json對象 }    
            

備注:開通藍牙4.0插件之后,才可使用此功能。

根據指定的外圍設備 UUID 及其服務 UUID 和特征 UUID 讀取數據

                    YDB.BLreadValueForCharacteristic(peripheralUUID, serviceUUID, characteristicUUID,callback);     
                     //參數說明:peripheralUUID 指定的藍牙外圍設備的 UUID(字符串) serviceUUID 指定的服務的 UUID  characteristicUUID 指定的特征的 UUID   callback 回調方法。
                     //返回數據樣例:{
                                         "status": "true" ,      //布爾類型;是否讀取成功,true|false
                                         "characteristic":{    //JSON對象;獲取監聽的特征的信息
                                         "uuid": "",        //字符串類型;特征的 UUID 
                                         "serviceUUID": "", //字符串類型;服務的 UUID 
                                         "value": "" ,        //字符串類型;特征的值
                                         "permissions": "", //字符串類型;特征的權限,取值范圍如下:
                                                            //readable:
                                                            //writeable:
                                                            //readEncryptionRequired:
                                                            //writeEncryptionRequired:
                                         "propertie": ""    //字符串類型;特征的屬性,取值范圍如下:
                                                            //broadcast:
                                                            //read:
                                                            //writeWithoutResponse:
                                                            //write:
                                                            //notify:
                                                            //indicate:
                                                            //authenticatedSignedWrites:
                                                            //extendedProperties:
                                                            //notifyEncryptionRequired:
                                                            //indicateEncryptionRequired:
                                        }      
                                    }
                                     
                    //示例:var YDB = new YDBOBJ();YDB.BLreadValueForCharacteristic('88:0F:10:86:6A:CF', '00002902-0000-1000-8000-00805f9b34fb', '00002A43-0000-1000-8000-00805F9B34FB', 'getcharacteristic');   
                           getcharacteristic是您的回調方法名。
                   function getcharacteristic(characteristic){ //characteristic是手機端給您返回的json對象 }    
            

備注:開通藍牙4.0插件之后,才可使用此功能。

根據指定的外圍設備 UUID 及其服務 UUID 和特征 UUID 及其描述符獲取數據

                    YDB.BLreadValueForDescriptor(peripheralUUID, serviceUUID, characteristicUUID,descriptorUUID,callback);     
                     //參數說明:peripheralUUID 指定的藍牙外圍設備的 UUID(字符串) serviceUUID 指定的服務的 UUID  characteristicUUID 指定的特征的 UUID  descriptorUUID 指定的描述符的 UUID   callback 回調方法。
                     //返回數據樣例:{
                                            "status": "true" ,      //布爾類型;是否讀取成功,true|false
                                            "descriptor":{        //JSON對象;獲取的所有描述符信息
                                            "uuid": "",        //字符串類型;描述符的 UUID 
                                            "serviceUUID": "", //字符串類型;服務的 UUID 
                                            "characteristicUUID":"",//字符串類型;特征的 UUID 
                                            "decode":"" ,        //布爾類型;描述符的值是否是二進制類型數據
                                            "value":""           //字符串類型;描述符的值,若 decode 為 true,則該值為轉碼后的值
                                            }      
                                    }
                                     
                    //示例:var YDB = new YDBOBJ();YDB.BLreadValueForDescriptor('88:0F:10:86:6A:CF', '00002902-0000-1000-8000-00805f9b34fb', '00002A43-0000-1000-8000-00805F9B34FB', '00002A43-0000-1000-8000-00805F9B34FB', 'getcharacteristic');   getcharacteristic是您的回調方法名。
                   function getcharacteristic(characteristic){ //characteristic是手機端給您返回的json對象 }    
            

備注:開通藍牙4.0插件之后,才可使用此功能。

根據指定的外圍設備 UUID 及其服務 UUID 和特征 UUID 寫數據

                    YDB.BLwriteValueForCharacteristic(peripheralUUID, serviceUUID, characteristicUUID,value,callback);     
                     //參數說明:peripheralUUID 指定的藍牙外圍設備的 UUID(字符串) serviceUUID 指定的服務的 UUID  characteristicUUID 指定的特征的 UUID  value 要寫入的數據 ,十六進制的字符串   callback 回調方法。
                     //返回數據樣例:{
                                                "status": "true" ,      //布爾類型;是否發送成功,true|false
                                                "characteristic":{    //JSON對象;獲取監聽的特征的信息
                                                "uuid": "",        //字符串類型;特征的 UUID 
                                                "serviceUUID": "", //字符串類型;服務的 UUID 
                                                "permissions": "", //字符串類型;特征的權限,取值范圍如下:
                                                                 //readable:
                                                                 //writeable:
                                                                 //readEncryptionRequired:
                                                                 //writeEncryptionRequired:
                                                "propertie": ""    //字符串類型;特征的屬性,取值范圍如下:
                                                                 //broadcast:
                                                                 //read:
                                                                 //writeWithoutResponse:
                                                                 //write:
                                                                 //notify:
                                                                 //indicate:
                                                                 //authenticatedSignedWrites:
                                                                 //extendedProperties:
                                                                 //notifyEncryptionRequired:
                                                                 //indicateEncryptionRequired:
                                             }      
                                        }
                                     
                    //示例:var YDB = new YDBOBJ();YDB.BLwriteValueForCharacteristic('88:0F:10:86:6A:CF', '00002902-0000-1000-8000-00805f9b34fb', '00002A43-0000-1000-8000-00805F9B34FB', 'ceshishuju', 'getcharacteristic');   
                           getcharacteristic是您的回調方法名。
                   function getcharacteristic(characteristic){ //characteristic是手機端給您返回的json對象 }    
            

備注:開通藍牙4.0插件之后,才可使用此功能。

根據指定的外圍設備 UUID 及其服務 UUID 和特征 UUID 及其描述符發送數據

                    YDB.BLwriteValueForDescriptor(peripheralUUID, serviceUUID, characteristicUUID,descriptorUUID,value,callback);     
                     //參數說明:peripheralUUID 指定的藍牙外圍設備的 UUID(字符串) serviceUUID 指定的服務的 UUID  characteristicUUID 指定的特征的 UUID  descriptorUUID 指定的描述符的 UUID  value 要發送的數據 ,十六進制的字符串   callback 回調方法。
                     //返回數據樣例:{
                                                "status": "true" ,      //布爾類型;是否發送成功,true|false
                                                "characteristic":{    //JSON對象;獲取監聽的特征的信息
                                                "uuid": ",        //字符串類型;特征的 UUID 
                                                "serviceUUID": "", //字符串類型;服務的 UUID 
                                                "permissions": "", //字符串類型;特征的權限,取值范圍如下:
                                                                 //readable:
                                                                 //writeable:
                                                                 //readEncryptionRequired:
                                                                 //writeEncryptionRequired:
                                                "propertie": "" ,  //字符串類型;特征的屬性,取值范圍如下:
                                                                 //broadcast:
                                                                 //read:
                                                                 //writeWithoutResponse:
                                                                 //write:
                                                                 //notify:
                                                                 //indicate:
                                                                 //authenticatedSignedWrites:
                                                                 //extendedProperties:
                                                                 //notifyEncryptionRequired:
                                                                 //indicateEncryptionRequired:
                                                "descriptors":[{        //數組類型;獲取的所有描述符信息的集合
                                                    "uuid": "",         //字符串類型;描述符的 UUID 
                                                    "serviceUUID": "",  //字符串類型;服務的 UUID 
                                                    "characteristicUUID":"",//字符串類型;特征的 UUID 
                                                    "decode":"" ,         //布爾類型;描述符的值是否是二進制類型數據
                                                    "value": ""           //字符串類型;描述符的值,若 decode 為 true,則該值為轉碼后的值
                                                }] 
                                             }       
                                        }
                    //示例:var YDB = new YDBOBJ();YDB.BLwriteValueForDescriptor('88:0F:10:86:6A:CF', '00002902-0000-1000-8000-00805f9b34fb', '00002A43-0000-1000-8000-00805F9B34FB','00002A43-0000-1000-8000-00805F9B34FB', 'ceshishuju', 'getcharacteristic');   getcharacteristic是您的回調方法名。
                   function getcharacteristic(characteristic){ //characteristic是手機端給您返回的json對象 }    
            

備注:開通藍牙4.0插件之后,才可使用此功能。

調用系統音效

                    YDB.Ring();
                    //此方法可調用手機系統默認通知鈴聲。
                    //示例:var YDB = new YDBOBJ();YDB.Ring(); 
            

備注:開通調用系統音效插件之后,才可使用此功能。

蘋果系統分享

                    YDB.iOSSystemShare('content', 'img', 'linkUrl');
                    // 參數說明:content:要分享的內容  img:分享顯示的圖片路徑(必須為直接可訪問的圖片路徑)  linkUrl:分享的鏈接地址(必須為直接可訪問的url)
                    //示例:YDB.iOSSystemShare("分享內容","https://static.ydbimg.com/Images/funimg/gn1.png","http://www.0306253.live/"); 
            

備注:開通蘋果系統分享插件之后,才可使用此功能。

Url參數設置

               當URL附帶約定的參數設置的時候,相應打開的界面會按照參數設置實現約定效果,具體參數如下:
               可選參數1(顯示隱藏頂部導航):YDBSetHeadBar,傳值0、1,當值為0時,頁面打開后不帶頂部導航,當值為1時顯示頂部導航
               可選參數2(開啟關閉下拉刷新):YDBSetDragRefresh,傳值0、1,當值為0時關閉下拉刷新,1則開啟下拉刷新
               可選參數3(頂部菜單呼出按鈕):YDBSetMoreButton,傳值0、1,當值為0時隱藏頂部更多按鈕,1時顯示更多按鈕
               可選參數4(設置氣泡提醒):YDBSetPopUp,傳值以逗號分隔的兩個數字,前一個代表氣泡出現在導航的索引,后一個代表氣泡顯示數字
               可選參數5(設置顯示標題):YDBSetTitle,設置顯示的標題
               示例:如果同時設置了以上四種URl參數,則您的URL形式如下所示(這里舉例為絕對路徑方式,當然相對路徑方式也支持)
               http://www.0306253.live/?YDBSetHeadBar=1&YDBSetDragRefresh=0&YDBSetMoreButton=1&YDBPopUp=0,122
            

適用模板:有導航模板、無導航模板

備注:URL參數設置為非js的一種約定,具體按照說明設置鏈接的URl字串就行。不需要額外的JS(包括YdbOnline.js)支持。

附錄1-常見錯誤及解決方法

調用YDB相關方法前,一定要先初始化定義。以下為常見錯誤及解決方法:

  1. 設置參數后發現沒有任何效果。建議按如下順序檢查:
    1. 請確認您使用的當前版本是否支持YdbOnline。
    2. 確保您初始化了YDB對象,并且調用方法名無誤

附錄2-DEMO頁面和示例代碼

DEMO頁面

http://www.0306253.live/API/JssdkDemo


示例代碼

http://www.0306253.live/API/JssdkDemo/JssdkDemo.rar

備注:鏈接中包含html、C#的示例代碼供第三方參考。

附錄3-問題反饋

郵箱地址:[email protected]

郵件主題:【YdbOnline反饋】

郵件內容說明:

用簡明的語言描述問題所在,并講清楚遇到該問題的場景,可附上截屏圖片,我們團隊會盡快處理你的反饋。

股票行情大盘走势