b8bbe53425
Publicly, get objects for a variant rather than from it since we're not actually getting the objects from the variant, just looking them up using the variant as an id. Internally, use `to_` rather than `get_` when converting between plugin and engine objects, since its typically just a cast or a lookup to do so.
47 lines
1.4 KiB
Vala
47 lines
1.4 KiB
Vala
/*
|
|
* Copyright © 2020 Michael Gratton <mike@vee.net>
|
|
*
|
|
* This software is licensed under the GNU Lesser General Public License
|
|
* (version 2.1 or later). See the COPYING file in this distribution.
|
|
*/
|
|
|
|
/**
|
|
* Provides plugins with access to email.
|
|
*
|
|
* Plugins that implement the {@link EmailExtension} interface may
|
|
* obtain instances of this object by calling {@link
|
|
* EmailContext.get_email_store} on their {@link EmailExtension.email}
|
|
* property.
|
|
*/
|
|
public interface Plugin.EmailStore : Geary.BaseObject {
|
|
|
|
|
|
/**
|
|
* The type of variant email identifiers.
|
|
*
|
|
* @see EmailIdentifier.to_variant
|
|
* @see get_email_identifier_for_variant
|
|
*/
|
|
public abstract GLib.VariantType email_identifier_variant_type { get; }
|
|
|
|
/** Emitted when an email has been displayed in the UI. */
|
|
public signal void email_displayed(Email sent);
|
|
|
|
/** Emitted when an email has been sent. */
|
|
public signal void email_sent(Email sent);
|
|
|
|
/** Returns the email with the given identifiers. */
|
|
public async abstract Gee.Collection<Email> get_email(
|
|
Gee.Collection<EmailIdentifier> ids,
|
|
GLib.Cancellable? cancellable
|
|
) throws GLib.Error;
|
|
|
|
/**
|
|
* Returns the email identifier specified by the given variant, if any.
|
|
*
|
|
* @see EmailIdentifier.to_variant
|
|
* @see email_identifier_variant_type
|
|
*/
|
|
public abstract EmailIdentifier? get_email_identifier_for_variant(GLib.Variant id);
|
|
|
|
}
|