245 lines
9.1 KiB
Objective-C
245 lines
9.1 KiB
Objective-C
|
|
#if __has_include(<Sentry/Sentry.h>)
|
|
# import <Sentry/SentryDefines.h>
|
|
# import <Sentry/SentrySpanProtocol.h>
|
|
#else
|
|
# import <SentryWithoutUIKit/SentryDefines.h>
|
|
# import <SentryWithoutUIKit/SentrySpanProtocol.h>
|
|
#endif
|
|
|
|
@class SentryEvent, SentryClient, SentryScope, SentryUser, SentryBreadcrumb, SentryId,
|
|
SentryUserFeedback, SentryTransactionContext;
|
|
@class SentryMetricsAPI;
|
|
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
@interface SentryHub : NSObject
|
|
SENTRY_NO_INIT
|
|
|
|
- (instancetype)initWithClient:(SentryClient *_Nullable)client
|
|
andScope:(SentryScope *_Nullable)scope;
|
|
|
|
@property (nonatomic, readonly) SentryMetricsAPI *metrics;
|
|
|
|
/**
|
|
* Starts a new SentrySession. If there's a running SentrySession, it ends it before starting the
|
|
* new one. You can use this method in combination with endSession to manually track SentrySessions.
|
|
* The SDK uses SentrySession to inform Sentry about release and project associated project health.
|
|
*/
|
|
- (void)startSession;
|
|
|
|
/**
|
|
* Ends the current SentrySession. You can use this method in combination with startSession to
|
|
* manually track SentrySessions. The SDK uses SentrySession to inform Sentry about release and
|
|
* project associated project health.
|
|
*/
|
|
- (void)endSession;
|
|
|
|
/**
|
|
* Ends the current session with the given timestamp.
|
|
* @param timestamp The timestamp to end the session with.
|
|
*/
|
|
- (void)endSessionWithTimestamp:(NSDate *)timestamp;
|
|
|
|
/**
|
|
* Captures a manually created event and sends it to Sentry.
|
|
* @param event The event to send to Sentry.
|
|
* @return The SentryId of the event or SentryId.empty if the event is not sent.
|
|
*/
|
|
- (SentryId *)captureEvent:(SentryEvent *)event NS_SWIFT_NAME(capture(event:));
|
|
|
|
/**
|
|
* Captures a manually created event and sends it to Sentry.
|
|
* @param event The event to send to Sentry.
|
|
* @param scope The scope containing event metadata.
|
|
* @return The SentryId of the event or SentryId.empty if the event is not sent.
|
|
*/
|
|
- (SentryId *)captureEvent:(SentryEvent *)event
|
|
withScope:(SentryScope *)scope NS_SWIFT_NAME(capture(event:scope:));
|
|
|
|
/**
|
|
* Creates a transaction, binds it to the hub and returns the instance.
|
|
* @param name The transaction name.
|
|
* @param operation Short code identifying the type of operation the span is measuring.
|
|
* @return The created transaction.
|
|
*/
|
|
- (id<SentrySpan>)startTransactionWithName:(NSString *)name
|
|
operation:(NSString *)operation
|
|
NS_SWIFT_NAME(startTransaction(name:operation:));
|
|
|
|
/**
|
|
* Creates a transaction, binds it to the hub and returns the instance.
|
|
* @param name The transaction name.
|
|
* @param operation Short code identifying the type of operation the span is measuring.
|
|
* @param bindToScope Indicates whether the SDK should bind the new transaction to the scope.
|
|
* @return The created transaction.
|
|
*/
|
|
- (id<SentrySpan>)startTransactionWithName:(NSString *)name
|
|
operation:(NSString *)operation
|
|
bindToScope:(BOOL)bindToScope
|
|
NS_SWIFT_NAME(startTransaction(name:operation:bindToScope:));
|
|
|
|
/**
|
|
* Creates a transaction, binds it to the hub and returns the instance.
|
|
* @param transactionContext The transaction context.
|
|
* @return The created transaction.
|
|
*/
|
|
- (id<SentrySpan>)startTransactionWithContext:(SentryTransactionContext *)transactionContext
|
|
NS_SWIFT_NAME(startTransaction(transactionContext:));
|
|
|
|
/**
|
|
* Creates a transaction, binds it to the hub and returns the instance.
|
|
* @param transactionContext The transaction context.
|
|
* @param bindToScope Indicates whether the SDK should bind the new transaction to the scope.
|
|
* @return The created transaction.
|
|
*/
|
|
- (id<SentrySpan>)startTransactionWithContext:(SentryTransactionContext *)transactionContext
|
|
bindToScope:(BOOL)bindToScope
|
|
NS_SWIFT_NAME(startTransaction(transactionContext:bindToScope:));
|
|
|
|
/**
|
|
* Creates a transaction, binds it to the hub and returns the instance.
|
|
* @param transactionContext The transaction context.
|
|
* @param bindToScope Indicates whether the SDK should bind the new transaction to the scope.
|
|
* @param customSamplingContext Additional information about the sampling context.
|
|
* @return The created transaction.
|
|
*/
|
|
- (id<SentrySpan>)startTransactionWithContext:(SentryTransactionContext *)transactionContext
|
|
bindToScope:(BOOL)bindToScope
|
|
customSamplingContext:(NSDictionary<NSString *, id> *)customSamplingContext
|
|
NS_SWIFT_NAME(startTransaction(transactionContext:bindToScope:customSamplingContext:));
|
|
|
|
/**
|
|
* Creates a transaction, binds it to the hub and returns the instance.
|
|
* @param transactionContext The transaction context.
|
|
* @param customSamplingContext Additional information about the sampling context.
|
|
* @return The created transaction.
|
|
*/
|
|
- (id<SentrySpan>)startTransactionWithContext:(SentryTransactionContext *)transactionContext
|
|
customSamplingContext:(NSDictionary<NSString *, id> *)customSamplingContext
|
|
NS_SWIFT_NAME(startTransaction(transactionContext:customSamplingContext:));
|
|
|
|
/**
|
|
* Captures an error event and sends it to Sentry.
|
|
* @param error The error to send to Sentry.
|
|
* @return The @c SentryId of the event or @c SentryId.empty if the event is not sent.
|
|
*/
|
|
- (SentryId *)captureError:(NSError *)error NS_SWIFT_NAME(capture(error:));
|
|
|
|
/**
|
|
* Captures an error event and sends it to Sentry.
|
|
* @param error The error to send to Sentry.
|
|
* @param scope The scope containing event metadata.
|
|
* @return The @c SentryId of the event or @c SentryId.empty if the event is not sent.
|
|
*/
|
|
- (SentryId *)captureError:(NSError *)error
|
|
withScope:(SentryScope *)scope NS_SWIFT_NAME(capture(error:scope:));
|
|
|
|
/**
|
|
* Captures an exception event and sends it to Sentry.
|
|
* @param exception The exception to send to Sentry.
|
|
* @return The @c SentryId of the event or @c SentryId.empty if the event is not sent.
|
|
*/
|
|
- (SentryId *)captureException:(NSException *)exception NS_SWIFT_NAME(capture(exception:));
|
|
|
|
/**
|
|
* Captures an exception event and sends it to Sentry.
|
|
* @param exception The exception to send to Sentry.
|
|
* @param scope The scope containing event metadata.
|
|
* @return The @c SentryId of the event or @c SentryId.empty if the event is not sent.
|
|
*/
|
|
- (SentryId *)captureException:(NSException *)exception
|
|
withScope:(SentryScope *)scope NS_SWIFT_NAME(capture(exception:scope:));
|
|
|
|
/**
|
|
* Captures a message event and sends it to Sentry.
|
|
* @param message The message to send to Sentry.
|
|
* @return The @c SentryId of the event or @c SentryId.empty if the event is not sent.
|
|
*/
|
|
- (SentryId *)captureMessage:(NSString *)message NS_SWIFT_NAME(capture(message:));
|
|
|
|
/**
|
|
* Captures a message event and sends it to Sentry.
|
|
* @param message The message to send to Sentry.
|
|
* @param scope The scope containing event metadata.
|
|
* @return The @c SentryId of the event or @c SentryId.empty if the event is not sent.
|
|
*/
|
|
- (SentryId *)captureMessage:(NSString *)message
|
|
withScope:(SentryScope *)scope NS_SWIFT_NAME(capture(message:scope:));
|
|
|
|
/**
|
|
* Captures a manually created user feedback and sends it to Sentry.
|
|
* @param userFeedback The user feedback to send to Sentry.
|
|
*/
|
|
- (void)captureUserFeedback:(SentryUserFeedback *)userFeedback
|
|
NS_SWIFT_NAME(capture(userFeedback:));
|
|
|
|
/**
|
|
* Use this method to modify the Scope of the Hub. The SDK uses the Scope to attach
|
|
* contextual data to events.
|
|
* @param callback The callback for configuring the Scope of the Hub.
|
|
*/
|
|
- (void)configureScope:(void (^)(SentryScope *scope))callback;
|
|
|
|
/**
|
|
* Adds a breadcrumb to the Scope of the Hub.
|
|
* @param crumb The Breadcrumb to add to the Scope of the Hub.
|
|
*/
|
|
- (void)addBreadcrumb:(SentryBreadcrumb *)crumb;
|
|
|
|
/**
|
|
* Returns a client if there is a bound client on the Hub.
|
|
*/
|
|
- (SentryClient *_Nullable)getClient;
|
|
|
|
/**
|
|
* Returns either the current scope or a new one if it was @c nil .
|
|
*/
|
|
@property (nonatomic, readonly, strong) SentryScope *scope;
|
|
|
|
/**
|
|
* Binds a different client to the hub.
|
|
*/
|
|
- (void)bindClient:(SentryClient *_Nullable)client;
|
|
|
|
/**
|
|
* Checks if integration is activated.
|
|
*/
|
|
- (BOOL)hasIntegration:(NSString *)integrationName;
|
|
|
|
/**
|
|
* Checks if a specific Integration (@c integrationClass) has been installed.
|
|
* @return @c YES if instance of @c integrationClass exists within
|
|
* @c SentryHub.installedIntegrations
|
|
*/
|
|
- (BOOL)isIntegrationInstalled:(Class)integrationClass;
|
|
|
|
/**
|
|
* Set user to the Scope of the Hub.
|
|
* @param user The user to set to the Scope.
|
|
*/
|
|
- (void)setUser:(SentryUser *_Nullable)user;
|
|
|
|
/**
|
|
* Reports to the ongoing UIViewController transaction
|
|
* that the screen contents are fully loaded and displayed,
|
|
* which will create a new span.
|
|
*/
|
|
- (void)reportFullyDisplayed;
|
|
|
|
/**
|
|
* Waits synchronously for the SDK to flush out all queued and cached items for up to the specified
|
|
* timeout in seconds. If there is no internet connection, the function returns immediately. The SDK
|
|
* doesn't dispose the client or the hub.
|
|
* @param timeout The time to wait for the SDK to complete the flush.
|
|
*/
|
|
- (void)flush:(NSTimeInterval)timeout NS_SWIFT_NAME(flush(timeout:));
|
|
|
|
/**
|
|
* Calls flush with @c SentryOptions/shutdownTimeInterval .
|
|
*/
|
|
- (void)close;
|
|
|
|
@end
|
|
|
|
NS_ASSUME_NONNULL_END
|