Class CalComponentAlarm

Hierarchy

CalComponentAlarm

Index

Constructors

constructor

Properties

name

Methods

Constructors

constructor

new CalComponentAlarm(): CalComponentAlarm

Returns CalComponentAlarm

Properties

Static name

name: string

Methods

free

free(): void

- Defined in ECalendar-1.2.d.ts:1935
Frees an alarm structure.

Returns void

getAction

getAction(action: CalComponentAlarmAction): void

- Defined in ECalendar-1.2.d.ts:1940
Queries the action type of an alarm.

Parameters
- action: CalComponentAlarmAction
  
  Return value for the alarm's action type.
Returns void

getAttendeeList

getAttendeeList(): CalComponentAttendee[]

- Defined in ECalendar-1.2.d.ts:1944
Gets the list of attendees associated with an alarm.

Returns CalComponentAttendee[]

getDescription

getDescription(description: CalComponentText): void

- Defined in ECalendar-1.2.d.ts:1949
Queries the description property of an alarm.

Parameters
- description: CalComponentText
  
  Return value for the description property and its parameters.
Returns void

getRepeat

getRepeat(repeat: CalComponentAlarmRepeat): void

- Defined in ECalendar-1.2.d.ts:1954
Queries the repeat/duration properties of an alarm.

Parameters
- repeat: CalComponentAlarmRepeat
  
  Return value for the repeat/duration properties.
Returns void

getTrigger

getTrigger(trigger: CalComponentAlarmTrigger): void

- Defined in ECalendar-1.2.d.ts:1959
Queries the trigger time for an alarm.

Parameters
- trigger: CalComponentAlarmTrigger
  
  Return value for the trigger time.
Returns void

getUid

getUid(): string

- Defined in ECalendar-1.2.d.ts:1963
Queries the unique identifier of an alarm subcomponent.

Returns string

hasAttendees

hasAttendees(): boolean

- Defined in ECalendar-1.2.d.ts:1967
Queries an alarm to see if it has attendees associated with it.

Returns boolean

setAction

setAction(action: CalComponentAlarmAction): void

- Defined in ECalendar-1.2.d.ts:1972
Sets the action type for an alarm.

Parameters
- action: CalComponentAlarmAction
  
  Action type.
Returns void

setAttendeeList

setAttendeeList(attendeeList: CalComponentAttendee[]): void

- Defined in ECalendar-1.2.d.ts:1977
Sets the list of attendees for an alarm.

Parameters
- attendeeList: CalComponentAttendee[]
  
  List of attendees.
Returns void

setDescription

setDescription(description: CalComponentText): void

- Defined in ECalendar-1.2.d.ts:1982
Sets the description property of an alarm.

Parameters
- description: CalComponentText
  
  Description property and its parameters, or NULL for no description.
Returns void

setRepeat

setRepeat(repeat: CalComponentAlarmRepeat): void

- Defined in ECalendar-1.2.d.ts:1987
Sets the repeat/duration values for an alarm.

Parameters
- repeat: CalComponentAlarmRepeat
  
  Repeat/duration values. To remove any repetitions from the alarm, set the repeat.repetitions to 0.
Returns void

setTrigger

setTrigger(trigger: CalComponentAlarmTrigger): void

- Defined in ECalendar-1.2.d.ts:1992
Sets the trigger time of an alarm.

Parameters
- trigger: CalComponentAlarmTrigger
  
  Trigger time structure.
Returns void