DEVAndreaCarratta.ICSFileGeneratorHelper 0.3.2

ics-file-generator-helper

ICS File Geneator Helper is a simple NuGet package to create .ics calendar files for events.

An ICS file is a widely used standard for calendar events, allowing you to share, schedule, and manage events across platforms like Google Calendar, Outlook, and Apple Calendar. The ICS files are commonly used for:

• Scheduling events or meetings.
• Sharing calendar invites via email.
• Importing events into personal or organizational calendars.

This package helps developers easily generate .ics files programmatically with customizable event details, making it perfect for integrating calendar functionality into your applications.

Features

• Generate .ics content as a string (text).
• Generate .ics content as a stream.
• Create CalendarEvent with dedicate service.

You can customize the CalendarEvent model to fit your needs.

Use Case

Easily create calendar events programmatically for sharing or exporting to other platforms.

How It Works

• Fill the CalendarEvent model with basic event details.
• Generate the .ics as a string or a stream.
• Customize the model for advanced use cases.

Examples:

ICSGeneratorConfiguration

var configuration = new ICSGeneratorConfiguration()
{
    ApplicationName = "ICSFileGeneratorHelper.Test",
    OrganizerMailDomainUID = true,
};

ICSGenerator & interface

IICSGenerator result = new ICSGenerator(configuration);

public interface IICSGenerator
{
    Stream GenerateAsStream(CalendarEvent calendarEvent);
    ValueTask<Stream> GenerateAsStreamAsync(CalendarEvent calendarEvent);
    string GenerateAsString(CalendarEvent calendarEvent);
    CalendarEvent GetCalendarEvent(string title, string description, DateTime from, DateTime to);
}

ICalendarEventService

ICalendarEventService calendarService = new CalendarEventService();

public interface ICalendarEventService
{
    CalendarEvent GenerateNew(string title, string description, DateTime from, DateTime to);
    void AddAttendeeEmail(CalendarEvent calendarEvent, string attendeeEmail, bool autoConfirm);
    void SetIsAllDay(CalendarEvent calendarEvent, bool isAllDay);
    void SetLocation(CalendarEvent calendarEvent, string location);
    void SetOrganizerEmail(CalendarEvent calendarEvent, string organizerEmail);
}

CalendarEvent

public CalendarEvent GetCalendarEvent(
    string title,
    string description,
    DateTime from,
    DateTime to)

{
  "Title": "Test Event",
  "Description": "This is a test event.",
  "Location": "Test Location",
  "From": "2023-10-01T10:00:00Z",
  "To": "2023-10-01T11:00:00Z",
  "IsAllDay": false,
  "OrganizerEmail": "organizer@example.com",
  "AttendeeEmails": {
    "attendee@example.com": true,
    "attendee-not-confirmed@example.com": false
  }
}