Package com.intellij.openapi.diagnostic

Class ErrorReportSubmitter

java.lang.Object

com.intellij.openapi.diagnostic.ErrorReportSubmitter

All Implemented Interfaces:

PluginAware

public abstract class ErrorReportSubmitter
extends java.lang.Object
implements PluginAware

This class should be extended by plugin vendor and provided by means of ExtensionPoints.ERROR_HANDLER_EP if reporting errors that happened in plugin code to vendor is desirable.

Constructor Summary

Constructors

Constructor and Description
ErrorReportSubmitter()

Method Summary

Modifier and Type	Method and Description
void	changeReporterAccount(java.awt.Component parentComponent) If getReporterAccount() returns a non-null value, this method may be called when a user wants to change a reporter account.
PluginDescriptor	getPluginDescriptor()
java.lang.String	getPrivacyNoticeText()
abstract java.lang.String	getReportActionText()
java.lang.String	getReporterAccount() If this reporter allows a user to identify themselves, the method should return either the name of an account that will be used for submitting reports or an empty string.
void	setPluginDescriptor(PluginDescriptor plugin) Called by the framework.
SubmittedReportInfo	submit(IdeaLoggingEvent[] events, java.awt.Component parent) Deprecated. do not override; implement submit(IdeaLoggingEvent[], String, Component, Consumer) instead
boolean	submit(IdeaLoggingEvent [] events, java.lang.String additionalInfo, java.awt.Component parentComponent, Consumer<SubmittedReportInfo> consumer) This method is called whenever an exception in a plugin code had happened and a user decided to report a problem to the plugin vendor.
void	submitAsync(IdeaLoggingEvent[] events, java.lang.String info, java.awt.Component parent, Consumer<SubmittedReportInfo> consumer) Deprecated. do not override; implement submit(IdeaLoggingEvent[], String, Component, Consumer) instead
boolean	trySubmitAsync(IdeaLoggingEvent[] events, java.lang.String info, java.awt.Component parent, Consumer<SubmittedReportInfo> consumer) Deprecated. do not override; implement submit(IdeaLoggingEvent[], String, Component, Consumer) instead

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ErrorReportSubmitter

public ErrorReportSubmitter()

Method Detail

setPluginDescriptor

public void setPluginDescriptor(PluginDescriptor plugin)

Called by the framework. Allows to identify the plugin that provided this extension.

Specified by:

setPluginDescriptor in interface PluginAware

Parameters:

plugin - descriptor of the plugin that provided this particular extension.

getPluginDescriptor

public PluginDescriptor getPluginDescriptor()

Returns:

plugin that provided this particular extension

getReportActionText

public abstract java.lang.String getReportActionText()

Returns:

an action text to be used in Error Reporter user interface, e.g. "Report to JetBrains".

getPrivacyNoticeText

public java.lang.String getPrivacyNoticeText()

Returns:

a text of a privacy notice to be shown in the dialog (in HTML; links are allowed).

getReporterAccount

public java.lang.String getReporterAccount()

If this reporter allows a user to identify themselves, the method should return either the name of an account that will be used for submitting reports or an empty string. Otherwise, it should return null.

changeReporterAccount

public void changeReporterAccount(java.awt.Component parentComponent)

If getReporterAccount() returns a non-null value, this method may be called when a user wants to change a reporter account. It is expected to be synchronous - i.e. do not return until a user finished entering their data.

submit

public boolean submit(IdeaLoggingEvent [] events,
                      java.lang.String additionalInfo,
                      java.awt.Component parentComponent,
                      Consumer<SubmittedReportInfo> consumer)

This method is called whenever an exception in a plugin code had happened and a user decided to report a problem to the plugin vendor.

Parameters:

events - a non-empty sequence of error descriptors.

additionalInfo - additional information provided by a user.

parentComponent - UI component to use as a parent in any UI activity from a submitter.

consumer - a callback to be called after sending is finished (or failed).

Returns:

true if reporting was started, false if a report can't be sent at the moment.

trySubmitAsync

@Deprecated
public boolean trySubmitAsync(IdeaLoggingEvent[] events,
                              java.lang.String info,
                              java.awt.Component parent,
                              Consumer<SubmittedReportInfo> consumer)

Deprecated. do not override; implement submit(IdeaLoggingEvent[], String, Component, Consumer) instead

submitAsync

@Deprecated
public void submitAsync(IdeaLoggingEvent[] events,
                        java.lang.String info,
                        java.awt.Component parent,
                        Consumer<SubmittedReportInfo> consumer)

Deprecated. do not override; implement submit(IdeaLoggingEvent[], String, Component, Consumer) instead

submit

@Deprecated
public SubmittedReportInfo submit(IdeaLoggingEvent[] events,
                                  java.awt.Component parent)

Deprecated. do not override; implement submit(IdeaLoggingEvent[], String, Component, Consumer) instead