Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
calIIcalComponent Interface Reference

General notes: More...

import "calIICSService.idl";

Inheritance diagram for calIIcalComponent:
Inheritance graph
[legend]
Collaboration diagram for calIIcalComponent:
Collaboration graph
[legend]

List of all members.

Public Member Functions

calIIcalComponent getFirstSubcomponent (in AUTF8String componentType)
calIIcalComponent getNextSubcomponent (in AUTF8String componentType)
AUTF8String serializeToICS ()
AUTF8String toString ()
 Return a string representation of this instance.
nsIInputStream serializeToICSStream ()
 Serializes this component (and subcomponents) directly to an input stream.
void addSubcomponent (in calIIcalComponent comp)
calIIcalProperty getFirstProperty (in AUTF8String kind)
calIIcalProperty getNextProperty (in AUTF8String kind)
void addProperty (in calIIcalProperty prop)
void addTimezoneReference (in calITimezone aTimezone)
 Timezones need special handling, as they must be emitted as children of VCALENDAR, but can be referenced by any sub component.
void getReferencedTimezones (out PRUint32 aCount,[array, size_is(aCount), retval] out calITimezone aTimezones)
 Returns an array of VTIMEZONE components.
calIIcalComponent clone ()
 Clones the component.
icalcomponentptr getIcalComponent ()
icaltimezoneptr getIcalTimezone ()

Public Attributes

const PRInt32 INVALID_VALUE = -1
 This is the value that an integer-valued getter will provide if there is no such property on the wrapped ical structure.
readonly attribute AUTF8String componentType
attribute AUTF8String uid
attribute AUTF8String prodid
attribute AUTF8String version
attribute AUTF8String method
 PUBLISH, REQUEST, REPLY, etc.
attribute AUTF8String status
 TENTATIVE, CONFIRMED, CANCELLED, etc.
attribute AUTF8String transp
 OPAQUE, TRANSPARENT, etc.
attribute AUTF8String summary
attribute AUTF8String description
attribute AUTF8String location
attribute AUTF8String categories
attribute AUTF8String URL
attribute PRInt32 priority
attribute AUTF8String icalClass
 PUBLIC, PRIVATE, CONFIDENTIAL, etc.
attribute calIDateTime startTime
attribute calIDateTime endTime
readonly attribute calIDuration duration
attribute calIDateTime dueTime
attribute calIDateTime stampTime
attribute calIDateTime createdTime
attribute calIDateTime completedTime
attribute calIDateTime lastModified
attribute calIDateTime recurrenceId
 The recurrence ID, a.k.a.

Detailed Description

General notes:

As with libical, use of getNextFoo(footype) is only valid if there have been no intervening getNextFoo(otherfootype)s, or removeFoo()s, or addFoo()s. In general, you want to do as little manipulation of your FooContainers as possible while iterating over them.

Definition at line 68 of file calIICSService.idl.


Member Function Documentation

Timezones need special handling, as they must be emitted as children of VCALENDAR, but can be referenced by any sub component.

Adding a second timezone (of the same TZID) will remove the first one.

Clones the component.

The cloned component is decoupled from any parent.

Returns:
cloned component
Parameters:
kindANY, ATTENDEE, X-WHATEVER, etc.
Parameters:
kindANY, XROOT, VCALENDAR, VEVENT, etc.
void calIIcalComponent::getReferencedTimezones ( out PRUint32  aCount,
[array, size_is(aCount), retval] out calITimezone  aTimezones 
)

Returns an array of VTIMEZONE components.

These are the timezones that are in use by this component and its children.

Serializes this component (and subcomponents) directly to an input stream.

Typically used for performance to avoid unnecessary conversions and XPConnect traversals.

Returns:
an input stream which can be read to get the serialized version of this component, encoded in UTF-8. Implements nsISeekableStream so that it can be used with nsIUploadChannel.
AUTF8String calIIcalComponent::toString ( )

Return a string representation of this instance.


Member Data Documentation

Definition at line 106 of file calIICSService.idl.

Definition at line 123 of file calIICSService.idl.

Definition at line 82 of file calIICSService.idl.

Definition at line 122 of file calIICSService.idl.

Definition at line 104 of file calIICSService.idl.

Definition at line 119 of file calIICSService.idl.

Definition at line 118 of file calIICSService.idl.

Definition at line 117 of file calIICSService.idl.

PUBLIC, PRIVATE, CONFIDENTIAL, etc.

Definition at line 114 of file calIICSService.idl.

This is the value that an integer-valued getter will provide if there is no such property on the wrapped ical structure.

Definition at line 74 of file calIICSService.idl.

Definition at line 124 of file calIICSService.idl.

Definition at line 105 of file calIICSService.idl.

PUBLISH, REQUEST, REPLY, etc.

Definition at line 91 of file calIICSService.idl.

Definition at line 109 of file calIICSService.idl.

Definition at line 85 of file calIICSService.idl.

The recurrence ID, a.k.a.

DTSTART-of-calculated-occurrence, or null if this isn't an occurrence.

Definition at line 130 of file calIICSService.idl.

Definition at line 120 of file calIICSService.idl.

Definition at line 116 of file calIICSService.idl.

TENTATIVE, CONFIRMED, CANCELLED, etc.

Definition at line 96 of file calIICSService.idl.

Definition at line 103 of file calIICSService.idl.

OPAQUE, TRANSPARENT, etc.

Definition at line 101 of file calIICSService.idl.

Definition at line 84 of file calIICSService.idl.

Definition at line 107 of file calIICSService.idl.

Definition at line 86 of file calIICSService.idl.


The documentation for this interface was generated from the following file: