C# Class Microsoft.HockeyApp.HockeyClientExtensionsWP81

Static extension class containing the main extension methods for controlling the HockeySDK client

Show file Open project: bitstadium/HockeySDK-Windows

Public Methods

Method	Description
CheckForAppUpdateAsync ( this @this, UpdateCheckSettings updateSettings = null ) : System.Threading.Tasks.Task	Call this method during startup of your app to check for Updates.
Configure ( this @this, string appIdentifier, TelemetryConfiguration configuration = null ) : IHockeyClientConfigurable	This is the main configuration method. Call this in the Constructor of your app. This registers an error handler for unhandled errors.
HandleReactivationOfFeedbackFilePicker ( this @this, IActivatedEventArgs e ) : bool	You need to call this method in your App's OnActivated method if you use the feedback feature. This allows for HockeyApp to continue after a PickFileAndContinue resume when adding images as attachments to a message
LogoutFromFeedbackAsync ( this @this ) : System.Threading.Tasks.Task	Call in your app if user logs out. Deletes all persistently stored data like FeedbackThreadToken, and cached Message. .
RegisterCustomUnhandledExceptionLogic ( this @this, bool>.Func customFunc ) : IHockeyClientConfigurable	The func you set will be called after HockeyApp has written the crash-log and allows you to continue If the func returns false the app will not terminate but keep running
RegisterCustomUnobserveredTaskExceptionLogic ( this @this, bool>.Func customFunc ) : IHockeyClientConfigurable	The func you set will be called after HockeyApp has written the crash-log and allows you to continue If the func returns false the app will not terminate but keep running
RegisterUnobservedTaskExceptionHandler ( this @this ) : IHockeyClientConfigurable	Adds the handler for UnobservedTaskException
ShowFeedback ( this @this, string initialUsername = null, string initialEmail = null ) : void	Invoke this method to navigate to the feedback UI where a user can send you a message including image attachments over the HockeyApp feedback system. Make sure to add a call to HockeyClient.Current.HandleReactivationOfFeedbackFilePicker(..) to your App's OnActivated() method to allow for resuming the process after PickFileAndContinue..
UnregisterUnobservedTaskExceptionHandler ( this @this ) : IHockeyClientConfigurable	Removes the handler for UnobservedTaskException

Private Methods

Method	Description
HandleAppResuming ( object sender, object e ) : void
HandleAppSuspending ( object sender, Windows e ) : void
TaskScheduler_UnobservedTaskException ( object sender, System.Threading.Tasks.UnobservedTaskExceptionEventArgs e ) : void

Method Details

CheckForAppUpdateAsync() public static method

Call this method during startup of your app to check for Updates.

public static CheckForAppUpdateAsync ( this @this, UpdateCheckSettings updateSettings = null ) : System.Threading.Tasks.Task
@this	this
updateSettings	UpdateCheckSettings	Settings to define context for Update checking.
return	System.Threading.Tasks.Task

Configure() public static method

This is the main configuration method. Call this in the Constructor of your app. This registers an error handler for unhandled errors.

public static Configure ( this @this, string appIdentifier, TelemetryConfiguration configuration = null ) : IHockeyClientConfigurable
@this	this
appIdentifier	string	Your unique app id from HockeyApp.
configuration	TelemetryConfiguration	Your unique app id from HockeyApp.
return	IHockeyClientConfigurable

HandleReactivationOfFeedbackFilePicker() public static method

You need to call this method in your App's OnActivated method if you use the feedback feature. This allows for HockeyApp to continue after a PickFileAndContinue resume when adding images as attachments to a message

public static HandleReactivationOfFeedbackFilePicker ( this @this, IActivatedEventArgs e ) : bool
@this	this
e	IActivatedEventArgs
return	bool

LogoutFromFeedbackAsync() public static method

Call in your app if user logs out. Deletes all persistently stored data like FeedbackThreadToken, and cached Message. .

public static LogoutFromFeedbackAsync ( this @this ) : System.Threading.Tasks.Task
@this	this
return	System.Threading.Tasks.Task

RegisterCustomUnhandledExceptionLogic() public static method

The func you set will be called after HockeyApp has written the crash-log and allows you to continue If the func returns false the app will not terminate but keep running

public static RegisterCustomUnhandledExceptionLogic ( this @this, bool>.Func customFunc ) : IHockeyClientConfigurable
@this	this
customFunc	bool>.Func	The custom function.
return	IHockeyClientConfigurable

RegisterCustomUnobserveredTaskExceptionLogic() public static method

The func you set will be called after HockeyApp has written the crash-log and allows you to continue If the func returns false the app will not terminate but keep running

public static RegisterCustomUnobserveredTaskExceptionLogic ( this @this, bool>.Func customFunc ) : IHockeyClientConfigurable
@this	this
customFunc	bool>.Func	The custom function.
return	IHockeyClientConfigurable

RegisterUnobservedTaskExceptionHandler() public static method

Adds the handler for UnobservedTaskException

public static RegisterUnobservedTaskExceptionHandler ( this @this ) : IHockeyClientConfigurable
@this	this
return	IHockeyClientConfigurable

ShowFeedback() public static method

Invoke this method to navigate to the feedback UI where a user can send you a message including image attachments over the HockeyApp feedback system. Make sure to add a call to HockeyClient.Current.HandleReactivationOfFeedbackFilePicker(..) to your App's OnActivated() method to allow for resuming the process after PickFileAndContinue..

public static ShowFeedback ( this @this, string initialUsername = null, string initialEmail = null ) : void
@this	this
initialUsername	string	[Optional] Username to prefill the name field
initialEmail	string	[Optional] Email to prefill the email field
return	void

UnregisterUnobservedTaskExceptionHandler() public static method

Removes the handler for UnobservedTaskException

public static UnregisterUnobservedTaskExceptionHandler ( this @this ) : IHockeyClientConfigurable
@this	this
return	IHockeyClientConfigurable