C# Класс Microsoft.HockeyApp.HockeyClient

Implements the HockeyClient singleton

Наследование: HockeyApp.IHockeyClient, IHockeyClientInternal, IHockeyClientConfigurable

Показать файл Открыть проект Примеры использования класса

Private Properties

Свойство	Тип	Описание
CreateInitializedContextAsync	Task
FillEmptyUserAndContactInfo	void
HandleException	void
HockeyClient	Channel
Initialize	void
IsTelemetryEnabled	bool
Track	void
TrackException	void
TrackRequest	void
TrackRequest	void
WriteTelemetryToDebugOutput	void

Открытые методы

Метод	Описание
AnyCrashesAvailableAsync ( ) : Task	Check for available crash-logs in storage
AuthorizeUserAsync ( string email, string password ) : Task	try to authorize a (hockeayapp) user by email and password
CheckForInitialization ( ) : void	Check if this HockeyClient has already been initialized (used internally by platform SDKs)
CreateCrashData ( Exception ex ) : ICrashData	Create a CrashData object from an Exception with the default CrashLogInformation
CreateCrashData ( Exception ex, CrashLogInformation crashLogInfo ) : ICrashData	Create a CrashData object from an Exception and a given CrashLogInformation
CreateCrashData ( string logString, string stackTrace ) : ICrashData	create a CrashData object from a logString and stacktrace (used for Unity crashes)
CreateNewFeedbackThread ( ) : IFeedbackThread	Create a feedback thread to post messages on
DeleteAllCrashesAsync ( ) : Task	Delete all crash-logs from storage
Deserialize ( Stream inputStream ) : ICrashData	Get an ICrashData object from crashlog-stream
Flush ( ) : void	Clears all buffers for this telemetry stream and causes any buffered data to be written to the underlying channel.
GetAppVersionsAsync ( ) : Task>	Get available app versions from the server
GetCrashFileNamesAsync ( ) : Task>	Retrieve filenames of crashlog files from storage
HandleExceptionAsync ( Exception ex ) : Task	Handle exception asyncronously
HandleInternalUnhandledException ( Exception unhandledException ) : void	Handle Exceptions that are swallowed because we don't want our SDK crash other apps For internal use by platform SDKs
IdentifyUserAsync ( string email, string appSecret ) : Task	Identify a user by his email-adress (hockeyapp id)
OpenFeedbackThreadAsync ( string threadToken ) : Task	Try to open an existng Feedbackthread
SendCrashesAndDeleteAfterwardsAsync ( ) : Task	Send crash-logs from storage and deletes the if they could be sent
TrackDependency ( DependencyTelemetry telemetry ) : void	Send information about external dependency call in the application.
TrackDependency ( string dependencyName, string commandName, DateTimeOffset startTime, System.TimeSpan duration, bool success ) : void	Send information about external dependency call in the application.
TrackEvent ( EventTelemetry telemetry ) : void	Send an EventTelemetry for display in Diagnostic Search and aggregation in Metrics Explorer.
TrackEvent ( string eventName ) : void	Send a custom event for display in Events tab.
TrackEvent ( string eventName, string>.IDictionary properties = null, double>.IDictionary metrics = null ) : void	Send an event telemetry for display in Diagnostic Search and aggregation in Metrics Explorer.
TrackException ( Exception exception, string>.IDictionary properties = null ) : void	Send an ExceptionTelemetry for display in Diagnostic Search.
TrackMetric ( MetricTelemetry telemetry ) : void	Send a MetricTelemetry for aggregation in Metric Explorer.
TrackMetric ( string name, double value, string>.IDictionary properties = null ) : void	Send a MetricTelemetry for aggregation in Metric Explorer.
TrackPageView ( PageViewTelemetry telemetry ) : void	Send information about the page viewed in the application.
TrackPageView ( string name ) : void	Send information about the page viewed in the application.
TrackTrace ( TraceTelemetry telemetry ) : void	Send a trace message for display in Diagnostic Search.
TrackTrace ( string message ) : void	Send a trace message for display in Diagnostic Search.
TrackTrace ( string message, string>.IDictionary properties ) : void	Send a trace message for display in Diagnostic Search.
TrackTrace ( string message, SeverityLevel severityLevel ) : void	Send a trace message for display in Diagnostic Search.
TrackTrace ( string message, SeverityLevel severityLevel, string>.IDictionary properties ) : void	Send a trace message for display in Diagnostic Search.

Приватные методы

Метод	Описание
CreateInitializedContextAsync ( ) : Task
FillEmptyUserAndContactInfo ( string email ) : void
HandleException ( Exception ex ) : void
HockeyClient ( ) : Channel
Initialize ( ) : void	Initializes telemetry client. For performance reasons, this call needs to be performed only after TelemetryConfiguration has been initialized.
IsTelemetryEnabled ( ) : bool	Check to determine if the tracking is enabled.
Track ( ITelemetry telemetry ) : void
TrackException ( ExceptionTelemetry telemetry ) : void	Send an ExceptionTelemetry for display in Diagnostic Search.
TrackRequest ( RequestTelemetry request ) : void	Send information about a request handled by the application.
TrackRequest ( string name, DateTimeOffset startTime, System.TimeSpan duration, string responseCode, bool success ) : void	Send information about a request handled by the application.
WriteTelemetryToDebugOutput ( ITelemetry telemetry ) : void

Описание методов

AnyCrashesAvailableAsync() публичный Метод

Check for available crash-logs in storage

public AnyCrashesAvailableAsync ( ) : Task
Результат	Task

AuthorizeUserAsync() публичный Метод

try to authorize a (hockeayapp) user by email and password

public AuthorizeUserAsync ( string email, string password ) : Task
email	string	email (hockeyapp user id)
password	string	password of the user
Результат	Task

CheckForInitialization() публичный Метод

Check if this HockeyClient has already been initialized (used internally by platform SDKs)

public CheckForInitialization ( ) : void
Результат	void

CreateCrashData() публичный Метод

Create a CrashData object from an Exception with the default CrashLogInformation

public CreateCrashData ( Exception ex ) : ICrashData
ex	Exception
Результат	ICrashData

CreateCrashData() публичный Метод

Create a CrashData object from an Exception and a given CrashLogInformation

public CreateCrashData ( Exception ex, CrashLogInformation crashLogInfo ) : ICrashData
ex	Exception
crashLogInfo	CrashLogInformation
Результат	ICrashData

CreateCrashData() публичный Метод

create a CrashData object from a logString and stacktrace (used for Unity crashes)

public CreateCrashData ( string logString, string stackTrace ) : ICrashData
logString	string
stackTrace	string
Результат	ICrashData

CreateNewFeedbackThread() публичный Метод

Create a feedback thread to post messages on

public CreateNewFeedbackThread ( ) : IFeedbackThread
Результат	IFeedbackThread

DeleteAllCrashesAsync() публичный Метод

Delete all crash-logs from storage

public DeleteAllCrashesAsync ( ) : Task
Результат	Task

Deserialize() публичный Метод

Get an ICrashData object from crashlog-stream

public Deserialize ( Stream inputStream ) : ICrashData
inputStream	Stream	stream from crashlog
Результат	ICrashData

Flush() публичный Метод

Clears all buffers for this telemetry stream and causes any buffered data to be written to the underlying channel.

public Flush ( ) : void
Результат	void

GetAppVersionsAsync() публичный Метод

Get available app versions from the server

public GetAppVersionsAsync ( ) : Task>
Результат	Task>

GetCrashFileNamesAsync() публичный Метод

Retrieve filenames of crashlog files from storage

public GetCrashFileNamesAsync ( ) : Task>
Результат	Task>

HandleExceptionAsync() публичный Метод

Handle exception asyncronously

public HandleExceptionAsync ( Exception ex ) : Task
ex	Exception	the exception that should be saved to a crashlog
Результат	Task

HandleInternalUnhandledException() публичный Метод

Handle Exceptions that are swallowed because we don't want our SDK crash other apps For internal use by platform SDKs

public HandleInternalUnhandledException ( Exception unhandledException ) : void
unhandledException	Exception	the exception to propagate
Результат	void

IdentifyUserAsync() публичный Метод

Identify a user by his email-adress (hockeyapp id)

public IdentifyUserAsync ( string email, string appSecret ) : Task
email	string	email (hockeyapp user id)
appSecret	string	app secret of the app
Результат	Task

OpenFeedbackThreadAsync() публичный Метод

Try to open an existng Feedbackthread

public OpenFeedbackThreadAsync ( string threadToken ) : Task
threadToken	string	thread token for this thread
Результат	Task

SendCrashesAndDeleteAfterwardsAsync() публичный Метод

Send crash-logs from storage and deletes the if they could be sent

public SendCrashesAndDeleteAfterwardsAsync ( ) : Task
Результат	Task

TrackDependency() публичный Метод

Send information about external dependency call in the application.

public TrackDependency ( DependencyTelemetry telemetry ) : void
telemetry	DependencyTelemetry
Результат	void

TrackDependency() публичный Метод

Send information about external dependency call in the application.

public TrackDependency ( string dependencyName, string commandName, DateTimeOffset startTime, System.TimeSpan duration, bool success ) : void
dependencyName	string	External dependency name.
commandName	string	Dependency call command name.
startTime	DateTimeOffset	The time when the dependency was called.
duration	System.TimeSpan	The time taken by the external dependency to handle the call.
success	bool	True if the dependency call was handled successfully.
Результат	void

TrackEvent() публичный Метод

Send an EventTelemetry for display in Diagnostic Search and aggregation in Metrics Explorer.

public TrackEvent ( EventTelemetry telemetry ) : void
telemetry	EventTelemetry	An event log item.
Результат	void

TrackEvent() публичный Метод

Send a custom event for display in Events tab.

public TrackEvent ( string eventName ) : void
eventName	string	Event name
Результат	void

TrackEvent() публичный Метод

Send an event telemetry for display in Diagnostic Search and aggregation in Metrics Explorer.

public TrackEvent ( string eventName, string>.IDictionary properties = null, double>.IDictionary metrics = null ) : void
eventName	string	A name for the event.
properties	string>.IDictionary	Named string values you can use to search and classify events.
metrics	double>.IDictionary	Measurements associated with this event.
Результат	void

TrackException() публичный Метод

Send an ExceptionTelemetry for display in Diagnostic Search.

public TrackException ( Exception exception, string>.IDictionary properties = null ) : void
exception	Exception	The exception to log.
properties	string>.IDictionary	Named string values you can use to classify and search for this exception.
Результат	void

TrackMetric() публичный Метод

Send a MetricTelemetry for aggregation in Metric Explorer.

public TrackMetric ( MetricTelemetry telemetry ) : void
telemetry	MetricTelemetry
Результат	void

TrackMetric() публичный Метод

Send a MetricTelemetry for aggregation in Metric Explorer.

public TrackMetric ( string name, double value, string>.IDictionary properties = null ) : void
name	string	Metric name.
value	double	Metric value.
properties	string>.IDictionary	Named string values you can use to classify and filter metrics.
Результат	void

TrackPageView() публичный Метод

Send information about the page viewed in the application.

public TrackPageView ( PageViewTelemetry telemetry ) : void
telemetry	PageViewTelemetry
Результат	void