StudyplusSDK 4.0.0

StudyplusSDK 4.0.0

测试已测试
Lang语言 Obj-CObjective C
许可证 MIT
Released最新版本2021年4月

developer-all 维护。



  • Studyplus inc

Studyplus iOS SDK for Objective-C。 新的 Studyplus iOS SDK for Swift。

要求

依赖

安装

手动安装

通过库和头文件

  1. 获取 StudyplusSDK。
    • git clone https://github.com/studyplus/Studyplus-iOS-SDK 或从 此页面 下载 zip 文件。
  2. build/Release/deliverables/StudyplusSDK 拷贝到您的项目中。
  3. 安装 AFNetworkingUICKeyChainStore
  4. 添加所需的框架(例如:Security.framework, SystemConfiguration.framework, MobileCoreServices, CoreGraphics 等)。请参阅 AFNetworkingUICKeyChainStore

通过源代码复制(iOS 8 需要)

  1. 获取 StudyplusSDK
    • git clone https://github.com/studyplus/Studyplus-iOS-SDK 或从 此页面 下载 zip 文件。
  2. 将 Studyplus-iOS-SDK/StudyplusSDK 目录复制到您的项目中。
  3. 安装 AFNetworkingUICKeyChainStore

用法

设置自定义 URL 方案

将 "studyplus-{your consumer key}" 设置为 URL 类型。 (例如:studyplus-MIoh79q7pfMbTUVA3BNsSeTaZRcOK3yg )

xcode

初始化

#import "SPLStudyplusDelegate.h"

@interface YourClass<SPLStudyplusDelegate>
-(BOOL)openURL:(NSURL*)url;
@end
#import "SPLStudyplus.h"

static NSString * const ConsumerKey = @"Your Studyplus consumer key";
static NSString * const ConsumerSecret = @"Your Studyplus consumer secret";

static SPLStudyplus *studyplus;

@implementation YourClass

-(id) init {

    if (self = [super init]) {
        studyplus = [SPLStudyplus studyplusWithConsumerKey:ConsumerKey
                                         andConsumerSecret:ConsumerSecret];
        studyplus.delegate = self;
    }
    return self;
}

认证或登录

@implementation AppDelegate

- (BOOL)application:(UIApplication *)application openURL:(NSURL *)url sourceApplication:(NSString *)sourceApplication annotation:(id)annotation
{
    return [yourClassObject openURL:url];
}
@interface YourClass
-(BOOL)openURL:(NSURL*)url;
@end
@implementation YourClass

-(void) doAuth {
    [studyplus auth];
}

-(void) doLogin
{
    [studyplus login];
}

// Called by AppDelegate
-(BOOL) openURL:(NSURL*)url
{
    return [studyplus openURL:url];
}

// callback methods
-(void)studyplusDidConnect:(SPLStudyplus*)studyplus
{
    NSLog(@"Auth or Login succeeded");
}

-(void)studyplusDidFailToConnect:(SPLStudyplus*)studyplus withError:(NSError*)error
{
    NSLog(@"Auth or Login failed");
}

- (void)studyplusDidCancel:(SPLStudyplus*)studyplus
{
    NSLog(@"Auth or Login canceled");
} 

将学习记录提交到 Studyplus

-(void)post
{

    // Create new study record.
    SPLStudyplusRecord *studyplusRecord =
      [SPLStudyplusRecord

       /**
        @see SPLStopwatch
        */
       recordWithDuration:[studyplus.stopwatch elapsedSeconds]

       /** You can add optional info.
       options:@{
           // Time the learning is ended. 学習を終えた日時。
           @"recordedAt" : [NSDate date],
           // Studyplus timeline comment. Studyplusのタイムライン上で表示されるコメント。
           @"comment" : @"アプリ◯◯で勉強しました!!",
           // @see SPLStudyplusRecordAmount
           @"amount" : [SPLStudyplusRecordAmount amount:100],
       }
       */

      ];

    // post
    [studyplus postStudyRecord:studyplusRecord];

}

// callback methods
-(void)studyplusDidPostStudyRecord:(SPLStudyplus*)studyplus
{
    NSLog(@"Post to Studyplus succeeded");
}

-(void)studyplusDidFailToPostStudyRecord:(SPLStudyplus*)studyplus withError:(NSError*)error
{
    // see @SPLStudyplusError with error.code.
    NSLog(@"Post to Studyplus failed");
}

关于 SDK 接口的更多信息

  • StudyplusSDK/SPLStudyplus.h
  • StudyplusSDK/SPLStudyplusDelegate.h
  • StudyplusSDK/SPLStudyplusRecord.h
  • StudyplusSDK/SPLStudyplusRecordAmount.h

示例应用程序

demo

  1. 运行 pod try StudyplusSDK 或查看示例目录并打开 StudyplusSDKDemo/StudyplusSDKDemo.xcodeproj
  2. 在 ViewController.m 中编辑消费者密钥和消费者密钥
  3. 使用您的消费者密钥设置 URL 类型
  4. 运行
  5. 执行 "Auth" 和 "Post record",在http://studyplus.jp查看公共时间表

许可协议

MIT 许可协议。