Interface ClickCallback.Options

Enclosing interface:

ClickCallback<T extends Audience>

public static sealed interface ClickCallback.Options

Options to configure how a callback can be executed.

Since:

4.13.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ClickCallback.Options.Builder	A builder for callback options.

Method Summary

Modifier and Type	Method	Description
static ClickCallback.Options.Builder	builder()	Create a new builder.
static ClickCallback.Options.Builder	builder(ClickCallback.Options existing)	Create a new builder populating from existing options.
Duration	lifetime()	How long this callback will last until it is made invalid.
int	uses()	The number of times this callback can be executed.

Method Details

builder

static ClickCallback.Options.Builder builder()

Create a new builder.

Returns:

the new builder

Since:

4.13.0

builder

static ClickCallback.Options.Builder builder(ClickCallback.Options existing)

Create a new builder populating from existing options.

Parameters:

existing - the existing options to populate this builder with

Returns:

the new builder

Since:

4.13.0

uses

int uses()

The number of times this callback can be executed.

By default callbacks are single-use.

Returns:

allowable use count, or ClickCallback.UNLIMITED_USES

Since:

4.13.0

lifetime

Duration lifetime()

How long this callback will last until it is made invalid.

By default callbacks last the value of ClickCallback.DEFAULT_LIFETIME.

Returns:

the duration of this callback

Since:

4.13.0