Bitrabbit forum JsBridge API

應(yīng)用簡述

  1. 什么是JSAPI
    JSAPI是比特兔論壇客戶端通過bridge機制,允許前端H5頁面通過特定的JS方法邻悬,可以直接調(diào)用對應(yīng)的拍照验庙、分享、回復之類的Native功能过牙。

但需要注意的是由于bridge的機制問題甥厦,iOS端暫時無法在iframe內(nèi)正常調(diào)用所有的JSAPI,請避免在iframe內(nèi)使用寇钉。

  1. JsBridge對象調(diào)用示例
// bridge對象綁定在window.BRBForumJSBridge上
var bridge = window.BRBForumJSBridge;
// 通過call函數(shù)來調(diào)用各個Native功能
bridge.call('openReplyForm', {
  text: '@#21',
  topic_id: '61' 
}, function (e) {
  // Native功能執(zhí)行之后的回調(diào)
  alert(JSON.stringify(e));
});
// 通過addEventListener來監(jiān)聽Native事件
bridge.on('replySuccess', function(e) {
  alert(JSON.stringify(e));
});
  1. JsBridge對象調(diào)用回調(diào)對象

call函數(shù)的第三個參數(shù)是一個回調(diào)函數(shù)刀疙,任何Native功能在執(zhí)行完成后,需要調(diào)用這個函數(shù)扫倡,傳回一個回調(diào)對象谦秧。

這個對象需要包含如下結(jié)構(gòu):

var e = {
  success: true, // 是否調(diào)用成功
  errorMessage: '如果success為false竟纳,需要傳回一個錯誤信息',
  data: '可選,有返回則返回'
}

事件擴展

事件擴展主要用于Native端調(diào)用JS端邏輯疚鲤。

1. JSBridge就位(ready)

JSBridge的注入是一個異步過程锥累,所以需要開發(fā)者監(jiān)聽這個ready事件再進行call調(diào)用。

BRBForumJSBridge.on('ready', function(e) {
  // 執(zhí)行其他call操作
});

2. 回復成功(replySuccess)

BRBForumJSBridge.on('replySuccess', function(content, post_id) {
  // 返回用戶輸入的內(nèi)容
  console.log(content);
});

3. 點贊和踩成功(upSuccess | downSuccess)

BRBForumJSBridge.on('upSuccess' | 'downSuccess', function(post_id) {
  // 返回點贊成功的post_id
  console.log(post_id);
});

4. 關(guān)注用戶成功(addFriendshipsSuccess)

BRBForumJSBridge.on('addFriendshipSuccess', function(user_id) {
  // 返回關(guān)注成功的user_id
  console.log(user_id);
});

5. 取消關(guān)注用戶成功(cancelFriendshipSuccess)

BRBForumJSBridge.on('cancelFriendshipSuccess', function(user_id) {
  // 返回關(guān)注成功的user_id
  console.log(user_id);
});

Native功能

call函數(shù)主要用戶JS端主動調(diào)用Native端功能集歇。

1. 喚起回復表單(openReplyForm)

BRBForumJSBridge.call('openReplyForm', {
  text: '@#21',
  topic_id: '61' 
}, function () {
  // when success
});

入?yún)ⅲ?/p>

參數(shù) 類型 必選 描述 例子
text string 喚起表單填入的字符串 '@#21'
topic_id string 回復的topic_id '32'

回調(diào)對象data:無

2. 回復樓層(replyFloor)

BRBForumJSBridge.call('replyFloor', {
  post_id: '11',
  refer_content: '<html>',
  refer_floor: '3'
}, function () {
  // when success
});

入?yún)ⅲ?/p>

參數(shù) 類型 必選 描述 例子
post_id string post id '111'
refer_content string 引用的html桶略,在上傳時直接加入用戶回復之前即可 '<blockquote><p><a data-mention="true" href="/users/24382" class="simditor-mention">@zn_test</a> #1</p>123123</blockquote>'
refer_floor string 回復的樓層 '3'

回調(diào)對象data:無

3. 點贊和踩(up | down)

BRBForumJSBridge.call('up' | 'down', {
  post_id: '2341',
}, function () {
  // when success
});

入?yún)ⅲ?/p>

參數(shù) 類型 必選 描述 例子
post_id string post id '214'

回調(diào)對象data:無

4. 關(guān)注用戶(addFriendship)

BRBForumJSBridge.call('addFriendship', {
  user_id: '2341',
}, function () {
  // when success
});

入?yún)ⅲ?/p>

參數(shù) 類型 必選 描述 例子
user_id string 用戶 id '214'

回調(diào)對象data:無

5. 取消關(guān)注用戶(cancelFriendship)

BRBForumJSBridge.call('cancelFriendship', {
  user_id: '2341',
}, function () {
  // when success
});

入?yún)ⅲ?/p>

參數(shù) 類型 必選 描述 例子
user_id string 用戶 id '214'

回調(diào)對象data:無

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市诲宇,隨后出現(xiàn)的幾起案子际歼,更是在濱河造成了極大的恐慌,老刑警劉巖姑蓝,帶你破解...
    沈念sama閱讀 221,576評論 6 515
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件鹅心,死亡現(xiàn)場離奇詭異,居然都是意外死亡纺荧,警方通過查閱死者的電腦和手機旭愧,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,515評論 3 399
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來虐秋,“玉大人榕茧,你說我怎么就攤上這事垃沦】透” “怎么了?”我有些...
    開封第一講書人閱讀 168,017評論 0 360
  • 文/不壞的土叔 我叫張陵肢簿,是天一觀的道長靶剑。 經(jīng)常有香客問我,道長池充,這世上最難降的妖魔是什么桩引? 我笑而不...
    開封第一講書人閱讀 59,626評論 1 296
  • 正文 為了忘掉前任,我火速辦了婚禮收夸,結(jié)果婚禮上坑匠,老公的妹妹穿的比我還像新娘。我一直安慰自己卧惜,他們只是感情好厘灼,可當我...
    茶點故事閱讀 68,625評論 6 397
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著咽瓷,像睡著了一般设凹。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上茅姜,一...
    開封第一講書人閱讀 52,255評論 1 308
  • 那天闪朱,我揣著相機與錄音,去河邊找鬼。 笑死奋姿,一個胖子當著我的面吹牛锄开,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播胀蛮,決...
    沈念sama閱讀 40,825評論 3 421
  • 文/蒼蘭香墨 我猛地睜開眼院刁,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了粪狼?” 一聲冷哼從身側(cè)響起退腥,我...
    開封第一講書人閱讀 39,729評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎再榄,沒想到半個月后狡刘,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 46,271評論 1 320
  • 正文 獨居荒郊野嶺守林人離奇死亡困鸥,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 38,363評論 3 340
  • 正文 我和宋清朗相戀三年嗅蔬,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片疾就。...
    茶點故事閱讀 40,498評論 1 352
  • 序言:一個原本活蹦亂跳的男人離奇死亡澜术,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出猬腰,到底是詐尸還是另有隱情鸟废,我是刑警寧澤,帶...
    沈念sama閱讀 36,183評論 5 350
  • 正文 年R本政府宣布姑荷,位于F島的核電站盒延,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏鼠冕。R本人自食惡果不足惜添寺,卻給世界環(huán)境...
    茶點故事閱讀 41,867評論 3 333
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望懈费。 院中可真熱鬧计露,春花似錦、人聲如沸憎乙。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,338評論 0 24
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽寨闹。三九已至胶坠,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間繁堡,已是汗流浹背沈善。 一陣腳步聲響...
    開封第一講書人閱讀 33,458評論 1 272
  • 我被黑心中介騙來泰國打工乡数, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人闻牡。 一個月前我還...
    沈念sama閱讀 48,906評論 3 376
  • 正文 我出身青樓净赴,卻偏偏與公主長得像,于是被迫代替她去往敵國和親罩润。 傳聞我的和親對象是個殘疾皇子玖翅,可洞房花燭夜當晚...
    茶點故事閱讀 45,507評論 2 359

推薦閱讀更多精彩內(nèi)容