VAlarm class - enough_icalendar library

Constructors

VAlarm({VComponent? parent})

Properties

action ↔ AlarmAction: Retrieves the action in case it is one described by the icalendar standard or AlarmAction.other in other cases.
getter/setter pair
actionText ↔ String?: Retrieve the alarm action as a text.
getter/setter pair
attachments ↔ List<AttachmentProperty>: Retrieves the attachments
getter/setter pair
attendees ↔ List<AttendeeProperty>: Retrieves the attendees
getter/setter pair
canReply → bool: Checks if this component can reply in its current state
no setterinherited
children → List<VComponent>: The children of this component, empty when there a no children
finalinherited
componentType → VComponentType: The type of the component, convenient for switch cases
finalinherited
description ↔ String?: Retrieves the description
getter/setter pair
duration ↔ IsoDuration?: Retrieves the duration of the alarm
getter/setter pair
hashCode → int: The hash code for this object.
no setterinherited
isVersion2 → bool: Checks if this version is 2.0, which is assumed to be true unless a different version is specified.
no setterinherited
name → String: The name of the component like VEVENT or VCALENDAR
finalinherited
parent → VComponent?: The parent component, if any
finalinherited
productId ↔ String?: Retrieves the product identifier that generated this iCalendar object
getter/setter pairinherited
properties → List<Property>: The properties of the component
finalinherited
repeat ↔ int: How often the alarm can be repeated, defaults to 0, ie no additional repeats after the first alaram.
getter/setter pair
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
summary ↔ String?: Gets the summmary / title
getter/setter pair
trigger ← TriggerProperty?: Sets the trigger, this is useful when you also want to specify the AlarmTriggerRelationship, for example
no getter
triggerDate ↔ DateTime?: Retrieves the date of the trigger.
getter/setter pair
triggerRelation → AlarmTriggerRelationship: Resolves if the triggerRelativeDuration is calculated in relation to the VEvent.start or VEvent.end time.
no setter
triggerRelativeDuration ↔ IsoDuration?: Retrieves the relative duration of the trigger, e.g. -15 minutes (-PT15M) as a reminder before an event starts.
getter/setter pair
version ↔ String?: Gets the version of this calendar, typically 2.0
getter/setter pairinherited

Methods

addAttachment(AttachmentProperty attachment) → void: Adds the given attachment
addAttendee(AttendeeProperty attendee) → void: Adds the given attendee
checkMandatoryProperty(String name) → void: Checks if the property with the given name is present.
inherited
checkValidity() → void: Classes can implement this to check the validity.
override
copy() → VComponent: Copies this component
inherited
findProperties(String propertyName) → Iterable<Property>: Retrieves all properties with the name propertyName
inherited
getProperties<T extends Property>(String propertyName) → Iterable<T>: Retrieves all matching properties with the name propertyName.
inherited
getProperty<T extends Property>(String propertyName) → T?: Retrieves the property with the propertyName
inherited
instantiate({VComponent? parent}) → VComponent: Creates a new instance of this component
override
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
removeAttachment(AttachmentProperty attachment) → bool: Removes the given attachment returning true when the attachment was found
removeAttachmentWithUri(Uri uri) → AttachmentProperty?: Removes the attachment with the given uri, returning it when it was found.
removeAttendee(AttendeeProperty attendee) → bool: Removes the given attendee returning true when the attendee was found
removeAttendeeWithEmail(String email) → AttendeeProperty?: Removes the attendee with the given email, returning it when it was found.
removeAttendeeWithUri(Uri uri) → AttendeeProperty?: Removes the attendee with the given uri, returning it when it was found.
removeProperty(String propertyName) → void: Removes all properties with the specified propertyName
inherited
render(StringBuffer buffer) → void: inherited
reply(AttendeeProperty attendee, {VComponent? parent, String? comment}) → VComponent: Creates a reply for this component.
inherited
setOrRemoveProperties(String propertyName, List<Property>? props) → void: Sets or removes the given props with the given propertyName
inherited
setOrRemoveProperty(String propertyName, Property? property) → void: Sets the given property when it is not null and otherwise removes the property with the given propertyName.
inherited
setProperties(String propertyName, List<Property> props) → void: Sets the given props by first removing any properties with the given propertyName.
inherited
setProperty(Property property) → void: Sets the property property, replacing other properties with the property.name first.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited
operator [](String propertyName) → Property?: Retrieves the first property with the name propertyName
inherited
operator []=(String propertyName, Property property) → void: Sets the property property, replacing other properties with the given propertyName first.
inherited

Constants

componentName → const String