NIMSDK-iOS
载入中...
搜索中...
未找到
<NIMResourceManager>协议 参考

#import <NIMResourceManagerProtocol.h>

类 <NIMResourceManager> 继承关系图:

构造函数

(void) - upload:progress:completion:
 
(void) - upload:scene:progress:completion:
 
(void) - upload:scene:md5:progress:completion:
 
(void) - upload:extraInfo:progress:completion:
 
(void) - checkFileQuickTransfer:fileSize:option:completion:
 
(void) - download:filepath:progress:completion:
 
(void) - download:filepath:extraInfo:progress:completion:
 
(void) - download:filepath:type:extraInfo:progress:completion:
 
(void) - download:filepath:type:extraInfo:thumbWidth:thumbHeight:progress:completion:
 
(void) - cancelTask:
 
(NSString *) - normalizeURLString:
 
(NSString *) - convertHttpToHttps:
 
(NSString *) - convertURLToAcceleratedURL:
 
(NSString *) - imageThumbnailURL:
 
(NSString *) - videoThumbnailURL:
 
(void) - searchResourceFiles:completion:
 
(void) - removeResourceFiles:completion:
 
(void) - fetchNOSURLWithURL:completion:
 
(void) - fetchNOSURLWithURL:roomId:completion:
 

详细描述

资源管理

函数文档

◆ cancelTask:

- (void) cancelTask: (NSString *)  filepath

取消上传/下载任务

参数
filepath上传/下载任务对应的文件路径 @discussion 如果同一个文件同时上传或者下载(理论上不应该出现这种情况),ResourceManager会进行任务合并,基于这个原则cancel的操作对象是某个文件对应的所有的上传/下载任务

◆ checkFileQuickTransfer:fileSize:option:completion:

- (void) checkFileQuickTransfer: (NSString *)  MD5
fileSize: (uint64_t)  size
option: (NIMResourceExtraInfo *)  option
completion: (NIMFileQuickTransferCompleteBlock completion 

◆ convertHttpToHttps:

- (NSString *) convertHttpToHttps: (NSString *)  urlString

将 http url 转换为 https url

参数
urlStringhttp url 地址 @discussion SDK 会自动处理除自定义消息外所有消息内的 http url 以保证符合苹果的审核请求,但是自定义消息中的 http 地址 SDK 并不知道具体属性在哪,所以在做这些文件下载时,需要上层自己处理 如果传入的 url 是 https 地址,直接返回字符串本身。如果传入的 url 是云信无法识别 host 的 http 地址,直接返回添加了 https 的地址

◆ convertURLToAcceleratedURL:

- (NSString *) convertURLToAcceleratedURL: (NSString *)  urlString

将 url 转换为加速后的 CDN url 地址

参数
urlString未加速 url 地址 @discussion SDK 会自动处理除自定义消息外所有消息内的 url 进行 CDN 加速,但是自定义消息中的 url 地址 SDK 并不知道具体属性在哪,所以在做这些文件下载时,需要上层传入对应的 URL 替换为走 CDN 格式的地址,以获得 CDN 加速的效果

◆ download:filepath:extraInfo:progress:completion:

- (void) download: (NSString *)  urlString
filepath: (NSString *)  filepath
extraInfo: (NIMResourceExtraInfo *_Nullable)  extraInfo
progress: (NIMHttpProgressBlock _Nullable)  progress
completion: (NIMDownloadCompleteBlock _Nullable)  completion 

下载文件

参数
urlString下载的RL
filepath下载路径
extraInfo资源辅助信息
progress进度Block
completion完成Block

◆ download:filepath:progress:completion:

- (void) download: (NSString *)  urlString
filepath: (NSString *)  filepath
progress: (nullable NIMHttpProgressBlock progress
completion: (nullable NIMDownloadCompleteBlock completion 

下载文件

参数
urlString下载的RL
filepath下载路径
progress进度Block
completion完成Block

◆ download:filepath:type:extraInfo:progress:completion:

- (void) download: (NSString *)  urlString
filepath: (NSString *)  filepath
type: (NSInteger)  type
extraInfo: (NIMResourceExtraInfo *)  info
progress: (NIMHttpProgressBlock progress
completion: (NIMDownloadCompleteBlock completion 

下载文件

参数
urlString下载的RL
filepath下载路径
typeFcs下载类型(特殊功能,开通请联系技术支持)
extraInfo资源辅助信息
progress进度Block
completion完成Block

◆ download:filepath:type:extraInfo:thumbWidth:thumbHeight:progress:completion:

- (void) download: (NSString *)  urlString
filepath: (NSString *)  filepath
type: (NSInteger)  type
extraInfo: (NIMResourceExtraInfo *)  info
thumbWidth: (NSInteger)  thumbWidth
thumbHeight: (NSInteger)  thumbHeight
progress: (NIMHttpProgressBlock progress
completion: (NIMDownloadCompleteBlock completion 

下载文件

参数
urlString下载的RL
filepath下载路径
typeFcs下载类型(特殊功能,开通请联系技术支持)
extraInfo资源辅助信息
thumbWidth缩略图宽度
thumbHeight缩略图高度
progress进度Block
completion完成Block

◆ fetchNOSURLWithURL:completion:

- (void) fetchNOSURLWithURL: (NSString *)  shortCode
completion: (NIMFetchURLCompletion completion 

使用短链换源链

参数
shortCode短链
completion完成回调 @discussion 当用户后台配置了NOS文件安全,文件上传的URL为短链,无法直接下载, 可通过该接口换取源链

◆ fetchNOSURLWithURL:roomId:completion:

- (void) fetchNOSURLWithURL: (NSString *)  shortCode
roomId: (NSString *_Nullable)  roomId
completion: (NIMFetchURLCompletion completion 

使用短链换源链

参数
shortCode短链
roomId聊天室ID
completion完成回调 @discussion 当用户后台配置了NOS文件安全,文件上传的URL为短链,无法直接下载, 可通过该接口换取源链

◆ imageThumbnailURL:

- (NSString *) imageThumbnailURL: (NSString *)  urlString

将传入的 nos 图片 url 调整为缩略图形式 url

参数
urlString图片url

◆ normalizeURLString:

- (NSString *) normalizeURLString: (NSString *)  urlString

规范化 URL 地址

参数
urlStringurl 地址 @discussion 按照 NIMSDK 的要求对 url 进行规范化处理,调用该接口等同于同时调用 convertHttpToHttps: 和 convertURLToAcceleratedURL:

◆ removeResourceFiles:completion:

- (void) removeResourceFiles: (NIMResourceQueryOption *)  option
completion: (NIMResourceDeleteHandler completion 

删除缓存的资源文件

参数
option搜索选项
completion完成回调

◆ searchResourceFiles:completion:

- (void) searchResourceFiles: (NIMResourceQueryOption *)  option
completion: (NIMResourceSearchHandler completion 

搜索缓存的资源文件

参数
option搜索选项
completion完成回调

◆ upload:extraInfo:progress:completion:

- (void) upload: (NSString *_Nonnull)  filepath
extraInfo: (nullable NIMResourceExtraInfo *)  extraInfo
progress: (nullable NIMHttpProgressBlock progress
completion: (nullable NIMUploadCompleteBlock completion 

上传文件

参数
filepath上传文件路径
extraInfo资源辅助信息
progress进度Block
completion上传Block

◆ upload:progress:completion:

- (void) upload: (NSString *)  filepath
progress: (nullable NIMHttpProgressBlock progress
completion: (nullable NIMUploadCompleteBlock completion 

上传文件

参数
filepath上传文件路径
progress进度Block
completion上传Block

◆ upload:scene:md5:progress:completion:

- (void) upload: (NSString *_Nonnull)  filepath
scene: (nullable NSString *)  scene
md5: (nullable NSString *)  md5
progress: (nullable NIMHttpProgressBlock progress
completion: (nullable NIMUploadCompleteBlock completion 

上传文件

参数
filepath上传文件路径
scene场景分组
md5文件MD5
progress进度Block
completion上传Block

◆ upload:scene:progress:completion:

- (void) upload: (NSString *)  filepath
scene: (nonnull NSString *)  scene
progress: (nullable NIMHttpProgressBlock progress
completion: (nullable NIMUploadCompleteBlock completion 

上传文件

参数
filepath上传文件路径
scene场景分组
progress进度Block
completion上传Block

◆ videoThumbnailURL:

- (NSString *) videoThumbnailURL: (NSString *)  urlString

将传入的 nos 视频 url 调整为缩略图形式 url

参数
urlString视频url

该协议的文档由以下文件生成: