BBASMPlugin+Storage.h
8.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
//
// BBASMPlugin+Storage.h
// SWAN
//
// Created by baidu on 2017/11/24.
// Copyright © 2017年 baidu. All rights reserved.
//
/*
每个手百小程序都可以有自己的本地缓存，可以通过 setStorage（setStorageSync）、getStorage（getStorageSync）、clearStorage（clearStorageSync）可以对本地缓存进行设置、获取和清理。同一个手百用户，同一个小程序 storage 上限为 10MB。localStorage 以用户维度隔离，同一台设备上，A 用户无法读取到 B 用户的数据。
注意： localStorage 是持久存储的，但是我们不建议将关键信息全部存在 localStorage，以防用户换设备的情况。
*/
#import "BBASMPlugin.h"
@interface BBASMPlugin (Storage)
/*
* @brief 性能数据监控使用：获取缓存大小
*
* @param appID 小程序id
* @return 缓存大小
*/
+ (unsigned long long)getStorageFileSize:(NSString *)appID;
/**
* 描 述: 将 data 存储在本地缓存中指定的 key 中
* 示 例: baiduboxapp://swanAPI/setStorage?params=\$params&callback=\$callback
* 文 档: http://ft.baidu.com/#/scheme/swan_setstorage
* 备 注:
* ********** description ************
* @name: setStorage
* @authority: swanAPI
* @path: /setStorage
* @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.storage.setStorage"}}}
*/
- (void)setStorage:(BBASchemeDispatcher *)dispatcher;
/**
* 描 述: 将 data 存储在本地缓存中指定的 key 中
* 示 例: baiduboxapp://swanAPI/setStorageSync?params=\$params&callback=\$callback
* 文 档: http://ft.baidu.com/#/scheme/swan_setstoragesync
* 备 注:
* ********** description ************
* @name: setStorageSync
* @authority: swanAPI
* @path: /setStorageSync
* @args: [{"name": "key", "value": "string"}, {"name": "data", "value": "*"}]
* @config: {"swan": {"web": {"invoke": "swan.prompt"}, "jsc": {"invoke": "swan.method.json", "method": "_naSwan.bridge.setStorageSync"}}}
*/
- (void)setStorageSync:(BBASchemeDispatcher *)dispatcher;
/**
* 描 述: 从本地缓存中异步获取指定 key 对应的内容
* 示 例: baiduboxapp://swanAPI/getStorage?params=\$params&callback=\$callback
* 文 档: http://ft.baidu.com/#/scheme/swan_getstorage
* 备 注:
* ********** description ************
* @name: getStorage
* @authority: swanAPI
* @path: /getStorage
* @args: [{"name": "key", "value": "string"}]
* @config: {"swan": {"web": {"invoke": "swan.message.url", "handler": "bridge"}, "jsc": {"invoke": "swan.method.json", "method": "_naSwan.bridge.storage.getStorage"}}}
*/
- (void)getStorage:(BBASchemeDispatcher *)dispatcher;
/**
* 描 述: 从本地缓存中同步获取指定 key 对应的内容
* 示 例: baiduboxapp://swanAPI/getStorageSync?params=\$params&callback=\$callback
* 文 档: http://ft.baidu.com/#/scheme/swan_getstoragesync
* 备 注:
* ********** description ************
* @name: getStorageSync
* @authority: swanAPI
* @path: /getStorageSync
* @args: [{"name": "key", "value": "string"}]
* @config: {"swan": {"web": {"invoke": "swan.prompt"}, "jsc": {"invoke": "swan.method.json", "method": "_naSwan.bridge.getStorageSync"}}}
*/
- (void)getStorageSync:(BBASchemeDispatcher *)dispatcher;
/**
* 描 述: 异步获取当前storage的相关信息
* 示 例: baiduboxapp://swanAPI/getStorageInfo?params=\$params&callback=\$callback
* 文 档: http://ft.baidu.com/#/scheme/swan_getstorageinfo
* 备 注:
* ********** description ************
* @name: getStorageInfo
* @authority: swanAPI
* @path: /getStorageInfo
* @args: []
* @config: {"swan": {"web": {"invoke": "swan.message.url", "handler": "bridge"}, "jsc": {"invoke": "swan.method.json", "method": "_naSwan.bridge.storage.getStorageInfo"}}}
*/
- (void)getStorageInfo:(BBASchemeDispatcher *)dispatcher;
/**
* 描 述: 同步获取当前storage的相关信息
* 示 例: baiduboxapp://swanAPI/getStorageInfoSync?params=\$params&callback=\$callback
* 文 档: http://ft.baidu.com/#/scheme/swan_getstorageinfosync
* 备 注:
* ********** description ************
* @name: getStorageInfoSync
* @authority: swanAPI
* @path: /getStorageInfoSync
* @args: []
* @config: {"swan": {"web": {"invoke": "swan.prompt"}, "jsc": {"invoke": "swan.method.json", "method": "_naSwan.bridge.getStorageInfoSync"}}}
*/
- (void)getStorageInfoSync:(BBASchemeDispatcher *)dispatcher;
/**
* 描 述: 从本地缓存中异步移除指定 key
* 示 例: baiduboxapp://swanAPI/removeStorage?params=\$params&callback=\$callback
* 文 档: http://ft.baidu.com/#/scheme/swan_removestorage
* 备 注:
* ********** description ************
* @name: removeStorage
* @authority: swanAPI
* @path: /removeStorage
* @args: [{"name": "key", "value": "string"}]
* @config: {"swan": {"web": {"invoke": "swan.message.url", "handler": "bridge"}, "jsc": {"invoke": "swan.method.json", "method": "_naSwan.bridge.storage.removeStorage"}}}
*/
- (void)removeStorage:(BBASchemeDispatcher *)dispatcher;
/**
* 描 述: 从本地缓存中同步移除指定 key
* 示 例: baiduboxapp://swanAPI/removeStorageSync?params=\$params&callback=\$callback
* 文 档: http://ft.baidu.com/#/scheme/swan_removestoragesync
* 备 注:
* ********** description ************
* @name: removeStorageSync
* @authority: swanAPI
* @path: /removeStorageSync
* @args: [{"name": "key", "value": "string"}]
* @config: {"swan": {"web": {"invoke": "swan.prompt"}, "jsc": {"invoke": "swan.method.json", "method": "_naSwan.bridge.removeStorageSync"}}}
*/
- (void)removeStorageSync:(BBASchemeDispatcher *)dispatcher;
/**
* 描 述: 清理本地数据缓存
* 示 例: baiduboxapp://swanAPI/clearStorage?params=\$params&callback=\$callback
* 文 档: http://ft.baidu.com/#/scheme/swan_clearstorage
* 备 注:
* ********** description ************
* @name: clearStorage
* @authority: swanAPI
* @path: /clearStorage
* @args: []
* @config: {"swan": {"web": {"invoke": "swan.message.url", "handler": "bridge"}, "jsc": {"invoke": "swan.method.json", "method": "_naSwan.bridge.storage.clearStorage"}}}
*/
- (void)clearStorage:(BBASchemeDispatcher *)dispatcher;
/**
* 描 述: 同步清理本地数据缓存
* 示 例: baiduboxapp://swanAPI/clearStorageSync?params=\$params&callback=\$callback
* 文 档: http://ft.baidu.com/#/scheme/swan_clearstoragesync
* 备 注:
* ********** description ************
* @name: clearStorageSync
* @authority: swanAPI
* @path: /clearStorageSync
* @args: []
* @config: {"swan": {"web": {"invoke": "swan.prompt"}, "jsc": {"invoke": "swan.method.json", "method": "_naSwan.bridge.clearStorageSync"}}}
*/
- (void)clearStorageSync:(BBASchemeDispatcher *)dispatcher;
#pragma mark - not API
+ (NSDictionary *)getStorageWithAppID:(NSString *)appID
param:(NSDictionary *)param
actionName:(NSString *)action
isSync:(BOOL)isSync
completion:(void (^)(NSDictionary *))completion;
+ (NSDictionary *)setStorageWithAppID:(NSString *)appID
param:(NSDictionary *)param
actionName:(NSString *)action
isSync:(BOOL)isSync
completion:(void (^)(NSDictionary *))completion;
+ (NSDictionary *)removeStorageWithAppID:(NSString *)appID
param:(NSDictionary *)param
actionName:(NSString *)action
isSync:(BOOL)isSync
completion:(void (^)(NSDictionary *))completion;
+ (NSDictionary *)clearStorageWithAppID:(NSString *)appID
param:(NSDictionary *)param
actionName:(NSString *)action
isSync:(BOOL)isSync
completion:(void (^)(NSDictionary *))completion;
+ (NSDictionary *)getStorageInfoWithAppID:(NSString *)appID
param:(NSDictionary *)param
actionName:(NSString *)action
isSync:(BOOL)isSync
completion:(void (^)(NSDictionary *))completion;
@end