Class AlarmBuilder
Builder for constructing Alarm instances.
Inherited Members
Namespace: DRIT.Mail.Rfc.ICal
Assembly: DRIT.Mail.dll
Syntax
public sealed class AlarmBuilder
Methods
View SourceAction(AlarmAction)
Sets the alarm action. Defaults to Display.
Declaration
public AlarmBuilder Action(AlarmAction action)
Parameters
| Type | Name | Description |
|---|---|---|
| AlarmAction | action | Specifies the action value. |
Returns
| Type | Description |
|---|---|
| AlarmBuilder |
Attach(string?)
Sets the attachment URI (for AUDIO/EMAIL/PROCEDURE actions).
Declaration
public AlarmBuilder Attach(string? attach)
Parameters
| Type | Name | Description |
|---|---|---|
| string | attach | Specifies the attach value. |
Returns
| Type | Description |
|---|---|
| AlarmBuilder |
Attendee(Attendee)
Adds an attendee (for EMAIL action).
Declaration
public AlarmBuilder Attendee(Attendee attendee)
Parameters
| Type | Name | Description |
|---|---|---|
| Attendee | attendee | Specifies the attendee value. |
Returns
| Type | Description |
|---|---|
| AlarmBuilder |
Build()
Builds the Alarm.
Declaration
public Alarm Build()
Returns
| Type | Description |
|---|---|
| Alarm |
Description(string?)
Sets the description (for DISPLAY/EMAIL actions).
Declaration
public AlarmBuilder Description(string? description)
Parameters
| Type | Name | Description |
|---|---|---|
| string | description | Specifies the description value. |
Returns
| Type | Description |
|---|---|
| AlarmBuilder |
Duration(ICalDuration?)
Sets the repeat duration.
Declaration
public AlarmBuilder Duration(ICalDuration? duration)
Parameters
| Type | Name | Description |
|---|---|---|
| ICalDuration | duration | Specifies the duration value. |
Returns
| Type | Description |
|---|---|
| AlarmBuilder |
Repeat(int)
Sets the repeat count.
Declaration
public AlarmBuilder Repeat(int count)
Parameters
| Type | Name | Description |
|---|---|---|
| int | count | The count value. |
Returns
| Type | Description |
|---|---|
| AlarmBuilder |
Summary(string?)
Sets the summary (for EMAIL action).
Declaration
public AlarmBuilder Summary(string? summary)
Parameters
| Type | Name | Description |
|---|---|---|
| string | summary | Specifies the summary value. |
Returns
| Type | Description |
|---|---|
| AlarmBuilder |
Trigger(ICalDateTime)
Sets the trigger as an absolute date-time.
Declaration
public AlarmBuilder Trigger(ICalDateTime dateTime)
Parameters
| Type | Name | Description |
|---|---|---|
| ICalDateTime | dateTime | The date time used by the operation. |
Returns
| Type | Description |
|---|---|
| AlarmBuilder |
Trigger(ICalDuration)
Sets the trigger as a duration relative to the start of the component.
Declaration
public AlarmBuilder Trigger(ICalDuration duration)
Parameters
| Type | Name | Description |
|---|---|---|
| ICalDuration | duration | Specifies the duration value. |
Returns
| Type | Description |
|---|---|
| AlarmBuilder |
Trigger(ICalDuration, AlarmTriggerRelated)
Sets the trigger as a duration relative to the specified point.
Declaration
public AlarmBuilder Trigger(ICalDuration duration, AlarmTriggerRelated related)
Parameters
| Type | Name | Description |
|---|---|---|
| ICalDuration | duration | Specifies the duration value. |
| AlarmTriggerRelated | related | Specifies the related value. |
Returns
| Type | Description |
|---|---|
| AlarmBuilder |