ファイルベースApp向けのClassKitについて

ファイルベースApp向けのClassKitについて

ClassKitフレームワークは、App内の教育活動をスクールワークAppを使用する教師から見えるようにするのに役立ちます。最新のファイルベースAPIを採用して、App内で生徒の学習進捗データを報告することで、教師に生徒の学習状況をより深く理解してもらう方法を紹介します。また、ClassKitを使ってさまざまな種類のデータを報告する方法や、デベロッパモードで実装をテストする方法も紹介します。

リソース
ダウンロード

♪ (ファイルベースApp向けのClassKitについて) こんにちは Marinです ClassKitチームのエンジニアです本日はファイルベースのApp向けに ClassKitに新たに追加した新しいAPIを紹介しますまずClassKitとの併用方法を含めスクールワークを紹介しその後ファイルベースApp向けの新しいAPIについて詳細を紹介します続いてサンプル実装をご覧いただき最後に ClassKitのデベロッパモードを使用して新しいAPIをテストする方法を紹介します最初にスクールワークの概要を簡単に紹介しますスクールワークは教育向けAppですこのAppを使用することで教師は課題や宿題を共有し生徒は学習を進められます ClassKitフレームワークを Appで採用し割り当てられるコンテンツすなわち CLSContextsを通知しアクティビティにおける進捗データの報告を開始すると教師はそのコンテンツを割り当て Appによって報告された進捗データを確認できます Appが ClassKit対応の場合教師がカリキュラムで Appを使用する確率が高くなりますまた近い将来スクールワークはさらに使いやすくなる予定です新たに追加予定の機能には教師のワークフローを円滑化し指示を提供し Appから教師にデータを提供する機能などが含まれますスクールワークについてご理解いただいたところで Appからのデータがスクールワークに送信される方法を見ていきましょう AppがClassKitフレームワークにデータを送信します ClassKitはそのデータをスクールワークAppで表面化しデータを生徒と教師の両方に提示しますこちらはスクールワークの画面です ClassKit対応Appの課題がいくつか表示されていますいずれかの課題をタップすると ClassKitを採用している Appの例と報告された生徒の進捗データが表示されますこのユースケースの詳細はあとで見ていきましょうスクールワークの概要を簡単に確認したところで次に新しいファイルベースの Progress APIを紹介します App Storeでは現在 19万本以上の教育Appが提供されています多くのデベロッパが ClassKitのコンテキストベースAPIを導入していますがそうでない場合もありますファイルと連携するAppについてまたはClassKitの導入を検討していたもののコンテキストがユースケースに適していなかったといったフィードバックをいただきましたそこでAppがファイルベースであるため ClassKitを導入できなかった方のために新しいAPIを追加しましたこの新しいAPIはファイルと連携するあらゆるAppに対応しますファイルの編集やファイルを開いて閲覧できるだけの Appをお使いならファイルベースApp向けのこの新しいAPIが気に入るはずですこの新しいAPIではファイルをスクールワークで割り当てれば App内で使うこれらのファイルで生徒の進捗データを報告できます ClassKit対応のAppから教師がコンテンツを割り当てると教師にとって有益な追加の情報に加え Appに最適なユースケースも提供されますひとつ重要なこととして Open in Placeを Appに採用する必要があります Open in Place対応の Appを使えば生徒と教師間で共有されているファイルのコピーではなく原本を Appで開くことができますこちらは進捗データをファイルに追加するための新しいAPIです fetchActivityと呼ばれるこのAPIは CLSDataStore内に存在しますここにはこのAPIのasyncと asyncの代替バージョンの両方が表示されています対象ファイルのURLをこのAPIに渡すと CLSActivityが返されます CLSActivityを取得したら進捗データを追加できますでは Appで送信できる進捗データのタイプについて見ていきましょうすでにClassKitを採用されている場合はすでに利用されている既存の進捗データのタイプの見直しとなります ClassKitを初めて利用する場合現在CLSContextsでこれらのクラスは使われていますが同じデータタイプをファイルにも適用できますこちらはCLSActivityですこれは特定のファイルに関連付けられているすべての進捗データが含まれたクラスです CLSActivityにはいくつかのデータタイプを追加できます 1つ目はdurationですこれは割り当てられたファイルの作業に生徒が費やす時間の長さとなりますすべてのファイルタイプで時間の報告が必要となりますこのAPIを使用するには CLSActivityにある startとstopメソッドを呼び出します 2つ目はprogressですこれは0～1の間の数値となります progressは通常ファイル全体を通しての生徒の進捗状況を判断するために使用されます例えば音声と動画ファイルがあり生徒がファイルの50%を再生したとしますこの場合再生の進捗を 0.5として報告できます進捗状況を追加するには progressプロパティを直接設定するか開始から終了までの範囲を追加します重複する範囲や同じ範囲を複数回追加することもできます生徒と教師の両方に正確な進捗状況が報告されるよう Appleがロジックを処理します primaryActivityItemもありますこれは編集できるファイルがある場合に役立ちます primaryActivityItemを設定するとこのデータが生徒と教師に注目してもらいたいデータであることを示すことができデータがスクールワークAppの UIの目立つ部分に表示されますさらに additionalActivityItemsプロパティもありますこれは一連のCLSActivityItemsで追加のメタデータを追加するために役立ちます primaryActivityItemを追加するには primaryActivityItemプロパティを CLSActivityで設定します additionalActivityItemを追加するには addAdditionalActivityItem関数を CLSActivityで呼び出し追加するactivityItemに渡します primaryActivityItemと additionalActivityItemのプロパティはCLSActivityItemの 3つのサブクラスのいずれかへの参照を保持しますこれから紹介するいずれかのサブクラスを追加できます 1つ目はCLSBinaryItemですこれはバイナリデータタイプを示すために使用されます用途例としてはクイズの問題が挙げられます例えば生徒の回答が正解だったか不正解だったかなどです CLSQuantityItemを追加することもできますこれは汎用の数値に使用されます例えばページ数やスライド数文書の合計文字数などに使用できます最後に紹介するサブクラスは CLSScoreItemですこのクラスは対象が何であれ合計の一部を示すために使用されます例えばクイズの点数つまり10点満点中8点を示す場合に使用されますこれらのサブクラスを自由に組み合わせアクティビティに追加できます 1つだけでも全部でも構いません追加できるデータタイプについて理解できたところでこのAPIをAppに採用するコードのサンプルを見ていきましょうこちらはテキストファイルを開いて編集できるサンプルAppです生徒がテキストファイルを開くとタイマーが起動します生徒がファイルを編集しファイルを閉じようとすると合計文字数が記録されタイマーが停止します私のコードの一部を使って説明しますこのコードは私がファイルを開き生徒がファイルで操作を始めるとき呼び出されますこのようにopenFile関数がありますこれは時間のトラッキングを開始する場所ですあなたのAppでファイルを開くための既存のコードにタイマーを開始するための短いコードを追加しますまず私のファイルのURLから CLSアクティビティを取得しますアクティビティを取得したら開始を呼び出し時間のトラッキングを開始して CLSDataStoreで保存を呼び出し追加した変更をコミットしますここにブレークポイントを追加しましょう実装をテストする際またここに戻ってきます次に生徒が作業を終了した場合にタイマーを停止し primaryActivityItemを追加する方法を紹介します生徒がファイルを閉じようとするとき呼び出されるコードの一部がこちらになりますここで CLSDataStore.shared. fetchActivityを呼び出し primaryActivityItemを取得しすでに存在する場合は更新し存在しない場合は新規 CLSQuantityItemを作成します CLSQuantityItemを取得したら値を更新し自分のアクティビティで primaryActivityItemとして設定できます自分のアクティビティに進捗状況を追加できます最後に停止を呼び出しタイマーを停止しますその後忘れずに保存を呼び出します CLSDataStoreで保存を呼び出さないと追加した変更はいずれも適用されませんここではブレークポイントも追加しますブレークポイントは生徒の進捗データの送信をデバッグする際に役立てられますサンプルAppにAPIを採用したのでスクールワークとデベロッパモードを使用して実装をテストする方法を見ていきましょうまずClassKit環境の Entitlementを developmentに設定する必要がありますこちらはXcode内ですデフォルト値はproductionですここでEntitlementの値を developmentに変更しデベロッパモードとスクールワークでテストできる環境を整えますこれでコードを実行するとコードがデベロッパモードで実行されますテスト終了後は必ずこの設定を productionに戻してください次にiPadでデベロッパモードをオンにします設定Appを開き > を選択しを選択してスクールワークでの役割を教師に変更します次にスクールワークAppを開きますスクールワークを開くと教師向けのUIが表示されます画面右上隅の課題作成ボタンをタップしボタンをタップして Appが対応するファイルを追加し課題を作成できます追加するファイルを選択し課題の対象クラスと課題名を入力しますオプションで指示のテキスト入力もできます入力したら右上隅の矢印ボタンをタップしこの課題をクラスに公開しますこれで課題を作成できたので役割を生徒に切り換え進捗データの送信の実装をテストします設定Appに戻り > を選択しをタップしますこれでスクールワークでの役割が生徒に変更されましたスクールワークAppに戻ると UIの右側隅に課題作成ボタンが表示されていないため生徒としてログインしていることがわかります画面中央に先ほど作成した課題が表示されていますこれをタップすると課題の詳細が表示されますファイルのアイコンをタップすると進捗データの報告を開始するAppにディープリンクされます Appでファイルが開きタイマーを開始するコードが呼び出されますここではタイマーを開始するため保存を呼び出した後ブレークポイントがヒットされたことが確認できますを押してAppに戻ると Student Progressバナーのドロップダウンが上部に表示されますこれは保存が正常に行われタイマーが開始されたことを通知するものですここではテキストを追加しエッセイを完成させますサンプルAppにはボタンがありますこれは生徒がファイルを編集後にタップするボタンですここでは画面左上隅のボタンをタップしますこの時点で closeFile関数が呼び出されます文字数をprimaryActivityItem として保存しタイマーを停止したことで 2つ目のブレークポイントがヒットされたことが確認できますここでを押してスクールワークに戻りますスクールワークでは Appから送信された進捗データを確認できますまずここに41分という時間が表示されています開始停止保存を正常に呼び出したことを示しています次に文字数も確認できますこれはprimaryActivityItemとして設定した項目です primaryActivityItemとして設定した CLSActivityItemサブクラスはすべて UIの主要部分であるここに表示されます 558の文字数が表示されており CLSQuantityItemの送信が正常に機能したことを示しています次に役割を再び教師に戻し Appによって送信されたデータを教師の画面で確認しましょう画面中央に生徒全員の平均時間と平均文字数が表示されていますその下に課題の対象となっている全生徒の行が表示されます生徒のセルではある生徒が送信したデータを確認できます生徒のセルをタップすると Appによって報告された進捗データを確認できます primaryActivityItemの時間が表示されており additionalActivityItemとして読みやすさの成績が表示されています以上がデベロッパモードを使用して ClassKitの統合をテストする方法です Entitlementを productionに戻すのをお忘れなくお疲れ様でした本日は新しいAPIからデベロッパモードで APIをテストする方法まで多くのことを学びました Appを教育用に使用することを検討されていない場合にも教育者がAppを活用できる機会はあります ClassKit対応のAppを使っていればすぐにカリキュラムにAppを取り入れることができますぜひAPIを採用してください視聴いただきありがとうございましたフィードバックをいただきありがとうございます他にもご意見がありましたらぜひお聞かせくださいまたコンテキストベースのAPIに関する詳細については前のセッション「What’s new in ClassKit」と 2018年のセッション「Introducing ClassKit」をご覧くださいぜひWWDCをお楽しみください ♪

func openFile() async throws {
     // Your existing code for opening a file goes here.
     let activity = await try CLSDataStore.shared.fetchActivity(for: fileURL)
     activity.start()
     await try CLSDataStore.shared.save()
}

8:07 - closeFile()

func closeFile() async throws {
     let activity = await try CLSDataStore.shared.fetchActivity(for: fileURL)
     let wordCount = activity.primaryActivityItem as? CLSQuantityItem ??
         CLSQuantityItem(identifier: "total_word_count", title: "Word Count")
     wordCount.quantity = currentDocumentWordCount()
     activity.primaryActivityItem = wordCount
     activity.progress = progress()
     activity.stop()
     await try CLSDataStore.shared.save()
}

8:48 - closeFile()2

func closeFile() async throws {
     let activity = await try CLSDataStore.shared.fetchActivity(for: fileURL)
     let wordCount = activity.primaryActivityItem as? CLSQuantityItem ??
         CLSQuantityItem(identifier: "total_word_count", title: "Word Count")
     wordCount.quantity = currentDocumentWordCount()
     activity.primaryActivityItem = wordCount
     activity.progress = progress()
     activity.stop()
     await try CLSDataStore.shared.save()
}

11:20 - openFile() BreakPointHit

func openFile() async throws {
     // Your existing code for opening a file goes here.
     let activity = await try CLSDataStore.shared.fetchActivity(for: fileURL)
     activity.start()
     await try CLSDataStore.shared.save()
}

11:55 - closeFile() BreakPointhit

func closeFile() async throws {
     let activity = await try CLSDataStore.shared.fetchActivity(for: fileURL)
     let wordCount = activity.primaryActivityItem as? CLSQuantityItem ??
         CLSQuantityItem(identifier: "total_word_count", title: "Word Count")
     wordCount.quantity = currentDocumentWordCount()
     activity.primaryActivityItem = wordCount
     activity.progress = progress()
     activity.stop()
     await try CLSDataStore.shared.save()
}

特定のトピックをお探しの場合は、上にトピックを入力すると、関連するトピックにすばやく移動できます。

クエリの送信中にエラーが発生しました。インターネット接続を確認して、もう一度お試しください。

リソース