calendar/providers/wcap/public/calIWcapSession.idl
author tbirdbld
Mon, 14 Nov 2016 03:02:33 -0800
changeset 26104 e95d9bd956af9a8e8506d857af298d14ef1e36fc
parent 15512 72f565c70050bcd991449c8e7543d91b5077abdf
child 34097 fe9337e031b81a7a57d4903a9747af2eec51f7ef
permissions -rwxr-xr-x
No bug, Automated blocklist update from host bld-linux64-spot-340 - a=blocklist-update

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#include "nsISupports.idl"

interface calIWcapCalendar;
interface nsIURI;


/**
 * WCAP session.
 */
[scriptable, uuid(477B4534-C297-40a1-ADF2-5A7E2A81816A)]
interface calIWcapSession : nsISupports
{
    /**
     * Setting this URI causes the session to logged out and disconnected.
     */
    attribute nsIURI uri;

    /**
     * User that has established this session.
     * @exception NS_ERROR_NOT_AVAILABLE if not logged in
     */
    readonly attribute string userId;

    /**
     * Determines whether the user is currentl logged in.
     * Does _not_ check whether the user's ticket has timed out!
     */
    readonly attribute boolean isLoggedIn;

    /**
     * Gets the default calendar instance of this session.
     */
    readonly attribute calIWcapCalendar defaultCalendar;
};