Click or drag to resize

iCal Class

Supports construction and attachment to an email message of an iCalendar scheduling item that can be used to communicate schedule items to a scheduling application such as Microsoft Outlook. See http://www.kanzaki.com/docs/ical/ for a good iCalendar specification. See http://www.ietf.org/rfc/rfc2445.txt for the official iCalendar specification.
Inheritance Hierarchy
SystemObject
  NetQuarry.MailiCal

Namespace:  NetQuarry.Mail
Assembly:  EAP.Core (in EAP.Core.dll) Version: 2.0.0.0 (4.6.8.0)
Syntax
public class iCal

The iCal type exposes the following members.

Constructors
  NameDescription
Public methodiCal
Standard constructor.
Top
Properties
  NameDescription
Public propertyCompany
Gets/sets the company originating the iCalendar. Together with the Product and Language, this is used to construct the ProductID (PRODID). The default is "NetQuarry".
Public propertyCreated
Gets/sets the created date/time (CREATED) for the iCalendar item, in UTC.
Public propertyDescription
Gets/sets the description (DESCRIPTION) for the iCalendar.
Public propertyEnd
Gets/sets the end date/time (DTEND) for the iCalendar item, in UTC.
Public propertyFilename
Gets/sets the filename for the iCalendar object. The Filename should not have an extension or path. The current default value is "meeting".
Public propertyFullFilename
Gets the full iCalendar filename (with a .ics extension) based on the Filename. The default is "meeting.ics".
Public propertyID
Gets/sets the iCalendar unique identifier (UID). The ID is used to associate a series of iCalendar items as pertaining to the same schedule item. For example, creating a new meeting, rescheduling the meeting, then cancelling the meeting. The series of related items sharing the same ID are ordered according to the SequenceNumber
Public propertyLanguage
Gets/sets the company originating the iCalendar. Together with the Company and Product, this is used to construct the ProductID (PRODID). The default is "EN".
Public propertyLocation
Gets/sets the location (LOCATION) for the iCalendar.
Public propertyOrganizerEmail
The email of the organizer of the iCalendar item. This is used for the "mailto" part of the "ORGANIZER" portion of the iCalendar which is combined with OrganizerName using CalAddress(String, String) to specify the organizer (ORGANIZER).
Public propertyOrganizerName
The name of the organizer of the iCalendar item. This is used for the "CN" part of the "ORGANIZER" portion of the iCalendar which is combined with OrganizerEmail using CalAddress(String, String) to specify the organizer (ORGANIZER).
Public propertyPrivacy
Gets/sets the "CLASS" attribute. Values can be: PUBLIC (default), PRIVATE or CONFIDENTIAL
Public propertyProduct
Gets/sets the product originating the iCalendar. Together with the Company and Language, this is used to construct the ProductID (PRODID). The default is obtained from the "TITLE" property of the IAppContext.
Public propertyRecurrence
Gets/Sets the Recurrence pattern for this appointment
Public propertyReminderMinutes
Gets/sets how many minutes before the iCalendar Start time a reminder should be given to the user in his scheduling system. If the value is zero or less then no reminder is specified. If a reminder is specified, the constructed iCalendar will include a VALARM with a TRIGGER. The current default is 15 minutes, however, this is subject to change in the future and a specific value should be provided if a specific reminder period is desired.
Public propertyResources
Gets/sets the resources (RESOURCE:) for the iCalendar.
Public propertySequenceNumber
Gets/sets the iCalendar sequence number (SEQUENCE) identifying the order of iCalendar items sharing the same ID (UID).
Public propertyStart
Gets/sets the start date/time (DTSTART) for the iCalendar item, in UTC.
Public propertySubject
The subject (SUMMARY) of the iCalendar item.
Public propertyTimeZone
Gets/Sets the timezone TimeZone object.
Public propertyTZID
Gets/Sets the TZID to use for Start/End date
Public propertyURL
Gets/Sets the URL for the iCalendar
Top
Methods
  NameDescription
Public methodAsAttachment
Construct the iCalendar file in memory and return it as an email attachment. Internally GetContent(iCalNotificationType, String) is used to construct the iCalendar text.
Public methodAsAttachments
Construct the iCalendar file in memory and return it as an email attachment in a single-item array of attachments. In this form the iCalendar is ready for immediate use when sending an email with no additional attachments. Internally GetContent(iCalNotificationType, String) is used to construct the iCalendar text and AsAttachment(iCalNotificationType, String) is used to construct the attachment.
Public methodCalAddress
Constructs an iCalendar MAILTO URI as defined by RFC 1738.
Public methodCreateGotoMeeting
IN DEVELOPMENT - Generates a GotoMeeting invitation to be included in the iCalendar Description.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetContent
Gets the iCalendar content string. Normally this is included as the content for a textfile attachment, with a .ics extension, to an email
Public methodGetEventContent
Returns the event content
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodStatic memberGetSubscription
Gets a VCALENDAR subscription for the provided list of events.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Top
Extension Methods
  NameDescription
Public Extension MethodEqualValue
Determines if the object value is equal to another object. If the two objects are null, then this returns true. There is special handling for guid comparisons (since a guid could be a string formatted in up to 3 different ways). If the special guid handling is not performed, then the object.Equals method is used.
(Defined by EAPUtil.)
Top
See Also