cache
Cache模块用于管理应用缓存,通过plus.cache获取缓存管理对象。
方法:
- clear: 清除应用的缓存数据
- calculate: 计算应用已使用的缓存数据大小
- setMaxSize: 设置应用的可使用的最大缓存大小
回调方法:
- CacheClearCallback: 清除应用缓存完成回调
- CacheCalculateCallback: 计算应用使用缓存容量回调
模块:
5+功能模块(permissions)
{
// ...
"permissions":{
// ...
"Cache": {
"description": "应用缓存"
}
}
}
clear
清除应用的缓存数据
void plus.cache.clear( clearCB );
参数:
- clearCB:
(
CacheClearCallback
)
可选 清除缓存操作完成回调函数
返回值:
void : 无平台支持:
- Android - 2.2+ (支持)
- iOS - 4.3+ (支持)
示例:
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Cache Example</title>
<script type="text/javascript">
// 扩展API加载完毕后调用onPlusReady回调函数
document.addEventListener( "plusready", onPlusReady, false );
var r = null;
// 扩展API加载完毕,现在可以正常调用扩展API
function onPlusReady() {
plus.cache.clear( function () {
alert( "Clear application cache successful!" );
});
}
</script>
</head>
<body>
</body>
</html>
calculate
计算应用已使用的缓存数据大小
void plus.cache.calculate( calculateCB );
参数:
- calculateCB:
(
CacheCalculateCallback
)
必选 计算缓存数据大小操作完成回调函数
返回值:
void : 无平台支持:
- Android - 2.2+ (支持)
- iOS - 4.3+ (支持)
示例:
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Cache Example</title>
<script type="text/javascript">
// 扩展API加载完毕后调用onPlusReady回调函数
document.addEventListener( "plusready", onPlusReady, false );
// 扩展API加载完毕,现在可以正常调用扩展API
function onPlusReady() {
plus.cache.calculate( function ( size ) {
alert( "Application cache size: " + size + " byte!" );
});
}
</script>
</head>
<body>
</body>
</html>
setMaxSize
设置应用的可使用的最大缓存大小
void plus.cache.setMaxSize( size );
说明:
应用缓存数据仅包括程序中使用webview产生的数据,不包括业务逻辑中使用扩展api保存的数据。 当应用缓存数据超过设置的最大值时程序将自动删除过期的数据,保证应用缓存数据不超过设定的最大值。 应用默认的缓存最大值不限,即取决于设备的可用空间大小。
参数:
- size:
(
Number
)
必选 应用可使用的最大缓存大小,单位为byte
返回值:
void : 无平台支持:
- Android - 2.2+ (支持)
- iOS - 4.3+ (支持)
示例:
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Cache Example</title>
<script type="text/javascript">
// 扩展API加载完毕后调用onPlusReady回调函数
document.addEventListener( "plusready", onPlusReady, false );
// 扩展API加载完毕,现在可以正常调用扩展API
function onPlusReady() {
// 设置应用的最大缓存数据大小为10M
plus.cache.setMaxSize( 10*1024*1024 );
}
</script>
</head>
<body>
</body>
</html>
CacheClearCallback
清除应用缓存完成回调
void onCompleted() {
// Clear cache completed code.
}
说明:
清除应用缓存回调函数,调用plus.cache.clear清除缓存操作时作为参数传入,在清除缓存操作完成时触发回调。
参数:
返回值:
void : 无平台支持:
- Android - 2.2+ (支持)
- iOS - 4.3+ (支持)
CacheCalculateCallback
计算应用使用缓存容量回调
void onCompleted( size ) {
// Calculate cache complete code.
}
说明:
计算应用当前使用缓存容量回调函数,调用plus.cache.calculate计算缓存容量操作时作为参数传入,在计算缓存容量大小完成时触发回调。
参数:
- size:
(
Number
)
必选 应用当前使用缓存的大小,单位为byte
返回值:
void : 无平台支持:
- Android - 2.2+ (支持)
- iOS - 4.3+ (支持)