IMPORTANT: In July 2025, we stopped releasing new versions of KTX modules, and we removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the previously released KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

AbstractOptions

public abstract class AbstractOptions<T extends AbstractOptions<@NonNull T>>

Known direct subclasses

AggregateHints, AggregateOptions, CollectionGroupOptions, CollectionHints, CollectionSourceOptions, FindNearestOptions, Pipeline.ExecuteOptions, RawOptions, UnnestOptions

`AggregateHints`
`AggregateOptions`
`CollectionGroupOptions`
`CollectionHints`
`CollectionSourceOptions`
`FindNearestOptions`
`Pipeline.ExecuteOptions`
`RawOptions`
`UnnestOptions`

Summary

Public methods
`final @NonNull T`	`with(@NonNull String key, boolean value)` Specify generic `Boolean` option
`final @NonNull T`	`with(@NonNull String key, double value)` Specify generic `Double` option
`final @NonNull T`	`with(@NonNull String key, @NonNull Field value)` Specify generic `Field` option
`final @NonNull T`	`with(@NonNull String key, long value)` Specify generic `Long` option
`final @NonNull T`	`with(@NonNull String key, @NonNull RawOptions value)` Specify `RawOptions` object
`final @NonNull T`	`with(@NonNull String key, @NonNull String value)` Specify generic `String` option

Protected methods
`final @NonNull T`	`adding(@NonNull AbstractOptions<@NonNull ?> newOptions)`
`final @NonNull T`	`with(@NonNull String key, @NonNull AbstractOptions<@NonNull ?> subSection)`
`final @NonNull T`	`with(@NonNull String key, @NonNull <Error class: unknown class> value)`
`final @NonNull T`	`with(@NonNull String key, @NonNull InternalOptions value)`
`final @NonNull T`	`with(@NonNull String key, @NonNull String values)`

Public methods

with

public final @NonNull T with(@NonNull String key, boolean value)

Specify generic Boolean option

Parameters
`@NonNull String key`	The option key
`boolean value`	The `Boolean` value of option

Returns
`@NonNull T`	A new options object.

with

public final @NonNull T with(@NonNull String key, double value)

Specify generic Double option

Parameters
`@NonNull String key`	The option key
`double value`	The `Double` value of option

Returns
`@NonNull T`	A new options object.

with

public final @NonNull T with(@NonNull String key, @NonNull Field value)

Specify generic Field option

Parameters
`@NonNull String key`	The option key
`@NonNull Field value`	The `Field` value of option

Returns
`@NonNull T`	A new options object.

with

public final @NonNull T with(@NonNull String key, long value)

Specify generic Long option

Parameters
`@NonNull String key`	The option key
`long value`	The `Long` value of option

Returns
`@NonNull T`	A new options object.

with

public final @NonNull T with(@NonNull String key, @NonNull RawOptions value)

Specify RawOptions object

Parameters
`@NonNull String key`	The option key
`@NonNull RawOptions value`	The `RawOptions` object

Returns
`@NonNull T`	A new options object.

with

public final @NonNull T with(@NonNull String key, @NonNull String value)

Specify generic String option

Parameters
`@NonNull String key`	The option key
`@NonNull String value`	The `String` value of option

Returns
`@NonNull T`	A new options object.

Protected methods

adding

protected final @NonNull T adding(@NonNull AbstractOptions<@NonNull ?> newOptions)

with

protected final @NonNull T with(@NonNull String key, @NonNull AbstractOptions<@NonNull ?> subSection)

with

protected final @NonNull T with(@NonNull String key, @NonNull <Error class: unknown class> value)

with

protected final @NonNull T with(@NonNull String key, @NonNull InternalOptions value)

with

protected final @NonNull T with(@NonNull String key, @NonNull String values)