HtmlForgeX

API Reference

Class

EmailIcsEvent

Namespace HtmlForgeX.Email
Assembly HtmlForgeX.Email
Modifiers sealed

Represents a single iCalendar event (VEVENT) used by EmailIcsCalendar.

Inheritance

  • Object
  • EmailIcsEvent

Constructors

public EmailIcsEvent() #

Methods

public EmailIcsEvent AddAttendee(String email, String name = null, Boolean rsvp = false, Boolean required = true) #
Returns: EmailIcsEvent

Adds an attendee (ATTENDEE).

Parameters

email System.String requiredposition: 0
name System.String = null optionalposition: 1
rsvp System.Boolean = false optionalposition: 2
required System.Boolean = true optionalposition: 3
public EmailIcsEvent WithAllDay(DateTime dateUtc, Int32 days = 1) #
Returns: EmailIcsEvent

Marks the event as all-day using a UTC date.

Parameters

dateUtc System.DateTime requiredposition: 0
days System.Int32 = 1 optionalposition: 1
public EmailIcsEvent WithDescription(String description) #
Returns: EmailIcsEvent

Sets the event description.

Parameters

description System.String requiredposition: 0
public EmailIcsEvent WithLocation(String location) #
Returns: EmailIcsEvent

Sets the event location.

Parameters

location System.String requiredposition: 0
public EmailIcsEvent WithOrganizer(String email, String name = null) #
Returns: EmailIcsEvent

Sets the organizer (ORGANIZER).

Parameters

email System.String requiredposition: 0
name System.String = null optionalposition: 1
public EmailIcsEvent WithSummary(String summary) #
Returns: EmailIcsEvent

Sets the event summary (title).

Parameters

summary System.String requiredposition: 0
public EmailIcsEvent WithUid(String uid) #
Returns: EmailIcsEvent

Sets the event UID.

Parameters

uid System.String requiredposition: 0
public EmailIcsEvent WithUrl(String url) #
Returns: EmailIcsEvent

Sets the event URL (URI value type).

Parameters

url System.String requiredposition: 0
public EmailIcsEvent WithWhen(DateTimeOffset start, DateTimeOffset end) #
Returns: EmailIcsEvent

Sets start/end date-time for a timed event.

Parameters

start System.DateTimeOffset requiredposition: 0
end System.DateTimeOffset requiredposition: 1

Properties

public String Uid { get; set; } #

Globally unique event identifier (UID).

public String Summary { get; set; } #

Event title (SUMMARY).

public String Description { get; set; } #

Event description (DESCRIPTION).

public String Location { get; set; } #

Event location (LOCATION).

public String Url { get; set; } #

Optional event URL (URL).

public DateTimeOffset Start { get; set; } #

Event start time.

public Nullable<DateTimeOffset> End { get; set; } #

Event end time (optional). When empty, defaults to Start + 1 hour for timed events.

public Boolean AllDay { get; set; } #

When true, outputs DTSTART/DTEND as VALUE=DATE (all-day event).

public Nullable<DateTimeOffset> TimestampUtc { get; set; } #

Optional event created/updated timestamp used for DTSTAMP (UTC).

public String OrganizerEmail { get; set; } #

Optional organizer email (ORGANIZER).

public String OrganizerName { get; set; } #

Optional organizer display name (CN parameter).

public List<EmailIcsAttendee> Attendees { get; } #

Optional attendees for REQUEST-style invites.