import { Breadcrumb } from './breadcrumb'; import { Context, Contexts } from './context'; import { EventProcessor } from './eventprocessor'; import { Extra, Extras } from './extra'; import { Primitive } from './misc'; import { RequestSession, Session } from './session'; import { Severity } from './severity'; import { Span } from './span'; import { Transaction } from './transaction'; import { User } from './user'; /** JSDocs */ export declare type CaptureContext = Scope | Partial | ((scope: Scope) => Scope); /** JSDocs */ export interface ScopeContext { user: User; level: Severity; extra: Extras; contexts: Contexts; tags: { [key: string]: Primitive; }; fingerprint: string[]; requestSession: RequestSession; } /** * Holds additional event information. {@link Scope.applyToEvent} will be * called by the client before an event will be sent. */ export interface Scope { /** Add new event processor that will be called after {@link applyToEvent}. */ addEventProcessor(callback: EventProcessor): this; /** * Updates user context information for future events. * * @param user User context object to be set in the current context. Pass `null` to unset the user. */ setUser(user: User | null): this; /** * Returns the `User` if there is one */ getUser(): User | undefined; /** * Set an object that will be merged sent as tags data with the event. * @param tags Tags context object to merge into current context. */ setTags(tags: { [key: string]: Primitive; }): this; /** * Set key:value that will be sent as tags data with the event. * * Can also be used to unset a tag by passing `undefined`. * * @param key String key of tag * @param value Value of tag */ setTag(key: string, value: Primitive): this; /** * Set an object that will be merged sent as extra data with the event. * @param extras Extras object to merge into current context. */ setExtras(extras: Extras): this; /** * Set key:value that will be sent as extra data with the event. * @param key String of extra * @param extra Any kind of data. This data will be normalized. */ setExtra(key: string, extra: Extra): this; /** * Sets the fingerprint on the scope to send with the events. * @param fingerprint string[] to group events in Sentry. */ setFingerprint(fingerprint: string[]): this; /** * Sets the level on the scope for future events. * @param level string {@link Severity} */ setLevel(level: Severity): this; /** * Sets the transaction name on the scope for future events. */ setTransactionName(name?: string): this; /** * Sets context data with the given name. * @param name of the context * @param context an object containing context data. This data will be normalized. Pass `null` to unset the context. */ setContext(name: string, context: Context | null): this; /** * Sets the Span on the scope. * @param span Span */ setSpan(span?: Span): this; /** * Returns the `Span` if there is one */ getSpan(): Span | undefined; /** * Returns the `Transaction` attached to the scope (if there is one) */ getTransaction(): Transaction | undefined; /** * Returns the `Session` if there is one */ getSession(): Session | undefined; /** * Sets the `Session` on the scope */ setSession(session?: Session): this; /** * Returns the `RequestSession` if there is one */ getRequestSession(): RequestSession | undefined; /** * Sets the `RequestSession` on the scope */ setRequestSession(requestSession?: RequestSession): this; /** * Updates the scope with provided data. Can work in three variations: * - plain object containing updatable attributes * - Scope instance that'll extract the attributes from * - callback function that'll receive the current scope as an argument and allow for modifications * @param captureContext scope modifier to be used */ update(captureContext?: CaptureContext): this; /** Clears the current scope and resets its properties. */ clear(): this; /** * Sets the breadcrumbs in the scope * @param breadcrumbs Breadcrumb * @param maxBreadcrumbs number of max breadcrumbs to merged into event. */ addBreadcrumb(breadcrumb: Breadcrumb, maxBreadcrumbs?: number): this; /** * Clears all currently set Breadcrumbs. */ clearBreadcrumbs(): this; } //# sourceMappingURL=scope.d.ts.map