BBASMPlugin+GlobalStorage.h 5.83 KB
//
//  BBASMPlugin+GlobalStorage.h
//  BBAMNP
//
//  Created by baidu on 2020/10/16.
//

#import "BBASMPlugin.h"


@interface BBASMPlugin (GlobalStorage)

/**
 * 描  述: 将 data 存储在本地缓存中指定的 key 中
 * 示  例: baiduboxapp://swanAPI/setGlobalStorage?params=\$params&callback=\$callback
 * 文  档: http://ft.baidu.com/#/scheme/swan_setglobalstorage
 * 备  注:
 * ********** description ************
 * @name:      boxjs.setGlobalStorage
 * @authority: swanAPI
 * @path:      /setGlobalStorage
 * @args:      [{"name": "key", "value": "string"}, {"name": "data", "value": "*"}]
 * @config:    {"swan": {"web": {"invoke": "swan.message.url", "handler": "bridge"}, "jsc": {"invoke": "swan.method.json", "method": "_naSwan.bridge.globalStorage.setGlobalStorage"}}}
 */
- (void)setGlobalStorage:(BBASchemeDispatcher *)dispatcher;

/**
 * 描  述: 将 data 存储在本地缓存中指定的 key 中
 * 示  例: baiduboxapp://swanAPI/setGlobalStorageSync?params=\$params&callback=\$callback
 * 文  档: http://ft.baidu.com/#/scheme/swan_setglobalstoragesync
 * 备  注:
 * ********** description ************
 * @name:      boxjs.setGlobalStorageSync
 * @authority: swanAPI
 * @path:      /setGlobalStorageSync
 * @args:      [{"name": "key", "value": "string"}, {"name": "data", "value": "*"}]
 * @config:    {"swan": {"web": {"invoke": "swan.prompt"}, "jsc": {"invoke": "swan.method.json", "method": "_naSwan.bridge.setGlobalStorageSync"}}}
 */
- (void)setGlobalStorageSync:(BBASchemeDispatcher *)dispatcher;

/**
 * 描  述: 从本地缓存中异步获取指定 key 对应的内容
 * 示  例: baiduboxapp://swanAPI/getGlobalStorage?params=\$params&callback=\$callback
 * 文  档: http://ft.baidu.com/#/scheme/swan_getglobalstorage
 * 备  注:
 * ********** description ************
 * @name:      boxjs.getGlobalStorage
 * @authority: swanAPI
 * @path:      /getGlobalStorage
 * @args:      [{"name": "key", "value": "string"}]
 * @config:    {"swan": {"web": {"invoke": "swan.message.url", "handler": "bridge"}, "jsc": {"invoke": "swan.method.json", "method": "_naSwan.bridge.globalStorage.getGlobalStorage"}}}
 */
- (void)getGlobalStorage:(BBASchemeDispatcher *)dispatcher;

/**
 * 描  述: 从本地缓存中同步获取指定 key 对应的内容
 * 示  例: baiduboxapp://swanAPI/getGlobalStorageSync?params=\$params&callback=\$callback
 * 文  档: http://ft.baidu.com/#/scheme/swan_getglobalstoragesync
 * 备  注:
 * ********** description ************
 * @name:      boxjs.getGlobalStorageSync
 * @authority: swanAPI
 * @path:      /getGlobalStorageSync
 * @args:      [{"name": "key", "value": "string"}]
 * @config:    {"swan": {"web": {"invoke": "swan.prompt"}, "jsc": {"invoke": "swan.method.json", "method": "_naSwan.bridge.getGlobalStorageSync"}}}
 */
- (void)getGlobalStorageSync:(BBASchemeDispatcher *)dispatcher;

/**
 * 描  述: 异步获取当前storage的相关信息
 * 示  例: baiduboxapp://swanAPI/getStorageInfo?params=\$params&callback=\$callback
 * 文  档: http://ft.baidu.com/#/scheme/swan_getglobalstorageinfo
 * 备  注:
 * ********** description ************
 * @name:      boxjs.getGlobalStorageInfo
 * @authority: swanAPI
 * @path:      /getGlobalStorageInfo
 * @args:      []
 * @config:    {"swan": {"web": {"invoke": "swan.message.url", "handler": "bridge"}, "jsc": {"invoke": "swan.method.json", "method": "_naSwan.bridge.globalStorage.getGlobalStorageInfo"}}}
 */
- (void)getGlobalStorageInfo:(BBASchemeDispatcher *)dispatcher;

/**
 * 描  述: 同步获取当前storage的相关信息
 * 示  例: baiduboxapp://swanAPI/getGlobalStorageInfoSync?params=\$params&callback=\$callback
 * 文  档: http://ft.baidu.com/#/scheme/swan_getglobalstorageinfosync
 * 备  注:
 * ********** description ************
 * @name:      boxjs.getGlobalStorageInfoSync
 * @authority: swanAPI
 * @path:      /getGlobalStorageInfoSync
 * @args:      []
 * @config:    {"swan": {"web": {"invoke": "swan.prompt"}, "jsc": {"invoke": "swan.method.json", "method": "_naSwan.bridge.getGlobalStorageInfoSync"}}}
 */
- (void)getGlobalStorageInfoSync:(BBASchemeDispatcher *)dispatcher;

/**
 * 描  述: 从本地缓存中异步移除指定 key
 * 示  例: baiduboxapp://swanAPI/removeGlobalStorage?params=\$params&callback=\$callback
 * 文  档: http://ft.baidu.com/#/scheme/swan_removeglobalstorage
 * 备  注:
 * ********** description ************
 * @name:      boxjs.removeGlobalStorage
 * @authority: swanAPI
 * @path:      /removeGlobalStorage
 * @args:      [{"name": "key", "value": "string"}]
 * @config:    {"swan": {"web": {"invoke": "swan.message.url", "handler": "bridge"}, "jsc": {"invoke": "swan.method.json", "method": "_naSwan.bridge.globalStorage.removeGlobalStorage"}}}
 */
- (void)removeGlobalStorage:(BBASchemeDispatcher *)dispatcher;

/**
 * 描  述: 从本地缓存中同步移除指定 key
 * 示  例: baiduboxapp://swanAPI/removeGlobalStorageSync?params=\$params&callback=\$callback
 * 文  档: http://ft.baidu.com/#/scheme/swan_removeglobalstoragesync
 * 备  注:
 * ********** description ************
 * @name:      boxjs.removeGlobalStorageSync
 * @authority: swanAPI
 * @path:      /removeGlobalStorageSync
 * @args:      [{"name": "key", "value": "string"}]
 * @config:    {"swan": {"web": {"invoke": "swan.prompt"}, "jsc": {"invoke": "swan.method.json", "method": "_naSwan.bridge.removeGlobalStorageSync"}}}
 */
- (void)removeGlobalStorageSync:(BBASchemeDispatcher *)dispatcher;

#pragma mark - not API
+ (NSDictionary *)getGlobalStorageWithAppID:(NSString *)appID param:(NSDictionary *)param actionName:(NSString *)action;
+ (NSDictionary *)setGlobalStorageWithAppID:(NSString *)appID param:(NSDictionary *)param actionName:(NSString *)action;
+ (NSDictionary *)removeGlobalStorageWithAppID:(NSString *)appID param:(NSDictionary *)param actionName:(NSString *)action;
+ (NSDictionary *)getGlobalStorageInfoWithAppID:(NSString *)appID actionName:(NSString *)action;

@end