StudyplusSDK-V2
StudyplusSDK-V2 是 Studyplus iOS SDK 的 Swift 版本。
要求
- iOS 9.0 或更高版本
- Swift 4.0 或更高版本
依赖
安装
CocoaPods
将以下行添加到您的 Podfile 中:
use_frameworks!
target 'YOUR_TARGET_NAME' do
pod 'StudyplusSDK-V2'
end
Carthage
将以下行添加到您的Cartfile中
github "studyplus/Studyplus-iOS-SDK-V2"
使用方法
- 如果您没有consumerKey和consumerSecret,请通过https://info.studyplus.co.jp/contact/studyplus-api联系
① 设置自定义URL scheme
- 将studyplus-{您的consumer key}设置为URL类型。(例如:studyplus-MIoh79q7pfMbTUVA3BNsSeTaZRcOK3yg )
② 设置consumerKey和consumerSecret
- 在您的Info.plist中设置consumerKey和consumerSecret。
<key>StudyplusSDK</key>
<dict>
<key>consumerKey</key>
<string>set_your_consumerKey</string>
<key>consumerSecret</key>
<string>set_your_consumerSecret</string>
</dict>
③ 设置LSApplicationQueriesSchemes
- 在info.plist中设置LSApplicationQueriesSchemes以检查是否安装了studyplus。
<key>LSApplicationQueriesSchemes</key>
<array>
<string>studyplus</string>
</array>
初始化
// when carthage is StudyplusSDK, cocoapods is StudyplusSDK_V2
import StudyplusSDK_V2
class ViewController: UIViewController, StudyplusLoginDelegate {
override func viewDidLoad() {
super.viewDidLoad()
Studyplus.shared.delegate = self
}
// ...
}
登录
// when carthage is StudyplusSDK, cocoapods is StudyplusSDK_V2
import StudyplusSDK_V2
class AppDelegate: UIResponder, UIApplicationDelegate {
func application(_ app: UIApplication, open url: URL, options: [UIApplicationOpenURLOptionsKey : Any] = [:]) -> Bool {
return Studyplus.shared.handle(appDelegateUrl: url)
}
}
// when carthage is StudyplusSDK, cocoapods is StudyplusSDK_V2
import StudyplusSDK_V2
class ViewController: UIViewController, StudyplusLoginDelegate {
// ...
// MARK: - Login
@IBAction func loginButton(_ sender: UIButton) {
Studyplus.shared.login()
}
// MARK: - StudyplusLoginDelegate
func studyplusDidSuccessToLogin() {
// do something
}
func studyplusDidFailToLogin(error: StudyplusError) {
// do something
}
func studyplusDidCancelToLogin() {
// do something
}
}
将学习记录发布到Studyplus
// when carthage is StudyplusSDK, cocoapods is StudyplusSDK_V2
import StudyplusSDK_V2
class ViewController: UIViewController, StudyplusLoginDelegate {
// ...
// MARK: - Post studyRecord to Studyplus
@IBAction func postStudyRecordButton(_ sender: UIButton) {
let recordAmount: StudyplusRecordAmount = StudyplusRecordAmount(amount: 10)
let record: StudyplusRecord = StudyplusRecord(duration: duration, recordedAt: Date(), amount: recordAmount, comment: "Today, I studied like anything.")
Studyplus.shared.post(studyRecord: record, success: {
// do something
}, failure: { error in
print("Error Code: \(error.code()), Message: \(error.message())")
})
}
}
演示应用
- 在演示应用的URL类型中设置 studyplus-{你的消费者密钥}。
- 在演示应用的Info.plist中设置 consumerKey 和 consumerSecret。
- 选择演示方案并运行。