Skip to content

Latest commit

 

History

History
126 lines (104 loc) · 5.88 KB

README.md

File metadata and controls

126 lines (104 loc) · 5.88 KB
Raw

腾讯云 存储SDK for iOS

XCTest

前言

您可以在新建项目，配置好SDK或者在已有的项目中集成进SDK，或者先运行下Demo感受下SDK是如何运作的。下载Demo体验请前点击Demo下载地址。

使用我们的SDK前，您需要配置好开发环境：

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

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

产品列表

当前仓库内提供的产品有:

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

xcframework 支持

提供xcframework打包脚本，可以自行打包。 克隆本仓库到本地。 执行以下命令：

chmod +x xcframework_build.sh
source xcframework_build.sh

framework 说明：

  • QCloudCore.xcframework 和 QCloudCOSXML.xcframework 为COS SDK核心组件，必须添加到项目中。
  • QCloudTrack.xcframework、COSBeaconAPI_Base.xcframework.zip、QimeiSDK.xcframework.zip 为日志上报组件，与 COS 上传下载功能无关，可选使用。

执行结束后，可在仓库根目录看到 xcframework文件夹。

集成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的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的APP需要一些额外的步骤来适配iOS9和以上的系统。

在集成SDK的APP的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-在Enviriments 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 and samples are released under the MIT license.

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.