io.sentry.core

Interface ISentryClient

All Known Implementing Classes:

SentryClient

public interface ISentryClient

Sentry Client interface

Method Summary

Modifier and Type	Method and Description
default SentryId	captureEnvelope(SentryEnvelope envelope) Captures an envelope.
SentryId	captureEnvelope(SentryEnvelope envelope, @Nullable java.lang.Object hint) Captures an envelope.
default SentryId	captureEvent(SentryEvent event) Captures the event.
default SentryId	captureEvent(SentryEvent event, @Nullable java.lang.Object hint) Capture the event
default SentryId	captureEvent(SentryEvent event, @Nullable Scope scope) Captures the event.
SentryId	captureEvent(SentryEvent event, @Nullable Scope scope, @Nullable java.lang.Object hint) Capture the event
default SentryId	captureException(java.lang.Throwable throwable) Captures the exception.
default SentryId	captureException(java.lang.Throwable throwable, @Nullable java.lang.Object hint) Captures the exception.
default SentryId	captureException(java.lang.Throwable throwable, @Nullable Scope scope) Captures the exception.
default SentryId	captureException(java.lang.Throwable throwable, @Nullable Scope scope, @Nullable java.lang.Object hint) Captures the exception.
default SentryId	captureMessage(java.lang.String message, SentryLevel level) Captures the message.
default SentryId	captureMessage(java.lang.String message, SentryLevel level, @Nullable Scope scope) Captures the message.
default void	captureSession(Session session) Captures a session.
void	captureSession(Session session, @Nullable java.lang.Object hint) Captures a session.
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

Method Detail

isEnabled

boolean isEnabled()

Whether the client is enabled or not

Returns:

true if its enabled or false otherwise.

captureEvent

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

Capture the event

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.

close

void close()

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

flush

void flush(long timeoutMillis)

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

Parameters:

timeoutMillis - time in milliseconds

captureEvent

default SentryId captureEvent(SentryEvent event)

Captures the event.

Parameters:

event - the event

Returns:

The Id (SentryId object) of the event

captureEvent

default SentryId captureEvent(SentryEvent event,
                              @Nullable
                              @Nullable Scope scope)

Captures the event.

Parameters:

event - the event

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

Returns:

The Id (SentryId object) of the event

captureEvent

default SentryId captureEvent(SentryEvent event,
                              @Nullable
                              @Nullable java.lang.Object hint)

Capture the event

Parameters:

event - the event

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

Returns:

The Id (SentryId object) of the event.

captureMessage

default SentryId captureMessage(java.lang.String message,
                                SentryLevel level,
                                @Nullable
                                @Nullable Scope scope)

Captures the message.

Parameters:

message - The message to send.

level - The message level.

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

Returns:

The Id (SentryId object) of the event

captureMessage

default SentryId captureMessage(java.lang.String message,
                                SentryLevel level)

Captures the message.

Parameters:

message - The message to send.

level - The message level.

Returns:

The Id (SentryId object) of the event

captureException

default SentryId captureException(java.lang.Throwable throwable)

Captures the exception.

Parameters:

throwable - The exception.

Returns:

The Id (SentryId object) of the event

captureException

default SentryId captureException(java.lang.Throwable throwable,
                                  @Nullable
                                  @Nullable Scope scope,
                                  @Nullable
                                  @Nullable java.lang.Object hint)

Captures the exception.

Parameters:

throwable - The exception.

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

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

Returns:

The Id (SentryId object) of the event

captureException

default SentryId captureException(java.lang.Throwable throwable,
                                  @Nullable
                                  @Nullable java.lang.Object hint)

Captures the exception.

Parameters:

throwable - The exception.

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

Returns:

The Id (SentryId object) of the event

captureException

default SentryId captureException(java.lang.Throwable throwable,
                                  @Nullable
                                  @Nullable Scope scope)

Captures the exception.

Parameters:

throwable - The exception.

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

Returns:

The Id (SentryId object) of the event

captureSession

void captureSession(Session session,
                    @Nullable
                    @Nullable java.lang.Object hint)

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

Parameters:

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

session - the Session

captureSession

default void captureSession(Session session)

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

Parameters:

session - the Session

captureEnvelope

SentryId captureEnvelope(SentryEnvelope envelope,
                         @Nullable
                         @Nullable java.lang.Object hint)

Captures an envelope.

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

captureEnvelope

default SentryId captureEnvelope(SentryEnvelope envelope)

Captures an envelope.

Parameters:

envelope - the SentryEnvelope to send.

Returns:

The Id (SentryId object) of the event