Calendars Read-Only API #1010

builttoroamteam · 2019-12-05T03:11:59Z

Calendars Read-Only API

Calendars API for reading calendar/event information seamlessly across uwp, iOS and Android
(Issue #996)

API

Calendars

Methods

API	Description
`Task<IEnumerable<Calendar>> GetCalendarsAsync()`	Retrieve all calendars for device
`Task<IEnumerable<CalendarEvent>> GetEventsAsync( string calendarId = null, DateTimeOffset? startDate = null, DateTimeOffset? endDate = null)`	Retrieve all events for a specified range/calendar. Null values for parameters will result in default values being used: null calendarId will return events from all calendares, startDate will default to the Now, endDate will default to startDate+14 days
`Task<CalendarEvent> GetEventByIdAsync(string eventId)`	Gets more detailed information about a specific event by the event id

Classes

public class Calendar
{
    string Id { get; set; }

    string Name { get; set; }
}

public class CalendarEvent
{
    string Id { get; set; }

    string CalendarId { get; set; }

    string Title { get; set; }

    string Description { get; set; }

    string Location { get; set; }

    bool AllDay { get; set; }

    DateTimeOffset Start { get; set; }

    DateTimeOffset? End { get; set; }

    TimeSpan? Duration { get; set; }

    IEnumerable<DeviceEventAttendee> Attendees { get; set; }
}

public class CalendarEventAttendee
{
    string Name { get; set; }

    string Email { get; set; }
}

Scenarios

User wants to see upcoming events.
User wants to see who is attending an upcoming event.
User wants to know when they will be free.

Platform Compatibility

Target Frameworks:
- iOS: Support on iOS for the API
- Android: Support on Android for the API
- UWP: Support on UWP for the API

Backward Compatibility

UWP: Windows 10 (introduced v10.0.10240.0)
(https://docs.microsoft.com/en-us/uwp/api/windows.applicationmodel.appointments.appointment)
Android: android:minSdkVersion="14"
(https://developer.android.com/reference/android/provider/CalendarContract)
iOS: All versions until reminders are added, then iOS 6
(https://developer.apple.com/documentation/eventkit/ekeventstore)

Contributors

@ScottBTR
@mkieres
@nickrandolph

msftclas · 2019-12-05T03:12:12Z

All CLA requirements met.

nickrandolph · 2019-12-10T05:11:32Z

@mattleibow / @jamesmontemagno any suggestions on how to fix the failing build - afaik the test cases should be passing but fails during the build. Any assistance and/or feedback would be greatly appreciated.

jamesmontemagno · 2019-12-14T18:44:02Z

I am happy with this overall. I think we should pull in @Redth's permissions and merge with some changes that were needed here for calendar and then would be good to go.

VSC-Service-Account · 2019-12-14T18:44:53Z

Docs Build status updates of commit a820831:

✅ Validation status: passed

File	Status	Preview URL	Details
DeviceTests/DeviceTests.Android/Properties/AndroidManifest.xml	✅Succeeded
DeviceTests/DeviceTests.Shared/Calendar_Tests.cs	✅Succeeded
DeviceTests/DeviceTests.UWP/Package.appxmanifest	✅Succeeded
DeviceTests/DeviceTests.iOS/Info.plist	✅Succeeded
Samples/Samples.Android/Properties/AndroidManifest.xml	✅Succeeded
Samples/Samples.UWP/Package.appxmanifest	✅Succeeded
Samples/Samples.iOS/Info.plist	✅Succeeded
Samples/Samples.iOS/Samples.iOS.csproj	✅Succeeded
Samples/Samples/App.xaml	✅Succeeded
Samples/Samples/Behaviors/BehaviorBase.cs	✅Succeeded
Samples/Samples/Behaviors/EventToCommandBehaviour.cs	✅Succeeded
Samples/Samples/Converters/CheckBoxEventArgsConverter.cs	✅Succeeded
Samples/Samples/Converters/DateSelectedEventArgsConverter.cs	✅Succeeded
Samples/Samples/Converters/TimeSelectedEventArgsConverter.cs	✅Succeeded
Samples/Samples/Samples.csproj	✅Succeeded
Samples/Samples/View/AppInfoPage.xaml	✅Succeeded
Samples/Samples/View/CalendarEventPage.xaml	✅Succeeded
Samples/Samples/View/CalendarEventPage.xaml.cs	✅Succeeded
Samples/Samples/View/CalendarPage.xaml	✅Succeeded
Samples/Samples/View/CalendarPage.xaml.cs	✅Succeeded
Samples/Samples/ViewModel/CalendarViewModel.cs	✅Succeeded
Samples/Samples/ViewModel/HomeViewModel.cs	✅Succeeded
Tests/Calendar_Tests.cs	✅Succeeded
Xamarin.Essentials/Calendar/Calendar.android.cs	✅Succeeded
Xamarin.Essentials/Calendar/Calendar.ios.cs	✅Succeeded
Xamarin.Essentials/Calendar/Calendar.netstandard.tvos.watchos.tizen.cs	✅Succeeded
Xamarin.Essentials/Calendar/Calendar.shared.cs	✅Succeeded
Xamarin.Essentials/Calendar/Calendar.uwp.cs	✅Succeeded
Xamarin.Essentials/Calendar/CalendarRequest.ios.cs	✅Succeeded
Xamarin.Essentials/Calendar/CalendarRequest.uwp.cs	✅Succeeded
Xamarin.Essentials/Permissions/Permissions.android.cs	✅Succeeded
Xamarin.Essentials/Permissions/Permissions.ios.cs	✅Succeeded
Xamarin.Essentials/Permissions/Permissions.shared.enums.cs	✅Succeeded
Xamarin.Essentials/Permissions/Permissions.uwp.cs	✅Succeeded
Xamarin.Essentials/Types/AttendeeDetails.android.cs	✅Succeeded
Xamarin.Essentials/Types/AttendeeDetails.ios.cs	✅Succeeded
Xamarin.Essentials/Types/DeviceCalendar.shared.cs	✅Succeeded
Xamarin.Essentials/Types/PlatformExtensions/CalendarExtensions.ios.cs	✅Succeeded

For more details, please refer to the build report.

Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report.

jamesmontemagno · 2019-12-14T18:46:21Z

My main thoughts are on naming...

DeviceEvent -> I would choose DeviceCalendarEvent or just CalendarEvent
*DeviceEventAttendee -> Same... DeviceCalendarEventAttendee or just CalendarEventAttendee

I understand not using just "Calendar" as that is the class name to access things, however you could make it "Calendars" for the class? lol and have "Calendar" :)

jamesmontemagno · 2019-12-14T18:46:40Z

I wouldn't worry about the android test failing it is something with the build server.

VSC-Service-Account · 2019-12-16T22:55:08Z

Docs Build status updates of commit a4958d9:

✅ Validation status: passed

File	Status	Preview URL	Details
DeviceTests/DeviceTests.Android/Properties/AndroidManifest.xml	✅Succeeded
DeviceTests/DeviceTests.Shared/Calendar_Tests.cs	✅Succeeded
DeviceTests/DeviceTests.UWP/Package.appxmanifest	✅Succeeded
DeviceTests/DeviceTests.iOS/Info.plist	✅Succeeded
Samples/Samples.Android/Properties/AndroidManifest.xml	✅Succeeded
Samples/Samples.UWP/Package.appxmanifest	✅Succeeded
Samples/Samples.iOS/Info.plist	✅Succeeded
Samples/Samples.iOS/Samples.iOS.csproj	✅Succeeded
Samples/Samples/App.xaml	✅Succeeded
Samples/Samples/Behaviors/BehaviorBase.cs	✅Succeeded
Samples/Samples/Behaviors/EventToCommandBehaviour.cs	✅Succeeded
Samples/Samples/Converters/CheckBoxEventArgsConverter.cs	✅Succeeded
Samples/Samples/Converters/DateSelectedEventArgsConverter.cs	✅Succeeded
Samples/Samples/Converters/TimeSelectedEventArgsConverter.cs	✅Succeeded
Samples/Samples/Samples.csproj	✅Succeeded
Samples/Samples/View/AppInfoPage.xaml	✅Succeeded
Samples/Samples/View/CalendarEventPage.xaml	✅Succeeded
Samples/Samples/View/CalendarEventPage.xaml.cs	✅Succeeded
Samples/Samples/View/CalendarPage.xaml	✅Succeeded
Samples/Samples/View/CalendarPage.xaml.cs	✅Succeeded
Samples/Samples/ViewModel/CalendarViewModel.cs	✅Succeeded
Samples/Samples/ViewModel/HomeViewModel.cs	✅Succeeded
Tests/Calendar_Tests.cs	✅Succeeded
Xamarin.Essentials/Calendar/Calendar.android.cs	✅Succeeded
Xamarin.Essentials/Calendar/Calendar.ios.cs	✅Succeeded
Xamarin.Essentials/Calendar/Calendar.netstandard.tvos.watchos.tizen.cs	✅Succeeded
Xamarin.Essentials/Calendar/Calendar.shared.cs	✅Succeeded
Xamarin.Essentials/Calendar/Calendar.uwp.cs	✅Succeeded
Xamarin.Essentials/Calendar/CalendarRequest.ios.cs	✅Succeeded
Xamarin.Essentials/Calendar/CalendarRequest.uwp.cs	✅Succeeded
Xamarin.Essentials/Permissions/Permissions.android.cs	✅Succeeded
Xamarin.Essentials/Permissions/Permissions.ios.cs	✅Succeeded
Xamarin.Essentials/Permissions/Permissions.shared.enums.cs	✅Succeeded
Xamarin.Essentials/Permissions/Permissions.uwp.cs	✅Succeeded
Xamarin.Essentials/Types/AttendeeDetails.android.cs	✅Succeeded
Xamarin.Essentials/Types/AttendeeDetails.ios.cs	✅Succeeded
Xamarin.Essentials/Types/DeviceCalendar.shared.cs	✅Succeeded
Xamarin.Essentials/Types/PlatformExtensions/CalendarExtensions.ios.cs	✅Succeeded

For more details, please refer to the build report.

Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report.

nickrandolph · 2019-12-17T20:35:35Z

@jamesmontemagno we've updated the class names based on your suggestions.
You mentioned pulling in some permissions - do we just need to rebase again off master, or are we waiting on another PR to be completed first?

jamesmontemagno · 2019-12-20T17:22:37Z

@nickrandolph the new permissions are in there. If you want to integrate with the new permissions that would be great!

* Calendar Read-Only API * Return exceptions that match test case System.NotImplementedException --> Xamarin.Essentials.NotImplementedInReferenceAssemblyException (#45)

nickrandolph · 2019-12-24T22:13:14Z

@jamesmontemagno / @Redth I've rebased onto the dev/calendar branch and have fixed up the usage for permissions. Let me know what else we need to adjust/work on.
Support for writing calendar events and dealing with recurring events is being worked on and will be submitted early in the new year, so it'd be good to get this PR merged so we only have a single PR related to calendars at a time.

jamesmontemagno · 2019-12-25T00:06:23Z

Awesome, that sounds great! Thanks for doing that. It is on the teams list to review and get in :) I am thinking we are doing 1.4.0 pretty soon so may get this in under a feature flag or put in right after to get into an early beta.

nickrandolph · 2019-12-25T00:35:18Z

I'd suggest going with the later option of early beta. Not sure how feature flagging would work since the calendar is pretty self contained, so feature flag wouldn't have much effect and just adds work to add/remove the flag.
If we can get it into beta, then we can integrate any feedback as part of adding support for recurring events (which will probably come before write support)

nickrandolph · 2020-01-19T22:54:52Z

@jamesmontemagno do you need anything more from us on this PR?

ScottBTR · 2020-01-23T02:01:32Z

Hi @jamesmontemagno,

I've brought some naming convention changes across as listed below:
API - Calendar --> Calendars
Properties - Calendars --> CalendarList
Models:

DeviceCalendar --> Calendar
DeviceEvent --> CalendarEvent
DeviceEventAttendee --> CalendarEventAttendee

Which shouldn't cause any issues.

But I noticed that since the permissions update that uwp was no longer working for the calendars API, this was due to UWP appointments. Not using x:Capability/x:DeviceCapability but instead uap:Capability.

(See: Appointments
https://docs.microsoft.com/en-us/windows/uwp/packaging/app-capability-declarations?redirectedfrom=MSDN)

Because of this please note the changes I've made to Permissions.uwp.cs, let me know if this poses any problems or requires any changes.

Thanks!

nickrandolph · 2020-02-12T23:22:29Z

@jamesmontemagno @Redth this PR is currently targetting the dev/calendar branch which is from back in December. Any chance you can either update that branch or switch this PR to target a more recent branch. We're keen to rebase and test our read-only work before we start pushing the write functionality
We have the write functionality around 90% ready, just want to work out what the road to a merge is!

nickrandolph · 2020-02-20T22:01:08Z

@Redth is the plan still to get this merged for the 1.5 release? If so, can you instruct what you need us to do.

Redth · 2020-02-20T22:10:13Z

@nickrandolph no it will likely go into a 1.6.0. We had to rush 1.5 preview out to align with Forms’ AndroidX strategy.

nickrandolph · 2020-02-20T22:13:32Z

@Redth no probs. We're pretty close to pushing the write functionality. Would you be able to update the target branch for this PR so that we can rebase it? I would actually suggest keeping the target branch as master until you're close to being able to merge it. That way we can rebase and update it as necessary.

Redth · 2020-02-20T22:16:43Z

@nickrandolph sure, just updated it to target develop (which is as good as master right now).

mattleibow · 2020-09-17T14:46:31Z

Merging this into a local branch for better CI and so we can start the merge on this in #1384 . Looking pretty good so far.

This comment has been minimized.

Sign in to view

Redth changed the base branch from master to dev/calendar December 19, 2019 21:09

ScottBTR and others added 2 commits December 25, 2019 08:46

Read-only Calendar API (#46)

883e390

* Calendar Read-Only API * Return exceptions that match test case System.NotImplementedException --> Xamarin.Essentials.NotImplementedInReferenceAssemblyException (#45)

Fixing up permissions usage

dcc9697

nickrandolph force-pushed the snapshot/2019-12-05-master branch from a4958d9 to dcc9697 Compare December 24, 2019 22:10

Feature/bridge naming convention changes (#69)

39e0916

builttoroamteam changed the title ~~Calendar Read-Only API~~ Calendars Read-Only API Jan 22, 2020

Redth changed the base branch from dev/calendar to develop February 20, 2020 22:15

jamesmontemagno added this to the 1.6.0 milestone Mar 30, 2020

jamesmontemagno added the awaiting-review This PR needs to have a set of eyes on it label Mar 30, 2020

jamesmontemagno changed the base branch from develop to 1.6.0 March 31, 2020 21:11

jamesmontemagno marked this pull request as ready for review March 31, 2020 21:11

Redth modified the milestones: 1.6.0, 1.7.0 Sep 15, 2020

mattleibow changed the base branch from 1.6.0 to develop September 17, 2020 13:58

mattleibow changed the base branch from develop to dev/calendar September 17, 2020 13:58

mattleibow merged commit c77ae06 into xamarin:dev/calendar Sep 17, 2020

mattleibow mentioned this pull request Sep 17, 2020

Merge [Readonly] Calendar API #1384

Closed

jamesmontemagno removed this from the 1.7.0 milestone Jul 15, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Calendars Read-Only API #1010

Calendars Read-Only API #1010

builttoroamteam commented Dec 5, 2019 •

edited

Loading

msftclas commented Dec 5, 2019 •

edited

Loading

This comment has been minimized.

nickrandolph commented Dec 10, 2019

jamesmontemagno commented Dec 14, 2019

VSC-Service-Account commented Dec 14, 2019

jamesmontemagno commented Dec 14, 2019

jamesmontemagno commented Dec 14, 2019

VSC-Service-Account commented Dec 16, 2019

nickrandolph commented Dec 17, 2019

jamesmontemagno commented Dec 20, 2019

nickrandolph commented Dec 24, 2019

jamesmontemagno commented Dec 25, 2019

nickrandolph commented Dec 25, 2019

nickrandolph commented Jan 19, 2020

ScottBTR commented Jan 23, 2020 •

edited

Loading

nickrandolph commented Feb 12, 2020

nickrandolph commented Feb 20, 2020

Redth commented Feb 20, 2020

nickrandolph commented Feb 20, 2020

Redth commented Feb 20, 2020

mattleibow commented Sep 17, 2020

Calendars Read-Only API #1010

Calendars Read-Only API #1010

Conversation

builttoroamteam commented Dec 5, 2019 • edited Loading

Calendars Read-Only API

API

Calendars

Methods

Classes

Scenarios

Platform Compatibility

Backward Compatibility

Contributors

msftclas commented Dec 5, 2019 • edited Loading

This comment has been minimized.

nickrandolph commented Dec 10, 2019

jamesmontemagno commented Dec 14, 2019

VSC-Service-Account commented Dec 14, 2019

✅ Validation status: passed

jamesmontemagno commented Dec 14, 2019

jamesmontemagno commented Dec 14, 2019

VSC-Service-Account commented Dec 16, 2019

✅ Validation status: passed

nickrandolph commented Dec 17, 2019

jamesmontemagno commented Dec 20, 2019

nickrandolph commented Dec 24, 2019

jamesmontemagno commented Dec 25, 2019

nickrandolph commented Dec 25, 2019

nickrandolph commented Jan 19, 2020

ScottBTR commented Jan 23, 2020 • edited Loading

nickrandolph commented Feb 12, 2020

nickrandolph commented Feb 20, 2020

Redth commented Feb 20, 2020

nickrandolph commented Feb 20, 2020

Redth commented Feb 20, 2020

mattleibow commented Sep 17, 2020

builttoroamteam commented Dec 5, 2019 •

edited

Loading

msftclas commented Dec 5, 2019 •

edited

Loading

ScottBTR commented Jan 23, 2020 •

edited

Loading