BBASMWebSocketPlugin.h 2.34 KB
//
//  BBASMWebSocketPlugin.h
//  SWAN
//
//  Created by baidu on 2018/5/25.
//  Copyright © 2018年 baidu. All rights reserved.
//

#import <BBASchemeDispatcher/BBASchemeDispatcher.h>

@interface BBASMWebSocketPlugin : BBASDPluginBase

/**
 * 描  述: 小程序webSocket的connect端能力
 * 示  例: baiduboxapp://swanAPI/webSocket/connect?params=$params&callback=$callback
 * 文  档: http://ft.baidu.com/#/scheme/swan_connect
 * 备  注:
 * ********** description ************
 * @name:      connectSocket
 * @authority: swanAPI
 * @path:      /webSocket/connect
 * @args:      [{"name": "url", "value": "string"}, {"name": "header", "value": "object="}, {"name": "method", "value": "string="}, {"name": "protocols", "value": "Array="}, {"name": "cb", "value": "object"}, {"name": "__plugin__", "value": "string="}]
 * @config:    {"swan": {"web": {"invoke": "swan.message.url", "handler": "bridge"}, "jsc": {"invoke": "swan.method.url", "method": "_naSwan.bridge.postMessage"}}}
 */
- (void)connect:(BBASchemeDispatcher*)dispatcher;

/**
 * 描  述: 小程序webSocket的send端能力
 * 示  例: baiduboxapp://swanAPI/webSocket/send?params=$params&callback=$callback
 * 文  档: http://ft.baidu.com/#/scheme/swan_send
 * 备  注:
 * ********** description ************
 * @name:      sendSocketMessage
 * @authority: swanAPI
 * @path:      /webSocket/send
 * @args:      [{"name": "taskID", "value": "string"}, {"name": "data", "value": "string"}, {"name": "dataType", "value": "string"}]
 * @config:    {"swan": {"web": {"invoke": "swan.message.url", "handler": "bridge"}, "jsc": {"invoke": "swan.method.url", "method": "_naSwan.bridge.postMessage"}}}
 */
- (void)send:(BBASchemeDispatcher*)dispatcher;

/**
 * 描  述: 小程序webSocket的close端能力
 * 示  例: baiduboxapp://swanAPI/webSocket/close?params=$params&callback=$callback
 * 文  档: http://ft.baidu.com/#/scheme/swan_close
 * 备  注:
 * ********** description ************
 * @name:      closeSocket
 * @authority: swanAPI
 * @path:      /webSocket/close
 * @args:      [{"name": "taskID", "value": "string"}, {"name": "code", "value": "string="}, {"name": "reason", "value": "string="}]
 * @config:    {"swan": {"web": {"invoke": "swan.message.url", "handler": "bridge"}, "jsc": {"invoke": "swan.method.url", "method": "_naSwan.bridge.postMessage"}}}
 */
- (void)close:(BBASchemeDispatcher*)dispatcher;

@end