X-Git-Url: http://git.maemo.org/git/?p=modest;a=blobdiff_plain;f=src%2Fmodest-tny-account-store.h;h=e67ccf9e05563939058af6a4b1fc3fe145a6a0fe;hp=e3cc541d5412e2802cbc84d4c2c0bca2ef3b729f;hb=8cb5d470d68036f3fc73156897144bafb83c78ef;hpb=9381d2949de3c1268e83284bd39a8ffb865ec851 diff --git a/src/modest-tny-account-store.h b/src/modest-tny-account-store.h index e3cc541..e67ccf9 100644 --- a/src/modest-tny-account-store.h +++ b/src/modest-tny-account-store.h @@ -1,13 +1,45 @@ +/* Copyright (c) 2006, Nokia Corporation + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are + * met: + * + * * Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * * Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * * Neither the name of the Nokia Corporation nor the names of its + * contributors may be used to endorse or promote products derived from + * this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS + * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED + * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A + * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER + * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, + * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, + * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR + * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF + * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING + * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + + /* modest-tny-account-store.h */ -/* insert (c)/licensing information) */ #ifndef __MODEST_TNY_ACCOUNT_STORE_H__ #define __MODEST_TNY_ACCOUNT_STORE_H__ #include +#include #include #include #include +#include +#include /* other include files */ @@ -32,60 +64,69 @@ struct _ModestTnyAccountStore { struct _ModestTnyAccountStoreClass { GObjectClass parent_class; - void (*password_requested) (ModestTnyAccountStore *self, - const gchar *account_name, - gpointer user_data); + void (*account_update) (ModestTnyAccountStore *self, + const gchar *account_name, + gpointer user_data); }; -/* member functions */ - /** * modest_tny_account_store_get_type: * - * Returns: GType of account store + * Returns: GType of the account store */ -GType modest_tny_account_store_get_type (void) G_GNUC_CONST; +GType modest_tny_account_store_get_type (void) G_GNUC_CONST; /** * modest_tny_account_store_new: - * @modest_acc_mgr: account manager to use for new account store + * @account_mgr: account manager to use for new account store * * creates new (tinymail) account store for account manager modest_acc_mgr * - * Returns: GObject of newly created account store + * Returns: newly created account store or NULL in case of error */ -GObject* modest_tny_account_store_new (ModestAccountMgr *modest_acc_mgr); +ModestTnyAccountStore* modest_tny_account_store_new (ModestAccountMgr *account_mgr); + /** - * modest_tny_account_store_get_account_mgr: - * @self: a TnyAccountStore instance - * - * retrieve the account manager associated with this account store. - * - * Returns: the account manager for @self. + * modest_tny_account_store_get_account_by_id + * @self: a ModestTnyAccountStore instance + * @id: some ID + * + * get the account with the given ID or NULL if it's not found + * + * Returns: the tnyaccount or NULL, + * g_object_unref when it's no longer needed */ -ModestAccountMgr *modest_tny_account_store_get_accout_mgr(ModestTnyAccountStore *self); +TnyAccount* modest_tny_account_store_get_tny_account_by_id (ModestTnyAccountStore *self, + const gchar *id); + /** - * tny_account_store_get_session: - * @self: a TnyAccountStore instance - * - * retrieve current tinymail camel session - * - * Returns: current tinymail camel session + * modest_tny_account_store_get_tny_account_by_account + * @self: a ModestTnyAccountStore instance + * @account_name: an account name + * @type: the tny account type + * + * get the tny account corresponding to one of the server_accounts for account with @account_name + * + * Returns: the tnyaccount or NULL in case it's not found or error, + * g_object_unref when it's no longer needed */ -TnySessionCamel* tny_account_store_get_session (TnyAccountStore *self); +TnyAccount* modest_tny_account_store_get_tny_account_by_account (ModestTnyAccountStore *self, + const gchar *account_name, + TnyAccountType type); /** - * tny_account_store_set_get_pass_func: + * tny_account_store_get_session * @self: a TnyAccountStore instance - * key: a key - * func: a function + * + * get the tny-camel-session for this account store. Note that this function + * does NOT have the modest_ prefix, as tinymail requires the symbol to be like this... * - * set the password function to function + * Returns: a tny-camel-session */ -void -modest_tny_account_store_set_get_pass_func (ModestTnyAccountStore *, ModestTnyGetPassFunc); +TnySessionCamel* tny_account_store_get_session (TnyAccountStore *self); + G_END_DECLS