venturo_api_manager library

Venturo API Manager A library to manage API requests with Dio

Classes

BackgroundTransformer
The default Transformer for Dio.
BaseOptions
A set of base settings for each Dio(). BaseOptions and Options will be merged into one RequestOptions before sending the requests. See Options.compose.
BindingWrapper
The methods and properties are modelled after the the real binding class.
Structured data to describe more information prior to the event captured. See Sentry.captureEvent().
CachingExceptionTypeIdentifier
CancelToken
Controls cancellation of Dio's requests.
Contexts
The context interfaces provide additional context data.
CostumeConsoleOutput
CustomSentryMeasurementUnit
Custom units without builtin conversion. No formatting will be applied to the measurement value in the Sentry product, and the value with the unit will be shown as is.
DebugImage
The list of debug images contains all dynamic libraries loaded into the process and their memory addresses. Instruction addresses in the Stack Trace are mapped into the list of debug images in order to retrieve debug files for symbolication. There are two kinds of debug images: Native debug images with types macho, elf, and pe Android debug images with type proguard more details : https://develop.sentry.dev/sdk/event-payloads/debugmeta/
DebugMeta
The debug meta interface carries debug information for processing errors and crash reports.
Dio
Dio enables you to make HTTP requests easily.
DioConnectivityRequestRetrier
Dio Connectivity Request Retrier This class is responsible for retrying failed requests when the device regains internet connectivity.
DioMixin
Dsn
The Data Source Name (DSN) tells the SDK where to send the events
ErrorInterceptorHandler
The handler for interceptors to handle error occurred during the request.
EventProcessor
EventProcessors are callbacks that run for every event. They can either return a new event which in most cases means just adding data or return null in case the event will be dropped and not sent.
ExceptionCause
Holds inner exception and stackTrace combinations contained in other exceptions
ExceptionCauseExtractor<T>
Extend this abstract class and return inner ExceptionCause of your exceptions.
ExceptionStackTraceExtractor<T>
Sentry handles Error.stackTrace by default. For other cases extend this abstract class and return a custom StackTrace of your exceptions.
ExceptionTypeIdentifier
An abstract class for identifying the type of Dart errors and exceptions.
FlutterSentryAttachment
FormData
A class to create readable "multipart/form-data" streams. It can be used to submit forms and file uploads to http server.
FusedTransformer
A Transformer that has a fast path for decoding UTF8-encoded JSON. If the response is utf8-encoded JSON and no custom decoder is specified in the RequestOptions, this transformer is significantly faster than the default SyncTransformer and the BackgroundTransformer. This improvement is achieved by using a fused Utf8Decoder and JsonDecoder to decode the response, which is faster than decoding the utf8-encoded JSON in two separate steps, since Dart uses a special fast decoder for this case. See https://github.com/dart-lang/sdk/blob/5b2ea0c7a227d91c691d2ff8cbbeb5f7f86afdb9/sdk/lib/_internal/vm/lib/convert_patch.dart#L40
Headers
The headers class for requests and responses.
Hint
Hints are used in BeforeSendCallback, BeforeBreadcrumbCallback and event processors.
HttpClientAdapter
HttpAdapter is a bridge between Dio and HttpClient.
Hub
SDK API contract which combines a client and scope management
HubAdapter
Hub adapter to make Integrations testable
Integration<T extends SentryOptions>
Code that provides middlewares, bindings or hooks into certain frameworks or environments, along with code that inserts those bindings and activates them.
Interceptor
Interceptor helps to deal with RequestOptions, Response, and DioException during the lifecycle of a request before it reaches users.
Interceptors
A Queue-Model list for Interceptors.
InterceptorsWrapper
A helper class to create interceptors in ease.
ISentrySpan
Represents performance monitoring Span.
IsolateErrorIntegration
NoOp web integration : isolate doesnt' work in browser
KeyPair
ListParam<T>
Indicates a param being used as queries or form data, and how does it gets formatted.
LoadReleaseIntegration
An Integration that loads the release version from native apps
LoggerInterceptor
Logger Interceptor This class provides logging functionality for API requests and responses. It logs request details, responses, and errors to help with debugging and monitoring.
LogInterceptor
LogInterceptor is used to print logs during network requests. It should be the last interceptor added, otherwise modifications by following interceptors will not be logged. This is because the execution of interceptors is in the order of addition.
Mechanism
Sentry Exception Mechanism The exception mechanism is an optional field residing in the Exception Interface. It carries additional information about the way the exception was created on the target system. This includes general exception values obtained from operating system or runtime APIs, as well as mechanism-specific values.
MultipartFile
A file to be uploaded as part of a MultipartRequest. This doesn't need to correspond to a physical file.
NoneSentryMeasurementUnit
Untyped value.
NoOpSentrySpan
OnErrorIntegration
Integration which captures PlatformDispatcher.onError See:
Options
The configuration for a single request. BaseOptions and Options will be merged into one RequestOptions before sending the requests. See Options.compose.
PerformanceCollector
PerformanceContinuousCollector
Used for collecting continuous data about vitals (slow, frozen frames, etc.) during a transaction/span.
PKCS12KeyPair
PlatformChecker
Helper to check in which environment the library is running. The environment checks (release/debug/profile) are mutually exclusive.
PlatformDispatcherWrapper
This class wraps the this as dynamic hack in a type-safe manner. It helps to introduce code, which uses newer features from Flutter without breaking Sentry on older versions of Flutter.
QueuedInterceptor
Interceptor in queue.
QueuedInterceptorsWrapper
A helper class to create queued-interceptors in ease.
RedirectRecord
A record that records the redirection happens during requests, including status code, request method, and the location.
RequestInterceptorHandler
The handler for interceptors to handle before the request has been sent.
RequestOptions
The internal request option class that is the eventual result after BaseOptions and Options are composed.
Response<T>
The Response class contains the payload (could be transformed) that respond from the request, and other information of the response.
ResponseBody
The response wrapper class for adapters.
ResponseInterceptorHandler
The handler for interceptors to handle after respond.
RetryInterceptor
Retry Interceptor This class handles automatic retrying of failed network requests due to connection errors.
RouteObserverBreadcrumb
This class makes it easier to record breadcrumbs for events of Flutters NavigationObserver by accepting RouteSettings.
RSA
RunZonedGuardedIntegration
Integration that runs runner function within runZonedGuarded and capture errors on the runZonedGuarded error handler. See https://api.dart.dev/stable/dart-async/runZonedGuarded.html
Scope
Scope data to be sent with the event
ScopeObserver
SdkInfo
An object describing the system SDK.
SdkVersion
Describes the SDK that is submitting events to Sentry.
SecurityInterceptor
Security Interceptor This class handles API response security by verifying signatures to ensure data integrity and authenticity.
Sentry
Sentry SDK main entry point
SentryApp
App context describes the application.
SentryAssetBundle
An AssetBundle which creates automatic performance traces for loading assets.
SentryAttachment
Arbitrary content which gets attached to an event.
SentryBaggage
SentryBaggageHeader
SentryBrowser
Carries information about the browser or user agent for web-related errors.
SentryClient
Logs crash reports and events to the Sentry.io service.
SentryCulture
Culture Context describes certain properties of the culture in which the software is used.
SentryDevice
This describes the device that caused the event.
SentryDisplayWidget
A widget that reports the Time To Initially Displayed (TTID) of its child widget.
SentryEnvelope
Class representation of Envelope file.
SentryEnvelopeItem
Item holding header information and JSON encoded data.
SentryEvent
An event to be reported to Sentry.io.
SentryException
The Exception Interface specifies an exception or error that occurred in a program.
SentryFeedback
SentryFeedbackWidget
SentryFlutterOptions
This class adds options which are only available in a Flutter environment. Note that some of these options require native Sentry integration, which is not available on all platforms.
SentryGeo
Geographical location of the end user or device.
SentryGpu
GPU context describes the GPU of the device.
SentryHttpClient
A http-package compatible HTTP client.
SentryId
Hexadecimal string representing a uuid4 value. The length is exactly 32 characters. Dashes are not allowed. Has to be lowercase.
SentryInterceptor
Interceptor for handling API request errors and sending them to Sentry.
SentryLevel
Severity of the logged Event.
SentryMask
Wrapping your widget in SentryMask will mask it when capturing replays.
SentryMeasurement
SentryMeasurementUnit
The unit of measurement of a metric value. Units augment metric values by giving them a magnitude and semantics. Units and their precisions are uniquely represented by a string identifier.
SentryMessage
The Message Interface carries a log message that describes an event or error. Optionally, it can carry a format string and structured parameters. This can help to group similar messages into the same issue. example of a serialized message:
SentryNavigatorObserver
This is a navigation observer to record navigational breadcrumbs. For now it only records navigation events and no gestures.
SentryOperatingSystem
Describes the operating system on which the event was created.
SentryOptions
Sentry SDK options
SentryPackage
A SentryPackage part of the SDK.
SentryPrivacyOptions
Configuration of the experimental privacy feature.
SentryProxy
SentryReplayOptions
Configuration of the experimental replay feature.
SentryRequest
The Request interface contains information on a HTTP request related to the event. In client SDKs, this can be an outgoing request, or the request that rendered the current web page. On server SDKs, this could be the incoming web request that is being handled.
SentryResponse
The response interface contains information on a HTTP request related to the event.
SentryRuntime
Describes a runtime in more detail.
SentrySamplingContext
Context used by TracesSamplerCallback to determine if transaction is going to be sampled.
SentryScreenshotWidget
You can add screenshots of child to crash reports by adding this widget. Ideally you are adding it around your app widget like in the following example.
SentryScreenshotWidgetStatus
SentrySpan
SentrySpanContext
SentryStackFrame
Frames belong to a StackTrace It should contain at least a filename, function or instruction_addr
SentryStackTrace
Stacktrace holds information about the frames of the stack.
SentryStatusCode
SentryThread
The Threads Interface specifies threads that were running at the time an event happened. These threads can also contain stack traces. See https://develop.sentry.dev/sdk/event-payloads/threads/
SentryTraceContext
SentryTraceContextHeader
SentryTraceHeader
Represents HTTP header "sentry-trace".
SentryTracesSamplingDecision
SentryTransaction
SentryTransactionContext
SentryTransactionInfo
SentryUnmask
Wrapping your widget in SentryUnmask will unmask it when capturing replays.
SentryUser
Describes the current user associated with the application, such as the currently signed in user.
SentryUserFeedback
SentryUserInteractionWidget
Enables the Auto instrumentation for user interaction tracing. It starts a transaction and finishes after the timeout. It adds a breadcrumb as well.
SentryViewHierarchy
SentryViewHierarchyElement
SentryWidget
This widget serves as a wrapper to include Sentry widgets such as SentryScreenshotWidget and SentryUserInteractionWidget.
SentryWidgetsFlutterBinding
SpanDataConvention
SpanId
The length is exactly 16 characters. Dashes are not allowed. Has to be lowercase.
SpanStatus
The Span statuses
Spotlight
Spotlight configuration class.
SyncTransformer
If you want to custom the transformation of request/response data, you can provide a Transformer by your self, and replace the transformer by setting the Dio.transformer.
TokenInterceptor
Token Interceptor This class handles authentication token management by adding the token to request headers if available.
Transformer
Transformer allows changes to the request/response data before it is sent/received to/from the server.
Transport
A transport is in charge of sending the event/envelope either via http or caching in the disk.
TypeCheckHint
Constants used for Type Check hints.
UnsupportedThrowablesHandler
A handler for unsupported throwables used for Expando
VentDio
VentDioMixin
Provides a mixin for making HTTP requests with Dio.
VentSentryEvent
Sentry Interceptor This class is responsible for integrating Sentry error tracking with API request error handling in Dio.
VenturoApiConfig
Configuration class for Venturo API Extends Dio's BaseOptions to provide default configurations
VenturoApiInterceptor
Venturo API Interceptor This class provides configuration options for API interceptors.
VenturoApiManager
Main class for managing API requests
VenturoApiSecurity
Provides security configuration for API encryption.

Enums

DioExceptionType
The exception enumeration indicates what type of exception has happened during requests.
DurationSentryMeasurementUnit
FractionSentryMeasurementUnit
Hash
InformationSentryMeasurementUnit
ListFormat
Specifies the array format (a single parameter with multiple parameter or multiple parameters with the same name). and the separator for array items.
MaxRequestBodySize
Describes the size of http request bodies which should be added to an event
MaxResponseBodySize
Describes the size of http response bodies which should be added to an event This enum might be removed at any time.
PEMCipher
ResponseType
Indicates which transformation should be applied to the response data.
SaltLength
SentryMaskingDecision
SentryOrientation
If a device is on portrait or landscape mode
SentryProxyType
SentryReplayQuality
The quality of the captured replay.
SentryScreenshotQuality
The quality of the attached screenshot
SentryTransactionNameSource
VenturoHeaderType

Mixins

OptionsMixin
The mixin class for options that provides common attributes.
SentryEventLike<T>
A SentryEventLike mixin that is extended by SentryEvent and SentryTransaction
SentryFlutter
Sentry Flutter SDK main entry point

Extensions

CacheableExceptionIdentifier on ExceptionTypeIdentifier
MaxRequestBodySizeX on MaxRequestBodySize
MaxResponseBodySizeX on MaxResponseBodySize
NativeFramesMeasurement on NativeFrames
ResponseCurlExtension on DioException
Response Curl Extension This extension provides a method to generate a cURL command from a DioException. It is useful for debugging API requests by replicating them in a terminal.
SentryMeasurementUnitExtension on SentryMeasurementUnit
VentDioExtension on Future<Response<T>>

Properties

logger → Logger
final

Functions

addBaggageHeader(SentryBaggageHeader baggage, Map<String, dynamic> headers, {SentryLogger? logger}) → void
addBaggageHeaderFromSpan(ISentrySpan span, Map<String, dynamic> headers, {SentryLogger? logger}) → void
addSentryTraceHeader(SentryTraceHeader traceHeader, Map<String, dynamic> headers) → void
addSentryTraceHeaderFromSpan(ISentrySpan span, Map<String, dynamic> headers) → void
containsTargetOrMatchesRegExp(List<String> tracePropagationTargets, String url) → bool
dartLogger(SentryLevel level, String message, {String? logger, Object? exception, StackTrace? stackTrace}) → void
A Logger that prints out the level and message
isValidSampleRand(double? sampleRand) → bool
isValidSampleRate(double? sampleRate) → bool
noOpLogger(SentryLevel level, String message, {String? logger, Object? exception, StackTrace? stackTrace}) → void
A NoOp logger that does nothing

Typedefs

AdditionalInfoExtractor = Map<String, dynamic>? Function(RouteSettings? from, RouteSettings? to)
AppRunner = FutureOr<void> Function()
Runs a callback inside of the runZonedGuarded method, useful for running your runApp(MyApp())
BeforeBreadcrumbCallback = Breadcrumb? Function(Breadcrumb? breadcrumb, Hint hint)
This function is called with an SDK specific breadcrumb object before the breadcrumb is added to the scope. When nothing is returned from the function, the breadcrumb is dropped
BeforeCaptureCallback = FutureOr<bool> Function(SentryEvent event, Hint hint, bool debounce)
A callback which can be used to suppress capturing of screenshots. It's called in ScreenshotEventProcessor if screenshots are enabled. This gives more fine-grained control over when capturing should be performed, e.g., only capture screenshots for fatal events or override any debouncing for important events.
BeforeMetricCallback = bool Function(String key, {Map<String, String>? tags})
This function is called right before a metric is about to be emitted. Can return true to emit the metric, or false to drop it.
BeforeScreenshotCallback = FutureOr<bool> Function(SentryEvent event, {Hint? hint})
BeforeSendCallback = FutureOr<SentryEvent?> Function(SentryEvent event, Hint hint)
This function is called with an SDK specific event object and can return a modified event object or nothing to skip reporting the event
BeforeSendTransactionCallback = FutureOr<SentryTransaction?> Function(SentryTransaction transaction)
This function is called with an SDK specific transaction object and can return a modified transaction object or nothing to skip reporting the transaction
ClockProvider = DateTime Function()
Used to provide timestamp for logging.
ContentLoader = FutureOr<Uint8List> Function()
DefaultTransformer = SyncTransformer
DioError = DioException
DioError describes the exception info when a request failed.
DioErrorType = DioExceptionType
Deprecated in favor of DioExceptionType and will be removed in future major versions.
DioMediaType = MediaType
The type (alias) for specifying the content-type of the MultipartFile.
ErrorCallback = bool Function(Object exception, StackTrace stackTrace)
FlutterOptionsConfiguration = FutureOr<void> Function(SentryFlutterOptions)
Configuration options callback
HeaderForEachCallback = void Function(String name, List<String> values)
The signature that iterates header fields.
InterceptorErrorCallback = void Function(DioException error, ErrorInterceptorHandler handler)
The signature of Interceptor.onError.
InterceptorSendCallback = void Function(RequestOptions options, RequestInterceptorHandler handler)
The signature of Interceptor.onRequest.
InterceptorSuccessCallback = void Function(Response response, ResponseInterceptorHandler handler)
The signature of Interceptor.onResponse.
JsonDecodeCallback = FutureOr Function(String)
The callback definition for decoding a JSON string.
JsonEncodeCallback = FutureOr<String> Function(Object)
The callback definition for encoding a JSON object.
OnFinishedCallback = Future<void> Function({DateTime? endTimestamp})
OnTransactionFinish = FutureOr<void> Function(ISentrySpan transaction)
Called when a transaction is finished.
OptionsConfiguration = FutureOr<void> Function(SentryOptions)
Configuration options callback
ProgressCallback = void Function(int count, int total)
The type of a progress listening callback when sending or receiving data.
RequestEncoder = FutureOr<List<int>> Function(String request, RequestOptions options)
The type of a request encoding callback.
ResponseDecoder = FutureOr<String?> Function(List<int> responseBytes, RequestOptions options, ResponseBody responseBody)
The type of a response decoding callback.
RouteNameExtractor = RouteSettings? Function(RouteSettings? settings)
RunZonedGuardedOnError = FutureOr<void> Function(Object, StackTrace)
Caught exception and stacktrace in runZonedGuarded
RunZonedGuardedRunner = Future<void> Function()
Called inside of runZonedGuarded
ScopeCallback = FutureOr<void> Function(Scope)
Configures the scope through the callback.
SentryLogger = void Function(SentryLevel level, String message, {Object? exception, String? logger, StackTrace? stackTrace})
Logger interface to log useful debugging information if debug is enabled
SentryScreenshotWidgetOnBuildCallback = bool Function(SentryScreenshotWidgetStatus currentStatus, SentryScreenshotWidgetStatus? previousStatus)
TracesSamplerCallback = double? Function(SentrySamplingContext samplingContext)
ValidateStatus = bool Function(int? status)
The type of a response status code validate callback.

Exceptions / Errors

DioException
DioException describes the exception info when a request failed.
InvalidSentryTraceHeaderException
NotNullableError<T>
A TypeError thrown by _checkNotNullable.
RSAException
SentryHttpClientError
ThrowableMechanism
A decorator that holds a Mechanism related to the decorated Exception