Back to index

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

import "calIGoogleSession.idl";

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

List of all members.

Public Member Functions

void invalidate ()
 Resets the Auth token and sets the persist attribute to false.
calIOperation getCalendars (in calIGenericOperationListener aListener)
 getCalendars Get the list of calendars for this session.
void asyncItemRequest (in calIGoogleRequest aRequest)
 asyncItemRequest Send a request to Google, logging in to the session if required.

Public Attributes

readonly attribute AUTF8String authToken
 The Authentication Token from Google.
readonly attribute AUTF8String userName
 The username for this session.
attribute boolean persist
 If set, the password will persist across restarts.
attribute AUTF8String fullName
 The user's full name, usually retrieved from the XML <author> fields.
attribute AUTF8String password
 The password used to authenticate.

Detailed Description

Definition at line 66 of file calIGoogleSession.idl.


Member Function Documentation

asyncItemRequest Send a request to Google, logging in to the session if required.

Parameters:
aRequestThe calIGoogleRequest to send

getCalendars Get the list of calendars for this session.

The operaion listener will be called with an array of calIGoogleCalendars.

Parameters:
aListenerThe listener to call when the calendars were retrieved

Resets the Auth token and sets the persist attribute to false.


Member Data Documentation

The Authentication Token from Google.

Definition at line 70 of file calIGoogleSession.idl.

The user's full name, usually retrieved from the XML <author> fields.

If unset, this will return the userName attribute.

Definition at line 87 of file calIGoogleSession.idl.

The password used to authenticate.

It is only important to implement the setter here, since the password is only used internally.

Definition at line 93 of file calIGoogleSession.idl.

If set, the password will persist across restarts.

Definition at line 81 of file calIGoogleSession.idl.

readonly attribute AUTF8String calIGoogleSession::userName

The username for this session.

To get a session with a different username, use calIGoogleSessionManager.

Definition at line 76 of file calIGoogleSession.idl.


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