Back to index

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

calIItipItem is an interface used to carry information between the mime parser, the imip-bar UI, and the iTIP processor. More...

import "calIItipItem.idl";

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

List of all members.

Public Member Functions

void init (in AUTF8String icalData)
 Initializes the item with an ics string.
calIItipItem clone ()
 Creates a new calItipItem with the same attributes as the one that clone() is called upon.
void getItemList (out unsigned long itemCount,[retval, array, size_is(itemCount)] out calIItemBase items)
 Get the list of items that are encapsulated in this calIItipItem.
calIItemBase modifyItem (in calIItemBase item)
 Get the first item from the iTIP message Bug XXX 351761: Need to find a way to make this use an nsISimpleEnumerator.
void setAttendeeStatus (in AString attendeeId, in AString status)
 Modifies the state of the given attendee in the item's ics.

Public Attributes

attribute PRBool isSend
 Attribute: isSend - set to TRUE when sending this item to initiate an iMIP communication.
attribute AUTF8String receivedMethod
 Attribute: receivedMethod - method the iTIP item had upon reciept.
attribute AUTF8String responseMethod
 Attribute: responseMethod - method that the protocol handler (or the user) decides to use to respond to the iTIP item (could be COUNTER, REPLY, DECLINECOUNTER, etc)
attribute unsigned long autoResponse
 Attribute: autoResponse Set to one of the three constants below.
const unsigned long AUTO = 0
 Used to tell the iTIP processor to use an automatic response when handling this iTIP item.
const unsigned long USER = 1
 Used to tell the iTIP processor to allow the user to edit the response.
const unsigned long NONE = 2
 Used to tell the iTIP processor not to respond at all.
attribute calICalendar targetCalendar
 Attribute: targetCalendar - the calendar that this thing should be stored in, if it should be stored onto a calendar.
attribute AUTF8String identity
 The identity this item was received on.
attribute AUTF8String localStatus
 localStatus: The response that the user has made to the invitation in this ItipItem.

Detailed Description

calIItipItem is an interface used to carry information between the mime parser, the imip-bar UI, and the iTIP processor.

It encapsulates a list of calIItemBase objects and provides specialized iTIP methods for those items.

Definition at line 52 of file calIItipItem.idl.


Member Function Documentation

Creates a new calItipItem with the same attributes as the one that clone() is called upon.

void calIItipItem::getItemList ( out unsigned long  itemCount,
[retval, array, size_is(itemCount)] out calIItemBase  items 
)

Get the list of items that are encapsulated in this calIItipItem.

Returns:
An array of calIItemBase items that are inside this calIItipItem
void calIItipItem::init ( in AUTF8String  icalData)

Initializes the item with an ics string.

Parameters:
-in parameter - AString of ical Data

Get the first item from the iTIP message Bug XXX 351761: Need to find a way to make this use an nsISimpleEnumerator.

Returns:
calIItemBase

calIItemBase getFirstItem(); Get next item from the iTIP message. If there is no next item then it returns NULL

Returns:
calIItemBase

calIItemBase getNextItem(); Modifies a calIItemBase that is in the component list. Internally, the interface will update the proper component. It does this via the UID of the component by calling hasSameIds().

Parameters:
inparameter - item to modify
Returns:
returns the new calIItemBase object for convienence
void calIItipItem::setAttendeeStatus ( in AString  attendeeId,
in AString  status 
)

Modifies the state of the given attendee in the item's ics.

Parameters:
attendeeId- AString containing attendee address
status- AString containing the new attendee status

Member Data Documentation

Used to tell the iTIP processor to use an automatic response when handling this iTIP item.

Definition at line 97 of file calIItipItem.idl.

Attribute: autoResponse Set to one of the three constants below.

Definition at line 91 of file calIItipItem.idl.

The identity this item was received on.

Helps to determine which attendee to manipulate. This should be the full email address of the attendee that is considered to be the local user.

Definition at line 120 of file calIItipItem.idl.

Attribute: isSend - set to TRUE when sending this item to initiate an iMIP communication.

This will be used by the iTIP processor to route the item directly to the email subsystem so that communication can be initiated. For example, if you are Sending a REQUEST, you would set this flag, and send the iTIP Item into the iTIP processor, which would handle everything else.

Definition at line 74 of file calIItipItem.idl.

localStatus: The response that the user has made to the invitation in this ItipItem.

Definition at line 126 of file calIItipItem.idl.

Used to tell the iTIP processor not to respond at all.

Definition at line 107 of file calIItipItem.idl.

Attribute: receivedMethod - method the iTIP item had upon reciept.

Definition at line 79 of file calIItipItem.idl.

Attribute: responseMethod - method that the protocol handler (or the user) decides to use to respond to the iTIP item (could be COUNTER, REPLY, DECLINECOUNTER, etc)

Definition at line 86 of file calIItipItem.idl.

Attribute: targetCalendar - the calendar that this thing should be stored in, if it should be stored onto a calendar.

This is a calendar ID

Definition at line 113 of file calIItipItem.idl.

Used to tell the iTIP processor to allow the user to edit the response.

Definition at line 102 of file calIItipItem.idl.


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