QCloudCOSXML 6.4.2

QCloudCOSXML 6.4.2

测试已测试
Lang语言 Obj-CObjective C
许可证 未知
Released上次发布Jul 2024

QCloudTerminalLab 维护。



  • QCloud Terminal 团队

腾讯云 存储SDK for iOS

XCTest

前言

您可以在新项目,配置好 SDK 或者将在已有项目中集成 SDK,或者先运行 Demo 感受 SDK 是如何工作的。点击此处下载 Demo 体验

在本 SDK 使用前,您需要配置好开发环境:

  • Xcode 7 或更新的版本
  • 运行环境为 iOS 8 以上

本仓库中只包含 SDK 的代码和 docset 格式的文档。如果需要更多信息,可以浏览腾讯云官网。具体的 SDK 文档在对应目录下的 REAME.md 中。

产品列表

当前仓库内提供的产品有

  • 基于 COS JSON API 封装的 SDK
  • 基于 COS XML API 封装的 SDK

集成SDK

您可以通过Cocoapods集成、下载源代码或使用我们打包好的动态库来进行SDK集成。在此我们推荐您采用Cocoapods方式进行集成。只需在您的Podfile中加入需要集成的库即可。
如果需要使用基于XML封装的SDK

pod 'QCloudCOSXML'

如果需要使用基于V4封装的重构后的SDK

pod 'QCloudNewCOSV4'

其他具体集成方式,请在SDK所在文件夹查看README了解更多。

接口说明

SDK包含的COS接口说明,请查看官网的iOS接口文档

文档集成

我们提供了docset格式的文档,位于仓库的Documents目录中,或可从release中下载。您可使用Dash直接打开,或将文档集成到Xcode中。

集成文档到Xcode

只需将docset格式的文档移动到~/Library/Developer/Shared/Documentation/DocSets文件夹,重启Xcode即可安装文档。安装成功后可于Xcode的Help-Documentation and API Reference中查看。您也可以使用命令行完成这一过程。

 $ cd docset所在路径
 $ mkdir -p ~/Library/Developer/Shared/Documentation/DocSets
 $ mv com.tencent.qcloudcosxml.ios.docset ~/Library/Developer/Shared/Documentation/DocSets

iOS9适配

我们的SDK运行在HTTP上。由于iOS9后苹果引入了App Transport Security (ATS)特性,集成SDK的应用需要一些额外的步骤来适配iOS9及更高版本。

在集成SDK的应用的info.plist中需要添加如下代码:

<key>NSAppTransportSecurity</key>
	<dict>
		<key>NSExceptionDomains</key>
		<dict>
			<key>myqcloud.com</key>
			<dict>
				<key>NSIncludesSubdomains</key>
				<true/>
				<key>NSTemporaryExceptionAllowsInsecureHTTPLoads</key>
				<true/>
			</dict>
		</dict>
	</dict>

日志

默认情况下,SDK内部的日志并不会直接输出到控制台中。在Debug等情况下需要查看日志的话,可以设置对应的环境变量开启。开启的具体方式为:在Xcode左上角选择点击当前的target-Edit Scheme-在Environments Variables中填入QCloudLogLevel这个环境变量,如果需要输出所有debug信息,那么将值设置为6。

为了方便问题排查及查看SDK日志,在app启动时会检测剪贴板字符串是否为“##qcloud-cos-log-ispct##”,如果是(不会对字符串本身进行任何操作),则会弹出日志alert,进行日志查看及上传;也可以手动关闭此功能。

[QCloudLogManager sharedInstance].shouldShowLog = NO;

代码块 Code Snippet

为了提升用户体验和降低出错概率,我们为一些常见接口提供了XCode中可使用的代码块。将它们集成进XCode后,可一键调用代码块填充代码,减少重复工作。

集成方法:将CodeSnippets文件夹下所需代码块文件(以.codesnippet结尾)复制到以下文件夹中(可在Finder中按Command+Shift+G,输入路径进行跳转)

~/Library/Developer/Xcode/UserData/CodeSnippets

集成后,重启XCode,并输入快捷方式(如cos),即可弹出对应填充选项,直接填充所需的基本代码,按回车键完成操作。

许可证 License

Tencent Cloud SDK for iOS 和示例代码以MIT许可证发布。

Copyright (c) 2017 腾讯云

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.