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.

MetadataChanges

enum MetadataChanges

Indicates whether metadata-only changes (that is, only DocumentSnapshot.getMetadata() or QuerySnapshot.getMetadata() changed) should trigger snapshot events.

Summary

Enum Values
`EXCLUDE`
`INCLUDE`

Public functions
`java-static MetadataChanges!`	`valueOf(name: String!)` Returns the enum constant of this type with the specified name.
`java-static Array<MetadataChanges!>!`	`values()` Returns an array containing the constants of this enum type, in the order they're declared.

Enum Values

EXCLUDE

val MetadataChanges.EXCLUDE: MetadataChanges

INCLUDE

val MetadataChanges.INCLUDE: MetadataChanges

Public functions

valueOf

java-static fun valueOf(name: String!): MetadataChanges!

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Returns
`MetadataChanges!`	the enum constant with the specified name

Throws
`java.lang.IllegalArgumentException: java.lang.IllegalArgumentException`	if this enum type has no constant with the specified name

values

java-static fun values(): Array<MetadataChanges!>!

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants.

Returns
`Array<MetadataChanges!>!`	an array containing the constants of this enum type, in the order they're declared