BBASMFilePlugin.h 4.15 KB
//
//  BBASMFilePlugin.h
//  SWAN
//
//  Created by baidu on 2018/3/12.
//  Copyright © 2018年 baidu. All rights reserved.
//

#import "BBASMUtilities.h"

@interface BBASMFilePlugin : BBASDPluginBase

/**
 * 描  述: 保存小程序中的临时文件到本地文件
 * 示  例: baiduboxapp://swanAPI/file/save?params=$params&callback=$callback
 * 文  档: http://ft.baidu.com/#/scheme/swan_file_save
 * 备  注:
 * ********** description ************
 * @name:      saveFile
 * @authority: swanAPI
 * @path:      /file/save
 * @args:      [{"name": "tempFilePath", "value": "string"}]
 * @config:    {"swan": {"web": {"invoke": "swan.message.url", "handler": "bridge"}, "jsc": {"invoke": "swan.method.url", "method": "_naSwan.bridge.postMessage"}}}
 */
- (void)save:(BBASchemeDispatcher *)dispatcher;

/**
 * 描  述: 删除本地存储的文件
 * 示  例: baiduboxapp://swanAPI/file/removeSavedFile?params=$params&callback=$callback
 * 文  档: http://ft.baidu.com/#/scheme/swan_file_removesavedfile
 * 备  注:
 * ********** description ************
 * @name:      removeSavedFile
 * @authority: swanAPI
 * @path:      /file/removeSavedFile
 * @args:      [{"name": "filePath", "value": "string"}]
 * @config:    {"swan": {"web": {"invoke": "swan.message.url", "handler": "bridge"}, "jsc": {"invoke": "swan.method.url", "method": "_naSwan.bridge.postMessage"}}}
 */
- (void)removeSavedFile:(BBASchemeDispatcher *)dispatcher;

/**
 * 描  述: 获取本地文件的文件信息。此接口只能用于获取已保存到本地的文件,若需要获取临时文件信息,请使用 getFileInfo接口。
 * 示  例: baiduboxapp://swanAPI/file/getSavedFileInfo?params=$params&callback=$callback
 * 文  档: http://ft.baidu.com/#/scheme/swan_file_getsavedfileinfo
 * 备  注:
 * ********** description ************
 * @name:      getSavedFileInfo
 * @authority: swanAPI
 * @path:      /file/getSavedFileInfo
 * @args:      [{"name": "filePath", "value": "string"}]
 * @config:    {"swan": {"web": {"invoke": "swan.message.url", "handler": "bridge"}, "jsc": {"invoke": "swan.method.url", "method": "_naSwan.bridge.postMessage"}}}
 */
- (void)getSavedFileInfo:(BBASchemeDispatcher *)dispatcher;

/**
 * 描  述: 获取本地已保存的文件列表
 * 示  例: baiduboxapp://swanAPI/file/getSavedFileList?params=$params&callback=$callback
 * 文  档: http://ft.baidu.com/#/scheme/swan_file_getsavedfilelist
 * 备  注:
 * ********** description ************
 * @name:      getSavedFileList
 * @authority: swanAPI
 * @path:      /file/getSavedFileList
 * @args:      []
 * @config:    {"swan": {"web": {"invoke": "swan.message.url", "handler": "bridge"}, "jsc": {"invoke": "swan.method.url", "method": "_naSwan.bridge.postMessage"}}}
 */
- (void)getSavedFileList:(BBASchemeDispatcher *)dispatcher;

/**
 * 描  述: 获取文件信息
 * 示  例: baiduboxapp://swanAPI/file/getInfo?params={"filePath":"bdfile://tmp_3c519ae5f019607f97c5d456e159091b.mp4","digestAlgorithm":"md5"}&callback=_bdbox_js_958&upgrade=0
 * 文  档: http://ft.baidu.com/#/scheme/swan_getinfo
 * 备  注:
 * ********** description ************
 * @name:      getFileInfo
 * @authority: swanAPI
 * @path:      /file/getInfo
 * @args:      [{"name": "filePath", "value": "string"}, {"name": "digestAlgorithm", "value": "string="}]
 * @config:    {"swan": {"web": {"invoke": "swan.message.url", "handler": "bridge"}, "jsc": {"invoke": "swan.method.url", "method": "_naSwan.bridge.postMessage"}}}
 */
- (void)getInfo:(BBASchemeDispatcher *)dispatcher;

/**
 * 描  述: 新开页面打开文档,支持格式:doc, xls, ppt, pdf, docx, xlsx, pptx。
 * 示  例: baiduboxapp://swanAPI/file/openDocument?params=\$params&callback=\$callback
 * 文  档: http://ft.baidu.com/#/scheme/swan_file_opendocument
 * 备  注:
 * ********** description ************
 * @name:      openDocument
 * @authority: swanAPI
 * @path:      /file/openDocument
 * @args:      [{"name": "filePath", "value": "string"}, {"name": "fileType", "value": "string="}]
 * @config:    {"swan": {"web": {"invoke": "swan.message.url", "handler": "bridge"}, "jsc": {"invoke": "swan.method.url", "method": "_naSwan.bridge.postMessage"}}}
 */
- (void)openDocument:(BBASchemeDispatcher*)aCommand;

@end