C# Class Mindscape.Raygun4Net.RaygunClient

Show file Open project: MindscapeHQ/raygun4net Class Usage Examples

Protected Properties

Property	Type	Description
_requestMessageOptions	RaygunRequestMessageOptions

Private Properties

Property	Type	Description
AndroidEnvironment_UnhandledExceptionRaiser	void
BuildRaygunIdentifierMessage	Mindscape.Raygun4Net.Messages.RaygunIdentifierMessage
BuildRequestMessage	Mindscape.Raygun4Net.Messages.RaygunRequestMessage
BuildRequestMessage	Task
BuildResponseMessage	Mindscape.Raygun4Net.Messages.RaygunResponseMessage
CurrentDomain_UnhandledException	void
DeleteFile	void
FileExists	bool
FlagExceptionAsSent	void
GetIsolatedStorageScope	IsolatedStorageFile
GetStoredMessageCount	int
GetVersion	string
PopulateCrashReportDirectoryStructure	void
RaygunClient_SendingMessage	void
SaveMessage	void
Send	void
Send	void
Send	void
Send	void
SendAsync	Task
SendCore	void
SendMessage	bool
SendMessage	bool
SendPulseMessage	bool
SendPulseSessionEvent	void
SendPulseSessionEventCore	void
SendPulseSessionEventNow	void
SendPulseTimingEventCore	void
SendPulseTimingEventNow	void
SendStoredMessages	void
SendStoredMessages	void
StripAndSend	Task
StripAndSend	void
StripAndSend	void
StripAndSend	void
StripWrapperExceptions	Exception
TaskScheduler_UnobservedTaskException	void
ValidateApiKey	bool
WriteExceptionInformation	void
sigaction	int

Public Methods

Method	Description
AddWrapperExceptions ( ) : void	Adds a list of outer exceptions that will be stripped, leaving only the valuable inner exception. This can be used when a wrapper exception, e.g. TargetInvocationException or AggregateException, contains the actual exception as the InnerException. The message and stack trace of the inner exception will then be used by Raygun for grouping and display. The above two do not need to be added manually, but if you have other wrapper exceptions that you want stripped you can pass them in here.
Attach ( string apiKey ) : void	Causes Raygun to listen to and send all unhandled exceptions and unobserved task exceptions.
Attach ( string apiKey, bool canReportNativeErrors, bool hijackNativeSignals ) : void	Causes Raygun to listen to and send all unhandled exceptions and unobserved task exceptions.
Attach ( string apiKey, string user ) : void	Causes Raygun to listen to and send all unhandled exceptions and unobserved task exceptions.
Attach ( string apiKey, string user, bool canReportNativeErrors, bool hijackNativeSignals ) : void	Causes Raygun to listen to and send all unhandled exceptions and unobserved task exceptions.
AttachCrashReporting ( ) : RaygunClient	Causes Raygun to listen to and send all unhandled exceptions and unobserved task exceptions. Native iOS exception reporting is not enabled with this method, an overload is available to do so.
AttachCrashReporting ( bool canReportNativeErrors, bool hijackNativeSignals ) : RaygunClient	Causes Raygun to listen to and send all unhandled exceptions and unobserved task exceptions.
AttachPulse ( ) : RaygunClient	Causes Raygun to automatically send session and view events for Raygun Pulse.
AttachPulse ( Activity mainActivity ) : RaygunClient	Causes Raygun to automatically send session and view events for Raygun Pulse.
Detach ( ) : void	Detaches Raygun from listening to unhandled exceptions and unobserved task exceptions.
DetachCrashReporting ( ) : void	Detaches Raygun from listening to unhandled exceptions and unobserved task exceptions.
DetachPulse ( ) : void	Detaches Raygun from automatically sending session and view events to Raygun Pulse.
IgnoreCookieNames ( ) : void	Adds a list of keys to ignore when attaching the cookies of an HTTP POST request. This allows you to remove sensitive data from the transmitted copy of the Cookies on the HttpRequest by specifying the keys you want removed. This method is only effective in a web context.
IgnoreFormFieldNames ( ) : void	Adds a list of keys to ignore when attaching the Form data of an HTTP POST request. This allows you to remove sensitive data from the transmitted copy of the Form on the HttpRequest by specifying the keys you want removed. This method is only effective in a web context.
IgnoreHeaderNames ( ) : void	Adds a list of keys to ignore when attaching the headers of an HTTP POST request. This allows you to remove sensitive data from the transmitted copy of the Headers on the HttpRequest by specifying the keys you want removed. This method is only effective in a web context.
IgnoreServerVariableNames ( ) : void	Adds a list of keys to ignore when attaching the server variables of an HTTP POST request. This allows you to remove sensitive data from the transmitted copy of the ServerVariables on the HttpRequest by specifying the keys you want removed. This method is only effective in a web context.
Initialize ( string apiKey ) : RaygunClient	Initializes the static RaygunClient with the given Raygun api key.
RaygunClient ( string apiKey ) : Foundation	Initializes a new instance of the RaygunClient class.
RaygunClient ( ) : System	Initializes a new instance of the RaygunClient class. Uses the ApiKey specified in the config file.
RaygunClient ( RaygunSettings settings, HttpContext context = null ) : System
RaygunClient ( string apiKey ) : System	Initializes a new instance of the RaygunClient class.
RemoveWrapperExceptions ( ) : void	Specifies types of wrapper exceptions that Raygun should send rather than stripping out and sending the inner exception. This can be used to remove the default wrapper exceptions (TargetInvocationException and AggregateException).
Send ( RaygunMessage raygunMessage ) : Task	Posts a RaygunMessage to the Raygun api endpoint.
Send ( Exception exception ) : void	Transmits an exception to Raygun.io synchronously, using the version number of the originating assembly.
Send ( Exception exception, IList tags ) : void	Transmits an exception to Raygun.io synchronously specifying a list of string tags associated with the message for identification. This uses the version number of the originating assembly.
Send ( Exception exception, IList tags, IDictionary userCustomData ) : void	Transmits an exception to Raygun.io synchronously specifying a list of string tags associated with the message for identification, as well as sending a key-value collection of custom data. This uses the version number of the originating assembly.
Send ( Exception exception, IList tags, IDictionary userCustomData, HttpContext context ) : void	Transmits an exception to Raygun synchronously specifying a list of string tags associated with the message for identification, as well as sending a key-value collection of custom data.
Send ( Exception exception, IList tags, IDictionary userCustomData, RaygunIdentifierMessage userInfo ) : void	Transmits an exception to Raygun.io synchronously specifying a list of string tags associated with the message for identification, as well as sending a key-value collection of custom data. This uses the version number of the originating assembly.
Send ( RaygunMessage raygunMessage ) : void	Posts a RaygunMessage to the Raygun.io api endpoint.
SendInBackground ( Exception exception ) : Task	Asynchronously transmits a message to Raygun.
SendInBackground ( Exception exception, IList tags ) : Task	Asynchronously transmits an exception to Raygun.
SendInBackground ( Exception exception, IList tags, IDictionary userCustomData ) : Task	Asynchronously transmits an exception to Raygun.
SendInBackground ( RaygunMessage raygunMessage ) : Task	Asynchronously transmits a message to Raygun.
SendInBackground ( Exception exception ) : void	Asynchronously transmits a message to Raygun.io.
SendInBackground ( Exception exception, IList tags ) : void	Asynchronously transmits a message to Raygun.io.
SendInBackground ( Exception exception, IList tags, IDictionary userCustomData ) : void	Asynchronously transmits a message to Raygun.io.
SendInBackground ( Exception exception, IList tags, IDictionary userCustomData, RaygunIdentifierMessage userInfo ) : void	Asynchronously transmits an exception to Raygun.io.
SendInBackground ( RaygunMessage raygunMessage ) : void	Asynchronously transmits a message to Raygun.io.
SendPulseTimingEvent ( RaygunPulseEventType eventType, string name, long milliseconds ) : void	Sends a pulse timing event to Raygun. The message is sent on a background thread.
SetCurrentContext ( HttpContext request ) : RaygunClient

Protected Methods

Method	Description
BuildMessage ( Exception exception, IList tags, IDictionary userCustomData ) : Mindscape.Raygun4Net.Messages.RaygunMessage
BuildMessage ( Exception exception, IList tags, IDictionary userCustomData, Mindscape.Raygun4Net.Messages.RaygunIdentifierMessage userInfoMessage ) : Mindscape.Raygun4Net.Messages.RaygunMessage
BuildMessage ( Exception exception, IList tags, IDictionary userCustomData, Mindscape.Raygun4Net.Messages.RaygunIdentifierMessage userInfoMessage, System.DateTime currentTime ) : Mindscape.Raygun4Net.Messages.RaygunMessage
BuildMessage ( Exception exception, IList tags, IDictionary userCustomData ) : Task
CanSend ( Exception exception ) : bool
CanSend ( Mindscape.Raygun4Net.Messages.RaygunMessage message ) : bool
CreateWebClient ( ) : WebClient
FlagAsSent ( Exception exception ) : void
OnCustomGroupingKey ( Exception exception, RaygunMessage message ) : Task
OnSendingMessage ( RaygunMessage raygunMessage ) : bool
StripWrapperExceptions ( Exception exception ) : IEnumerable

Private Methods

Method	Description
AndroidEnvironment_UnhandledExceptionRaiser ( object sender, RaiseThrowableEventArgs e ) : void
BuildRaygunIdentifierMessage ( string machineName ) : Mindscape.Raygun4Net.Messages.RaygunIdentifierMessage
BuildRequestMessage ( ) : Mindscape.Raygun4Net.Messages.RaygunRequestMessage
BuildRequestMessage ( ) : Task
BuildResponseMessage ( ) : Mindscape.Raygun4Net.Messages.RaygunResponseMessage
CurrentDomain_UnhandledException ( object sender, UnhandledExceptionEventArgs e ) : void
DeleteFile ( File dir, string fileName ) : void
FileExists ( string files, string fileName ) : bool
FlagExceptionAsSent ( Exception exception ) : void
GetIsolatedStorageScope ( ) : IsolatedStorageFile
GetStoredMessageCount ( ) : int
GetVersion ( ) : string
PopulateCrashReportDirectoryStructure ( ) : void
RaygunClient_SendingMessage ( object sender, RaygunSendingMessageEventArgs e ) : void
SaveMessage ( string message ) : void
Send ( PulseEventBatch batch ) : void
Send ( RaygunMessage raygunMessage, int timeout ) : void
Send ( RaygunPulseMessage raygunPulseMessage ) : void
Send ( string message ) : void
SendAsync ( Exception exception, IList tags, IDictionary userCustomData, HttpContext context ) : Task
SendCore ( PulseEventBatch batch ) : void
SendMessage ( string message ) : bool
SendMessage ( string message, int timeout ) : bool
SendPulseMessage ( string message ) : bool
SendPulseSessionEvent ( RaygunPulseSessionEventType eventType ) : void	Sends a Pulse session event to Raygun. The message is sent on a background thread.
SendPulseSessionEventCore ( RaygunPulseSessionEventType eventType ) : void
SendPulseSessionEventNow ( RaygunPulseSessionEventType eventType ) : void
SendPulseTimingEventCore ( RaygunPulseEventType eventType, string name, long milliseconds ) : void
SendPulseTimingEventNow ( RaygunPulseEventType eventType, string name, long milliseconds ) : void
SendStoredMessages ( ) : void
SendStoredMessages ( int timeout ) : void
StripAndSend ( Exception exception, IList tags, IDictionary userCustomData ) : Task
StripAndSend ( Exception exception, IList tags, IDictionary userCustomData ) : void
StripAndSend ( Exception exception, IList tags, IDictionary userCustomData, RaygunIdentifierMessage userInfo, DateTime currentTime ) : void
StripAndSend ( Exception exception, IList tags, IDictionary userCustomData, int timeout ) : void
StripWrapperExceptions ( Exception exception ) : Exception
TaskScheduler_UnobservedTaskException ( object sender, UnobservedTaskExceptionEventArgs e ) : void
ValidateApiKey ( ) : bool
WriteExceptionInformation ( string identifier, Exception exception ) : void
sigaction ( Signal sig, IntPtr act, IntPtr oact ) : int

Method Details

AddWrapperExceptions() public method

Adds a list of outer exceptions that will be stripped, leaving only the valuable inner exception. This can be used when a wrapper exception, e.g. TargetInvocationException or AggregateException, contains the actual exception as the InnerException. The message and stack trace of the inner exception will then be used by Raygun for grouping and display. The above two do not need to be added manually, but if you have other wrapper exceptions that you want stripped you can pass them in here.

public AddWrapperExceptions ( ) : void
return	void