io.sentry

Class SentryClient

java.lang.Object

io.sentry.SentryClient

All Implemented Interfaces:

ISentryClient

public final class SentryClient
extends java.lang.Object
implements ISentryClient

Constructor Summary

Constructors

Constructor and Description
SentryClient(@NotNull SentryOptions options, @Nullable Connection connection)

Method Summary

Modifier and Type	Method and Description
@Nullable SentryId	captureEnvelope(@NotNull SentryEnvelope envelope, @Nullable java.lang.Object hint) Captures an envelope.
@NotNull SentryId	captureEvent(@NotNull SentryEvent event, @Nullable Scope scope, @Nullable java.lang.Object hint) Capture the event
void	captureSession(@NotNull Session session, @Nullable java.lang.Object hint) Captures a session.
SentryId	captureTransaction(@NotNull SentryTransaction transaction, @NotNull Scope scope, @Nullable java.lang.Object hint) Captures a transaction.
void	captureUserFeedback(UserFeedback userFeedback) Captures a manually created user feedback and sends it to Sentry.
void	close() Flushes out the queue for up to timeout seconds and disable the client.
void	flush(long timeoutMillis) Flushes events queued up, but keeps the client enabled.
boolean	isEnabled() Whether the client is enabled or not

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.sentry.ISentryClient

captureEnvelope, captureEvent, captureEvent, captureEvent, captureException, captureException, captureException, captureException, captureMessage, captureMessage, captureSession, captureTransaction

Constructor Detail

SentryClient

public SentryClient(@NotNull
                    @NotNull SentryOptions options,
                    @Nullable
                    @Nullable Connection connection)

Method Detail

isEnabled

public boolean isEnabled()

Description copied from interface: ISentryClient

Whether the client is enabled or not

Specified by:

isEnabled in interface ISentryClient

Returns:

true if its enabled or false otherwise.

captureEvent

@NotNull
public @NotNull SentryId captureEvent(@NotNull
                                               @NotNull SentryEvent event,
                                               @Nullable
                                               @Nullable Scope scope,
                                               @Nullable
                                               @Nullable java.lang.Object hint)

Description copied from interface: ISentryClient

Capture the event

Specified by:

captureEvent in interface ISentryClient

Parameters:

event - the event

scope - An optional scope to be applied to the event.

hint - SDK specific but provides high level information about the origin of the event.

Returns:

The Id (SentryId object) of the event.

captureUserFeedback

public void captureUserFeedback(UserFeedback userFeedback)

Description copied from interface: ISentryClient

Captures a manually created user feedback and sends it to Sentry.

Specified by:

captureUserFeedback in interface ISentryClient

Parameters:

userFeedback - The user feedback to send to Sentry.

captureSession

@ApiStatus.Internal
public void captureSession(@NotNull
                                               @NotNull Session session,
                                               @Nullable
                                               @Nullable java.lang.Object hint)

Description copied from interface: ISentryClient

Captures a session. This method transform a session to an envelope and forwards to captureEnvelope

Specified by:

captureSession in interface ISentryClient

Parameters:

session - the Session

hint - SDK specific but provides high level information about the origin of the event

captureEnvelope

@ApiStatus.Internal
 @Nullable
public @Nullable SentryId captureEnvelope(@NotNull
                                                                         @NotNull SentryEnvelope envelope,
                                                                         @Nullable
                                                                         @Nullable java.lang.Object hint)

Description copied from interface: ISentryClient

Captures an envelope.

Specified by:

captureEnvelope in interface ISentryClient

Parameters:

envelope - the SentryEnvelope to send.

hint - SDK specific but provides high level information about the origin of the event

Returns:

The Id (SentryId object) of the event

captureTransaction

public SentryId captureTransaction(@NotNull
                                   @NotNull SentryTransaction transaction,
                                   @NotNull
                                   @NotNull Scope scope,
                                   @Nullable
                                   @Nullable java.lang.Object hint)

Description copied from interface: ISentryClient

Captures a transaction.

Specified by:

captureTransaction in interface ISentryClient

Parameters:

transaction - the SentryTransaction to send

scope - An optional scope to be applied to the event.

hint - SDK specific but provides high level information about the origin of the event

Returns:

The Id (SentryId object) of the event

close

public void close()

Description copied from interface: ISentryClient

Flushes out the queue for up to timeout seconds and disable the client.

Specified by:

close in interface ISentryClient

flush

public void flush(long timeoutMillis)

Description copied from interface: ISentryClient

Flushes events queued up, but keeps the client enabled. Not implemented yet.

Specified by:

flush in interface ISentryClient

Parameters:

timeoutMillis - time in milliseconds