iOS SDK

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

电话咨询 - 7x24 小时

400-151-8800

邮件咨询

cloud@pingan.com

在线客服

7x24 小时,急速解答

工单支持

解决云产品相关技术问题