平安云 - 云以致用智造未来

iOS SDK

1. 简介 <ul> <li>本文档主要介绍 OBS iOS SDK 的接口使用及注意事项；</li> <li>并且假设您是平安云用户，且已经开通了OBS服务；</li> <li>如果您还没有开通或者还不了解平安云 OBS 服务，请登录<a href="/ssr/products/OBS" target="_blank">OBS产品主页</a>进行了解。</li> <li>OBS-iOS-SDK 是由平安云团队开发的工具包。便于开发者在 iOS 上方便使用平安云当中的 OBS 服务。</li> </ul> 文档主要罗列了 OBS-iOS-SDK 中，上传、下载以及删除的一些基本方法，并对方法参数进行简要解释，且对响应方法有一个详细的说明。 2. SDK下载 IOS SDK 开发包最新版本 <a href="https://pcp-portal-sca.obs-cn-shenzhen.pinganyun.com/sdk%2Fobs-iOS-sdk-1.0.3.zip?response-content-disposition=attachment%3Bfilename%3Dobs-iOS-sdk-1.0.3.zip" target="_blank">v1.0.3</a> IOS Demo <a href="http://iobs.pingan.com.cn/download/iobs-dmz-dev-aid/ObsTest_demo?attname=" target="_blank">下载</a> 签名服务Demo <a href="http://iobs.pingan.com.cn/download/iobs-dmz-dev-aid/sign-demo?attname=" target="_blank">JAVA版下载</a> 3. API概览 <table> <caption> </caption> <thead> <tr> <th> API </th> <th> 描述 </th> </tr> </thead> <tbody> <tr> <td> initWithTokenGeter </td> <td> 初始化服务 </td> </tr> <tr> <td> initWithBackupHosts </td> <td> 使用备用域名生成上传实例 </td> </tr> <tr> <td> putFileWithData </td> <td> 上传 data 文件 </td> </tr> <tr> <td> putFileWithPath </td> <td> 根据路径上传文件 </td> </tr> <tr> <td> uploadImage </td> <td> 上传图片并压缩 </td> </tr> <tr> <td> sliceUploadFileWithPath </td> <td> 分片上传文件 </td> </tr> <tr> <td> downloadWithBucket </td> <td> 下载文件 </td> </tr> </tbody> </table> 4. API描述 （1） initWithTokenGeter 接口描述 基础初始化方法 请求参数 <table> <caption> </caption> <thead> <tr> <th> 参数名称 </th> <th> 参数类型 </th> <th> 是否必须 </th> <th> 参数描述 </th> <th> 备注 </th> </tr> </thead> <tbody> <tr> <td> tokenGeter </td> <td> IOBSTokenGeter </td> <td> true </td> <td> 获取token回调 </td> <td> - </td> </tr> </tbody> </table> 响应参数 <table> <caption> </caption> <thead> <tr> <th> 参数名称 </th> <th> 参数类型 </th> <th> 参数描述 </th> <th> 备注 </th> </tr> </thead> <tbody> <tr> <td> instancetype </td> <td> IOBSUploadToken </td> <td> 上传管理类实例 </td> <td> - </td> </tr> </tbody> </table> （2） initWithBackupHosts 接口描述 使用备用域名生成上传实例 请求参数 <table> <caption> </caption> <thead> <tr> <th> 参数名称 </th> <th> 参数类型 </th> <th> 是否必须 </th> <th> 参数描述 </th> <th> 备注 </th> </tr> </thead> <tbody> <tr> <td> hosts </td> <td> NSArray * </td> <td> true </td> <td> 备用域名池 </td> <td> - </td> </tr> <tr> <td> tokenGeter </td> <td> IOBSTokenGeter </td> <td> true </td> <td> 获取token回调 </td> <td> - </td> </tr> </tbody> </table> 响应参数 <table> <caption> </caption> <thead> <tr> <th> 参数名称 </th> <th> 参数类型 </th> <th> 参数描述 </th> <th> 备注 </th> </tr> </thead> <tbody> <tr> <td> instancetype </td> <td> IOBSUploadToken </td> <td> 上传管理类实例 </td> <td> - </td> </tr> </tbody> </table> （3） putFileWithData 接口描述 传 data 文件 请求参数 <table> <caption> </caption> <thead> <tr> <th> 参数名称 </th> <th> 参数类型 </th> <th> 是否必须 </th> <th> 参数描述 </th> <th> 备注 </th> </tr> </thead> <tbody> <tr> <td> fileData </td> <td> NSData * </td> <td> true </td> <td> 获取token回调 </td> <td> - </td> </tr> <tr> <td> bucket </td> <td> NSString * </td> <td> true </td> <td> 上传到指定 bucket 名称 </td> <td> - </td> </tr> <tr> <td> key </td> <td> NSString * </td> <td> True </td> <td> 上传对应 bucket 里文件的 key </td> <td> - </td> </tr> <tr> <td> option </td> <td> IOBSUploadOption * </td> <td> false </td> <td> 上传时传入的可选参数实现上传文件时候的进度查看 </td> <td> - </td> </tr> <tr> <td> baseUrl </td> <td> NSString * </td> <td> false </td> <td> 基础域名 e.g @”obs-cn-shenzhen.yun.pingan.com” </td> <td> - </td> </tr> <tr> <td> Complete Handler </td> <td> IOBSUploadCompletionHandler </td> <td> false </td> <td> 上传完成后的回调函数 </td> <td> - </td> </tr> </tbody> </table> 响应参数 无 （4） putFileWithPath 接口描述 根据路径上传文件 请求参数 <table> <caption> </caption> <thead> <tr> <th> 参数名称 </th> <th> 参数类型 </th> <th> 是否必须 </th> <th> 参数描述 </th> <th> 备注 </th> </tr> </thead> <tbody> <tr> <td> path </td> <td> NSString * </td> <td> true </td> <td> 上传路径 </td> <td> - </td> </tr> <tr> <td> bucket </td> <td> NSString * </td> <td> true </td> <td> 上传到指定 bucket 名称 </td> <td> - </td> </tr> <tr> <td> key </td> <td> NSString * </td> <td> true </td> <td> 上传对应 bucket 里文件的 key </td> <td> - </td> </tr> <tr> <td> option </td> <td> IOBSUploadOption * </td> <td> false </td> <td> 上传时传入的可选参数实现上传文件时候的进度查看 </td> <td> - </td> </tr> <tr> <td> baseUrl </td> <td> NSString * </td> <td> false </td> <td> 基础域名 e.g @”obs-cn-shenzhen.yun.pingan.com” </td> <td> - </td> </tr> <tr> <td> Complete Handler </td> <td> IOBSUploadCompletionHandler </td> <td> false </td> <td> 上传完成后的回调函数 </td> <td> - </td> </tr> </tbody> </table> 响应参数 无 （5） uploadImage 接口描述 上传图片并压缩 请求参数 <table> <caption> </caption> <thead> <tr> <th> 参数名称 </th> <th> 参数类型 </th> <th> 是否必须 </th> <th> 参数描述 </th> <th> 备注 </th> </tr> </thead> <tbody> <tr> <td> image </td> <td> UIImage * </td> <td> true </td> <td> 上传图片 </td> <td> - </td> </tr> <tr> <td> scale </td> <td> CGFloat </td> <td> true </td> <td> 压缩比例(图片尺寸根据比例压缩) </td> <td> - </td> </tr> <tr> <td> bucket </td> <td> NSString * </td> <td> true </td> <td> 上传到指定 bucket 名称 </td> <td> bucket </td> </tr> <tr> <td> key </td> <td> NSString * </td> <td> true </td> <td> 上传对应 bucket 里文件的 key </td> <td> key </td> </tr> <tr> <td> option </td> <td> IOBSUploadOption * </td> <td> false </td> <td> 上传时传入的可选参数实现上传文件时候的进度查看 </td> <td> option </td> </tr> <tr> <td> baseUrl </td> <td> NSString * </td> <td> false </td> <td> 基础域名 e.g @”obs-cn-shenzhen.yun.pingan.com” </td> <td> baseUrl </td> </tr> <tr> <td> Complete Handler </td> <td> IOBSUploadCompletionHandler </td> <td> false </td> <td> 上传完成后的回调函数 </td> <td> - </td> </tr> </tbody> </table> 响应参数 无 （6） sliceUploadFileWithPath 接口描述 分片上传文件 请求参数 <table> <caption> </caption> <thead> <tr> <th> 参数名称 </th> <th> 参数类型 </th> <th> 是否必须 </th> <th> 参数描述 </th> <th> 备注 </th> </tr> </thead> <tbody> <tr> <td> filePath </td> <td> NSString * </td> <td> true </td> <td> 上传文件的路径 </td> <td> - </td> </tr> <tr> <td> bucket </td> <td> NSString * </td> <td> true </td> <td> 上传到指定 bucket 名称 </td> <td> - </td> </tr> <tr> <td> key </td> <td> NSString * </td> <td> true </td> <td> 上传对应 bucket 里文件的 key </td> <td> - </td> </tr> <tr> <td> option </td> <td> IOBSUploadOption * </td> <td> false </td> <td> 上传时传入的可选参数实现上传文件时候的进度查看 </td> <td> - </td> </tr> <tr> <td> baseUrl </td> <td> NSString * </td> <td> false </td> <td> 基础域名 e.g @”obs-cn-shenzhen.yun.pingan.com” </td> <td> - </td> </tr> <tr> <td> complete Handler </td> <td> IOBSUploadCompletionHandler </td> <td> false </td> <td> 上传完成后的回调函数 </td> <td> - </td> </tr> </tbody> </table> 响应参数 无 （7） downloadWithBucket 接口描述 下载文件 请求参数 <table> <caption> </caption> <thead> <tr> <th> 参数名称 </th> <th> 参数类型 </th> <th> 是否必须 </th> <th> 参数描述 </th> <th> 备注 </th> </tr> </thead> <tbody> <tr> <td> path </td> <td> NSString * </td> <td> true </td> <td> 保存路径 </td> <td> - </td> </tr> <tr> <td> bucket </td> <td> NSString * </td> <td> true </td> <td> 文件所在bucket </td> <td> - </td> </tr> <tr> <td> key </td> <td> NSString * </td> <td> true </td> <td> 上传对应 bucket 里文件的 key </td> <td> - </td> </tr> <tr> <td> host </td> <td> NSString * </td> <td> true </td> <td> 服务器域名 </td> <td> - </td> </tr> <tr> <td> complete Handler </td> <td> IOBSUploadCompletionHandler </td> <td> false </td> <td> 上传完成后的回调函数 </td> <td> - </td> </tr> </tbody> </table> 响应参数 无

以上内容是否解决了您的问题？是否