iOS SDK 开发指南
本文介绍如何在游戏中加入云存档功能。
集成前准备
- 参考 开发者中心配置 创建应用、开启云存档服务
- 参考 iOS 集成指南 完成基础接入
- 云存档模块依赖于 TapTap 登录模块,开发者接入前应先完成 TapTap 登录的接入
SDK 获取
远程依赖
- 在工程 Podfile 文件中对应模块下添加依赖:
pod 'TapTapSDK/CloudSave', '~> 4.11.1'
- 执行
Pod install下载对应依赖文件
本地文件依赖
云存档依赖于初始化和 TapTap 登录模块,使用本地文件方式添加依赖时,需先参考集成指南 和 TapTap 登录添加对应本地文件依赖项。
- 在下载页下载如下文件:
TapTapCloudSaveSDK.xcframework云存档依赖库cloudsave_sdk.xcframework云存档底层依赖库
- 在工程中添加
framework静态库,注意添加时选择 Embed 方式为 Do Not Embed
注册/注销统一状态码监听回调
统一状态回调,不同 code 代表不同的状态。
- Swift
- Objective-C
import TapTapCloudSaveSDK
class CloudSaveCallbackImpl: NSObject, TapTapCloudSaveCallback {
override init() {}
func onResult(_ resultCode: Int) {
// 处理云存档的状态码
// 300001:需要登录
// 300002:初始化失败 需重新初始化
}
}
let callback = CloudSaveCallbackImpl()
TapTapCloudSave.registerCloudSaveCallback(callback)
// 不需要接收回调时调用接口移除之前设置的回调对象
TapTapCloudSave.unregisterCloudSaveCallback(callback)
#import "TapTapCloudSaveSDK/TapTapCloudSaveSDK-Swift.h"
@interface GameMainController () <TapTapCloudSaveCallback>
@end
@implementation GameMainController
- (void)handleCloudSaveCallback {
//注册回调
[TapTapCloudSave registerCloudSaveCallback:self];
// 不需要接收回调时调用接口移除之前设置的回调对象
[TapTapCloudSave unregisterCloudSaveCallback:self];
}
- (void)onResult:(NSInteger)resultCode {
// 处理云存档的状态码
// 300001:需要登录
// 300002:初始化失败 需重新初始化
}
@end
参数说明:
| 方法 | 参数 | 类型 | 说明 |
|---|---|---|---|
registerCloudSaveCallback | callback | TapTapCloudSaveCallback | 接收需要登录、初始化失败等模块状态。 |
unregisterCloudSaveCallback | callback | TapTapCloudSaveCallback | 注销状态回调,需传入注册时的同一个对象。 |
状态码取值见结果码说明。状态回调不返回单次创建、下载等请求的结果;各请求结果由 TapTapCloudSaveRequestCallback 返回。
创建存档
创建游戏存档并上传云端。
info
存档名称仅支持【英文/数字/下划线/中划线】,不支持中文
存档摘要 (summary) 以及额外信息 (extra) 无此限制,但 summary 不能为空字符串
一分钟内最多可调用 60 次(与更新存档共享冷却时间)
- Swift
- Objective-C
import TapTapCloudSaveSDK
// 存档元信息
let metadata = ArchiveMetadata(
name: "archive_name", // 存档名称
summary: "archive_desc", // 存档描述
extra: "extra_info", // 额外信息
playtime: 0 // 游戏时长(秒)
)
// 存档文件路径(单个存档文件大小不超过10MB)
let archiveFilePath = "path/to/archive/file"
// 存档封面路径(可选,封面大小不超过512KB)
let archiveCoverPath = "path/to/cover/image"
// 请求回调
class CloudSaveRequestCallback: NSObject, TapTapCloudSaveRequestCallback {
func onRequestError(errorCode: Int, errorMessage: String) {
// 处理请求错误
}
func onArchiveCreated(archive: ArchiveData) {
// 创建成功,archive.uuid 为云存档唯一标识
// archive.fileId 为存档文件标识
}
}
let callback = CloudSaveRequestCallback()
TapTapCloudSave.createArchive(
archiveMetadata: metadata,
archiveFilePath: archiveFilePath,
archiveCoverPath: archiveCoverPath,
callback: callback
)
#import "TapTapCloudSaveSDK/TapTapCloudSaveSDK-Swift.h"
// 存档元信息
ArchiveMetadata *metadata = [[ArchiveMetadata alloc] initWithName:@"archive_name" // 存档名称
summary:@"archive_desc" // 存档描述
extra:@"extra_info" // 额外信息
playtime:0]; // 游戏时长(秒)
// 存档文件路径(单个存档文件大小不超过10MB)
NSString *archiveFilePath = @"path/to/archive/file";
// 存档封面路径(可选,封面大小不超过512KB)
NSString *archiveCoverPath = @"path/to/cover/image";
// 请求回调
id<TapTapCloudSaveRequestCallback> callback = // 实现回调协议
[TapTapCloudSave createArchiveWithArchiveMetadata:metadata
archiveFilePath:archiveFilePath
archiveCoverPath:archiveCoverPath
callback:callback];
参数说明:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
archiveMetadata | ArchiveMetadata | 是 | 存档元信息,字段说明见下表。 |
archiveFilePath | String | 是 | 本地存档文件路径。SDK 会读取该路径对应的文件并上传,文件大小不能超过 10 MB。 |
archiveCoverPath | String | 否 | 本地封面文件路径。传入空值或空字符串表示不上传封面,封面大小不能超过 512 KB。 |
callback | TapTapCloudSaveRequestCallback | 是 | 接收创建存档的成功或失败结果。 |
ArchiveMetadata 字段:
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
name | String | 是 | 存档名称,不能为空,最多 60 字节;仅支持英文字母、数字、下划线和中划线。 |
summary | String | 是 | 存档描述,不能为空,最多 500 字节。 |
extra | String | 否 | 开发者自定义信息,最多 1000 字节,允许为空。可用于记录存档版本等业务信息。 |
playtime | Integer | 是 | 当前存档对应的游戏时长,单位为秒,必须是非负数。 |
创建成功后返回 ArchiveData:
| 字段 | 类型 | 说明 |
|---|---|---|
uuid | String | 云存档的唯一标识,用于更新或删除存档。 |
fileId | String | 存档文件标识,与 uuid 一起用于下载存档数据或封面。 |
name | String | 存档名称。创建结果不保证返回该字段。 |
summary | String | 存档描述。创建结果不保证返回该字段。 |
extra | String | 开发者写入的自定义信息。创建结果不保证返回该字段。 |
playtime | Integer | 游戏时长,单位为秒。创建结果不保证返回该字段。 |
saveSize | Integer | 存档文件大小,单位为字节。创建结果不保证返回该字段。 |
coverSize | Integer | 存档封面大小,单位为字节。创建结果不保证返回该字段。 |
createdTime | Integer | 存档创建时间,秒级时间戳。创建结果不保证返回该字段。 |
modifiedTime | Integer | 存档最后修改时间,秒级时间戳。创建结果不保证返回该字段。 |
如需读取完整的存档元信息,请调用获取存档列表接口。
获取存档列表
获取当前用户的存档列表。
- Swift
- Objective-C
import TapTapCloudSaveSDK
class CloudSaveRequestCallback: NSObject, TapTapCloudSaveRequestCallback {
func onArchiveListResult(archives: [ArchiveData]) {
// 处理存档列表
}
func onRequestError(errorCode: Int, errorMessage: String) {
// 处理请求错误
}
}
let callback = CloudSaveRequestCallback()
TapTapCloudSave.getArchiveList(callback: callback)
#import "TapTapCloudSaveSDK/TapTapCloudSaveSDK-Swift.h"
id<TapTapCloudSaveRequestCallback> callback = // 实现回调协议
[TapTapCloudSave getArchiveListWithCallback:callback];
参数说明:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
callback | TapTapCloudSaveRequestCallback | 是 | 接收存档列表或请求失败结果;没有存档时返回空列表。 |
列表中的每一项均为 ArchiveData,字段说明见创建存档中的返回字段表。
下载存档
下载指定的存档文件。
- Swift
- Objective-C
import TapTapCloudSaveSDK
// 存档UUID
let archiveUuid = "archive_uuid"
// 存档文件ID
let archiveFileId = "archive_file_id"
class CloudSaveRequestCallback: NSObject, TapTapCloudSaveRequestCallback {
func onArchiveDataResult(archiveUUID: String, archiveFileID: String, data: Data) {
// 处理下载的存档数据
}
func onRequestError(errorCode: Int, errorMessage: String) {
// 处理请求错误
}
}
let callback = CloudSaveRequestCallback()
TapTapCloudSave.getArchiveData(
archiveUUID: archiveUuid,
archiveFileID: archiveFileId,
callback: callback
)
#import "TapTapCloudSaveSDK/TapTapCloudSaveSDK-Swift.h"
// 存档UUID
NSString *archiveUuid = @"archive_uuid";
// 存档文件ID
NSString *archiveFileId = @"archive_file_id";
id<TapTapCloudSaveRequestCallback> callback = // 实现回调协议
[TapTapCloudSave getArchiveDataWithArchiveUUID:archiveUuid
archiveFileID:archiveFileId
callback:callback];
参数说明:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
archiveUUID | String | 是 | 云存档的唯一标识,即 ArchiveData.uuid。 |
archiveFileID | String | 是 | 存档文件标识,即 ArchiveData.fileId。 |
callback | TapTapCloudSaveRequestCallback | 是 | 接收存档文件的原始二进制数据或请求失败结果;游戏需要自行解析数据或写入本地文件。 |
更新存档
更新指定的存档文件。
info
存档名称仅支持【英文/数字/下划线/中划线】,不支持中文
存档摘要 (summary) 以及额外信息 (extra) 无此限制,但 summary 不能为空字符串
一分钟内最多可调用 60 次(与创建存档共享冷却时间)
- Swift
- Objective-C
import TapTapCloudSaveSDK
// 存档UUID
let archiveUuid = "archive_uuid"
// 存档元信息
let metadata = ArchiveMetadata(
name: "new_archive_name", // 更新后的存档名称
summary: "new_archive_desc", // 更新后的存档描述
extra: "extra", // 额外信息
playtime: 0 // 游戏时长(秒)
)
// 新的存档文件路径(单个存档文件大小不超过10MB)
let archiveFilePath = "path/to/new/archive/file"
// 新的存档封面路径(可选,封面大小不超过512KB)
let archiveCoverPath = "path/to/new/cover/image"
class CloudSaveRequestCallback: NSObject, TapTapCloudSaveRequestCallback {
func onArchiveUpdated(archive: ArchiveData) {
// 处理存档更新成功
}
func onRequestError(errorCode: Int, errorMessage: String) {
// 处理请求错误
}
}
let callback = CloudSaveRequestCallback()
TapTapCloudSave.updateArchive(
archiveUUID: archiveUuid,
archiveMetadata: metadata,
archiveFilePath: archiveFilePath,
archiveCoverPath: archiveCoverPath,
callback: callback
)
#import "TapTapCloudSaveSDK/TapTapCloudSaveSDK-Swift.h"
// 存档UUID
NSString *archiveUuid = @"archive_uuid";
// 存档元信息
ArchiveMetadata *metadata = [[ArchiveMetadata alloc] initWithName:@"new_archive_name" // 更新后的存档名称
summary:@"new_archive_desc" // 更新后的存档描述
extra:@"extra" // 额外信息
playtime:0]; // 游戏时长(秒)
// 新的存档文件路径(单个存档文件大小不超过10MB)
NSString *archiveFilePath = @"path/to/new/archive/file";
// 新的存档封面路径(可选,封面大小不超过512KB)
NSString *archiveCoverPath = @"path/to/new/cover/image";
id<TapTapCloudSaveRequestCallback> callback = // 实现回调协议
[TapTapCloudSave updateArchiveWithArchiveUUID:archiveUuid
archiveMetadata:metadata
archiveFilePath:archiveFilePath
archiveCoverPath:archiveCoverPath
callback:callback];
参数说明:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
archiveUUID | String | 是 | 要更新的云存档唯一标识,即 ArchiveData.uuid。 |
archiveMetadata | ArchiveMetadata | 是 | 更新后的存档元信息,字段说明见创建存档中的 ArchiveMetadata 字段表。 |
archiveFilePath | String | 是 | 更新后的本地存档文件路径。SDK 会读取该路径对应的文件并上传,文件大小不能超过 10 MB。 |
archiveCoverPath | String | 否 | 更新后的本地封面文件路径。传入空值或空字符串表示不上传封面,封面大小不能超过 512 KB。 |
callback | TapTapCloudSaveRequestCallback | 是 | 接收更新存档的成功或失败结果。 |
删除存档
删除指定的存档文件。
- Swift
- Objective-C
import TapTapCloudSaveSDK
// 存档UUID
let archiveUuid = "archive_uuid"
class CloudSaveRequestCallback: NSObject, TapTapCloudSaveRequestCallback {
func onArchiveDeleted(archive: ArchiveData) {
// 处理存档删除成功
}
func onRequestError(errorCode: Int, errorMessage: String) {
// 处理请求错误
}
}
let callback = CloudSaveRequestCallback()
TapTapCloudSave.deleteArchive(archiveUUID: archiveUuid, callback: callback)
#import "TapTapCloudSaveSDK/TapTapCloudSaveSDK-Swift.h"
// 存档UUID
NSString *archiveUuid = @"archive_uuid";
id<TapTapCloudSaveRequestCallback> callback = // 实现回调协议
[TapTapCloudSave deleteArchiveWithArchiveUUID:archiveUuid callback:callback];
参数说明:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
archiveUUID | String | 是 | 要删除的云存档唯一标识,即 ArchiveData.uuid。 |
callback | TapTapCloudSaveRequestCallback | 是 | 接收删除存档的成功或失败结果。 |
获取存档封面
获取指定存档的封面图片。
- Swift
- Objective-C
import TapTapCloudSaveSDK
// 存档UUID
let archiveUuid = "archive_uuid"
// 存档文件ID
let archiveFileId = "archive_file_id"
class CloudSaveRequestCallback: NSObject, TapTapCloudSaveRequestCallback {
func onArchiveCoverResult(archiveUUID: String, archiveFileID: String, coverData: Data) {
// 处理封面数据
}
func onRequestError(errorCode: Int, errorMessage: String) {
// 处理请求错误
}
}
let callback = CloudSaveRequestCallback()
TapTapCloudSave.getArchiveCover(
archiveUUID: archiveUuid,
archiveFileID: archiveFileId,
callback: callback
)
#import "TapTapCloudSaveSDK/TapTapCloudSaveSDK-Swift.h"
// 存档UUID
NSString *archiveUuid = @"archive_uuid";
// 存档文件ID
NSString *archiveFileId = @"archive_file_id";
id<TapTapCloudSaveRequestCallback> callback = // 实现回调协议
[TapTapCloudSave getArchiveCoverWithArchiveUUID:archiveUuid
archiveFileID:archiveFileId
callback:callback];
参数说明:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
archiveUUID | String | 是 | 云存档的唯一标识,即 ArchiveData.uuid。 |
archiveFileID | String | 是 | 存档文件标识,即 ArchiveData.fileId。 |
callback | TapTapCloudSaveRequestCallback | 是 | 接收封面文件的原始二进制数据或请求失败结果。 |
结果码说明
| 结果码 | 说明 |
|---|---|
| 300001 | 需要登录 |
| 300002 | 初始化失败,需要重新初始化 |
请求错误码
以下错误码会在请求失败时返回。
| 错误码 | 说明 |
|---|---|
| 400000 | 非法的存档文件/封面大小 |
| 400001 | 存档上传频率超限 |
| 400002 | 指定的存档不存在 |
| 400003 | 单个应用下存档数量超限 |
| 400004 | 单个应用下使用存储空间超限 |
| 400005 | 总使用存储空间超限 |
| 400006 | 创建/更新云存档超时,通常是由于网络卡顿,耗时过长导致 |
| 400007 | 上传云存档并发调用次数超过 10 个,或者并发更新同一个云存档 |
| 400008 | 找不到可用的 OSS 供应商 |
| 400009 | 存档名称不合法 |
| 400010 | 禁止同一台机器同一个ClientID多个进程使用同一账号 |
国际化
TapTapCloudSave 支持设置语言:目前只支持简体中文