QCloudTrack 6.4.2

QCloudTrack 6.4.2

QCloudTerminalLab 维护。



  • 作者
  • QCloudTerminalLab

腾讯云 存储SDK for iOS

XCTest

前言

您可以在创建新项目后配置好 SDK,或者在现有项目中集成 SDK,或者先运行一下 Demo 感受 SDK 是如何工作的。点击Demo 下载地址 进行下载体验。

在使用我们的 SDK 之前,您需要配置好开发环境:

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

本仓库中仅包含 SDK 代码和 docset 格式的文档。如需更多信息,请访问腾讯云官网。具体 SDK 文档可在对应目录下的 README.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中。安装成功后可以在Xcode的“帮助-文档和API参考”中查看。您也可以使用命令行完成这一过程。

 $ 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 内部的日志不会直接输出到控制台。在调试等情况下需要查看日志时,可以设置对应的环境变量来开启它。开启的具体方法为:在 Xcode 左上角点击当前的 target-编辑方案-在环境变量中填写 QCloudLogLevel 这个环境变量,如果需要输出所有调试信息,那么将值设置为 6。

为了便于排查问题和查看 SDK 日志,在应用启动时会检测剪贴板字符串是否为“##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.