io.sentry

Class Scope

java.lang.Object

io.sentry.Scope

All Implemented Interfaces:

java.lang.Cloneable

public final class Scope
extends java.lang.Object
implements java.lang.Cloneable

Scope data to be sent with the event

Constructor Summary

Constructors

Constructor and Description
Scope(@NotNull SentryOptions options) Scope's ctor

Method Summary

Modifier and Type	Method and Description
void	addBreadcrumb(@NotNull Breadcrumb breadcrumb) Adds a breadcrumb to the breadcrumbs queue It also executes the BeforeBreadcrumb callback if set
void	addBreadcrumb(@NotNull Breadcrumb breadcrumb, @Nullable java.lang.Object hint) Adds a breadcrumb to the breadcrumbs queue It also executes the BeforeBreadcrumb callback if set
void	addEventProcessor(@NotNull EventProcessor eventProcessor) Adds an event processor to the Scope's event processors list
void	clear() Resets the Scope to its default state
void	clearBreadcrumbs() Clear all the breadcrumbs
@NotNull Scope	clone() Clones a Scope aka deep copy
@NotNull Contexts	getContexts() Returns the Scope's contexts
@Nullable SentryLevel	getLevel() Returns the Scope's SentryLevel
@Nullable java.lang.String	getTransaction() Returns the Scope's transaction
@Nullable User	getUser() Returns the Scope's user
void	removeContexts(@NotNull java.lang.String key) Removes a value from the Scope's contexts
void	removeExtra(@NotNull java.lang.String key) Removes an extra from the Scope's extras
void	removeTag(@NotNull java.lang.String key) Removes a tag from the Scope's tags
void	setContexts(@NotNull java.lang.String key, @NotNull java.lang.Boolean value) Sets the Scope's contexts
void	setContexts(@NotNull java.lang.String key, @NotNull java.lang.Number value) Sets the Scope's contexts
void	setContexts(@NotNull java.lang.String key, @NotNull java.lang.Object value) Sets the Scope's contexts
void	setContexts(@NotNull java.lang.String key, @NotNull java.lang.String value) Sets the Scope's contexts
void	setExtra(@NotNull java.lang.String key, @NotNull java.lang.String value) Sets an extra to the Scope's extra map
void	setFingerprint(@NotNull java.util.List<java.lang.String> fingerprint) Sets the Scope's fingerprint list
void	setLevel(@Nullable SentryLevel level) Sets the Scope's SentryLevel Level from scope exceptionally take precedence over the event
void	setTag(@NotNull java.lang.String key, @NotNull java.lang.String value) Sets a tag to Scope's tags
void	setTransaction(@Nullable java.lang.String transaction) Sets the Scope's transaction
void	setUser(@Nullable User user) Sets the Scope's user

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Scope

public Scope(@NotNull
             @NotNull SentryOptions options)

Scope's ctor

Parameters:

options - the options

Method Detail

getLevel

@Nullable
public @Nullable SentryLevel getLevel()

Returns the Scope's SentryLevel

Returns:

the SentryLevel

setLevel

public void setLevel(@Nullable
                     @Nullable SentryLevel level)

Sets the Scope's SentryLevel Level from scope exceptionally take precedence over the event

Parameters:

level - the SentryLevel

getTransaction

@Nullable
public @Nullable java.lang.String getTransaction()

Returns the Scope's transaction

Returns:

the transaction

setTransaction

public void setTransaction(@Nullable
                           @Nullable java.lang.String transaction)

Sets the Scope's transaction

Parameters:

transaction - the transaction

getUser

@Nullable
public @Nullable User getUser()

Returns the Scope's user

Returns:

the user

setUser

public void setUser(@Nullable
                    @Nullable User user)

Sets the Scope's user

Parameters:

user - the user

setFingerprint

public void setFingerprint(@NotNull
                           @NotNull java.util.List<java.lang.String> fingerprint)

Sets the Scope's fingerprint list

Parameters:

fingerprint - the fingerprint list

addBreadcrumb

public void addBreadcrumb(@NotNull
                          @NotNull Breadcrumb breadcrumb,
                          @Nullable
                          @Nullable java.lang.Object hint)

Adds a breadcrumb to the breadcrumbs queue It also executes the BeforeBreadcrumb callback if set

Parameters:

breadcrumb - the breadcrumb

hint - the hint

addBreadcrumb

public void addBreadcrumb(@NotNull
                          @NotNull Breadcrumb breadcrumb)

Adds a breadcrumb to the breadcrumbs queue It also executes the BeforeBreadcrumb callback if set

Parameters:

breadcrumb - the breadcrumb

clearBreadcrumbs

public void clearBreadcrumbs()

Clear all the breadcrumbs

clear

public void clear()

Resets the Scope to its default state

setTag

public void setTag(@NotNull
                   @NotNull java.lang.String key,
                   @NotNull
                   @NotNull java.lang.String value)

Sets a tag to Scope's tags

Parameters:

key - the key

value - the value

removeTag

public void removeTag(@NotNull
                      @NotNull java.lang.String key)

Removes a tag from the Scope's tags

Parameters:

key - the key

setExtra

public void setExtra(@NotNull
                     @NotNull java.lang.String key,
                     @NotNull
                     @NotNull java.lang.String value)

Sets an extra to the Scope's extra map

Parameters:

key - the key

value - the value

removeExtra

public void removeExtra(@NotNull
                        @NotNull java.lang.String key)

Removes an extra from the Scope's extras

Parameters:

key - the key

getContexts

@NotNull
public @NotNull Contexts getContexts()

Returns the Scope's contexts

Returns:

the contexts

setContexts

public void setContexts(@NotNull
                        @NotNull java.lang.String key,
                        @NotNull
                        @NotNull java.lang.Object value)

Sets the Scope's contexts

Parameters:

key - the context key

value - the context value

setContexts

public void setContexts(@NotNull
                        @NotNull java.lang.String key,
                        @NotNull
                        @NotNull java.lang.Boolean value)

Sets the Scope's contexts

Parameters:

key - the context key

value - the context value

setContexts

public void setContexts(@NotNull
                        @NotNull java.lang.String key,
                        @NotNull
                        @NotNull java.lang.String value)

Sets the Scope's contexts

Parameters:

key - the context key

value - the context value

setContexts

public void setContexts(@NotNull
                        @NotNull java.lang.String key,
                        @NotNull
                        @NotNull java.lang.Number value)

Sets the Scope's contexts

Parameters:

key - the context key

value - the context value

removeContexts

public void removeContexts(@NotNull
                           @NotNull java.lang.String key)

Removes a value from the Scope's contexts

Parameters:

key - the Key

clone

@NotNull
public @NotNull Scope clone()
                              throws java.lang.CloneNotSupportedException

Clones a Scope aka deep copy

Overrides:

clone in class java.lang.Object

Returns:

the cloned Scope

Throws:

java.lang.CloneNotSupportedException - if object is not cloneable

addEventProcessor

public void addEventProcessor(@NotNull
                              @NotNull EventProcessor eventProcessor)

Adds an event processor to the Scope's event processors list

Parameters:

eventProcessor - the event processor