BBASMPlugin+Components.h 4.77 KB
//
//  BBASMPlugin+Components.h
//  SWAN
//
//  Created by baidu on 2017/11/24.
//  Copyright © 2017年 baidu. All rights reserved.
//

#import "BBASMPlugin.h"

@interface BBASMPlugin (Components)

/**
 * 描  述: 小程序WebView组件,插入webview组件
 * 示  例: baiduboxapp://swanAPI/insertWebView?params=$params&callback=$callback
 * 文  档: http://ft.baidu.com/#/scheme/swan_insertwebview
 * 备  注:
 * ********** description ************
 * @name:      webView.insert
 * @authority: swanAPI
 * @path:      /insertWebView
 * @args:      [{"name": "slaveId", "value": "string="}, {"name": "viewId", "value": "string="},{"name": "componentId","value": "string="},{"name": "parentId", "value": "string="}, {"name": "hide", "value": "boolean="}, {"name": "src", "value": "string="},{"name": "type", "value": "string="},{"name": "userAgent", "value": "string="},{"name": "cb", "value": "string="},{"name": "targetUrls", "value": "Array="}]
 * @config:    {"swan": {"web": {"invoke": "swan.message.url", "handler": "bridge"}, "jsc": {"invoke": "swan.method.url", "method": "_naSwan.bridge.postMessage"}}}
 */
- (void)insertWebView:(BBASchemeDispatcher *)dispatcher;

/**
 * 描  述: 移除小程序中的webview组件
 * 示  例: baiduboxapp://swanAPI/removeWebView?params=$params&callback=$callback
 * 文  档: http://ft.baidu.com/#/scheme/swan_removewebview
 * 备  注:
 * ********** description ************
 * @name:      webView.remove
 * @authority: swanAPI
 * @path:      /removeWebView
 * @args:      [{"name": "slaveId", "value": "string="}, {"name": "parentId", "value": "string="},{"name": "componentId","value": "string="},{"name": "viewId", "value": "string="}]
 * @config:    {"swan": {"web": {"invoke": "swan.message.url", "handler": "bridge"}, "jsc": {"invoke": "swan.method.url", "method": "_naSwan.bridge.postMessage"}}}
 */
- (void)removeWebView:(BBASchemeDispatcher *)dispatcher;

/**
 * 描  述: 更新小程序中的webview组件展示的url
 * 示  例: baiduboxapp://swanAPI/updateWebView?params=$params&callback=$callback
 * 文  档: http://ft.baidu.com/#/scheme/swan_updatewebview
 * 备  注:
 * ********** description ************
 * @name:      webView.update
 * @authority: swanAPI
 * @path:      /updateWebView
 * @args:      [{"name": "slaveId",  "value": "string="},{"name": "componentId","value": "string="},{"name": "viewId",  "value": "string="},  {"name": "parentId",  "value": "string="},  {"name": "hide",  "value": "boolean="},  {"name": "src",  "value": "string="},{"name": "type", "value": "string="},{"name": "userAgent", "value": "string="},{"name": "cb", "value": "string="},{"name": "targetUrls", "value": "Array="}]
 * @config:    {"swan": {"web": {"invoke": "swan.message.url", "handler": "bridge"}, "jsc": {"invoke": "swan.method.url", "method": "_naSwan.bridge.postMessage"}}}
 */
- (void)updateWebView:(BBASchemeDispatcher *)dispatcher;

/**
 * 描  述: 开始下拉刷新,调用后触发下拉刷新动画,效果与用户手动下拉刷新一致
 * 示  例: baiduboxapp://swanAPI/startPullDownRefresh?params=\$params&callback=\$callback
 * 文  档: http://ft.baidu.com/#/scheme/swan_startpulldownrefresh
 * 备  注:
 * ********** description ************
 * @name:      startPullDownRefresh
 * @authority: swanAPI
 * @path:      /startPullDownRefresh
 * @args:      []
 * @config:    {"swan": {"web": {"invoke": "swan.message.url", "handler": "bridge"}, "jsc": {"invoke": "swan.method.json", "method": "_naSwan.bridge.interactionBridge.startPullDownRefresh"}}}
 */
- (void)startPullDownRefresh:(BBASchemeDispatcher *)dispatcher;

/**
 * 描  述: 停止当前页面下拉刷新
 * 示  例: baiduboxapp://swanAPI/stopPullDownRefresh?params=\$params&callback=\$callback
 * 文  档: http://ft.baidu.com/#/scheme/swan_stoppulldownrefresh
 * 备  注:
 * ********** description ************
 * @name:      stopPullDownRefresh
 * @authority: swanAPI
 * @path:      /stopPullDownRefresh
 * @args:      []
 * @config:    {"swan": {"web": {"invoke": "swan.message.url", "handler": "bridge"}, "jsc": {"invoke": "swan.method.json", "method": "_naSwan.bridge.interactionBridge.stopPullDownRefresh"}}}
 */
- (void)stopPullDownRefresh:(BBASchemeDispatcher *)dispatcher;

/**
 * @brief 开始下拉刷新,调用后触发下拉刷新动画,效果与用户手动下拉刷新一致
 * @param appId 小程序appId
 * @param actionName 端能力名称
 * @return 端能力调用结果
 */
+ (NSDictionary *)startPullDownRefreshWithAppId:(NSString *)appId
                                     actionName:(NSString *)actionName;

/**
 * @brief 停止当前页面下拉刷新
 * @param appId 小程序appId
 * @param actionName 端能力名称
 * @return 端能力调用结果
 */
+ (NSDictionary *)stopPullDownRefreshWithAppId:(NSString *)appId
                                    actionName:(NSString *)actionName;

@end