CalendarとEventKitの説明

CalendarとEventKitの説明

ユーザーが時間をよりうまく管理できるようにカレンダーを取り入れる方法を学びましょう。アプリから新しいイベントを作成し、イベントを取得し、バーチャル会議の機能拡張を実装する方法を説明します。また、ユーザーのカレンダーデータのプライバシーを侵害せずにアプリが継続して接続できるようにカレンダーのアクセスレベルを変更する方法もご説明します。

関連する章
- 0:41 - Integrate with Calendar
- 1:52 - Frameworks overview
- 4:36 - Adding events
- 4:56 - Adding: EventKitUI
- 8:07 - Adding: Siri Event Suggestions
- 10:59 - Adding: Write-only
- 12:16 - Adding: EventKit
- 14:23 - Full Access
- 18:01 - Virtual conferences
リソース
関連ビデオ

WWDC23
- プライバシーの新機能
WWDC20
- Siri Event Suggestionsを使ってリーチを広げる
ダウンロード

♪♪
こんにちは Adamですこの動画ではカレンダーと EventKitを使用することで皆さんのアプリがユーザーの時間管理に役立つようにする方法を説明しますまずアプリとカレンダーを連携させるいくつかの方法と関連するフレームワークの概要について説明します次にこれらのフレームワークを使用してイベントの追加や完全アクセスによるイベントの取得バーチャル会議拡張の実装など一般的な機能を実装する方法についての具体的な例を紹介します
ユーザーはカレンダーに依存して時間を追跡したり将来の予定を立てますがカレンダーにはさまざまな用途がありますカレンダーと連携することでアプリは異なる役割を果たすことができますこれらの役割がすべて1つにまとまるとより豊富なカレンダー体験を提供することができます一部のアプリは予約チケットの購入会合の手配をサポートしますイベントを追加することでそれらに関与します一部のアプリはカスタムカレンダーウィジェットやプランナーなどのイベントを表示するのに役立ちます
両方のアクションを行うアプリもありますユーザーがイベントを確認し編集して予定を管理するのをサポートします
音声通話やビデオ通話をサポートするアプリもカレンダーと連携できますバーチャル会議拡張はカレンダーアプリの体験を向上するだけでなく皆さんのアプリにショートカットを提供します
これらすべてがまとまることで一貫した時間管理体験を提供しますこれらの各分野については後で具体的な例を紹介します
カレンダーの連携に使用できるフレームワークは2つあります EventKitフレームワークはカレンダーデータと直接動作します EventKitUIはiOS Mac CatalystフレームワークでアプリでカレンダーUIを表示するためのビューコントローラーを提供しますそれぞれを詳しく見てみましょう
EventKitの基本的なタイプから説明します
EKEventStoreはカレンダーデータの主要な接点となります EventStoreはアクセスのリクエストや取得・保存に使用しますアプリケーションでは1つのみ使用します EKEventクラスは特定のイベントをあらわしタイトル開始日終了日場所などのプロパティがあります各イベントはカレンダーに属しており EKCalendarクラスで表されますカレンダーにはタイトルと色がありイベントを色付けするのに便利です最後に各カレンダーアカウントは EKSourceによって表されますこれはカレンダーのコレクションですソースはUIでカレンダーをグループ化するのに便利です
EventKitはカレンダーデータを操作するための基礎的なフレームワークです EventKitUIはEventKitの上に構築され便利な組み込みのビューを提供します EventKitUIが提供するビューコントローラーは3つあります EKEventEditViewControllerはイベントエディターを表示しますこれを使用して新規イベントを追加するか既存のイベントに変更を加えます EKEventViewControllerはイベントの詳細を表示しますこれを使用して既存のイベントについての情報をアプリで表示します EKCalendarChooserはカレンダーリストを表示し単一または複数の選択をサポートしますこれを使用するとユーザーはカレンダーを選択してイベントを追加したりアプリで表示するカレンダーを選択したりできます
カレンダーは非公開なのでシステムは許可なしにアプリがカレンダーイベントを書き込んだり読み込んだりすることを防止しますアプリによるカレンダーへのアクセスレベルは3つありますアクセスなし書き込み専用アクセスまたは完全アクセスですカレンダーアクセスのないアプリは EventKitUIまたは Siri Event Suggestionsを使用してイベントを追加できます書き込み専用アクセスを持つアプリは EventKitで直接イベントを追加できます完全アクセスのあるアプリは既存のイベントの取得や変更既存のカレンダーへのアクセスと新規カレンダーの作成が行えます
カレンダーを操作するための最も一般的な方法の1つは新規イベントを追加することですイベントは異なる方法でカレンダーに追加できます EventKitUIかSiri Event Suggestionsで一度に1つのイベントを追加できますイベントを直接保存する場合は EventKitを使用しますイベントをカレンダーに追加するための一番簡単な方法は EventKitUIにほとんどの作業を任せる方法です EKEventEditViewControllerを提示しイベントの詳細が入力されているエディターを表示しますこれによりユーザーはカレンダーを選択したりイベントを保存する前にその他の変更を行うことができます iOS 17ではこのUIは別の処理で実行されますつまりカレンダーへのアクセスを要求する必要はありません
EventKitUIにイベントを追加するには４つの手順を踏みますまずイベントストアを作成します次にイベントを作成し詳細を入力します次にビューコントローラーを作成しイベントの編集に構成します最後にビューコントローラーを提示しますコードを使用して詳細に見てみましょうまずeventStoreを作成します次にイベントを作成し詳細を入力しますここで設定した詳細はエディターUIで使用されますエディターが提示されるとユーザーは変更を行うことができますしかしボタンを押すだけで確認できるのが理想的ですですので適切な詳細を入力することでユーザーの時間を節約できますすべてのイベントにはタイトルが必要ですタイトルはウィジェットや通知など多くの場所で使用されるのでシンプルなものにしましょう
最も重要なプロパティは開始日と終了日です開始日の作成には DateComponentを使用します
開始日を作成したら期間を追加して終了日を計算します基盤のカレンダーとDateComponents タイプで日付を計算してくださいそうしないと夏時間が始まる頃に予期せぬエラーが発生しますこのサンプルでは開始日に2時間足します
イベントが特定の時間帯で起こる場合はそれも設定することを忘れないでくださいデフォルトの時間帯は現在のシステムの時間帯となります
場所を設定しイベントが起こる場所をユーザーに伝えます完全な住所を含めるか MapKitハンドルを使用するとマップの提案や出発時間の通知などの機能を有効にできます最後にメモを入力して詳細情報を追加します
イベントプロパティを設定したら次のステップは EKEvent EditViewControllerの作成ですイベントとイベントストアプロパティを割当てますユーザーはエディターを使用してイベントの追加やキャンセルを行えますイベントが追加されたかどうかを確認するには委譲プロパティを使用して EKEventEditViewDelegate プロトコルを実装します
最後にエディターを提示しますこの時点ではイベントはまだカレンダーに追加されていませんボタンをタップすることでイベントが保存されますをタップすると何も保存されずにエディターが終了します EventKitUIでイベントを追加する完全な例については「Accessing Calendar using EventKit and EventKitUI」サンプルコードの「DropInLessons」ターゲットをご覧くださいアプリで行った予約のイベントを Siri Event Suggestionsで追加することもできます Siri Event Suggestions APIは Intents Frameworkの一部です Calendarアクセスのプロンプトを必要とせず UIはアプリに表示されません代わりにイベントは招待状のように Calendar Inboxに表示されます表示後にカレンダーに追加するか無視することができます
Siri Event Suggestionsはレストランやホテルの予約フライトやレンタルカーの予約コンサートやスポーツイベントなどのチケット予約をサポートします予約がキャンセルされたり変更された場合はイベントを更新することができます
Siri Event Suggestions APIを使用するには４つの手順を踏みますまずINReservationを作成します次に予約をIntentsと応答にラップします次にINInteractionを作成します最後に操作をシステムにドネートしますではいくつかのサンプルコードを見てみましょうシステムが予約を特定するための一意の参照が必要になります INSpeakableStringインスタンスを作成し一意の言語 identifierと話されたフレーズでこの参照を作成しますこの表現はSiriとの会話でこの予約を参照する際に使用できます
INDateComponentsRangeを使用してこの予約の開始時間と終了時間を設定します
CLPlacemarkタイプを使用してこのイベントの場所を提供します
次に INReservationのサブクラスの 1つのインスタンスを作成しそれをすべて1つにまとめますレストランの予約には INRestaurantReservationを使用しますこのinitializerにはここには表示されていないオプションの引数がいくつかあり各サブクラスには独自のオプションがあります詳細についてはドキュメントをご覧ください
次のステップは予約の参照を使用して INGetReservationDetailsIntentを作成することです次に予約のオブジェクトを使用して INGetReservationDetailsIntent Responseを作成します
次にインテントと応答で INInteractionを作成します
最後に操作のドネートメソッドを呼び出します
この例はSiri Event Suggestionsを活用できるほんのわずかな例です Siri Event Suggestionsを作成するための詳細については WWDC20「Broaden your reach with Siri Event Suggestions」をご覧ください EventKitUIやSiri Event Suggestionsはイベントの追加において最高の体験を提供します書き込み専用アクセスはアプリがカスタム編集UIを表示する必要がある場合一度に複数のイベントを追加する場合イベントをユーザー操作なしで追加したい場合のみに使用します
書き込み専用アクセスをリクエストするには Infoplistに NSCalendarsWriteOnly AccessUsageDescriptionキーを追加してアプリがアクセスを必要とする理由を説明しますこの文字列が要求プロンプトに表示されますこちらはサンプルアプリのプロンプトです「選択するカレンダーに反復のレッスンを保存する」
書き込み専用アクセスにはある制限があります 1つはユーザーにアクセスを拒否する選択肢があることアクセスが許可されてもアプリは同じアプリから追加されたイベントを含むカレンダーの既存のイベントを読み込むことができませんまたアプリはカレンダーリストの読み込みや新規カレンダーの作成ができません書き込み専用アクセスは iOS 17と macOS Sonomaの新機能ですこれが既存のアプリに与える影響の詳細については「What's new in Privacy」の動画をご覧ください
書き込み専用アクセスによる新規イベントの追加は EventKitUIによる新規イベントの追加と似ていますどちらもイベントストアの作成から始まります次に書き込み専用アクセスをリクエストしますアクセスが許可されたら新規イベントを作成し詳細を入力します最後にイベントを保存しますより詳細に説明しましょうまずイベントストアを作成します requestWriteOnlyAccessToEventsで書き込み専用アクセスをリクエストします戻り値によりアクセスが許可されたかどうかがわかりますユーザーはアクセスを拒否できるのでその場合は丁寧に対応しましょうユーザーがアプリのアクセスの必要性を理解すればほとんどの場合アクセスが許可されるのでユーザーがアクセスが必要なアプリを初めて操作する際にアクセスをリクエストする必要があります次にイベントを作成し詳細を入力しますここでも重要な違いがあります EventKitUIを使用する場合入力した詳細はエディターに表示され入力されていない内容にはデフォルトの値がつきますイベントをEventKitで直接保存する場合どの内容も自動的に入力されません皆さんが設定したものだけが保存されます入力する必要のあるプロパティがいくつかありますさもないと保存に失敗します
必須のプロパティはカレンダーですイベントストアのdefaultCalendar ForNewEventsプロパティを使用してカレンダーの使用が設定でデフォルトとして構成されるようにします
タイトル開始日終了日も必須の項目ですそれ以外はすべてオプションとなりますしかしできる限り詳細を入力することをおすすめします
詳細の入力が完了したらイベントをイベントストアの保存メソッドを使用して保存します
EventKitでイベントを追加する完全な例は「Accessing Calendar using EventKit and EventKitUI」にあるサンプルプロジェクトで「RepeatingLessons」ターゲットをご覧ください
イベントをカレンダーに追加したいアプリは EventKitUI Siri Event Suggestionsまたは書き込み専用アクセスを使用してくださいカレンダーデータを読み込む必要のあるごく一部のアプリには完全アクセスを利用できます
アプリに既存のイベントの表示更新削除が必要なコア機能がある場合にのみ完全アクセスをリクエストします完全アクセスをリクエストするには Infoplistに NSCalendars FullAccessUsageDescription キーを含みますこの文字列が要求プロンプトに表示されますカレンダーには機密情報が含まれており完全アクセスへのプロンプトには含まれているデータの量が説明されますアプリによるカレンダー情報の読み込みをユーザーが信頼するのは簡単ではありませんユーザーがアプリを信頼しなければリクエストは拒否される場合がありますアプリのコア体験に欠かせない場合にのみ完全アクセスをリクエストしてくださいまたアクセスが必要な理由が明確である場合にのみリクエストしてください
アプリがコア機能に対して完全アクセスが必要である場合イベントを取得する必要があるでしょうこれを行うにはまずイベントストアを作成します次に完全アクセスをリクエストします次にpredicate.を作成します最後にイベントをイベントストアから取得しますそのコードについて説明しますこれまでの例と同じようにまずイベントストアを作成しますアプリには1つのイベントストアのみが必要ですですのでこれを再利用します requestFullAccessToEventsメソッドを呼び出して完全アクセスを要求しますプロンプトが表示されアクセスが許可されたかどうかを示します完全アクセスは拒否されることが多いためうまく対処してください完全アクセスを取得したらイベントストアの predicateForEventsメソッドを呼出して predicateを作成します predicateはどのイベントを取得するかと日付範囲およびオプションのカレンダーリストを説明しますこのコードは当月の範囲を使用しています最良のパフォーマンスのために最短の範囲を選択しましょうカレンダーの引数がnilのままの場合すべてのカレンダーからの結果が含まれます最後にpredicateをイベントストアのイベント(マッチング) メソッドにパスしてイベントを取得すると一致したイベントの配列が返されますこの配列のイベントは順番通りに表示されません必要に応じてイベントを並び変えてくださいイベントの取得に関する完全な例を見てみたい場合は「Accessing Calendar using EventKit and EventKitUI」の「MonthlyEvents」ターゲットをご覧ください
iOS 17とmacOS Sonoma以前のリリースに対応するにはランタイムの可用性チェックを一度実行します iOS 17とmacOS Sonoma以降では新しい requestAccessメソッドを呼び出します旧バージョンのOSでは古い requestAccessメソッドを呼び出します
iOS 17またはmacOS Sonoma 以前には追加の使用文字列が必要です NSCalendarsUsageDescriptionキーをカレンダーアクセスに含めます EventKitUIを使用するアプリにも NSContactsUsageDescriptionキーを含める必要があります EventKitUIはアプリに連絡先のアクセスを要求するからです
アクセスを要求する際にアプリにこれらの文字列が欠落している場合アプリはクラッシュします
これまでイベントの追加方法と取得方法について説明しましたがカレンダーとの連携は他の用途でも活用できますアプリが音声通話やビデオ通話に対応するのならバーチャル会議拡張を使用するとユーザーは通話をイベントに直接追加することができますこの拡張を使用する方法は2つありますイベントに場所を追加する場合バーチャル会議のカスタムオプションが場所ピッカーに表示されますこの例では FaceTimeと Skypeのバーチャル会議拡張が提供するオプションがありますいずれかをタップするとバーチャル会議がイベントに追加されますバーチャル会議のあるイベントにはカスタムの参加オプションがイベント詳細欄に表示されますバーチャル会議拡張の作成は簡単ですまずXcodeで「Virtual Conference Extension」ターゲットを作成します次にプロトコル拡張で2つのメソッドを使って実装します fetchAvailableRoomTypesを実装して利用可能なルームタイプを提供します次に fetchVirtualConferenceを実装して選択したルームタイプのバーチャル会議オブジェクトを提供します実演してみましょう
まずXcodeで「Virtual Conference Extension」ターゲットを作成します EKVirtualConferenceProviderのスタブされたサブクラスができますオーバーライドする最初のメソッドは fetchAvailableRoomTypesです場所ピッカーにルームタイプが表示されます
各ルームタイプに対しタイトルを選択しますこれはアプリのアイコンの横のUIに表示されます
また各ルームタイプに対して一意のidentifierを選択します identifierはどのルームが選択されたかを Extensionに知らせます
タイトルとidentifierを使用して EKVirtualConferenceRoomTypeDescriptorのインスタンスを作成しますアプリが複数のルームタイプに対応する場合各ルームタイプにインスタンスを作成します最後にルームタイプの配列を返します
次に実装するメソッドは fetchVirtualConferenceですこれはルームタイプの1つが選択された場合に呼び出されます identifierの引数はどのルームが選択されたかを示します
バーチャル会議には1つ以上のdescriptorがありこれはカレンダーに参加方法を伝えます EKVirtualConferenceURLDescriptorを作成して URLとオプションのタイトルを開きます
URLにはユニバーサルリングを使用してアプリが直接開かれるのを許可しますタイトルは複数の参加オプションを区別するのに役立ちますここでは参加方法が1つしかないため必要ありません
詳細文字列で追加情報を提供しますこのテキストはイベント詳細UIの特別バーチャル会議セクションに表示されます
最後にこれらをすべて1つにまとめて EKVirtualConferenceDescriptorを作成し返しますここでのタイトルは複数のルームタイプを区別するのに役立ちますこの例ではルームタイプが1つだけなのでタイトルはnilのままです
この2つのメソッドでアプリはカレンダーアプリの場所ピッカーにバーチャル会議のオプションとして表示されます
カレンダーとの連携方法をいくつかご紹介したところで皆さんのアプリがどのように寄与するか考えましょう EventKitUIまたはSiri Event Suggestionsでアクセスの要求なしにイベントを作成アクセスを要求する必要がある場合は最小限のアクセスを必要なときにのみ要求します音声通話やビデオ通話のアプリの場合はバーチャル会議拡張を実装しましょう皆さんのアプリがカレンダーと連携するのを見るのが楽しみですご視聴ありがとうございます ♪ ♪

// Create an event store
let store = EKEventStore()

// Create an event
let event = EKEvent(eventStore: store)
event.title = "WWDC23 Keynote"
let startDateComponents = DateComponents(year: 2023, month: 6, day: 5, hour: 10)
let startDate = Calendar.current.date(from: startDateComponents)!
event.startDate = startDate
event.endDate = Calendar.current.date(byAdding: .hour, value: 2, to: startDate)!
event.timeZone = TimeZone(identifier: "America/Los_Angeles")
event.location = "1 Apple Park Way, Cupertino, CA, United States"
event.notes = "Kick off an exhilarating week of technology and community."

// Create a view controller
let eventEditViewController = EKEventEditViewController()
eventEditViewController.event = event
eventEditViewController.eventStore = store
eventEditViewController.editViewDelegate = self

// Present the view controller
present(eventEditViewController, animated: true)

9:17 - Siri Event Suggestions

// Create an INReservation
let spokenPhrase = “Lunch at Caffè Macs”
let reservationReference = INSpeakableString(vocabularyIdentifier: "df9bc3f5",
                                             spokenPhrase: spokenPhrase,
                                             pronunciationHint: nil)
let duration = INDateComponentsRange(start: myEventStart, end: myEventEnd)
let location = CLPlacemark(location: myCLLocation,
                           name: "Caffè Macs",
                           postalAddress: myAddress)
let reservation = INRestaurantReservation(itemReference: reservationReference,
                                          reservationStatus: .confirmed,
                                          reservationHolderName: "Jane Appleseed",
                                          reservationDuration: duration,
                                          restaurantLocation: location)

// Create an intent and response
let intent = INGetReservationDetailsIntent(reservationContainerReference:
    reservationReference)
let intentResponse = INGetReservationDetailsIntentResponse(code: .success, userActivity: nil)
intentResponse.reservations = [reservation]

// Create an INInteraction
let interaction = INInteraction(intent: intent, response: intentResponse)

// Donate the interaction to the system
interaction.donate()

12:41 - Adding an event with write-only access

// Create an event store
let store = EKEventStore()

// Request write-only access
guard try await store.requestWriteOnlyAccessToEvents() else { return }

// Create an event
let event = EKEvent(eventStore: store)
event.calendar = store.defaultCalendarForNewEvents
event.title = "WWDC23 Keynote"
event.startDate = myEventStartDate
event.endDate = myEventEndDate
event.timeZone = TimeZone(identifier: "America/Los_Angeles")
event.location = "1 Apple Park Way, Cupertino, CA, United States"
event.notes = "Kick off an exhilarating week of technology and community."

// Save the event
guard try eventStore.save(event, span: .thisEvent) else { return }

15:51 - Fetch events

// Create an event store
let store = EKEventStore()

// Request full access
guard try await store.requestFullAccessToEvents() else { return }

// Create a predicate
guard let interval = Calendar.current.dateInterval(of: .month, for: Date()) else { return }
let predicate = store.predicateForEvents(withStart: interval.start,
                                         end: interval.end,
                                         calendars: nil)

// Fetch the events
let events = store.events(matching: predicate)

let sortedEvents = events.sorted { $0.compareStartDate(with: $1) == .orderedAscending }

19:18 - Virtual conference extension

// Create the extension target
class VirtualConferenceProvider: EKVirtualConferenceProvider {
  
    // Provide the room types
    override func fetchAvailableRoomTypes() async throws ->
        [EKVirtualConferenceRoomTypeDescriptor] {
        let title = "My Room"
        let identifier = "my_room"
        let roomType = EKVirtualConferenceRoomTypeDescriptor(title: title, identifier: identifier)
        return [roomType]
    }

    // Provide the virtual conference
    override func fetchVirtualConference(identifier: EKVirtualConferenceRoomTypeIdentifier)
        async throws -> EKVirtualConferenceDescriptor {
        let urlDescriptor = EKVirtualConferenceURLDescriptor(title: nil, url: myURL)
        let details = "Enter the meeting code 12345 to enter the meeting."
        return EKVirtualConferenceDescriptor(title: nil,
                                             urlDescriptors: [urlDescriptor],
                                             conferenceDetails: details)
    }
  
}

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

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

関連する章

リソース

関連ビデオ

WWDC23

WWDC20