JCSDK Objective-C API Reference for iOS/macOS  2.5.1
构造函数 | 类方法 | 所有成员列表
JCStorage类 参考

构造函数

(JCStorageItem *) - uploadFileByExpireTime:expiredSeconds:cookie:
 
(JCStorageItem *) - downloadFile:savePath:cookie:
 
(bool) - cancelFile:
 
(bool) - cancelFileByCookie:
 

类方法

(JCStorage *) + create:callback:
 
(void) + destroy
 

详细描述

文件存储类

上传文件:将文件上传至服务器,上传成功后服务器会返回文件地址,地址一般会有一定的有效期

下载文件:通过上传文件服务器返回的地址来下载该文件

函数文档

◆ cancelFile:

- (bool) cancelFile: (JCStorageItem *)  item

取消正在进行的文件上传下载

参数
itemJCStorageItem 对象,由 uploadFileByExpireTimedownloadFile 返回
返回
  • true: 成功,会收到 onFileResult 回调
  • false: 失败,不会收到回调

◆ cancelFileByCookie:

- (bool) cancelFileByCookie: (id)  cookie

通过cookie取消正在进行的文件上传下载

通过 cookie 来匹配缓存中的 JCStorageItem 对象

  • 若能匹配上,则会调用 cancelFile 方法并它提供返回值
  • 若匹配不上,则会直接返回 false
参数
cookie上传下载传入的 cookie
返回
  • true: 成功
  • false: 失败

◆ create:callback:

+ (JCStorage*) create: (JCClient *)  client
callback: (id< JCStorageCallback >)  callback 

创建 JCStorage 对象

JCStorage 的所有接口函数,如无特殊说明,都建议在主线程调用

注解
  • 调用此方法创建 JCStorage 对象后,期间没有调用过 destroy 方法销毁对象,然后又重复调用此方法,会直接返回第一次创建的 JCStorage 对象
  • 调用此方法前确保 JCClient 已完成初始化,即 state 获取的状态值不等于 JCClientStateNotInit
参数
clientJCClient 对象
callbackJCStorageCallback 对象,用于回调相关通知
返回
返回 JCStorage 对象
异常
JCClient、JCStorageCallback 任意一个参数传空就会出现调用异常

◆ destroy

+ (void) destroy

销毁 JCStorage 对象

该方法为同步调用,需要等待 JCStorage 实例资源释放后才能执行其他操作,调用此方法后,你将无法再使用 JCStorage 的其它方法和回调。
我们 不建议 在 JCSDK 的回调中调用此方法销毁 JCStorage 对象,否则会出现崩溃。
如需在销毁后再次创建 JCStorage 实例,需要等待 destroy 方法执行结束后再创建实例。

◆ downloadFile:savePath:cookie:

- (JCStorageItem*) downloadFile: (NSString *)  uri
savePath: (NSString *)  savePath
cookie: (id)  cookie 

下载文件

参数
uri文件地址
savePath本地文件保存地址,由用户自行指定,需精确到文件名及格式,例如:/Documents/JuphoonCloud/audio.wmv。请确保目录存在且可写。
cookie标志数据
  • JCStorageItem 对象:
    • 调用底层接口成功,返回的 JCStorageItem 对象的状态为 JCStorageItemStateTransfering,并且会收到 onFileUpdate 回调
    • 调用底层接口失败,返回的 JCStorageItem 对象的状态为 JCStorageItemStateFail,并且会收到 onFileResult 回调
  • null:异常调用,不会收到回调

◆ uploadFileByExpireTime:expiredSeconds:cookie:

- (JCStorageItem*) uploadFileByExpireTime: (NSString *)  path
expiredSeconds: (int)  expiredSeconds
cookie: (id)  cookie 

上传文件

参数
path文件路径,需精确到文件名及格式,例如:/Documents/JuphoonCloud/audio.wmv。请确保目录存在。
cookie标志数据
expiredSeconds过期秒数,-1表示永久
返回
  • JCStorageItem 对象:
    • 调用底层接口成功,返回的 JCStorageItem 对象的状态为 JCStorageItemStateTransfering,并且会收到 onFileUpdate 回调
    • 调用底层接口失败,返回的 JCStorageItem 对象的状态为 JCStorageItemStateFail,并且会收到 onFileResult 回调
  • null:异常调用,不会收到回调

该类的文档由以下文件生成: