[geary/mjog/plugin-problem-reports: 1/3] Plugin.Application: Add support for reporting problems




commit cceb9a860dfcdfe4bfef1785934209d5b7a0ab2f
Author: Michael Gratton <mike vee net>
Date:   Tue Jul 7 09:54:23 2020 +1000

    Plugin.Application: Add support for reporting problems

 src/client/plugin/plugin-application.vala | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
---
diff --git a/src/client/plugin/plugin-application.vala b/src/client/plugin/plugin-application.vala
index 19bb837c5..52ae110f3 100644
--- a/src/client/plugin/plugin-application.vala
+++ b/src/client/plugin/plugin-application.vala
@@ -61,4 +61,20 @@ public interface Plugin.Application : Geary.BaseObject {
     public abstract async void empty_folder(Folder folder)
         throws Error.PERMISSION_DENIED;
 
+
+    /**
+     * Displays problem report for an error.
+     *
+     * Calling this method will display a problem report for the
+     * plugin with a given error so that both people using the
+     * application are aware that an error condition exists, and that
+     * they may report the problem to developers.
+     *
+     * Since displaying an error report causes visual and workflow
+     * disruptions, and as such this method called with care and only
+     * when necessary. For logging, use {@link GLib.debug} and related
+     * methods and these will appear in Geary's Inspector.
+     */
+    public abstract void report_problem(GLib.Error error);
+
 }


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]