Class Alarm

An alarm (RFC 5545 §3.6.6), a sub-component of VEVENT or VTODO.

Inheritance
object
Alarm
Inherited Members
Namespace: DRIT.Mail.Rfc.ICal
Assembly: DRIT.Mail.dll
Syntax
public sealed class Alarm

Constructors

View Source

Alarm(AlarmAction, AlarmTrigger, string?, string?, int?, ICalDuration?, IReadOnlyList<Attendee>?, string?)

Initializes a new instance of the Alarm class.

Declaration
public Alarm(AlarmAction action, AlarmTrigger trigger, string? description = null, string? summary = null, int? repeat = null, ICalDuration? duration = null, IReadOnlyList<Attendee>? attendees = null, string? attach = null)
Parameters
Type Name Description
AlarmAction action
AlarmTrigger trigger
string description
string summary
int? repeat
ICalDuration duration
IReadOnlyList<Attendee> attendees
string attach

Properties

View Source

Action

Gets the alarm action (AUDIO, DISPLAY, EMAIL, PROCEDURE).

Declaration
public AlarmAction Action { get; }
Property Value
Type Description
AlarmAction
View Source

Attach

Gets the attachment URI (for AUDIO/EMAIL/PROCEDURE actions), or null.

Declaration
public string? Attach { get; }
Property Value
Type Description
string
View Source

Attendees

Gets the attendees (for EMAIL action). May be empty.

Declaration
public IReadOnlyList<Attendee> Attendees { get; }
Property Value
Type Description
IReadOnlyList<Attendee>
View Source

Description

Gets the description (for DISPLAY/EMAIL actions), or null.

Declaration
public string? Description { get; }
Property Value
Type Description
string
View Source

Duration

Gets the repeat duration, or null.

Declaration
public ICalDuration? Duration { get; }
Property Value
Type Description
ICalDuration
View Source

Repeat

Gets the repeat count, or null if the alarm does not repeat.

Declaration
public int? Repeat { get; }
Property Value
Type Description
int?
View Source

Summary

Gets the summary (for EMAIL action), or null.

Declaration
public string? Summary { get; }
Property Value
Type Description
string
View Source

Trigger

Gets the alarm trigger.

Declaration
public AlarmTrigger Trigger { get; }
Property Value
Type Description
AlarmTrigger