C# Class Microsoft.HockeyApp.HockeyClientWP8SLExtension

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

Show file Open project: bitstadium/HockeySDK-Windows Class Usage Examples

Public Methods

Method	Description
AuthorizeUser ( this @this, Uri successRedirect, System.Windows.Navigation.NavigationService navigationService = null, string eMail = null, TokenValidationPolicy tokenValidationPolicy = TokenValidationPolicy.EveryLogin, AuthValidationMode authValidationMode = AuthValidationMode.Graceful ) : void	Authorizes user with hockeyapp auth. Opening a login page to require (hockeaypp) userid and pass from user if needed
CheckForUpdates ( this @this, UpdateCheckSettings settings = null ) : void	Check for available updates
Configure ( this @this, string appId, TelemetryConfiguration telemetryConfiguration = null, System.Windows.Controls.Frame rootFrame = null ) : IHockeyClientConfigurable	main configuration method. call in app constructor
IdentifyUser ( this @this, string appSecret, Uri successRedirect, System.Windows.Navigation.NavigationService navigationService = null, string eMail = null, TokenValidationPolicy tokenValidationPolicy = TokenValidationPolicy.EveryLogin, AuthValidationMode authValidationMode = AuthValidationMode.Graceful ) : void	Identify user with hockeaypp auth. Opening a login page to require valid email address for app if needed
LogoutUser ( this @this ) : void	Logout the user by forgetting validation token
RegisterCustomUnhandledExceptionLogic ( this @this, Action customAction ) : IHockeyClientConfigurable	The action you set will be called after HockeyApp has written the crash-log and allows you to run custom logic like marking the exception as handled
RegisterCustomUnobserveredTaskExceptionLogic ( this @this, Action customAction ) : IHockeyClientConfigurable	The action you set will be called after HockeyApp has written the crash-log and allows you to run custom logic like exiting the application
SendCrashesAsync ( this @this, bool sendWithoutAsking = false ) : Task	Send any collected crashes to the HockeyApp server. You should normally call this during startup of your app.
ShowFeedback ( this @this ) : void	Open the feedback UI
UseCustomResourceManager ( this @this, ResourceManager manager ) : IHockeyClientConfigurable	Provide a custom resource manager to override standard sdk i18n strings

Private Methods

Method	Description
ShowFeedbackUI ( this @this, System.Windows.Navigation.NavigationService navigationService ) : void

Method Details

AuthorizeUser() public static method

Authorizes user with hockeyapp auth. Opening a login page to require (hockeaypp) userid and pass from user if needed

public static AuthorizeUser ( this @this, Uri successRedirect, System.Windows.Navigation.NavigationService navigationService = null, string eMail = null, TokenValidationPolicy tokenValidationPolicy = TokenValidationPolicy.EveryLogin, AuthValidationMode authValidationMode = AuthValidationMode.Graceful ) : void
@this	this
successRedirect	System.Uri	Page-URI to redirect to after successful login
navigationService	System.Windows.Navigation.NavigationService	[optional] obsolete - not needed
eMail	string	[Optional] initial email
tokenValidationPolicy	TokenValidationPolicy
authValidationMode	AuthValidationMode
return	void

CheckForUpdates() public static method

Check for available updates

public static CheckForUpdates ( this @this, UpdateCheckSettings settings = null ) : void
@this	this
settings	UpdateCheckSettings
return	void

Configure() public static method

main configuration method. call in app constructor

public static Configure ( this @this, string appId, TelemetryConfiguration telemetryConfiguration = null, System.Windows.Controls.Frame rootFrame = null ) : IHockeyClientConfigurable
@this	this
appId	string
telemetryConfiguration	TelemetryConfiguration
rootFrame	System.Windows.Controls.Frame
return	IHockeyClientConfigurable

IdentifyUser() public static method

Identify user with hockeaypp auth. Opening a login page to require valid email address for app if needed

public static IdentifyUser ( this @this, string appSecret, Uri successRedirect, System.Windows.Navigation.NavigationService navigationService = null, string eMail = null, TokenValidationPolicy tokenValidationPolicy = TokenValidationPolicy.EveryLogin, AuthValidationMode authValidationMode = AuthValidationMode.Graceful ) : void
@this	this
appSecret	string	Your app's app secret (see HockeyApp app page)
successRedirect	System.Uri	Page-URI to redirect to after successful login
navigationService	System.Windows.Navigation.NavigationService	[optional] obsolete - not needed
eMail	string	[Optional] initial email
tokenValidationPolicy	TokenValidationPolicy
authValidationMode	AuthValidationMode
return	void

LogoutUser() public static method

Logout the user by forgetting validation token

public static LogoutUser ( this @this ) : void
@this	this
return	void

RegisterCustomUnhandledExceptionLogic() public static method

The action you set will be called after HockeyApp has written the crash-log and allows you to run custom logic like marking the exception as handled

public static RegisterCustomUnhandledExceptionLogic ( this @this, Action customAction ) : IHockeyClientConfigurable
@this	this
customAction	Action	The custom action.
return	IHockeyClientConfigurable

RegisterCustomUnobserveredTaskExceptionLogic() public static method

The action you set will be called after HockeyApp has written the crash-log and allows you to run custom logic like exiting the application

public static RegisterCustomUnobserveredTaskExceptionLogic ( this @this, Action customAction ) : IHockeyClientConfigurable
@this	this
customAction	Action
return	IHockeyClientConfigurable

SendCrashesAsync() public static method

Send any collected crashes to the HockeyApp server. You should normally call this during startup of your app.

public static SendCrashesAsync ( this @this, bool sendWithoutAsking = false ) : Task
@this	this
sendWithoutAsking	bool	configures if available crashes are sent immediately or if the user should be asked if the crashes should be sent or discarded
return	Task

ShowFeedback() public static method

Open the feedback UI

public static ShowFeedback ( this @this ) : void
@this	this
return	void

UseCustomResourceManager() public static method

Provide a custom resource manager to override standard sdk i18n strings

public static UseCustomResourceManager ( this @this, ResourceManager manager ) : IHockeyClientConfigurable
@this	this
manager	ResourceManager	resource manager to use
return	IHockeyClientConfigurable