Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
calIIcsSerializer Interface Reference

An interface for serializing calendar items into an ICS string. More...

import "calIIcsSerializer.idl";

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

List of all members.

Public Member Functions

void addItems ([array, size_is(aCount)] in calIItemBase aItems, in unsigned long aCount)
 Add some items to the items that are to be serialized.
void addProperty (in calIIcalProperty aProperty)
 Add a property to the top-level properties to be added on serializing.
void addComponent (in calIIcalComponent aComponent)
 Add a component to the top-level components to be added on serializing.
AString serializeToString ()
 Serialize the added items, properties and components into an ICS string.
nsIInputStream serializeToInputStream ()
 Serialize the added items, properties and components into an ICS stream.
void serializeToStream (in nsIOutputStream aStream)
 Serialize the added items, properties and components into an ICS stream.

Detailed Description

An interface for serializing calendar items into an ICS string.

Note that this is not a service. A new instance must be created for every new set of items to be serialized.

Definition at line 52 of file calIIcsSerializer.idl.


Member Function Documentation

Add a component to the top-level components to be added on serializing.

Can be called multiple times, and appends to the set on every call.

Parameters:
aComponentThe component to be added
void calIIcsSerializer::addItems ( [array, size_is(aCount)] in calIItemBase  aItems,
in unsigned long  aCount 
)

Add some items to the items that are to be serialized.

Can be called multiple times, and appends to the set on every call.

Parameters:
aItemsThe items to be added
aCountThe number of items to add

Add a property to the top-level properties to be added on serializing.

Can be called multiple times, and appends to the set on every call.

Parameters:
aPropertyThe property to be added

Serialize the added items, properties and components into an ICS stream.

Returns:
A stream containing the serialized items, properties and components.

Serialize the added items, properties and components into an ICS stream.

Parameters:
aStreamA stream into which the serialized items, properties and components will be written.

Serialize the added items, properties and components into an ICS string.

Returns:
A string containing the serialized items, properties and components.

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