/ical4android

Allows usage of iCalendar files with the Android calendar provider

Primary LanguageKotlinGNU General Public License v3.0GPL-3.0

Development tests Documentation Latest Version

ical4android

ical4android is a library for Android that brings together iCalendar and Android. It's a framework for

  • parsing and generating iCalendar resources (using ical4j) from/into data classes that are compatible with the Android Calendar Provider and third-party task providers,
  • accessing the Android Calendar Provider (and third-party task providers) over a unified API.

It has been primarily developed for:

and is currently used as git submodule.

Generated KDoc: https://bitfireat.github.io/ical4android/

For questions, suggestions etc. use Github discussions. We're happy about contributions! In case of bigger changes, please let us know in the discussions before. Then make the changes in your own repository and send a pull request.

This software is not affiliated to, nor has it been authorized, sponsored or otherwise approved by Google LLC. Android is a trademark of Google LLC.

How to use

  1. Add the jitpack.io repository to your project's level build.gradle:
    allprojects {
        repositories {
            // ... more repos
            maven { url "https://jitpack.io" }
        }
    }
    or if you are using settings.gradle:
    dependencyResolutionManagement {
        repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
        repositories {
            // ... more repos
            maven { url "https://jitpack.io" }
        }
    }
  2. Add the dependency to your module's build.gradle file:
    dependencies {
       implementation 'com.github.bitfireAT:ical4android:<version>'
    }

Contact

bitfire web engineering GmbH
Florastraße 27
2540 Bad Vöslau, AUSTRIA

License

Copyright (C) Ricki Hirner and contributors.

This program comes with ABSOLUTELY NO WARRANTY. This is free software, and you are welcome to redistribute it under the conditions of the GNU GPL v3.