欢迎。

欢迎来到 Guitarparty iOS 和 OS X 客户端库。此库使开发人员能够访问 Guitarparty.com 数据库中的大量和弦和吉他谱。

我在探索苹果公司开发的新 Swift 语言的过程中编写了这个库。所以请享受它，捕捉错误，提交 pull 请求，并根据自己的需求尽可能多地使用这个库。

需求

• Xcode 6.3 （与 Swift 1.2 一起运行良好；我将在 Swift 发生变化时更新并重新编译以确保一切正常。）

• iOS 8+ （动态框架无法编译低于此版本的任何版本。）

  或者

• OS X 10.9+ （Swift 与早期的大熊版兼容）

安装

使用 CocoaPods

pod 'Guitarparty-Cocoa'

运行 pod install 然后在 Swift 中使用 import Guitarparty 或在 Objective-C 中使用 @import Guitarparty; 导入。

API 密钥

在您使用此库的任何内容之前，您需要从 http://www.guitarparty.com/developers/api-key/ 获取一个 API 密钥。

然后调用 Guitarparty 类的 setAPIKey() 方法来为所有请求设置 API 密钥

Swift

Guitarparty.setAPIKey("{API_KEY}")

Objective-C

[Guitarparty setAPIKey:@"{API_KEY}"];

如何使用

此库包含 4 个对象类别

• 歌曲
• 艺术家
• 派对
• 和弦

每个类别都包含对象本身、一个 列表 对象和一个 检索器 对象，包含查询对象类别的可能方式。

例如，以下是使用查询字符串搜索歌曲的方法

Swift

SongFetcher.searchForSongs(query: "Jolene") { (results: SongList?, error: NSError?) in
            if error != nil {
                // Handle error here
            } else {
                if results != nil { // Check to make sure there is in fact a song list
                    self.songList = results!
                }
            }
        }

Objective-C

[SongFetcher searchForSongsWithQuery:@"Jolene" completionHandler:^(SongList *results, NSError *error) {
        if (error) {
            // Handle error here
        } else {
            if (results) { // Check to make sure there is in fact a song list
                self.songList = results
            }
        }
    }];

文档

此库使用标准的内联文档方法进行了良好的文档记录。因此，快速查看 SDK 中的任何符号都会为该项提供文档。

许可证

版权所有 2014 Matthew Wyskiel

许可协议：Apache License 2.0（“许可”）；除非遵守本许可协议，否则不允许使用此文件。您可以在以下位置获取许可协议副本：

https://apache.ac.cn/licenses/LICENSE-2.0

除非适用法律要求或书面同意，否则在许可证下分发的软件按“现状”分发，不提供任何类型的保证或条件，无论是明示的还是默示的。有关许可证中规定的具体权限和限制，请参阅许可证。