Back to index

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

calIItipTransport is a generic transport interface that is implemented by transports (eg: email, XMPP, etc.) wishing to send calIItipItems More...

import "calIItipTransport.idl";

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

List of all members.

Public Member Functions

void sendItems (in PRUint32 count,[array, size_is(count)] in calIAttendee recipientArray, in calIItipItem item)
 Sends a calIItipItem to the recipients using the specified title and alternative representation.

Public Attributes

readonly attribute AUTF8String defaultIdentity
 Default identity for me within this transport.
readonly attribute AUTF8String scheme
 Scheme to be used to prefix attendees.
attribute AUTF8String senderAddress
 Sending identity.
readonly attribute AUTF8String type
 Type of the transport: email, xmpp, etc.

Detailed Description

calIItipTransport is a generic transport interface that is implemented by transports (eg: email, XMPP, etc.) wishing to send calIItipItems

Definition at line 50 of file calIItipTransport.idl.


Member Function Documentation

void calIItipTransport::sendItems ( in PRUint32  count,
[array, size_is(count)] in calIAttendee  recipientArray,
in calIItipItem  item 
)

Sends a calIItipItem to the recipients using the specified title and alternative representation.

If a calIItipItem is attached, then an ICS representation of those objects are generated and attached to the email. If the calIItipItem is null, then the item(s) is sent without any text/calendar mime part.

Parameters:
countsize of recipient array
recipientArrayarray of recipients
calIItipItemset of calIItems encapsulated as calIItipItems

Member Data Documentation

Default identity for me within this transport.

For example, this is your default email address in Thunderbird.

XXX This should probably go away, using the default identity is far from practical. Only user right now is calUtils's sendItipInvitation. See bug 431126.

Definition at line 60 of file calIItipTransport.idl.

readonly attribute AUTF8String calIItipTransport::scheme

Scheme to be used to prefix attendees.

For example, the Email transport should reuturn "mailto".

Definition at line 66 of file calIItipTransport.idl.

Sending identity.

This can be set to change the "sender" identity from defaultIdentity above.

Definition at line 72 of file calIItipTransport.idl.

readonly attribute AUTF8String calIItipTransport::type

Type of the transport: email, xmpp, etc.

Definition at line 77 of file calIItipTransport.idl.


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