Alarm Class

Represents alarm calendar entity. You can use AddAlarm or AddAlarm(Alarm) to add alarm to event. You can check Alarms collection to get alarms defined for a event.

Inheritance Hierarchy

SystemObject
Limilabs.Mail.PDIBasePdiEntity
Limilabs.Mail.AppointmentsAlarm

Namespace: Limilabs.Mail.Appointments
Assembly: Mail (in Mail.dll) Version: 3.0.26106.1555

Syntax

C++

Copy

[SerializableAttribute]
public class Alarm : BasePdiEntity

<SerializableAttribute>
Public Class Alarm
	Inherits BasePdiEntity

[SerializableAttribute]
public ref class Alarm : public BasePdiEntity

[<SerializableAttribute>]
type Alarm = 
    class
        inherit BasePdiEntity
    end

The Alarm type exposes the following members.

Constructors

	Name	Description
	Alarm	Creates new event entity

Top

Properties

	Name	Description
	Action	Gets or sets alarm action (display, audio).
	AlarmOffset	Gets alarm offset. Offset is relative to RelativeTo property.
	AlarmTime	Gets exact alarm time (Always converted to the UTC value).
	Description	Gets or sets alarm description.
	RelativeTo	Gets relative to information of AlarmOffset.

Top

Methods

	Name	Description
	AddCustomHeader	Adds custom header to this entity. (Inherited from BasePdiEntity)
	BeforeEnd	Sets the alarm time offset relative to end of the event.
	BeforeStart	Sets the alarm time offset relative to start of the event.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	ExactlyAt	Sets the alarm time to precise date and time.
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetHeader	Gets header with specified key from this calendar entity. (Inherited from BasePdiEntity)
	GetHeaders	Gets header with specified key from this calendar entity. (Inherited from BasePdiEntity)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	RenderFinal	Renders this entity as a string. (Inherited from BasePdiEntity)
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Remarks


            BEGIN:VALARM
            ACTION:DISPLAY
            DESCRIPTION:REMINDER
            TRIGGER;RELATED=START:-PT15M
            END:VALARM

Reference

Limilabs.Mail.Appointments Namespace